Coverage for skema/program_analysis/CAST2FN/model/cast/function_def.py: 70%
67 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 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 FunctionDef(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 'func_args': 'list[Var]',
34 'body': 'list[AstNode]'
35 }
36 if hasattr(AstNode, "swagger_types"):
37 swagger_types.update(AstNode.swagger_types)
39 attribute_map = {
40 'name': 'name',
41 'func_args': 'func_args',
42 'body': 'body'
43 }
44 if hasattr(AstNode, "attribute_map"):
45 attribute_map.update(AstNode.attribute_map)
47 def __init__(self, name=None, func_args=None, body=None, *args, **kwargs): # noqa: E501
48 """FunctionDef - a model defined in Swagger""" # noqa: E501
49 self._name = None
50 self._func_args = None
51 self._body = None
52 self.discriminator = None
53 if name is not None:
54 self.name = name
55 if func_args is not None:
56 self.func_args = func_args
57 if body is not None:
58 self.body = body
59 AstNode.__init__(self, *args, **kwargs)
61 @property
62 def name(self):
63 """Gets the name of this FunctionDef. # noqa: E501
66 :return: The name of this FunctionDef. # noqa: E501
67 :rtype: str
68 """
69 return self._name
71 @name.setter
72 def name(self, name):
73 """Sets the name of this FunctionDef.
76 :param name: The name of this FunctionDef. # noqa: E501
77 :type: str
78 """
80 self._name = name
82 @property
83 def func_args(self):
84 """Gets the func_args of this FunctionDef. # noqa: E501
87 :return: The func_args of this FunctionDef. # noqa: E501
88 :rtype: list[Var]
89 """
90 return self._func_args
92 @func_args.setter
93 def func_args(self, func_args):
94 """Sets the func_args of this FunctionDef.
97 :param func_args: The func_args of this FunctionDef. # noqa: E501
98 :type: list[Var]
99 """
101 self._func_args = func_args
103 @property
104 def body(self):
105 """Gets the body of this FunctionDef. # noqa: E501
108 :return: The body of this FunctionDef. # noqa: E501
109 :rtype: list[AstNode]
110 """
111 return self._body
113 @body.setter
114 def body(self, body):
115 """Sets the body of this FunctionDef.
118 :param body: The body of this FunctionDef. # noqa: E501
119 :type: list[AstNode]
120 """
122 self._body = body
124 def to_dict(self):
125 """Returns the model properties as a dict"""
126 result = {}
128 for attr, _ in six.iteritems(self.swagger_types):
129 value = getattr(self, attr)
130 if isinstance(value, list):
131 result[attr] = list(map(
132 lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
133 value
134 ))
135 elif hasattr(value, "to_dict"):
136 result[attr] = value.to_dict()
137 elif isinstance(value, dict):
138 result[attr] = dict(map(
139 lambda item: (item[0], item[1].to_dict())
140 if hasattr(item[1], "to_dict") else item,
141 value.items()
142 ))
143 else:
144 result[attr] = value
145 if issubclass(FunctionDef, dict):
146 for key, value in self.items():
147 result[key] = value
149 return result
151 def to_str(self):
152 """Returns the string representation of the model"""
153 return pprint.pformat(self.to_dict())
155 def __repr__(self):
156 """For `print` and `pprint`"""
157 return self.to_str()
159 def __eq__(self, other):
160 """Returns true if both objects are equal"""
161 if not isinstance(other, FunctionDef):
162 return False
164 return self.__dict__ == other.__dict__
166 def __ne__(self, other):
167 """Returns true if both objects are not equal"""
168 return not self == other