o c@sldZddlZddlZddlmZmZddlmZmZm Z m Z ddl m Z e dddZ Gd ddejd ZdS) zJOSE interfaces.N)MappingSequence)AnyTypeTypeVarUnion)errorsGenericJSONDeSerializableJSONDeSerializable)boundc@seZdZdZejdefddZdefddZe ejde e dede fd d Z e de e d e eefde fd d ZdedefddZdefddZe dddefddZdS)r a Interface for (de)serializable JSON objects. Please recall, that standard Python library implements :class:`json.JSONEncoder` and :class:`json.JSONDecoder` that perform translations based on respective :ref:`conversion tables ` that look pretty much like the one below (for complete tables see relevant Python documentation): .. _conversion-table: ====== ====== JSON Python ====== ====== object dict ... ... ====== ====== While the above **conversion table** is about translation of JSON documents to/from the basic Python types only, :class:`JSONDeSerializable` introduces the following two concepts: serialization Turning an arbitrary Python object into Python object that can be encoded into a JSON document. **Full serialization** produces a Python object composed of only basic types as required by the :ref:`conversion table `. **Partial serialization** (accomplished by :meth:`to_partial_json`) produces a Python object that might also be built from other :class:`JSONDeSerializable` objects. deserialization Turning a decoded Python object (necessarily one of the basic types as required by the :ref:`conversion table `) into an arbitrary Python object. Serialization produces **serialized object** ("partially serialized object" or "fully serialized object" for partial and full serialization respectively) and deserialization produces **deserialized object**, both usually denoted in the source code as ``jobj``. Wording in the official Python documentation might be confusing after reading the above, but in the light of those definitions, one can view :meth:`json.JSONDecoder.decode` as decoder and deserializer of basic types, :meth:`json.JSONEncoder.default` as serializer of basic types, :meth:`json.JSONEncoder.encode` as serializer and encoder of basic types. One could extend :mod:`json` to support arbitrary object (de)serialization either by: - overriding :meth:`json.JSONDecoder.decode` and :meth:`json.JSONEncoder.default` in subclasses - or passing ``object_hook`` argument (or ``object_hook_pairs``) to :func:`json.load`/:func:`json.loads` or ``default`` argument for :func:`json.dump`/:func:`json.dumps`. Interestingly, ``default`` is required to perform only partial serialization, as :func:`json.dumps` applies ``default`` recursively. This is the idea behind making :meth:`to_partial_json` produce only partial serialization, while providing custom :meth:`json_dumps` that dumps with ``default`` set to :meth:`json_dump_default`. To make further documentation a bit more concrete, please, consider the following imaginatory implementation example:: class Foo(JSONDeSerializable): def to_partial_json(self): return 'foo' @classmethod def from_json(cls, jobj): return Foo() class Bar(JSONDeSerializable): def to_partial_json(self): return [Foo(), Foo()] @classmethod def from_json(cls, jobj): return Bar() returncCst)aPartially serialize. Following the example, **partial serialization** means the following:: assert isinstance(Bar().to_partial_json()[0], Foo) assert isinstance(Bar().to_partial_json()[1], Foo) # in particular... assert Bar().to_partial_json() != ['foo', 'foo'] :raises josepy.errors.SerializationError: in case of any serialization error. :returns: Partially serializable object. )NotImplementedErrorselfr>/opt/certbot/lib/python3.10/site-packages/josepy/interfaces.pyto_partial_jsoncz"JSONDeSerializable.to_partial_jsoncsdtdtffdd |S)aDFully serialize. Again, following the example from before, **full serialization** means the following:: assert Bar().to_json() == ['foo', 'foo'] :raises josepy.errors.SerializationError: in case of any serialization error. :returns: Fully serialized object. objr cst|tr |St|tr|St|tr fdd|DSt|tr0tfdd|DSt|tr@fdd|DS|S)Ncsg|]}|qSrr.0subobj _serializerr szBJSONDeSerializable.to_json.._serialize..c3s|]}|VqdS)Nrrrrr szAJSONDeSerializable.to_json.._serialize..csi|] \}}||qSrr)rkeyvaluerrr szBJSONDeSerializable.to_json.._serialize..) isinstancer rstrlistrtupleritems)rrrrrs       z.JSONDeSerializable.to_json.._serialize)rrrrrto_jsonvs zJSONDeSerializable.to_jsonclsjobjcCs|S)aDeserialize a decoded JSON document. :param jobj: Python object, composed of only other basic data types, as decoded from JSON document. Not necessarily :class:`dict` (as decoded from "JSON object" document). :raises josepy.errors.DeserializationError: if decoding was unsuccessful, e.g. in case of unparseable X509 certificate, or wrong padding in JOSE base64 encoded string, etc. r)r%r&rrr from_jsonrzJSONDeSerializable.from_json json_stringc Cs<zt|}Wnty}zt|d}~ww||S)z&Deserialize from JSON document string.N)jsonloads ValueErrorrDeserializationErrorr')r%r(r*errorrrr json_loadss  zJSONDeSerializable.json_loadskwargscKstj|fd|ji|S)zsDump to JSON string using proper serializer. :returns: JSON document string. :rtype: str default)r)dumpsjson_dump_default)rr/rrr json_dumpsszJSONDeSerializable.json_dumpscCs|jddddS)zNDump the object to pretty JSON document string. :rtype: str T),z: ) sort_keysindent separators)r3rrrrjson_dumps_prettysz$JSONDeSerializable.json_dumps_pretty python_objectcCs"t|tr |Stt|d)aSerialize Python object. This function is meant to be passed as ``default`` to :func:`json.dump` or :func:`json.dumps`. They call ``default(python_object)`` only for non-basic Python types, so this function necessarily raises :class:`TypeError` if ``python_object`` is not an instance of :class:`IJSONSerializable`. Please read the class docstring for more information. z is not JSON serializable)rr r TypeErrorrepr)r%r:rrrr2s z$JSONDeSerializable.json_dump_defaultN)__name__ __module__ __qualname____doc__abcabstractmethodrrr$ classmethodrr r'rr bytesr.r3r9r2rrrrr s$V      ) metaclass)r@rAr)collections.abcrrtypingrrrrjosepyrr ABCMetar rrrrs