Coverage for skema/gromet/fn/gromet_box.py: 59%

49 statements  

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

1# coding: utf-8 

2 

3""" 

4 Grounded Model Exchange (GroMEt) schema for Function Networks 

5 

6 This document defines the GroMEt Function Network data model. Note that Metadata is defined in separate spec. __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/). This can be used to generate the client code based off of this spec, and in the process this will generate the data model 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.7`.) 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_FN_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/skema.gromet.fn.`. For java, they will be located in `$OUTPUT_PATH/src/main/java/io/swagger/client/model/` If generating GroMEt schema data model classes in SKEMA (AutoMATES), then after generating the above, follow the instructions here: ``` <automates>/automates/model_assembly/gromet/model/README.md ``` # noqa: E501 

7 

8 OpenAPI spec version: 0.1.10 

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 

17from skema.gromet.fn.gromet_object import GrometObject # noqa: F401,E501 

18 

19class GrometBox(GrometObject): 

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 } 

34 if hasattr(GrometObject, "swagger_types"): 

35 swagger_types.update(GrometObject.swagger_types) 

36 

37 attribute_map = { 

38 'name': 'name' 

39 } 

40 if hasattr(GrometObject, "attribute_map"): 

41 attribute_map.update(GrometObject.attribute_map) 

42 

43 def __init__(self, name=None, *args, **kwargs): # noqa: E501 

44 """GrometBox - a model defined in Swagger""" # noqa: E501 

45 self._name = None 

46 self.discriminator = None 

47 if name is not None: 

48 self.name = name 

49 GrometObject.__init__(self, *args, **kwargs) 

50 

51 @property 

52 def name(self): 

53 """Gets the name of this GrometBox. # noqa: E501 

54 

55 

56 :return: The name of this GrometBox. # noqa: E501 

57 :rtype: str 

58 """ 

59 return self._name 

60 

61 @name.setter 

62 def name(self, name): 

63 """Sets the name of this GrometBox. 

64 

65 

66 :param name: The name of this GrometBox. # noqa: E501 

67 :type: str 

68 """ 

69 

70 self._name = name 

71 

72 def to_dict(self): 

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

74 result = {} 

75 

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

77 value = getattr(self, attr) 

78 if isinstance(value, list): 

79 result[attr] = list(map( 

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

81 value 

82 )) 

83 elif hasattr(value, "to_dict"): 

84 result[attr] = value.to_dict() 

85 elif isinstance(value, dict): 

86 result[attr] = dict(map( 

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

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

89 value.items() 

90 )) 

91 else: 

92 result[attr] = value 

93 if issubclass(GrometBox, dict): 

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

95 result[key] = value 

96 

97 return result 

98 

99 def to_str(self): 

100 """Returns the string representation of the model""" 

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

102 

103 def __repr__(self): 

104 """For `print` and `pprint`""" 

105 return self.to_str() 

106 

107 def __eq__(self, other): 

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

109 if not isinstance(other, GrometBox): 

110 return False 

111 

112 return self.__dict__ == other.__dict__ 

113 

114 def __ne__(self, other): 

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

116 return not self == other