← Back
Editing: json_util.cpython-38.pyc
U ��]�= � @ s� d Z ddlZddlZddlZddlZddlZddlmZmZm Z m Z e� e �Z G dd� de�ZG dd� dej�Ze�e�G dd � d e je j��Zd d � Zd d d�Zdd� Zd dd�Zdd� Zdd� Zdd� Z dd� Z G dd � d e�Z dS ) z�JSON (de)serialization framework. The framework presented here is somewhat based on `Go's "json" package`_ (especially the ``omitempty`` functionality). .. _`Go's "json" package`: http://golang.org/pkg/encoding/json/ � N)�b64�errors� interfaces�utilc @ sr e Zd ZdZdZddd�Zedd� �Zd d � Zd d � Z d d� Z dd� Z dd� Z dd� Z edd� �Zedd� �ZdS )�Fielda� JSON object field. :class:`Field` is meant to be used together with :class:`JSONObjectWithFields`. ``encoder`` (``decoder``) is a callable that accepts a single parameter, i.e. a value to be encoded (decoded), and returns the serialized (deserialized) value. In case of errors it should raise :class:`~josepy.errors.SerializationError` (:class:`~josepy.errors.DeserializationError`). Note, that ``decoder`` should perform partial serialization only. :ivar str json_name: Name of the field when encoded to JSON. :ivar default: Default value (used when not present in JSON object). :ivar bool omitempty: If ``True`` and the field value is empty, then it will not be included in the serialized JSON object, and ``default`` will be used for deserialization. Otherwise, if ``False``, field is considered as required, value will always be included in the serialized JSON objected, and it must also be present when deserializing. )� json_name�default� omitempty�fdec�fencNFc C s> || _ || _|| _|d kr | jn|| _|d kr4| jn|| _d S �N)r r r �default_decoderr �default_encoderr )�selfr r r �decoder�encoder� r �2/usr/lib/python3/dist-packages/josepy/json_util.py�__init__/ s zField.__init__c C s t |t� o| S )z�Is the provided value considered "empty" for this field? This is useful for subclasses that might want to override the definition of being empty, e.g. for some more exotic data types. )� isinstance�bool��cls�valuer r r �_empty9 s z Field._emptyc C s | � |�o| jS )zOmit the value in output?)r r �r r r r r �omitC s z Field.omitc K s4 t | j| j| j| j| jd�}|�|� t| �f |�S )N)r r r r r )�dictr r r r r �update�type)r �kwargsZcurrentr r r �_update_paramsG s � zField._update_paramsc C s | j |d�S )z6Descriptor to change the decoder on JSON object field.)r �r! )r r r r r r N s z Field.decoderc C s | j |d�S )z6Descriptor to change the encoder on JSON object field.)r r" )r r r r r r R s z Field.encoderc C s | � |�S )z4Decode a value, optionally with context JSON object.)r r r r r �decodeV s z Field.decodec C s | � |�S )z4Encode a value, optionally with context JSON object.)r r r r r �encodeZ s z Field.encodec sT t |t�r t� fdd�|D ��S t |t�rLt�t� fdd�t�|�D ���S |S dS )z�Default decoder. Recursively deserialize into immutable types ( :class:`josepy.util.frozendict` instead of :func:`dict`, :func:`tuple` instead of :func:`list`). c 3 s | ]}� � |�V qd S r �r )�.0Zsubvalue�r r r � <genexpr>i s z(Field.default_decoder.<locals>.<genexpr>c 3 s& | ] \}}� � |�� � |�fV qd S r r% )r& �keyr r' r r r( l s �N)r �list�tupler r Z frozendict�six� iteritemsr r r' r r ^ s ��zField.default_decoderc C s |S )z Default (passthrough) encoder.r r r r r r q s zField.default_encoder)NFNN)�__name__� __module__� __qualname__�__doc__� __slots__r � classmethodr r r! r r r# r$ r r r r r r r s$ � r c @ s e Zd ZdZdd� ZdS )�JSONObjectWithFieldsMetaa� Metaclass for :class:`JSONObjectWithFields` and its subclasses. It makes sure that, for any class ``cls`` with ``__metaclass__`` set to ``JSONObjectWithFieldsMeta``: 1. All fields (attributes of type :class:`Field`) in the class definition are moved to the ``cls._fields`` dictionary, where keys are field attribute names and values are fields themselves. 2. ``cls.__slots__`` is extended by all field attribute names (i.e. not :attr:`Field.json_name`). Original ``cls.__slots__`` are stored in ``cls._orig_slots``. In a consequence, for a field attribute name ``some_field``, ``cls.some_field`` will be a slot descriptor and not an instance of :class:`Field`. For example:: some_field = Field('someField', default=()) class Foo(object): __metaclass__ = JSONObjectWithFieldsMeta __slots__ = ('baz',) some_field = some_field assert Foo.__slots__ == ('some_field', 'baz') assert Foo._orig_slots == () assert Foo.some_field is not Field assert Foo._fields.keys() == ['some_field'] assert Foo._fields['some_field'] is some_field As an implementation note, this metaclass inherits from :class:`abc.ABCMeta` (and not the usual :class:`type`) to mitigate the metaclass conflict (:class:`ImmutableMap` and :class:`JSONDeSerializable`, parents of :class:`JSONObjectWithFields`, use :class:`abc.ABCMeta` as its metaclass). c C s� i }|D ]}|� t|di �� qtt�|��D ] \}}t|t�r.|�|�||< q.|�dd�|d< tt |d �t t� |�� �|d< ||d< t j � | |||�S )N�_fieldsr2 r Z _orig_slots)r �getattrr+ r, r- r r �pop�getr* Ziterkeys�abc�ABCMeta�__new__)Zmcs�name�basesZdikt�fields�baser) r r r r r; � s �z JSONObjectWithFieldsMeta.__new__N)r. r/ r0 r1 r; r r r r r4 y s 'r4 c sh e Zd ZdZedd� �Z� fdd�Zdd� Zdd � Zd d � Z ed d � �Z edd� �Z edd� �Z � Z S )�JSONObjectWithFieldsa� JSON object with fields. Example:: class Foo(JSONObjectWithFields): bar = Field('Bar') empty = Field('Empty', omitempty=True) @bar.encoder def bar(value): return value + 'bar' @bar.decoder def bar(value): if not value.endswith('bar'): raise errors.DeserializationError('No bar suffix!') return value[:-3] assert Foo(bar='baz').to_partial_json() == {'Bar': 'bazbar'} assert Foo.from_json({'Bar': 'bazbar'}) == Foo(bar='baz') assert (Foo.from_json({'Bar': 'bazbar', 'Empty': '!'}) == Foo(bar='baz', empty='!')) assert Foo(bar='baz').bar == 'baz' c C s t dd� t�| j�D ��S )zGet default fields values.c S s g | ]\}}||j f�qS r )r )r& �slot�fieldr r r � <listcomp>� s z2JSONObjectWithFields._defaults.<locals>.<listcomp>)r r, r- r5 r' r r r � _defaults� s �z JSONObjectWithFields._defaultsc s" t t| �jf t| �� f|�� d S r )�superr@ r r rD )r r �� __class__r r r � s �z JSONObjectWithFields.__init__c C sD z| j | }W n$ tk r2 t�d�|���Y nX |�t| |��S )z�Encode a single field. :param str name: Name of the field to be encoded. :raises errors.SerializationError: if field cannot be serialized :raises errors.Error: if field could not be found zField not found: {0})r5 �KeyErrorr �Error�formatr$ r6 )r r< rB r r r r$ � s zJSONObjectWithFields.encodec C s� i }t � }t�| j�D ]z\}}t| |�}|�|�rB|�||f� qz|�|�||j< W q t j k r� } zt � d� |||���W 5 d}~X Y qX q|S )zSerialize fields to JSON.z Could not encode {0} ({1}): {2}N) �setr, r- r5 r6 r �addr$ r r ZSerializationErrorrJ )r �jobjZomittedrA rB r �errorr r r �fields_to_partial_json� s" ��z+JSONObjectWithFields.fields_to_partial_jsonc C s | � � S r )rO )r r r r �to_partial_json� s z$JSONObjectWithFields.to_partial_jsonc C sV t � }t�| j�D ]$\}}|js|j|kr|�|j� q|rRt�d� d� |����d S )Nz&The following fields are required: {0}�,) rK r, r- r5 r r rL r �DeserializationErrorrJ �join)r rM Zmissing�_rB r r r �_check_required s ��z$JSONObjectWithFields._check_requiredc C s� | � |� i }t�| j�D ]z\}}|j|kr>|jr>|j||< q||j }z|�|�||< W q tj k r� } zt� d� |||���W 5 d}~X Y qX q|S )z Deserialize fields from JSON.z#Could not decode {0!r} ({1!r}): {2}N) rU r, r- r5 r r r r# r rR rJ )r rM r> rA rB r rN r r r �fields_from_json s" ��z%JSONObjectWithFields.fields_from_jsonc C s | f | � |��S r )rV )r rM r r r � from_json s z JSONObjectWithFields.from_json)r. r/ r0 r1 r3 rD r r$ rO rP rU rV rW � __classcell__r r rF r r@ � s r@ c C s t �| ��d�S )zNEncode JOSE Base-64 field. :param bytes data: :rtype: `unicode` �ascii)r Z b64encoder# )�datar r r �encode_b64jose$ s r[ Fc C s� t jr tntj}zt�| �� �}W n, |k rN } zt� |��W 5 d}~X Y nX |dk r�|sht |�|ksx|r�t |�|k r�t� d� |���|S )a Decode JOSE Base-64 field. :param unicode data: :param int size: Required length (after decoding). :param bool minimum: If ``True``, then `size` will be treated as minimum required length, as opposed to exact equality. :rtype: bytes Nz&Expected at least or exactly {0} bytes) r, �PY2� TypeError�binasciirI r Z b64decoder$ r rR �lenrJ )rZ �size�minimum� error_clsZdecodedrN r r r �decode_b64jose/ s � ��rc c C s t �| ��� S )z;Hexlify. :param bytes value: :rtype: unicode )r^ Zhexlifyr# )r r r r � encode_hex16H s rd c C s� | � � } |dk r@|s$t| �|d ks8|r@t| �|d k r@t�� �tjrJtntj}z t� | �W S |k r� } zt�|��W 5 d}~X Y nX dS )a Decode hexlified field. :param unicode value: :param int size: Required length (after decoding). :param bool minimum: If ``True``, then `size` will be treated as minimum required length, as opposed to exact equality. :rtype: bytes N� ) r$ r_ r rR r, r\ r] r^ rI Z unhexlify)r r` ra rb rN r r r � decode_hex16R s �� rf c C s t tj�tjj| j��S )z�Encode certificate as JOSE Base-64 DER. :type cert: `OpenSSL.crypto.X509` wrapped in `.ComparableX509` :rtype: unicode )r[ �OpenSSL�cryptoZdump_certificate� FILETYPE_ASN1�wrapped)Zcertr r r � encode_certh s �rk c C sT z t �tj�tjjt| ���W S tjjk rN } zt� |��W 5 d}~X Y nX dS )z�Decode JOSE Base-64 DER-encoded certificate. :param unicode b64der: :rtype: `OpenSSL.crypto.X509` wrapped in `.ComparableX509` N) r �ComparableX509rg rh Zload_certificateri rc rI r rR �Zb64derrN r r r � decode_certs s �rn c C s t tj�tjj| j��S )zEncode CSR as JOSE Base-64 DER. :type csr: `OpenSSL.crypto.X509Req` wrapped in `.ComparableX509` :rtype: unicode )r[ rg rh Zdump_certificate_requestri rj )Zcsrr r r � encode_csr� s �ro c C sT z t �tj�tjjt| ���W S tjjk rN } zt� |��W 5 d}~X Y nX dS )z�Decode JOSE Base-64 DER-encoded CSR. :param unicode b64der: :rtype: `OpenSSL.crypto.X509Req` wrapped in `.ComparableX509` N) r rl rg rh Zload_certificate_requestri rc rI r rR rm r r r � decode_csr� s �rp c @ sJ e Zd ZdZeZdZeZed dd��Z edd� �Z dd � Z ed d � �Z dS ) �TypedJSONObjectWithFieldszJSON object with type.r Nc C s |dkr|j n|}|| j|< |S )z(Register class for JSON deserialization.N)�typ�TYPES)r �type_clsrr r r r �register� s z"TypedJSONObjectWithFields.registerc C s� | t �| j�kr0| j|kr,t�d�| j���| S t|t�sJt�d�|���z|| j }W n t k rv t�d��Y nX z | j| W S t k r� t� ||��Y nX dS )z&Get the registered class for ``jobj``.zMissing type field ({0})z {0} is not a dictionary objectzmissing type fieldN) r, Z itervaluesrs �type_field_namer rR rJ r r rH ZUnrecognizedTypeError)r rM rr r r r � get_type_cls� s$ � � z&TypedJSONObjectWithFields.get_type_clsc C s | � � }| j|| j< |S )a Get JSON serializable object. :returns: Serializable JSON object representing ACME typed object. :meth:`validate` will almost certainly not work, due to reasons explained in :class:`josepy.interfaces.IJSONSerializable`. :rtype: dict )rO rr rv )r rM r r r rP � s z)TypedJSONObjectWithFields.to_partial_jsonc C s | � |�}|f |�|��S )z�Deserialize ACME object from valid JSON object. :raises josepy.errors.UnrecognizedTypeError: if type of the ACME object has not been registered. )rw rV )r rM rt r r r rW � s z#TypedJSONObjectWithFields.from_json)N) r. r/ r0 r1 �NotImplementedrr rv rs r3 ru rw rP rW r r r r rq � s rq )NF)NF) r1 r9 r^ Zloggingrg r, Zjosepyr r r r Z getLoggerr. Zlogger�objectr r: r4 Z add_metaclassZ ImmutableMapZJSONDeSerializabler@ r[ rc rd rf rk rn ro rp rq r r r r �<module> s( d;o
Save File
Cancel