py_serializable.helpers ======================= .. py:module:: py_serializable.helpers Classes ------- .. autoapisummary:: py_serializable.helpers.BaseHelper py_serializable.helpers.Iso8601Date py_serializable.helpers.XsdDate py_serializable.helpers.XsdDateTime Module Contents --------------- .. py:class:: BaseHelper Base Helper. Inherit from this class and implement/override the needed functions! This class does not provide any functionality, it is more like a Protocol with some fallback implementations. .. py:method:: serialize(o: Any) -> Union[Any, str] :classmethod: :abstractmethod: general purpose serializer .. py:method:: deserialize(o: Any) -> Any :classmethod: :abstractmethod: general purpose deserializer .. py:method:: json_normalize(o: Any, *, view: Optional[Type[py_serializable.ViewType]], prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) -> Optional[Any] :classmethod: json specific normalizer .. py:method:: json_serialize(o: Any) -> Union[str, Any] :classmethod: json specific serializer .. py:method:: json_denormalize(o: Any, *, prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) -> Any :classmethod: json specific denormalizer :param tCls: the class that was desired to denormalize to :param pCls: tha prent class - as context .. py:method:: json_deserialize(o: Any) -> Any :classmethod: json specific deserializer .. py:method:: xml_normalize(o: Any, *, element_name: str, view: Optional[Type[py_serializable.ViewType]], xmlns: Optional[str], prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) -> Optional[Union[xml.etree.ElementTree.Element, Any]] :classmethod: xml specific normalizer .. py:method:: xml_serialize(o: Any) -> Union[str, Any] :classmethod: xml specific serializer .. py:method:: xml_denormalize(o: xml.etree.ElementTree.Element, *, default_ns: Optional[str], prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) -> Any :classmethod: xml specific denormalizer .. py:method:: xml_deserialize(o: Union[str, Any]) -> Any :classmethod: xml specific deserializer .. py:class:: Iso8601Date Bases: :py:obj:`BaseHelper` Base Helper. Inherit from this class and implement/override the needed functions! This class does not provide any functionality, it is more like a Protocol with some fallback implementations. .. py:method:: serialize(o: Any) -> str :classmethod: general purpose serializer .. py:method:: deserialize(o: Any) -> datetime.date :classmethod: general purpose deserializer .. py:method:: json_normalize(o: Any, *, view: Optional[Type[py_serializable.ViewType]], prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) -> Optional[Any] :classmethod: json specific normalizer .. py:method:: json_serialize(o: Any) -> Union[str, Any] :classmethod: json specific serializer .. py:method:: json_denormalize(o: Any, *, prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) -> Any :classmethod: json specific denormalizer :param tCls: the class that was desired to denormalize to :param pCls: tha prent class - as context .. py:method:: json_deserialize(o: Any) -> Any :classmethod: json specific deserializer .. py:method:: xml_normalize(o: Any, *, element_name: str, view: Optional[Type[py_serializable.ViewType]], xmlns: Optional[str], prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) -> Optional[Union[xml.etree.ElementTree.Element, Any]] :classmethod: xml specific normalizer .. py:method:: xml_serialize(o: Any) -> Union[str, Any] :classmethod: xml specific serializer .. py:method:: xml_denormalize(o: xml.etree.ElementTree.Element, *, default_ns: Optional[str], prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) -> Any :classmethod: xml specific denormalizer .. py:method:: xml_deserialize(o: Union[str, Any]) -> Any :classmethod: xml specific deserializer .. py:class:: XsdDate Bases: :py:obj:`BaseHelper` Base Helper. Inherit from this class and implement/override the needed functions! This class does not provide any functionality, it is more like a Protocol with some fallback implementations. .. py:method:: serialize(o: Any) -> str :classmethod: general purpose serializer .. py:method:: deserialize(o: Any) -> datetime.date :classmethod: general purpose deserializer .. py:method:: json_normalize(o: Any, *, view: Optional[Type[py_serializable.ViewType]], prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) -> Optional[Any] :classmethod: json specific normalizer .. py:method:: json_serialize(o: Any) -> Union[str, Any] :classmethod: json specific serializer .. py:method:: json_denormalize(o: Any, *, prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) -> Any :classmethod: json specific denormalizer :param tCls: the class that was desired to denormalize to :param pCls: tha prent class - as context .. py:method:: json_deserialize(o: Any) -> Any :classmethod: json specific deserializer .. py:method:: xml_normalize(o: Any, *, element_name: str, view: Optional[Type[py_serializable.ViewType]], xmlns: Optional[str], prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) -> Optional[Union[xml.etree.ElementTree.Element, Any]] :classmethod: xml specific normalizer .. py:method:: xml_serialize(o: Any) -> Union[str, Any] :classmethod: xml specific serializer .. py:method:: xml_denormalize(o: xml.etree.ElementTree.Element, *, default_ns: Optional[str], prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) -> Any :classmethod: xml specific denormalizer .. py:method:: xml_deserialize(o: Union[str, Any]) -> Any :classmethod: xml specific deserializer .. py:class:: XsdDateTime Bases: :py:obj:`BaseHelper` Base Helper. Inherit from this class and implement/override the needed functions! This class does not provide any functionality, it is more like a Protocol with some fallback implementations. .. py:method:: serialize(o: Any) -> str :classmethod: general purpose serializer .. py:method:: deserialize(o: Any) -> datetime.datetime :classmethod: general purpose deserializer .. py:method:: json_normalize(o: Any, *, view: Optional[Type[py_serializable.ViewType]], prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) -> Optional[Any] :classmethod: json specific normalizer .. py:method:: json_serialize(o: Any) -> Union[str, Any] :classmethod: json specific serializer .. py:method:: json_denormalize(o: Any, *, prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) -> Any :classmethod: json specific denormalizer :param tCls: the class that was desired to denormalize to :param pCls: tha prent class - as context .. py:method:: json_deserialize(o: Any) -> Any :classmethod: json specific deserializer .. py:method:: xml_normalize(o: Any, *, element_name: str, view: Optional[Type[py_serializable.ViewType]], xmlns: Optional[str], prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) -> Optional[Union[xml.etree.ElementTree.Element, Any]] :classmethod: xml specific normalizer .. py:method:: xml_serialize(o: Any) -> Union[str, Any] :classmethod: xml specific serializer .. py:method:: xml_denormalize(o: xml.etree.ElementTree.Element, *, default_ns: Optional[str], prop_info: py_serializable.ObjectMetadataLibrary.SerializableProperty, ctx: Type[Any], **kwargs: Any) -> Any :classmethod: xml specific denormalizer .. py:method:: xml_deserialize(o: Union[str, Any]) -> Any :classmethod: xml specific deserializer