Coverage for skema/gromet/metadata/source_code_collection.py: 88%
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 SourceCodeCollection(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 'name': 'str',
34 'global_reference_id': 'str',
35 'files': 'list[CodeFileReference]'
36 }
37 if hasattr(Metadata, "swagger_types"):
38 swagger_types.update(Metadata.swagger_types)
40 attribute_map = {
41 'gromet_type': 'gromet_type',
42 'name': 'name',
43 'global_reference_id': 'global_reference_id',
44 'files': 'files'
45 }
46 if hasattr(Metadata, "attribute_map"):
47 attribute_map.update(Metadata.attribute_map)
49 def __init__(self, gromet_type='SourceCodeCollection', name=None, global_reference_id=None, files=None, *args, **kwargs): # noqa: E501
50 """SourceCodeCollection - a model defined in Swagger""" # noqa: E501
51 self._gromet_type = None
52 self._name = None
53 self._global_reference_id = None
54 self._files = None
55 self.discriminator = None
56 if gromet_type is not None:
57 self.gromet_type = gromet_type
58 if name is not None:
59 self.name = name
60 if global_reference_id is not None:
61 self.global_reference_id = global_reference_id
62 if files is not None:
63 self.files = files
64 Metadata.__init__(self, *args, **kwargs)
66 @property
67 def gromet_type(self):
68 """Gets the gromet_type of this SourceCodeCollection. # noqa: E501
71 :return: The gromet_type of this SourceCodeCollection. # 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 SourceCodeCollection.
81 :param gromet_type: The gromet_type of this SourceCodeCollection. # noqa: E501
82 :type: str
83 """
85 self._gromet_type = gromet_type
87 @property
88 def name(self):
89 """Gets the name of this SourceCodeCollection. # noqa: E501
91 Code Collection name # noqa: E501
93 :return: The name of this SourceCodeCollection. # noqa: E501
94 :rtype: str
95 """
96 return self._name
98 @name.setter
99 def name(self, name):
100 """Sets the name of this SourceCodeCollection.
102 Code Collection name # noqa: E501
104 :param name: The name of this SourceCodeCollection. # noqa: E501
105 :type: str
106 """
108 self._name = name
110 @property
111 def global_reference_id(self):
112 """Gets the global_reference_id of this SourceCodeCollection. # noqa: E501
114 URL (e.g., GitHub url), or aske_id # noqa: E501
116 :return: The global_reference_id of this SourceCodeCollection. # noqa: E501
117 :rtype: str
118 """
119 return self._global_reference_id
121 @global_reference_id.setter
122 def global_reference_id(self, global_reference_id):
123 """Sets the global_reference_id of this SourceCodeCollection.
125 URL (e.g., GitHub url), or aske_id # noqa: E501
127 :param global_reference_id: The global_reference_id of this SourceCodeCollection. # noqa: E501
128 :type: str
129 """
131 self._global_reference_id = global_reference_id
133 @property
134 def files(self):
135 """Gets the files of this SourceCodeCollection. # noqa: E501
138 :return: The files of this SourceCodeCollection. # noqa: E501
139 :rtype: list[CodeFileReference]
140 """
141 return self._files
143 @files.setter
144 def files(self, files):
145 """Sets the files of this SourceCodeCollection.
148 :param files: The files of this SourceCodeCollection. # noqa: E501
149 :type: list[CodeFileReference]
150 """
152 self._files = files
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(SourceCodeCollection, 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, SourceCodeCollection):
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