Coverage for skema/gromet/metadata/text_description.py: 45%

1# coding: utf-8 

2 

3""" 

4 GroMEt Metadata spec 

5 

6 Grounded Model Exchange (GroMEt) Metadata schema specification __Using Swagger to Generate Class Structure__ To automatically generate Python or Java models corresponding to this document, you can use [swagger-codegen](https://swagger.io/tools/swagger-codegen/). We can use this to generate client code based off of this spec that will also generate the class structure. 1. Install via the method described for your operating system [here](https://github.com/swagger-api/swagger-codegen#Prerequisites). Make sure to install a version after 3.0 that will support openapi 3. 2. Run swagger-codegen with the options in the example below. The URL references where the yaml for this documentation is stored on github. Make sure to replace CURRENT_VERSION with the correct version. (The current version is `0.1.4`.) To generate Java classes rather, change the `-l python` to `-l java`. Change the value to the `-o` option to the desired output location. ``` swagger-codegen generate -l python -o ./client -i https://raw.githubusercontent.com/ml4ai/automates-v2/master/docs/source/gromet_metadata_v{CURRENT_VERSION}.yaml ``` 3. Once it executes, the client code will be generated at your specified location. For python, the classes will be located in `$OUTPUT_PATH/swagger_client/models/`. For java, they will be located in `$OUTPUT_PATH/src/main/java/io/swagger/client/model/` If generating GroMEt Metadata schema data model classes in SKEMA (AutoMATES), then after generating the above, follow the instructions here: ``` <automates>/automates/model_assembly/gromet/metadata/README.md ``` # noqa: E501 

7 

8 OpenAPI spec version: 0.1.8 

9 Contact: claytonm@arizona.edu 

10 Generated by: https://github.com/swagger-api/swagger-codegen.git 

11""" 

12 

13import pprint 

14import re # noqa: F401 

15 

16import six 

17from skema.gromet.metadata.text_extraction_metadata import TextExtractionMetadata # noqa: F401,E501 

18 

19class TextDescription(TextExtractionMetadata): 

20 """NOTE: This class is auto generated by the swagger code generator program. 

21 

22 Do not edit the class manually. 

23 """ 

24 """ 

25 Attributes: 

26 swagger_types (dict): The key is attribute name 

27 and the value is attribute type. 

28 attribute_map (dict): The key is attribute name 

29 and the value is json key in definition. 

30 """ 

31 swagger_types = { 

32 'gromet_type': 'str', 

33 'text_extraction': 'TextExtraction', 

34 'variable_identifier': 'str', 

35 'variable_definition': 'str' 

36 } 

37 if hasattr(TextExtractionMetadata, "swagger_types"): 

38 swagger_types.update(TextExtractionMetadata.swagger_types) 

39 

40 attribute_map = { 

41 'gromet_type': 'gromet_type', 

42 'text_extraction': 'text_extraction', 

43 'variable_identifier': 'variable_identifier', 

44 'variable_definition': 'variable_definition' 

45 } 

46 if hasattr(TextExtractionMetadata, "attribute_map"): 

47 attribute_map.update(TextExtractionMetadata.attribute_map) 

48 

49 def __init__(self, gromet_type='TextDescription', text_extraction=None, variable_identifier=None, variable_definition=None, *args, **kwargs): # noqa: E501 

50 """TextDescription - a model defined in Swagger""" # noqa: E501 

51 self._gromet_type = None 

52 self._text_extraction = None 

53 self._variable_identifier = None 

54 self._variable_definition = None 

55 self.discriminator = None 

56 if gromet_type is not None: 

57 self.gromet_type = gromet_type 

58 if text_extraction is not None: 

59 self.text_extraction = text_extraction 

60 if variable_identifier is not None: 

61 self.variable_identifier = variable_identifier 

62 if variable_definition is not None: 

63 self.variable_definition = variable_definition 

64 TextExtractionMetadata.__init__(self, *args, **kwargs) 

65 

66 @property 

67 def gromet_type(self): 

