Coverage for skema/gromet/metadata/provenance.py: 82%

61 statements  

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

1# coding: utf-8 

2 

3""" 

4 GroMEt Metadata spec 

5 

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 

7 

8 OpenAPI spec version: 0.1.8 

9 Contact: claytonm@arizona.edu 

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

11""" 

12 

13import pprint 

14import re # noqa: F401 

15 

16import six 

17 

18class Provenance(object): 

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

20 

21 Do not edit the class manually. 

22 """ 

23 """ 

24 Attributes: 

25 swagger_types (dict): The key is attribute name 

26 and the value is attribute type. 

27 attribute_map (dict): The key is attribute name 

28 and the value is json key in definition. 

29 """ 

30 swagger_types = { 

31 'gromet_type': 'str', 

32 'method': 'str', 

33 'timestamp': 'datetime' 

34 } 

35 

36 attribute_map = { 

37 'gromet_type': 'gromet_type', 

38 'method': 'method', 

39 'timestamp': 'timestamp' 

40 } 

41 

42 def __init__(self, gromet_type='Provenance', method=None, timestamp=None): # noqa: E501 

43 """Provenance - a model defined in Swagger""" # noqa: E501 

44 self._gromet_type = None 

45 self._method = None 

46 self._timestamp = None 

47 self.discriminator = None 

48 if gromet_type is not None: 

49 self.gromet_type = gromet_type 

50 if method is not None: 

51 self.method = method 

52 if timestamp is not None: 

53 self.timestamp = timestamp 

54 

55 @property 

56 def gromet_type(self): 

57 """Gets the gromet_type of this Provenance. # noqa: E501 

58 

59 

60 :return: The gromet_type of this Provenance. # noqa: E501 

61 :rtype: str 

62 """ 

63 return self._gromet_type 

64 

65 @gromet_type.setter 

66 def gromet_type(self, gromet_type): 

67 """Sets the gromet_type of this Provenance. 

68 

69 

70 :param gromet_type: The gromet_type of this Provenance. # noqa: E501 

71 :type: str 

72 """ 

73 

74 self._gromet_type = gromet_type 

75 

76 @property 

77 def method(self): 

78 """Gets the method of this Provenance. # noqa: E501 

79 

80 The inference method (with version) used to derive data. # noqa: E501 

81 

82 :return: The method of this Provenance. # noqa: E501 

83 :rtype: str 

84 """ 

85 return self._method 

86 

87 @method.setter 

88 def method(self, method): 

89 """Sets the method of this Provenance. 

90 

91 The inference method (with version) used to derive data. # noqa: E501 

92 

93 :param method: The method of this Provenance. # noqa: E501 

94 :type: str 

95 """ 

96 

97 self._method = method 

98 

99 @property 

100 def timestamp(self): 

101 """Gets the timestamp of this Provenance. # noqa: E501 

102 

103 Date and time that metadata was generated. # noqa: E501 

104 

105 :return: The timestamp of this Provenance. # noqa: E501 

106 :rtype: datetime 

107 """ 

108 return self._timestamp 

109 

110 @timestamp.setter 

111 def timestamp(self, timestamp): 

112 """Sets the timestamp of this Provenance. 

113 

114 Date and time that metadata was generated. # noqa: E501 

115 

116 :param timestamp: The timestamp of this Provenance. # noqa: E501 

117 :type: datetime 

118 """ 

119 

120 self._timestamp = timestamp 

121 

122 def to_dict(self): 

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

124 result = {} 

125 

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

127 value = getattr(self, attr) 

128 if isinstance(value, list): 

129 result[attr] = list(map( 

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

131 value 

132 )) 

133 elif hasattr(value, "to_dict"): 

134 result[attr] = value.to_dict() 

135 elif isinstance(value, dict): 

136 result[attr] = dict(map( 

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

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

139 value.items() 

140 )) 

141 else: 

142 result[attr] = value 

143 if issubclass(Provenance, dict): 

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

145 result[key] = value 

146 

147 return result 

148 

149 def to_str(self): 

150 """Returns the string representation of the model""" 

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

152 

153 def __repr__(self): 

154 """For `print` and `pprint`""" 

155 return self.to_str() 

156 

157 def __eq__(self, other): 

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

159 if not isinstance(other, Provenance): 

160 return False 

161 

162 return self.__dict__ == other.__dict__ 

163 

164 def __ne__(self, other): 

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

166 return not self == other