openc2lib.types.base.enumerated

 1import aenum
 2
 3from openc2lib.types.base.openc2_type import Openc2Type
 4
 5class Enumerated(Openc2Type, aenum.Enum):
 6	""" OpenC2 Enumerated
 7
 8		Implements OpenC2 Enumerated:
 9		>A set of named integral constants. The API value is a name.
10
11		The constants may be anything, including strings, integers, classes.
12	"""
13
14	# Convert enumerations to str
15	def todict(self, e):
16		""" Converts to dictionary 
17		
18			It is used to convert this object to an intermediary representation during 
19			serialization. It takes an `Encoder` argument that is used to recursively
20			serialize inner data and structures (the `Encoder` provides standard methods
21			for converting base types to dictionaries).. 
22
23			:param e: The `Encoder` that is being used.
24			:return: A dictionary compliants to the Language Specification's serialization
25			rules.
26		"""
27		return self.name
28
29	@classmethod
30	def fromdict(cls, dic, e):
31		""" Builds instance from dictionary 
32
33			It is used during deserialization to create an openc2lib instance from the text message.
34			It takes an `Encoder` instance that is used to recursively build instances of the inner
35			objects (the `Encoder` provides standard methods to create instances of base objects like
36			strings, integers, boolean).
37
38			:param dic: The intermediary dictionary representation from which the object is built.
39			:param e: The `Encoder that is being used.
40			:return: An instance of this class initialized from the dictionary values.
41		"""
42		try:
43			return cls[str(dic)]
44		except:
45			raise TypeError("Unexpected enum value: ", dic)
46