Coverage for skema/program_analysis/CAST2FN/model/cast/record_def.py: 74%
76 statements
« prev ^ index » next coverage.py v7.5.0, created at 2024-04-30 17:15 +0000
1# coding: utf-8
3"""
4 SKEMA Common Abstract Syntax Tree (CAST)
6 This document outlines the structure of the CAST that will be used as a generic representation of the semantics of a program written in any language. This will be used when creating functions networks from programs using the SKEMA Program Analysis pipeline. __Generating 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. 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/cast_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/` # noqa: E501
8 OpenAPI spec version: 1.2.6
10 Generated by: https://github.com/swagger-api/swagger-codegen.git
11"""
13import pprint
14import re # noqa: F401
16import six
17from skema.program_analysis.CAST2FN.model.cast.ast_node import AstNode # noqa: F401,E501
19class RecordDef(AstNode):
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 'name': 'str',
33 'bases': 'list[str]',
34 'funcs': 'list[AstNode]',
35 'fields': 'list[Var]'
36 }
37 if hasattr(AstNode, "swagger_types"):
38 swagger_types.update(AstNode.swagger_types)
40 attribute_map = {
41 'name': 'name',
42 'bases': 'bases',
43 'funcs': 'funcs',
44 'fields': 'fields'
45 }
46 if hasattr(AstNode, "attribute_map"):
47 attribute_map.update(AstNode.attribute_map)
49 def __init__(self, name=None, bases=None, funcs=None, fields=None, *args, **kwargs): # noqa: E501
50 """RecordDef - a model defined in Swagger""" # noqa: E501
51 self._name = None
52 self._bases = None
53 self._funcs = None
54 self._fields = None
55 self.discriminator = None
56 if name is not None:
57 self.name = name
58 if bases is not None:
59 self.bases = bases
60 if funcs is not None:
61 self.funcs = funcs
62 if fields is not None:
63 self.fields = fields
64 AstNode.__init__(self, *args, **kwargs)
66 @property
67 def name(self):
68 """Gets the name of this RecordDef. # noqa: E501
71 :return: The name of this RecordDef. # noqa: E501
72 :rtype: str
73 """
74 return self._name
76 @name.setter
77 def name(self, name):
78 """Sets the name of this RecordDef.
81 :param name: The name of this RecordDef. # noqa: E501
82 :type: str
83 """
85 self._name = name
87 @property
88 def bases(self):
89 """Gets the bases of this RecordDef. # noqa: E501
92 :return: The bases of this RecordDef. # noqa: E501
93 :rtype: list[str]
94 """
95 return self._bases
97 @bases.setter
98 def bases(self, bases):
99 """Sets the bases of this RecordDef.
102 :param bases: The bases of this RecordDef. # noqa: E501
103 :type: list[str]
104 """
106 self._bases = bases
108 @property
109 def funcs(self):
110 """Gets the funcs of this RecordDef. # noqa: E501
113 :return: The funcs of this RecordDef. # noqa: E501
114 :rtype: list[AstNode]
115 """
116 return self._funcs
118 @funcs.setter
119 def funcs(self, funcs):
120 """Sets the funcs of this RecordDef.
123 :param funcs: The funcs of this RecordDef. # noqa: E501
124 :type: list[AstNode]
125 """
127 self._funcs = funcs
129 @property
130 def fields(self):
131 """Gets the fields of this RecordDef. # noqa: E501
134 :return: The fields of this RecordDef. # noqa: E501
135 :rtype: list[Var]
136 """
137 return self._fields
139 @fields.setter
140 def fields(self, fields):
141 """Sets the fields of this RecordDef.
144 :param fields: The fields of this RecordDef. # noqa: E501
145 :type: list[Var]
146 """
148 self._fields = fields
150 def to_dict(self):
151 """Returns the model properties as a dict"""
152 result = {}
154 for attr, _ in six.iteritems(self.swagger_types):
155 value = getattr(self, attr)
156 if isinstance(value, list):
157 result[attr] = list(map(
158 lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
159 value
160 ))
161 elif hasattr(value, "to_dict"):
162 result[attr] = value.to_dict()
163 elif isinstance(value, dict):
164 result[attr] = dict(map(
165 lambda item: (item[0], item[1].to_dict())
166 if hasattr(item[1], "to_dict") else item,
167 value.items()
168 ))
169 else:
170 result[attr] = value
171 if issubclass(RecordDef, dict):
172 for key, value in self.items():
173 result[key] = value
175 return result
177 def to_str(self):
178 """Returns the string representation of the model"""
179 return pprint.pformat(self.to_dict())
181 def __repr__(self):
182 """For `print` and `pprint`"""
183 return self.to_str()
185 def __eq__(self, other):
186 """Returns true if both objects are equal"""
187 if not isinstance(other, RecordDef):
188 return False
190 return self.__dict__ == other.__dict__
192 def __ne__(self, other):
193 """Returns true if both objects are not equal"""
194 return not self == other