coretex.codable.codable.Codable Class Reference

Inheritance diagram for coretex.codable.codable.Codable:

Public Member Functions
Dict[str, Any]	encode (self)
None	onDecode (self)
Self	decode (cls, Dict[str, Any] encodedObject)

Detailed Description

    Class whose subclasses can be serialized/deserialized into/from a JSON format object

Definition at line 54 of file codable.py.

Member Function Documentation

decode()

Self coretex.codable.codable.Codable.decode	(		cls,
		Dict[str, Any]	encodedObject
	)

    Decodes the json object into a python object

    Parameters
    ----------
    encodedObject : Dict[str, Any]
json encoded object

    Returns
    -------
    Self -> Decoded python object

Definition at line 263 of file codable.py.

    def decode(cls, encodedObject: Dict[str, Any]) -> Self:
        """
            Decodes the json object into a python object
 
            Parameters
            ----------
            encodedObject : Dict[str, Any]
                json encoded object
 
            Returns
            -------
            Self -> Decoded python object
        """
        obj = cls()
 
        obj._updateFields(encodedObject)
        obj.onDecode()
 
        return obj

encode()

Dict[str, Any] coretex.codable.codable.Codable.encode

(

self

)

    Encodes python object into dictionary which contains
    only values representable by standard python library/types

    Returns
    -------
    Dict[str, Any] -> encoded object which can be serialized into json string

Definition at line 147 of file codable.py.

    def encode(self) -> Dict[str, Any]:
        """
            Encodes python object into dictionary which contains
            only values representable by standard python library/types
 
            Returns
            -------
            Dict[str, Any] -> encoded object which can be serialized into json string
        """
 
        encodedObject: Dict[str, Any] = {}
 
        for key, value in self.__dict__.items():
            descriptor = self.__class__.__keyDescriptorByPythonName(key)
 
            # skip ignored fields for encoding
            if descriptor is not None and not descriptor.isEncodable:
                # print(f">> [Coretex] Skipping encoding for field: {key}")
                continue
 
            encodedKey = self.__encodeKey(key)
            encodedValue = self._encodeValue(key, value)
 
            encodedObject[encodedKey] = encodedValue
 
        return encodedObject
 

onDecode()

None coretex.codable.codable.Codable.onDecode

(

self

)

    Callback which is called once the object has been decoded

Definition at line 255 of file codable.py.

    def onDecode(self) -> None:
        """
            Callback which is called once the object has been decoded
        """
 
        pass
 

---

The documentation for this class was generated from the following file:

• src/coretex/codable/codable.py