Coverage for skema/gromet/metadata/equation_definition.py: 45%
76 statements
« prev ^ index » next coverage.py v7.5.0, created at 2024-04-30 17:15 +0000
« prev ^ index » next coverage.py v7.5.0, created at 2024-04-30 17:15 +0000
1# coding: utf-8
3"""
4 GroMEt Metadata spec
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
8 OpenAPI spec version: 0.1.8
9 Contact: claytonm@arizona.edu
10 Generated by: https://github.com/swagger-api/swagger-codegen.git
11"""
13import pprint
14import re # noqa: F401
16import six
17from skema.gromet.metadata.metadata import Metadata # noqa: F401,E501
19class EquationDefinition(Metadata):
20 """NOTE: This class is auto generated by the swagger code generator program.
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 'equation_extraction': 'EquationExtraction',
34 'equation_mathml_source': 'str',
35 'equation_latex_source': 'str'
36 }
37 if hasattr(Metadata, "swagger_types"):
38 swagger_types.update(Metadata.swagger_types)
40 attribute_map = {
41 'gromet_type': 'gromet_type',
42 'equation_extraction': 'equation_extraction',
43 'equation_mathml_source': 'equation_mathml_source',
44 'equation_latex_source': 'equation_latex_source'
45 }
46 if hasattr(Metadata, "attribute_map"):
47 attribute_map.update(Metadata.attribute_map)
49 def __init__(self, gromet_type='EquationDefinition', equation_extraction=None, equation_mathml_source=None, equation_latex_source=None, *args, **kwargs): # noqa: E501
50 """EquationDefinition - a model defined in Swagger""" # noqa: E501
51 self._gromet_type = None
52 self._equation_extraction = None
53 self._equation_mathml_source = None
54 self._equation_latex_source = None
55 self.discriminator = None
56 if gromet_type is not None:
57 self.gromet_type = gromet_type
58 if equation_extraction is not None:
59 self.equation_extraction = equation_extraction
60 if equation_mathml_source is not None:
61 self.equation_mathml_source = equation_mathml_source
62 if equation_latex_source is not None:
63 self.equation_latex_source = equation_latex_source
64 Metadata.__init__(self, *args, **kwargs)
66 @property
67 def gromet_type(self):
68 """Gets the gromet_type of this EquationDefinition. # noqa: E501
71 :return: The gromet_type of this EquationDefinition. # noqa: E501
72 :rtype: str
73 """
74 return self._gromet_type
76 @gromet_type.setter
77 def gromet_type(self, gromet_type):
78 """Sets the gromet_type of this EquationDefinition.
81 :param gromet_type: The gromet_type of this EquationDefinition. # noqa: E501
82 :type: str
83 """
85 self._gromet_type = gromet_type
87 @property
88 def equation_extraction(self):
89 """Gets the equation_extraction of this EquationDefinition. # noqa: E501
92 :return: The equation_extraction of this EquationDefinition. # noqa: E501
93 :rtype: EquationExtraction
94 """
95 return self._equation_extraction
97 @equation_extraction.setter
98 def equation_extraction(self, equation_extraction):
99 """Sets the equation_extraction of this EquationDefinition.
102 :param equation_extraction: The equation_extraction of this EquationDefinition. # noqa: E501
103 :type: EquationExtraction
104 """
106 self._equation_extraction = equation_extraction
108 @property
109 def equation_mathml_source(self):
110 """Gets the equation_mathml_source of this EquationDefinition. # noqa: E501
112 Source MathML of equation # noqa: E501
114 :return: The equation_mathml_source of this EquationDefinition. # noqa: E501
115 :rtype: str
116 """
117 return self._equation_mathml_source
119 @equation_mathml_source.setter
120 def equation_mathml_source(self, equation_mathml_source):
121 """Sets the equation_mathml_source of this EquationDefinition.
123 Source MathML of equation # noqa: E501
125 :param equation_mathml_source: The equation_mathml_source of this EquationDefinition. # noqa: E501
126 :type: str
127 """
129 self._equation_mathml_source = equation_mathml_source
131 @property
132 def equation_latex_source(self):
133 """Gets the equation_latex_source of this EquationDefinition. # noqa: E501
135 Source LaTeX of equation # noqa: E501
137 :return: The equation_latex_source of this EquationDefinition. # noqa: E501
138 :rtype: str
139 """
140 return self._equation_latex_source
142 @equation_latex_source.setter
143 def equation_latex_source(self, equation_latex_source):
144 """Sets the equation_latex_source of this EquationDefinition.
146 Source LaTeX of equation # noqa: E501
148 :param equation_latex_source: The equation_latex_source of this EquationDefinition. # noqa: E501
149 :type: str
150 """
152 self._equation_latex_source = equation_latex_source
154 def to_dict(self):
155 """Returns the model properties as a dict"""
156 result = {}
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(EquationDefinition, dict):
176 for key, value in self.items():
177 result[key] = value
179 return result
181 def to_str(self):
182 """Returns the string representation of the model"""
183 return pprint.pformat(self.to_dict())
185 def __repr__(self):
186 """For `print` and `pprint`"""
187 return self.to_str()
189 def __eq__(self, other):
190 """Returns true if both objects are equal"""
191 if not isinstance(other, EquationDefinition):
192 return False
194 return self.__dict__ == other.__dict__
196 def __ne__(self, other):
197 """Returns true if both objects are not equal"""
198 return not self == other