openc2lib.types.base.enumerated_id

 1from openc2lib.types.base.openc2_type import Openc2Type
 2from openc2lib.types.base.enumerated import Enumerated
 3
 4# This class should check the names are integers.
 5# The enum syntax only allows to define <str = int> pairs,
 6# so to use this class it is necessary to define mnemonic label
 7# TODO: Test this code
 8class EnumeratedID(Enumerated):
 9	""" OpenC2 EnumeratedID
10
11		Implements OpenC2 EnumeratedID: 
12		>A set of unnamed integral constants. The API value is an id.
13
14		The current implementation does not check the values to be integer.
15		However, coversion to/from integer is explicitly done during the
16		intermediary dictionary serialization, hence throwing an Exception if
17		the IDs are not integers.
18	"""
19
20	def todict(self, e):
21		""" Converts to dictionary 
22		
23			It is used to convert this object to an intermediary representation during 
24			serialization. It takes an `Encoder` argument that is used to recursively
25			serialize inner data and structures (the `Encoder` provides standard methods
26			for converting base types to dictionaries).. 
27
28			:param e: The `Encoder` that is being used.
29			:return: A dictionary compliants to the Language Specification's serialization
30			rules.
31		"""
32		return int(self.value)
33
34	@classmethod
35	def fromdict(cls, dic, e):
36		""" Builds instance from dictionary 
37
38			It is used during deserialization to create an openc2lib instance from the text message.
39			It takes an `Encoder` instance that is used to recursively build instances of the inner
40			objects (the `Encoder` provides standard methods to create instances of base objects like
41			strings, integers, boolean).
42
43			:param dic: The intermediary dictionary representation from which the object is built.
44			:param e: The `Encoder that is being used.
45			:return: An instance of this class initialized from the dictionary values.
46		"""
47		try:
48			return cls(int(dic))
49		except:
50			raise TypeError("Unexpected enum value: ", dic)