68 """Gets the gromet_type of this TextDescription. # noqa: E501 

69 

70 

71 :return: The gromet_type of this TextDescription. # noqa: E501 

72 :rtype: str 

73 """ 

74 return self._gromet_type 

75 

76 @gromet_type.setter 

77 def gromet_type(self, gromet_type): 

78 """Sets the gromet_type of this TextDescription. 

79 

80 

81 :param gromet_type: The gromet_type of this TextDescription. # noqa: E501 

82 :type: str 

83 """ 

84 

85 self._gromet_type = gromet_type 

86 

87 @property 

88 def text_extraction(self): 

89 """Gets the text_extraction of this TextDescription. # noqa: E501 

90 

91 

92 :return: The text_extraction of this TextDescription. # noqa: E501 

93 :rtype: TextExtraction 

94 """ 

95 return self._text_extraction 

96 

97 @text_extraction.setter 

98 def text_extraction(self, text_extraction): 

99 """Sets the text_extraction of this TextDescription. 

100 

101 

102 :param text_extraction: The text_extraction of this TextDescription. # noqa: E501 

103 :type: TextExtraction 

104 """ 

105 

106 self._text_extraction = text_extraction 

107 

108 @property 

109 def variable_identifier(self): 

110 """Gets the variable_identifier of this TextDescription. # noqa: E501 

111 

112 Variable identifier # noqa: E501 

113 

114 :return: The variable_identifier of this TextDescription. # noqa: E501 

115 :rtype: str 

116 """ 

117 return self._variable_identifier 

118 

119 @variable_identifier.setter 

120 def variable_identifier(self, variable_identifier): 

121 """Sets the variable_identifier of this TextDescription. 

122 

123 Variable identifier # noqa: E501 

124 

125 :param variable_identifier: The variable_identifier of this TextDescription. # noqa: E501 

126 :type: str 

127 """ 

128 

129 self._variable_identifier = variable_identifier 

130 

131 @property 

132 def variable_definition(self): 

133 """Gets the variable_definition of this TextDescription. # noqa: E501 

134 

135 Variable definition text # noqa: E501 

136 

137 :return: The variable_definition of this TextDescription. # noqa: E501 

138 :rtype: str 

139 """ 

140 return self._variable_definition 

141 

142 @variable_definition.setter 

143 def variable_definition(self, variable_definition): 

144 """Sets the variable_definition of this TextDescription. 

145 

146 Variable definition text # noqa: E501 

147 

148 :param variable_definition: The variable_definition of this TextDescription. # noqa: E501 

149 :type: str 

150 """ 

151 

152 self._variable_definition = variable_definition 

153 

154 def to_dict(self): 

155 """Returns the model properties as a dict""" 

156 result = {} 

157 

158 for attr, _ in six.iteritems(self.swagger_types): 

159 value = getattr(self, attr) 

160 if isinstance(value, list): 

161 result[attr] = list(map( 

162 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 

163 value 

164 )) 

165 elif hasattr(value, "to_dict"): 

166 result[attr] = value.to_dict() 

167 elif isinstance(value, dict): 

168 result[attr] = dict(map( 

169 lambda item: (item[0], item[1].to_dict()) 

170 if hasattr(item[1], "to_dict") else item, 

171 value.items() 

172 )) 

173 else: 

174 result[attr] = value 

175 if issubclass(TextDescription, dict): 

176 for key, value in self.items(): 

177 result[key] = value 

178 

179 return result 

180 

181 def to_str(self): 

182 """Returns the string representation of the model""" 

183 return pprint.pformat(self.to_dict()) 

184 

185 def __repr__(self): 

186 """For `print` and `pprint`""" 

187 return self.to_str() 

188 

189 def __eq__(self, other): 

190 """Returns true if both objects are equal""" 

191 if not isinstance(other, TextDescription): 

192 return False 

193 

194 return self.__dict__ == other.__dict__ 

195 

196 def __ne__(self, other): 

197 """Returns true if both objects are not equal""" 

198 return not self == other