Coverage for skema/program_analysis/CAST2FN/model/cast/model_import.py: 74%

76 statements  

« prev     ^ index     » next       coverage.py v7.5.0, created at 2024-04-30 17:15 +0000

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 ModelImport(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 'name': 'str', 

33 'alias': 'str', 

34 'symbol': 'str', 

35 'all': 'Bool' 

36 } 

37 if hasattr(AstNode, "swagger_types"): 

38 swagger_types.update(AstNode.swagger_types) 

39 

40 attribute_map = { 

41 'name': 'name', 

42 'alias': 'alias', 

43 'symbol': 'symbol', 

44 'all': 'all' 

45 } 

46 if hasattr(AstNode, "attribute_map"): 

47 attribute_map.update(AstNode.attribute_map) 

48 

49 def __init__(self, name=None, alias=None, symbol=None, all=None, *args, **kwargs): # noqa: E501 

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

51 self._name = None 

52 self._alias = None 

53 self._symbol = None 

54 self._all = None 

55 self.discriminator = None 

56 if name is not None: 

57 self.name = name 

58 if alias is not None: 

59 self.alias = alias 

60 if symbol is not None: 

61 self.symbol = symbol 

62 if all is not None: 

63 self.all = all 

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

65 

66 @property 

67 def name(self): 

68 """Gets the name of this ModelImport. # noqa: E501 

69 

70 

71 :return: The name of this ModelImport. # noqa: E501 

72 :rtype: str 

73 """ 

74 return self._name 

75 

76 @name.setter 

77 def name(self, name): 

78 """Sets the name of this ModelImport. 

79 

80 

81 :param name: The name of this ModelImport. # noqa: E501 

82 :type: str 

83 """ 

84 

85 self._name = name 

86 

87 @property 

88 def alias(self): 

89 """Gets the alias of this ModelImport. # noqa: E501 

90 

91 

92 :return: The alias of this ModelImport. # noqa: E501 

93 :rtype: str 

94 """ 

95 return self._alias 

96 

97 @alias.setter 

98 def alias(self, alias): 

99 """Sets the alias of this ModelImport. 

100 

101 

102 :param alias: The alias of this ModelImport. # noqa: E501 

103 :type: str 

104 """ 

105 

106 self._alias = alias 

107 

108 @property 

109 def symbol(self): 

110 """Gets the symbol of this ModelImport. # noqa: E501 

111 

112 

113 :return: The symbol of this ModelImport. # noqa: E501 

114 :rtype: str 

115 """ 

116 return self._symbol 

117 

118 @symbol.setter 

119 def symbol(self, symbol): 

120 """Sets the symbol of this ModelImport. 

121 

122 

123 :param symbol: The symbol of this ModelImport. # noqa: E501 

124 :type: str 

125 """ 

126 

127 self._symbol = symbol 

128 

129 @property 

130 def all(self): 

131 """Gets the all of this ModelImport. # noqa: E501 

132 

133 When true, then all of the symbols of the module are being imported (and Import.symbol will be empty) # noqa: E501 

134 

135 :return: The all of this ModelImport. # noqa: E501 

136 :rtype: Bool 

137 """ 

138 return self._all 

139 

140 @all.setter 

141 def all(self, all): 

142 """Sets the all of this ModelImport. 

143 

144 When true, then all of the symbols of the module are being imported (and Import.symbol will be empty) # noqa: E501 

145 

146 :param all: The all of this ModelImport. # noqa: E501 

147 :type: Bool 

148 """ 

149 

150 self._all = all 

151 

152 def to_dict(self): 

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

154 result = {} 

155 

156 for attr, _ in six.iteritems(self.swagger_types): 

157 value = getattr(self, attr) 

158 if isinstance(value, list): 

159 result[attr] = list(map( 

160 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 

161 value 

162 )) 

163 elif hasattr(value, "to_dict"): 

164 result[attr] = value.to_dict() 

165 elif isinstance(value, dict): 

166 result[attr] = dict(map( 

167 lambda item: (item[0], item[1].to_dict()) 

168 if hasattr(item[1], "to_dict") else item, 

169 value.items() 

170 )) 

171 else: 

172 result[attr] = value 

173 if issubclass(ModelImport, dict): 

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

175 result[key] = value 

176 

177 return result 

178 

179 def to_str(self): 

180 """Returns the string representation of the model""" 

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

182 

183 def __repr__(self): 

184 """For `print` and `pprint`""" 

185 return self.to_str() 

186 

187 def __eq__(self, other): 

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

189 if not isinstance(other, ModelImport): 

190 return False 

191 

192 return self.__dict__ == other.__dict__ 

193 

194 def __ne__(self, other): 

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

196 return not self == other