o
6dF @ s d Z ddlmZmZ ddlZddlZddlZddlZddlZddl Z ddl
Z
ddl Z ddl Z ddl
mZmZ dZer>ddlZG dd deZG dd d eZG d
d d eZG d d
d
eZG dd deZG dd deZ d'ddZ d(ddZ G dd deZ d)ddZ d*dd Z e
d Z!d d Z"d d! Z#zddl$Z$W n
e%y Y dS w ej&e dd"Z'd#d$ Z(ej&e dd"Z) d+d%d&Z*dS ),a
Serializers for Stone data types.
Currently, only JSON is officially supported, but there's an experimental
msgpack integration. If possible, serializers should be kept separate from the
RPC format.
This module should be dropped into a project that requires the use of Stone. In
the future, this could be imported from a pre-installed Python package, rather
than being added to a project.
)absolute_importunicode_literalsN)
stone_basestone_validatorsFc @ e Zd Zedd ZdS )CallerPermissionsInterfacec C t )zL
Returns the list of permissions this caller has access to.
NotImplementedErrorself r
C:\Users\jesus\OneDrive\Desktop\erpjis_fastapi\backend\jisbackend\Lib\site-packages\stone/backends/python_rsrc/stone_serializers.py permissions' s z&CallerPermissionsInterface.permissionsN__name__
__module__ __qualname__propertyr r
r
r
r r % r c @ r )CallerPermissionsDefaultc C s g S Nr
r r
r
r r 1 s z$CallerPermissionsDefault.permissionsNr r
r
r
r r / r r c @ s e Zd ZdZdd ZdS )StoneEncoderInterfacez4
Interface defining a stone object encoder.
c C r )a
Validate ``value`` using ``validator`` and return the encoding.
Args:
validator: the ``stone_validators.Validator`` used to validate
``value``
value: the object to encode
Returns:
The encoded object. This is implementation-defined.
Raises:
stone_validators.ValidationError: Raised if ``value`` (or one
of its sub-values).
r r validatorvaluer
r
r encode; s z StoneEncoderInterface.encodeN)r r r __doc__r r
r
r
r r 6 s r c @ sh e Zd Zdd Zedd Zdd Zdd Zd d
Zd d Z d
d Z
dd Z dd Z dd Z
dd ZdS )StoneSerializerBasec C s2 |r|nt | _i | _|dur| j| dS dS )a_
Constructor, `obviously
`.
Args:
caller_permissions (list): The list of raw-string caller permissions with which
to serialize.
alias_validators (``typing.Mapping``, optional): A mapping of
custom validation callables in the format
``{stone_validators.Validator:
typing.Callable[[typing.Any], None], ...}``. These callables must
raise a ``stone_validators.ValidationError`` on failure.
Defaults to ``None``.
N)r caller_permissions_alias_validatorsupdate)r r alias_validatorsr
r
r __init__Q s z StoneSerializerBase.__init__c C | j S )z
A ``typing.Mapping`` of custom validation callables in the format
``{stone_validators.Validator: typing.Callable[typing.Any],
...}``.
)r r r
r
r r" h z$StoneSerializerBase.alias_validatorsc C s | ||S r )
encode_subr r
r
r r q s zStoneSerializerBase.encodec s t tjr
j} j}nut tjrj} j}nht tjr'j} j}n[t tj r4j} j
}nNt tj rjt tj rU j
jrN fdd}|}nj} j}n- j
jrc fdd}|}nj} j}nt tjrwj} j}n tdtj|| ||S )z
Callback intended to be called by other ``encode`` methods to
delegate encoding of sub-values. Arguments have the same semantics
as with the ``encode`` method.
c | j d S r validate_with_permissionsr valr r r
r r) zAStoneSerializerBase.encode_sub..validate_with_permissionsc r' r r( r* r, r
r r) r- zUnsupported data type {})
isinstancebvListvalidate encode_listMap
encode_mapNullableencode_nullable Primitiveencode_primitiveStruct
StructTreer r encode_struct_treeZvalidate_type_only
encode_structUnion encode_unionValidationErrorformattyper )r r r Z
validate_fZencode_fr) r
r, r r& t s<
z StoneSerializerBase.encode_subc C r )z
Callback for serializing a ``stone_validators.List``. Arguments
have the same semantics as with the ``encode`` method.
r r r
r
r r2 z StoneSerializerBase.encode_listc C r )z
Callback for serializing a ``stone_validators.Map``. Arguments
have the same semantics as with the ``encode`` method.
r r r
r
r r4 rB z StoneSerializerBase.encode_mapc C r )z
Callback for serializing a ``stone_validators.Nullable``.
Arguments have the same semantics as with the ``encode`` method.
r r r
r
r r6 rB z#StoneSerializerBase.encode_nullablec C r )z
Callback for serializing a ``stone_validators.Primitive``.
Arguments have the same semantics as with the ``encode`` method.
r r r
r
r r8 rB z$StoneSerializerBase.encode_primitivec C r )z
Callback for serializing a ``stone_validators.Struct``. Arguments
have the same semantics as with the ``encode`` method.
r r r
r
r r< rB z!StoneSerializerBase.encode_structc C r )z
Callback for serializing a ``stone_validators.StructTree``.
Arguments have the same semantics as with the ``encode`` method.
r r r
r
r r; rB z&StoneSerializerBase.encode_struct_treec C r )z
Callback for serializing a ``stone_validators.Union``. Arguments
have the same semantics as with the ``encode`` method.
r r r
r
r r> rB z StoneSerializerBase.encode_unionN)r r r r# r r" r r& r2 r4 r6 r8 r< r; r> r
r
r
r r O s
6 r c sx e Zd Z fddZedd Zedd Z fddZd d
Zd d Z d
d Z
dd Z dd Z dd Z
dd Z ZS ) StoneToPythonPrimitiveSerializerc s* t t| j||d || _|| _|| _dS )a
Args:
alias_validators (``typing.Mapping``, optional): Passed
to ``StoneSerializer.__init__``. Defaults to ``None``.
for_msgpack (bool, optional): See the like-named property.
Defaults to ``False``.
old_style (bool, optional): See the like-named property.
Defaults to ``False``.
should_redact (bool, optional): Whether to perform redaction on
marked fields. Defaults to ``False``.
)r" N)superrC r# _for_msgpack
_old_style
should_redact)r r r" for_msgpack old_stylerG __class__r
r r# s
z)StoneToPythonPrimitiveSerializer.__init__c C r$ )z
EXPERIMENTAL: A flag associated with the serializer indicating
whether objects produced by the ``encode`` method should be
encoded for msgpack.
rE r r
r
r rH s z,StoneToPythonPrimitiveSerializer.for_msgpackc C r$ z
A flag associated with the serializer indicating whether objects
produced by the ``encode`` method should be encoded according to
Dropbox's old or new API styles.
rF r r
r
r rI r% z*StoneToPythonPrimitiveSerializer.old_stylec sj | j r,t dr,t|tr fdd|D S t|tr& fdd| D S j|S tt |
|S )N_redactc s g | ]} j |qS r
rO apply).0vr r
r
s z?StoneToPythonPrimitiveSerializer.encode_sub..c s i | ] \}}| j |qS r
rP )rR krS rT r
r
s z?StoneToPythonPrimitiveSerializer.encode_sub..) rG hasattrr. listdictitemsrO rQ rD rC r& r rJ rT r r& s
z+StoneToPythonPrimitiveSerializer.encode_subc s |} fdd|D S )Nc s g | ] } j|qS r
)r& item_validator)rR Z
value_itemr, r
r rU s z@StoneToPythonPrimitiveSerializer.encode_list..)r1 r r r Zvalidated_valuer
r, r r2 s
z,StoneToPythonPrimitiveSerializer.encode_listc s" |} fdd| D S )Nc s* i | ]\}} j| j|qS r
)r&
key_validatorvalue_validatorrR keyr r, r
r rW
z?StoneToPythonPrimitiveSerializer.encode_map..)r1 r[ r] r
r, r r4 s
z+StoneToPythonPrimitiveSerializer.encode_mapc C s |d u rd S | |j|S r )r& r r r
r
r r6 & s z0StoneToPythonPrimitiveSerializer.encode_nullablec C s || j v r | j | | t|tjrd S t|tjr t||jS t|tjr3| jr+|S t
| dS t|tj rBt|t
rBt|S |S )Nascii)r" r. r/ Void Timestamp _strftimer@ BytesrH base64 b64encodedecodeIntegerboolintr r
r
r r8 , s
z1StoneToPythonPrimitiveSerializer.encode_primitivec C s t }|jj}| jjD ]}d|}|t|j|g }q |D ]N\}}zt||} W n ty> }
zt
|
j d d }
~
ww d| } | d urmt|| t j
urmz
| || ||< W q t j
yl }
z|
| d }
~
ww q |S )N_all_{}_fields_r z _%s_value) collections OrderedDict
definition _all_fields_r r r@ getattrAttributeErrorr/ r? argsbbZNOT_SETr&
add_parent) r r r d
all_fieldsextra_permissionZall_fields_name
field_namefield_validatorZ field_valueexcZ value_keyr
r
r r< B s0
z.StoneToPythonPrimitiveSerializer.encode_structc C s t ||jjv sJ dt ||jf |jjt | \}}t|dks'J |t|tjr4J d|j | jrC|d | ||i}|S t
}|d |d< | | || |S )Nz'%r is not a serializable subtype of %r. z8Cannot serialize type %r because it enumerates subtypes.r .tag) rA rq Z_pytype_to_tag_and_subtype_lenr. r/ r: rI r< ro rp r! )r r r tagssubtyperx r
r
r r; a s z3StoneToPythonPrimitiveSerializer.encode_struct_treec s2 |j d u r
td|j|j js td|j |j|j j}t|tj p5t|tj
o5|j d u } fdd} j rX|d u rF|j S |rK|j S |||j |j }|j |iS |r_d|j iS |||j |j }t|tj
rp|j
}t|tjrt|tjst }|j |d< || |S td|j f|j |ffS )Nz
no tag setz'caller does not have access to '{}' tagc
s: z | |}W |S tjy } z|| d }~ww r )r& r/ r? rw )Z
sub_validatorZ sub_valueZ
parent_tag encoded_valr} r r
r r& s
zAStoneToPythonPrimitiveSerializer.encode_union..encode_subr )Z_tagr/ r? rq _is_tag_presentr r@ _get_val_data_typer. rd r5 _valuerI r r9 r: ro rp r! )r r r r| Zis_noner& r rx r
r r r> v sJ
z-StoneToPythonPrimitiveSerializer.encode_union)r r r r# r rH rI r& r2 r4 r6 r8 r< r; r>
__classcell__r
r
rJ r rC s
rC c s e Zd Z fddZ ZS )StoneToJsonSerializerc s t tt| ||S r )jsondumpsrD r r r rJ r
r r s z StoneToJsonSerializer.encode)r r r r r r
r
rJ r r s r c C s d}t |||||}|| |S )aA Encodes an object into JSON based on its type.
Args:
data_type (Validator): Validator for obj.
obj (object): Object to be serialized.
caller_permissions (list): The list of raw-string caller permissions with which
to serialize.
alias_validators (Optional[Mapping[bv.Validator, Callable[[], None]]]):
Custom validation functions. These must raise bv.ValidationError on
failure.
Returns:
str: JSON-encoded object.
This function will also do additional validation that wasn't done by the
objects themselves:
1. The passed in obj may not have been validated with data_type yet.
2. If an object that should be a Struct was assigned to a field, its
type has been validated, but the presence of all required fields
hasn't been.
3. If an object that should be a Union was assigned to a field, whether
or not a tag has been set has not been validated.
4. A list may have passed validation initially, but been mutated since.
Example of serializing a struct to JSON:
struct FileRef
path String
rev String
> fr = FileRef()
> fr.path = 'a/b/c'
> fr.rev = '1234'
> JsonEncoder.encode(fr)
"{'path': 'a/b/c', 'rev': '1234'}"
Example of serializing a union to JSON:
union UploadMode
add
overwrite
update FileRef
> um = UploadMode()
> um.set_add()
> JsonEncoder.encode(um)
'"add"'
> um.update = fr
> JsonEncoder.encode(um)
"{'update': {'path': 'a/b/c', 'rev': '1234'}}"
F)r r ) data_typeobjr r" rI rG rH
serializerr
r
r json_encode s
6
r c C s t |||||}|| |S )a Encodes an object into a JSON-compatible dict based on its type.
Args:
data_type (Validator): Validator for obj.
obj (object): Object to be serialized.
caller_permissions (list): The list of raw-string caller permissions
with which to serialize.
Returns:
An object that when passed to json.dumps() will produce a string
giving the JSON-encoded object.
See json_encode() for additional information about validation.
)rC r )r r r r" rI rH rG r r
r
r json_compat_obj_encode s
r c @ s e Zd Zdd Zedd Zedd Zdd Zd d
Zd d Z d
d Z
dd Z dd Z dd Z
dd Zdd Zdd Zdd Zd d Zd S ) PythonPrimitiveToStoneDecoderc C s, |r|nt | _|| _|| _|| _|| _d S r )r r r" strictrF rE )r r r" rH rI r r
r
r r#
s
z&PythonPrimitiveToStoneDecoder.__init__c C r$ )z
EXPERIMENTAL: A flag associated with the serializer indicating
whether objects produced by the ``encode`` method should be
encoded for msgpack.
rL r r
r
r rH r% z)PythonPrimitiveToStoneDecoder.for_msgpackc C r$ rM rN r r
r
r rI r% z'PythonPrimitiveToStoneDecoder.old_stylec C s t |tjr | ||S t |tjr| ||S t |tjr-| jr'| ||S | ||S t |tj
r9| ||S t |tj rE|
||S t |tjrQ| ||S t |tjr^| ||dS td| )zI
See json_compat_obj_decode() for argument descriptions.
FzCannot handle type %r.)r. r/ r: decode_struct_treer9
decode_structr= rI decode_union_old decode_unionr0 decode_listr3
decode_mapr5 decode_nullabler7 make_stone_friendlyAssertionErrorr r r r
r
r json_compat_obj_decode_helper' s. z;PythonPrimitiveToStoneDecoder.json_compat_obj_decode_helperc
C s |du r | r | S t|tstdt| |jj}| j j
D ]}d |}|t |j|g }q#| j
rf|jj}| j j
D ]}d |}|t |j|i }q?|D ]}||vre|dsetd| qS| } | | || || | j | S )zz
The data_type argument must be a Struct.
See json_compat_obj_decode() for argument descriptions.
Nzexpected object, got %srn z_all_{}_field_names_r zunknown field '%s') has_default get_defaultr. rZ r/ r? generic_type_namerq rr r r r@ rs r Z_all_field_names_union
startswithdecode_struct_fieldsZ%validate_fields_only_with_permissions)
r r r ry rz Zall_extra_fieldsZall_field_namesZall_extra_field_namesra insr
r
r r D s6
z+PythonPrimitiveToStoneDecoder.decode_structc C sz |D ]8\}}||v r.z| ||| }t||| W q tjy- } z|| d}~ww | r:t||| qdS )a
Args:
ins: An instance of the class representing the data type being decoded.
The object will have its fields set.
fields: A tuple of (field_name: str, field_validator: Validator)
obj (dict): JSON-compatible dict that is being decoded.
strict (bool): See :func:`json_compat_obj_decode`.
Returns:
None: `ins` has its fields set based on the contents of `obj`.
N)r setattrr/ r? rw r r )r r fieldsr nameZfield_data_typerS er
r
r r d s
z2PythonPrimitiveToStoneDecoder.decode_struct_fieldsc C s d}t |tjrK|}|j|| jr8|j|| j}t |tjtj fs*t
d| ||jj kr7t
d| n+| j sD|jj rD|jj }n t
d| t |t
rY| ||\}}n
t
dt| |t||S )y
The data_type argument must be a Union.
See json_compat_obj_decode() for argument descriptions.
N$expected object for '%s', got symbol(unexpected use of the catch-all tag '%s'unknown tag '%s'!expected string or object, got %s)r. six string_typesrq r r r r/ rd r5 r?
_catch_allr rZ decode_union_dictr
ensure_str)r r r r+ tag
val_data_typer
r
r r z s2
z*PythonPrimitiveToStoneDecoder.decode_unionc
C sV d|vr t d|d }t|tjs t dt | |j|| js9| j s2|jj
r2|jj
d fS t d| ||jj
krFt d| |j || j}t|t j rZ|j
}d}nd}t|t jr| j r||v r{|| d ur{t dt || |D ]}||kr|dkrt d | q}d }||fS t|t jt jt jt jt jfr||v r|| }z| ||}W n t jy } z| | d } ~ ww |rd }nt d
| |D ]}||kr|dkrt d | q||fS t|t jr%|rt|d krd }||fS |}z | ||}W ||fS t jy$ } z| | d } ~ ww J t|) Nr missing '.tag' keyztag must be string, got %sr r TFexpected null, got %szunexpected key '%s'zmissing '%s' keyr~ )r/ r? r. r r r rq r r r r r r5 r rd r7 r0 r: r= r3 r rw r9 r rA )
r r r r r Znullablera r+ raw_valr r
r
r r s
z/PythonPrimitiveToStoneDecoder.decode_union_dictc
C s d}t |tjr>|}|j|| jr+|j|| j}t |tjtj fs*t
d| n| j s7|jj r7|jj }nt
d| t |t
rt|dkrRt
dt| t|d }|| }|j|| jr|j|| j}t |tj ry|du ryd}nSt |tjr|du s| j sd}nCt
dt| z| ||}W n0 tj
y } z|| d}~ww | j s|jj r|jj }nt
d| t
dt| |t||S ) r Nr r r~ zexpected 1 key, got %sr r r )r. r r rq r r r r/ rd r5 r? r r rZ r rY r r rw r )r r r r+ r r r r r
r
r r s\
z.PythonPrimitiveToStoneDecoder.decode_union_oldc C s | ||}| ||S )z~
The data_type argument must be a StructTree.
See json_compat_obj_decode() for argument descriptions.
) determine_struct_tree_subtyper )r r r r r
r
r r s z0PythonPrimitiveToStoneDecoder.decode_struct_treec C s d|vr t dt|d tjs t jdt |d dd|d f}||jjv rB|jj| }t|t jr@t dd | |S | j
rOt dd | |jj rU|S t dd ||jj f ) z
Searches through the JSON-object-compatible dict using the data type
definition to determine which of the enumerated subtypes `obj` is.
r r zexpected string, got %s)parentz#tag '%s' refers to non-leaf subtype.zunknown subtype '%s'z0unknown subtype '%s' and '%s' is not a catch-all)
r/ r? r. r r r rq Z_tag_to_subtype_r: joinr Z_is_catch_all_r )r r r Zfull_tags_tupler r
r
r r s6
z;PythonPrimitiveToStoneDecoder.determine_struct_tree_subtypec s2 t |tstdt| fdd|D S )zx
The data_type argument must be a List.
See json_compat_obj_decode() for argument descriptions.
zexpected list, got %sc s g | ] } j|qS r
)r r\ )rR itemr r r
r rU J s z=PythonPrimitiveToStoneDecoder.decode_list..)r. rY r/ r? r r r
r r r B s
z)PythonPrimitiveToStoneDecoder.decode_listc s6 t |tstdt| fdd| D S )zw
The data_type argument must be a Map.
See json_compat_obj_decode() for argument descriptions.
zexpected dict, got %sc s* i | ]\}} j| j|qS r
)r r^ r_ r` r r
r rW V rb z.)r. rZ r/ r? r r[ r r
r r r N s
z(PythonPrimitiveToStoneDecoder.decode_mapc C s |dur | |j|S dS )z|
The data_type argument must be a Nullable.
See json_compat_obj_decode() for argument descriptions.
N)r r r r
r
r r \ s z-PythonPrimitiveToStoneDecoder.decode_nullablec
C s$ t |tjr'z
tj||j}W nn ttfy& } zt|j d d}~ww t |tj
rV| j r?t |t j
r<|d}nC|}n@zt|}W n8 ttjfyU tdw t |tjrj| jrh|durhtddS |r}| jjrx||| j n|| |}| jdur|| jv r| j| | |S )z
Convert a Python object to a type that will pass validation by its
validator.
Validation by ``alias_validators`` is performed even if ``validate`` is
false.
r Nutf-8z invalid base64-encoded byteszexpected null, got value)r. r/ re datetimestrptimer@ TypeError
ValueErrorr? ru rg rH r text_typer rh b64decodebinasciiErrorrd r r r r) r1 r" )r r r+ r1 retr r
r
r r f s:
z1PythonPrimitiveToStoneDecoder.make_stone_friendlyN)r r r r# r rH rI r r r r r r r r r r r r r
r
r
r r s$
F9#
r Tc C s< zt |}W n ty tdw t| |||||dS )au Performs the reverse operation of json_encode.
Args:
data_type (Validator): Validator for serialized_obj.
serialized_obj (str): The JSON string to deserialize.
caller_permissions (list): The list of raw-string caller permissions
with which to serialize.
alias_validators (Optional[Mapping[bv.Validator, Callable[[], None]]]):
Custom validation functions. These must raise bv.ValidationError on
failure.
strict (bool): If strict, then unknown struct fields will raise an
error, and unknown union variants will raise an error even if a
catch all field is specified. strict should only be used by a
recipient of serialized JSON if it's guaranteed that its Stone
specs are at least as recent as the senders it receives messages
from.
Returns:
The returned object depends on the input data_type.
- Boolean -> bool
- Bytes -> bytes
- Float -> float
- Integer -> long
- List -> list
- Map -> dict
- Nullable -> None or its wrapped type.
- String -> unicode (PY2) or str (PY3)
- Struct -> An instance of its definition attribute.
- Timestamp -> datetime.datetime
- Union -> An instance of its definition attribute.
z could not decode input as JSON)r r" r rI )r loadsr r/ r? json_compat_obj_decode)r serialized_objr r" r rI deserialized_objr
r
r json_decode s !
r c C s6 t |||||}t| tjr|| |dS || |S )ap
Decodes a JSON-compatible object based on its data type into a
representative Python object.
Args:
data_type (Validator): Validator for serialized_obj.
obj: The JSON-compatible object to decode based on data_type.
caller_permissions (list): The list of raw-string caller permissions
with which to serialize.
strict (bool): If strict, then unknown struct fields will raise an
error, and unknown union variants will raise an error even if a
catch all field is specified. See json_decode() for more.
Returns:
See json_decode().
T)r r. r/ r7 r r )r r r r" r rI rH decoderr
r
r r s r z((^|[^%])(%%)*%s)c C s8 g }d} | ||}|dkr |S || |d }q)Nr r~ )findappend)textsubstrsitesijr
r
r _findall s
r c C s@ z| |W S ty tjr| jdkr Y nw t|r"td| j}d| }d|d |d }|| }|d| d d }| }t ||f|dd }t
|t |}t ||d f|dd }t
|t |d } g }
|D ] } | | v r|
| qu|} d | jf }
|
D ]} | d | |
| | d
d } q| S ) Nil z/This strftime implementation does not handle %si d i r~ z%4d )
strftimer r PY2year
_ILLEGAL_Ssearchr timetupletimer strr )dtfmtr deltaoffr s1Zsites1s2Zsites2r sitesZsyearr
r
r rf s:
"rf )rH c C s t jt| |ddS )Nr )encoding)msgpackr msgpack_compat_obj_encode)r r r
r
r msgpack_encode s
r c C s t j|ddd}t| |||S )Nr ignore)r unicode_errors)r r msgpack_compat_obj_decode)r r r" r r r
r
r msgpack_decode' s r )NNFF)NNFFF)NNTF)NNTFF)NT)+r
__future__r r rh r ro r functoolsr rer r Zstone.backends.python_rsrcr rv r r/ Z_MYPYtypingobjectr r r r rC r r r r r r compiler r rf r ImportErrorpartialr r r r r
r
r
r sr
O
;
+
#*