FilesExpand file tree

master

/

catalog.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

175 lines (131 loc) · 4.79 KB

master

/

catalog.py

Copy path

Top

File metadata and controls

• Code
• Blame

175 lines (131 loc) · 4.79 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

"""

A class that uses different static functions depending on a parameter passed

during initialization. Uses a single dictionary instead of multiple conditions.

"""

__author__ = "Ibrahim Diop <ibrahim@sikilabs.com>"

class Catalog:

"""catalog of multiple static methods that are executed depending on an init parameter

"""

def __init__(self, param: str) -> None:

# dictionary that will be used to determine which static method is

# to be executed but that will be also used to store possible param

# value

self._static_method_choices = {

"param_value_1": self._static_method_1,

"param_value_2": self._static_method_2,

}

# simple test to validate param value

if param in self._static_method_choices.keys():

self.param = param

else:

raise ValueError(f"Invalid Value for Param: {param}")

@staticmethod

def _static_method_1() -> str:

return "executed method 1!"

@staticmethod

def _static_method_2() -> str:

return "executed method 2!"

def main_method(self) -> str:

"""will execute either _static_method_1 or _static_method_2

depending on self.param value

"""

return self._static_method_choices[self.param]()

# Alternative implementation for different levels of methods

class CatalogInstance:

"""catalog of multiple methods that are executed depending on an init

parameter

"""

def __init__(self, param: str) -> None:

self.x1 = "x1"

self.x2 = "x2"

# simple test to validate param value

if param in self._instance_method_choices:

self.param = param

else:

raise ValueError(f"Invalid Value for Param: {param}")

def _instance_method_1(self) -> str:

return f"Value {self.x1}"

def _instance_method_2(self) -> str:

return f"Value {self.x2}"

_instance_method_choices = {

"param_value_1": _instance_method_1,

"param_value_2": _instance_method_2,

}

def main_method(self) -> str:

"""will execute either _instance_method_1 or _instance_method_2

depending on self.param value

"""

return self._instance_method_choices[self.param].__get__(self)() # type: ignore

# type ignore reason: https://github.com/python/mypy/issues/10206

class CatalogClass:

"""catalog of multiple class methods that are executed depending on an init

parameter

"""

x1 = "x1"

x2 = "x2"

def __init__(self, param: str) -> None:

# simple test to validate param value

if param in self._class_method_choices:

self.param = param

else:

raise ValueError(f"Invalid Value for Param: {param}")

@classmethod

def _class_method_1(cls) -> str:

return f"Value {cls.x1}"

@classmethod

def _class_method_2(cls) -> str:

return f"Value {cls.x2}"

_class_method_choices = {

"param_value_1": _class_method_1,

"param_value_2": _class_method_2,

}

def main_method(self) -> str:

"""will execute either _class_method_1 or _class_method_2

depending on self.param value

"""

return self._class_method_choices[self.param].__get__(None, self.__class__)() # type: ignore

# type ignore reason: https://github.com/python/mypy/issues/10206

class CatalogStatic:

"""catalog of multiple static methods that are executed depending on an init

parameter

"""

def __init__(self, param: str) -> None:

# simple test to validate param value

if param in self._static_method_choices:

self.param = param

else:

raise ValueError(f"Invalid Value for Param: {param}")

@staticmethod

def _static_method_1() -> str:

return "executed method 1!"

@staticmethod

def _static_method_2() -> str:

return "executed method 2!"

_static_method_choices = {

"param_value_1": _static_method_1,

"param_value_2": _static_method_2,

}

def main_method(self) -> str:

"""will execute either _static_method_1 or _static_method_2

depending on self.param value

"""

return self._static_method_choices[self.param].__get__(None, self.__class__)() # type: ignore

# type ignore reason: https://github.com/python/mypy/issues/10206

def main():

"""

>>> test = Catalog('param_value_2')

>>> test.main_method()

'executed method 2!'

>>> test = CatalogInstance('param_value_1')

>>> test.main_method()

'Value x1'

>>> test = CatalogClass('param_value_2')

>>> test.main_method()

'Value x2'

>>> test = CatalogStatic('param_value_1')

>>> test.main_method()

'executed method 1!'

"""

if __name__ == "__main__":

import doctest

doctest.testmod()