Coverage for skema/program_analysis/CAST2FN/model/cast/loop.py: 91%

1# coding: utf-8 

2 

3""" 

4 SKEMA Common Abstract Syntax Tree (CAST) 

5 

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 

7 

8 OpenAPI spec version: 1.2.6 

9  

10 Generated by: https://github.com/swagger-api/swagger-codegen.git 

11""" 

12 

13import pprint 

14import re # noqa: F401 

15 

16import six 

17from skema.program_analysis.CAST2FN.model.cast.ast_node import AstNode # noqa: F401,E501 

18 

19class Loop(AstNode): 

20 """NOTE: This class is auto generated by the swagger code generator program. 

21 

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 'pre': 'list[AstNode]', 

33 'expr': 'AstNode', 

34 'body': 'list[AstNode]', 

35 'post': 'list[AstNode]' 

36 } 

37 if hasattr(AstNode, "swagger_types"): 

38 swagger_types.update(AstNode.swagger_types) 

39 

40 attribute_map = { 

41 'pre': 'pre', 

42 'expr': 'expr', 

43 'body': 'body', 

44 'post': 'post' 

45 } 

46 if hasattr(AstNode, "attribute_map"): 

47 attribute_map.update(AstNode.attribute_map) 

48 

49 def __init__(self, pre=None, expr=None, body=None, post=None, *args, **kwargs): # noqa: E501 

50 """Loop - a model defined in Swagger""" # noqa: E501 

51 self._pre = None 

52 self._expr = None 

53 self._body = None 

54 self._post = None 

55 self.discriminator = None 

56 if pre is not None: 

57 self.pre = pre 

58 if expr is not None: 

59 self.expr = expr 

60 if body is not None: 

61 self.body = body 

62 if post is not None: 

63 self.post = post 

64 AstNode.__init__(self, *args, **kwargs) 

65 

66 @property 

67 def pre(self): 

68 """Gets the pre of this Loop. # noqa: E501 

69 

70 This holds any expressions related to initializing a loop. In general, this is populated as a result of Program Analysis translating a loop idiom from some source language, e.g., a Python for-loop involves specifying an iterator and calling _next on it (syntactically this happens implicitly in Python; behind the scenes, Python creates an iterator and calls _next on it). # noqa: E501 

71 

72 :return: The pre of this Loop. # noqa: E501 

73 :rtype: list[AstNode] 

74 """ 

75 return self._pre 

76 

77 @pre.setter 

78 def pre(self, pre): 

79 """Sets the pre of this Loop. 

80 

81 This holds any expressions related to initializing a loop. In general, this is populated as a result of Program Analysis translating a loop idiom from some source language, e.g., a Python for-loop involves specifying an iterator and calling _next on it (syntactically this happens implicitly in Python; behind the scenes, Python creates an iterator and calls _next on it). # noqa: E501 

82 

83 :param pre: The pre of this Loop. # noqa: E501 

84 :type: list[AstNode] 

85 """ 

86 

87 self._pre = pre 

88 

89 @property 

90 def expr(self): 

91 """Gets the expr of this Loop. # noqa: E501 

92 

93 

94 :return: The expr of this Loop. # noqa: E501 

95 :rtype: AstNode 

96 """ 

97 return self._expr 

98 

99 @expr.setter 

100 def expr(self, expr): 

101 """Sets the expr of this Loop. 

102 

103 

104 :param expr: The expr of this Loop. # noqa: E501 

105 :type: AstNode 

106 """ 

107 

108 self._expr = expr 

109 

110 @property 

111 def body(self): 

112 """Gets the body of this Loop. # noqa: E501 

113 

114 

115 :return: The body of this Loop. # noqa: E501 

116 :rtype: list[AstNode] 

117 """ 

118 return self._body 

119 

120 @body.setter 

121 def body(self, body): 

122 """Sets the body of this Loop. 

123 

124 

125 :param body: The body of this Loop. # noqa: E501 

126 :type: list[AstNode] 

127 """ 

128 

129 self._body = body 

130 

131 @property 

132 def post(self): 

133 """Gets the post of this Loop. # noqa: E501 

134 

135 TODO. # noqa: E501 

136 

137 :return: The post of this Loop. # noqa: E501 

138 :rtype: list[AstNode] 

139 """ 

140 return self._post 

141 

142 @post.setter 

143 def post(self, post): 

144 """Sets the post of this Loop. 

145 

146 TODO. # noqa: E501 

147 

148 :param post: The post of this Loop. # noqa: E501 

149 :type: list[AstNode] 

150 """ 

151 

152 self._post = post 

153 

154 def to_dict(self): 

155 """Returns the model properties as a dict""" 

156 result = {} 

157 

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(Loop, dict): 

176 for key, value in self.items(): 

177 result[key] = value 

178 

179 return result 

180 

181 def to_str(self): 

182 """Returns the string representation of the model""" 

183 return pprint.pformat(self.to_dict()) 

184 

185 def __repr__(self): 

186 """For `print` and `pprint`""" 

187 return self.to_str() 

188 

189 def __eq__(self, other): 

190 """Returns true if both objects are equal""" 

191 if not isinstance(other, Loop): 

192 return False 

193 

194 return self.__dict__ == other.__dict__ 

195 

196 def __ne__(self, other): 

197 """Returns true if both objects are not equal""" 

198 return not self == other