Coverage for skema/gromet/metadata/text_grounding.py: 42%
79 statements
« 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
18class TextGrounding(object):
19 """NOTE: This class is auto generated by the swagger code generator program.
21 Do not edit the class manually.
22 """
23 """
24 Attributes:
25 swagger_types (dict): The key is attribute name
26 and the value is attribute type.
27 attribute_map (dict): The key is attribute name
28 and the value is json key in definition.
29 """
30 swagger_types = {
31 'gromet_type': 'str',
32 'argument_name': 'str',
33 'id': 'str',
34 'description': 'str',
35 'score': 'float'
36 }
38 attribute_map = {
39 'gromet_type': 'gromet_type',
40 'argument_name': 'argument_name',
41 'id': 'id',
42 'description': 'description',
43 'score': 'score'
44 }
46 def __init__(self, gromet_type='TextGrounding', argument_name=None, id=None, description=None, score=None): # noqa: E501
47 """TextGrounding - a model defined in Swagger""" # noqa: E501
48 self._gromet_type = None
49 self._argument_name = None
50 self._id = None
51 self._description = None
52 self._score = None
53 self.discriminator = None
54 if gromet_type is not None:
55 self.gromet_type = gromet_type
56 if argument_name is not None:
57 self.argument_name = argument_name
58 if id is not None:
59 self.id = id
60 if description is not None:
61 self.description = description
62 if score is not None:
63 self.score = score
65 @property
66 def gromet_type(self):
67 """Gets the gromet_type of this TextGrounding. # noqa: E501
70 :return: The gromet_type of this TextGrounding. # noqa: E501
71 :rtype: str
72 """
73 return self._gromet_type
75 @gromet_type.setter
76 def gromet_type(self, gromet_type):
77 """Sets the gromet_type of this TextGrounding.
80 :param gromet_type: The gromet_type of this TextGrounding. # noqa: E501
81 :type: str
82 """
84 self._gromet_type = gromet_type
86 @property
87 def argument_name(self):
88 """Gets the argument_name of this TextGrounding. # noqa: E501
91 :return: The argument_name of this TextGrounding. # noqa: E501
92 :rtype: str
93 """
94 return self._argument_name
96 @argument_name.setter
97 def argument_name(self, argument_name):
98 """Sets the argument_name of this TextGrounding.
101 :param argument_name: The argument_name of this TextGrounding. # noqa: E501
102 :type: str
103 """
105 self._argument_name = argument_name
107 @property
108 def id(self):
109 """Gets the id of this TextGrounding. # noqa: E501
112 :return: The id of this TextGrounding. # noqa: E501
113 :rtype: str
114 """
115 return self._id
117 @id.setter
118 def id(self, id):
119 """Sets the id of this TextGrounding.
122 :param id: The id of this TextGrounding. # noqa: E501
123 :type: str
124 """
126 self._id = id
128 @property
129 def description(self):
130 """Gets the description of this TextGrounding. # noqa: E501
133 :return: The description of this TextGrounding. # noqa: E501
134 :rtype: str
135 """
136 return self._description
138 @description.setter
139 def description(self, description):
140 """Sets the description of this TextGrounding.
143 :param description: The description of this TextGrounding. # noqa: E501
144 :type: str
145 """
147 self._description = description
149 @property
150 def score(self):
151 """Gets the score of this TextGrounding. # noqa: E501
154 :return: The score of this TextGrounding. # noqa: E501
155 :rtype: float
156 """
157 return self._score
159 @score.setter
160 def score(self, score):
161 """Sets the score of this TextGrounding.
164 :param score: The score of this TextGrounding. # noqa: E501
165 :type: float
166 """
168 self._score = score
170 def to_dict(self):
171 """Returns the model properties as a dict"""
172 result = {}
174 for attr, _ in six.iteritems(self.swagger_types):
175 value = getattr(self, attr)
176 if isinstance(value, list):
177 result[attr] = list(map(
178 lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
179 value
180 ))
181 elif hasattr(value, "to_dict"):
182 result[attr] = value.to_dict()
183 elif isinstance(value, dict):
184 result[attr] = dict(map(
185 lambda item: (item[0], item[1].to_dict())
186 if hasattr(item[1], "to_dict") else item,
187 value.items()
188 ))
189 else:
190 result[attr] = value
191 if issubclass(TextGrounding, dict):
192 for key, value in self.items():
193 result[key] = value
195 return result
197 def to_str(self):
198 """Returns the string representation of the model"""
199 return pprint.pformat(self.to_dict())
201 def __repr__(self):
202 """For `print` and `pprint`"""
203 return self.to_str()
205 def __eq__(self, other):
206 """Returns true if both objects are equal"""
207 if not isinstance(other, TextGrounding):
208 return False
210 return self.__dict__ == other.__dict__
212 def __ne__(self, other):
213 """Returns true if both objects are not equal"""
214 return not self == other