Coverage for skema/gromet/metadata/debug.py: 86%
76 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
17from skema.gromet.metadata.metadata import Metadata # noqa: F401,E501
19class Debug(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 'debug_type': 'str',
34 'severity': 'str',
35 'message': 'str'
36 }
37 if hasattr(Metadata, "swagger_types"):
38 swagger_types.update(Metadata.swagger_types)
40 attribute_map = {
41 'gromet_type': 'gromet_type',
42 'debug_type': 'debug_type',
43 'severity': 'severity',
44 'message': 'message'
45 }
46 if hasattr(Metadata, "attribute_map"):
47 attribute_map.update(Metadata.attribute_map)
49 def __init__(self, gromet_type='Debug', debug_type=None, severity=None, message=None, *args, **kwargs): # noqa: E501
50 """Debug - a model defined in Swagger""" # noqa: E501
51 self._gromet_type = None
52 self._debug_type = None
53 self._severity = None
54 self._message = None
55 self.discriminator = None
56 if gromet_type is not None:
57 self.gromet_type = gromet_type
58 if debug_type is not None:
59 self.debug_type = debug_type
60 if severity is not None:
61 self.severity = severity
62 if message is not None:
63 self.message = message
64 Metadata.__init__(self, *args, **kwargs)
66 @property
67 def gromet_type(self):
68 """Gets the gromet_type of this Debug. # noqa: E501
71 :return: The gromet_type of this Debug. # 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 Debug.
81 :param gromet_type: The gromet_type of this Debug. # noqa: E501
82 :type: str
83 """
85 self._gromet_type = gromet_type
87 @property
88 def debug_type(self):
89 """Gets the debug_type of this Debug. # noqa: E501
91 Info about the debug message, e.g., system component that generated (e.g., \"CommentExtractor\", \"Code2FN\", \"MORAE\"). # noqa: E501
93 :return: The debug_type of this Debug. # noqa: E501
94 :rtype: str
95 """
96 return self._debug_type
98 @debug_type.setter
99 def debug_type(self, debug_type):
100 """Sets the debug_type of this Debug.
102 Info about the debug message, e.g., system component that generated (e.g., \"CommentExtractor\", \"Code2FN\", \"MORAE\"). # noqa: E501
104 :param debug_type: The debug_type of this Debug. # noqa: E501
105 :type: str
106 """
108 self._debug_type = debug_type
110 @property
111 def severity(self):
112 """Gets the severity of this Debug. # noqa: E501
114 The severity level of the debug event, e.g.: 'Error', 'Warning', 'Notice' # noqa: E501
116 :return: The severity of this Debug. # noqa: E501
117 :rtype: str
118 """
119 return self._severity
121 @severity.setter
122 def severity(self, severity):
123 """Sets the severity of this Debug.
125 The severity level of the debug event, e.g.: 'Error', 'Warning', 'Notice' # noqa: E501
127 :param severity: The severity of this Debug. # noqa: E501
128 :type: str
129 """
131 self._severity = severity
133 @property
134 def message(self):
135 """Gets the message of this Debug. # noqa: E501
137 The message payload # noqa: E501
139 :return: The message of this Debug. # noqa: E501
140 :rtype: str
141 """
142 return self._message
144 @message.setter
145 def message(self, message):
146 """Sets the message of this Debug.
148 The message payload # noqa: E501
150 :param message: The message of this Debug. # noqa: E501
151 :type: str
152 """
154 self._message = message
156 def to_dict(self):
157 """Returns the model properties as a dict"""
158 result = {}
160 for attr, _ in six.iteritems(self.swagger_types):
161 value = getattr(self, attr)
162 if isinstance(value, list):
163 result[attr] = list(map(
164 lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
165 value
166 ))
167 elif hasattr(value, "to_dict"):
168 result[attr] = value.to_dict()
169 elif isinstance(value, dict):
170 result[attr] = dict(map(
171 lambda item: (item[0], item[1].to_dict())
172 if hasattr(item[1], "to_dict") else item,
173 value.items()
174 ))
175 else:
176 result[attr] = value
177 if issubclass(Debug, dict):
178 for key, value in self.items():
179 result[key] = value
181 return result
183 def to_str(self):
184 """Returns the string representation of the model"""
185 return pprint.pformat(self.to_dict())
187 def __repr__(self):
188 """For `print` and `pprint`"""
189 return self.to_str()
191 def __eq__(self, other):
192 """Returns true if both objects are equal"""
193 if not isinstance(other, Debug):
194 return False
196 return self.__dict__ == other.__dict__
198 def __ne__(self, other):
199 """Returns true if both objects are not equal"""
200 return not self == other