Coverage for skema/gromet/metadata/comment_type.py: 42%
36 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
18class CommentType(object):
19 """NOTE: This class is auto generated by the swagger code generator program.
21 Do not edit the class manually.
22 """
24 """
25 allowed enum values
26 """
27 DOCSTRING = "DOCSTRING"
28 OTHER = "OTHER"
29 """
30 Attributes:
31 swagger_types (dict): The key is attribute name
32 and the value is attribute type.
33 attribute_map (dict): The key is attribute name
34 and the value is json key in definition.
35 """
36 swagger_types = {
37 }
39 attribute_map = {
40 }
42 def __init__(self): # noqa: E501
43 """CommentType - a model defined in Swagger""" # noqa: E501
44 self.discriminator = None
46 def to_dict(self):
47 """Returns the model properties as a dict"""
48 result = {}
50 for attr, _ in six.iteritems(self.swagger_types):
51 value = getattr(self, attr)
52 if isinstance(value, list):
53 result[attr] = list(map(
54 lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
55 value
56 ))
57 elif hasattr(value, "to_dict"):
58 result[attr] = value.to_dict()
59 elif isinstance(value, dict):
60 result[attr] = dict(map(
61 lambda item: (item[0], item[1].to_dict())
62 if hasattr(item[1], "to_dict") else item,
63 value.items()
64 ))
65 else:
66 result[attr] = value
67 if issubclass(CommentType, dict):
68 for key, value in self.items():
69 result[key] = value
71 return result
73 def to_str(self):
74 """Returns the string representation of the model"""
75 return pprint.pformat(self.to_dict())
77 def __repr__(self):
78 """For `print` and `pprint`"""
79 return self.to_str()
81 def __eq__(self, other):
82 """Returns true if both objects are equal"""
83 if not isinstance(other, CommentType):
84 return False
86 return self.__dict__ == other.__dict__
88 def __ne__(self, other):
89 """Returns true if both objects are not equal"""
90 return not self == other