File: //opt/gsutil/third_party/apitools/apitools/base/py/__pycache__/encoding_helper.cpython-39.pyc
a
�z�g�w � @ s( d Z ddlZddlZddlZddlZddlZddlmZ ddlmZ ddlm Z ddl
m Z e� ddd g�Z
e� d
d d g�ZG d
d� de�ZG dd� de� dg d���Zi Zi Zi Zi Zdd� Zdd� Zdd� Zdd� Zdd� Zdbd d �Zd d � Z d d!� Z d"d#� Z dcd%d&�Z d'd(� Z d)d*� Z!ddd+d,�Z"d-d.� Z#d/d0� Z$d1d2� Z%d3d4� Z&G d5d6� d6e j'�Z(d7d8� Z)d9d:� Z*d;d<� Z+d=d>� Z,d?d@� Z-dAdB� Z.dCdD� Z/dEdF� Z0dGdH� Z1ee.e/�ej2� i Z3i Z4dedIdJ�Z5dfdKdL�Z6dgdMdN�Z7dhdOdP�Z8didQdR�Z9dSdT� Z:dUdV� Z;dWdX� Z<dYdZ� Z=d[d\� Z>d]d^� Z?djd`da�Z@dS )kz@Common code for converting proto to other formats, such as JSON.� N)�
message_types)�messages)� protojson)�
exceptions�_Codec�encoder�decoder� CodecResult�value�completec @ s e Zd ZdZdZdZdZdS )�EdgeTypez'The type of transition made by an edge.� � � N)�__name__�
__module__� __qualname__�__doc__�SCALAR�REPEATED�MAP� r r �D/opt/gsutil/third_party/apitools/apitools/base/py/encoding_helper.pyr $ s r c @ s e Zd ZdZdZdd� ZdS )� ProtoEdgea. A description of a one-level transition from a message to a value.
Protobuf messages can be arbitrarily nested as fields can be defined with
any "message" type. This nesting property means that there are often many
levels of proto messages within a single message instance. This class can
unambiguously describe a single step from a message to some nested value.
Properties:
type_: EdgeType, The type of transition represented by this edge.
field: str, The name of the message-typed field.
index: Any, Additional data needed to make the transition. The semantics
of the "index" property change based on the value of "type_":
SCALAR: ignored.
REPEATED: a numeric index into "field"'s list.
MAP: a key into "field"'s mapping.
r c C s& | j tjkr| jS d�| j| j�S d S )Nz{}[{}])�type_r r �field�format�index��selfr r r �__str__? s zProtoEdge.__str__N)r r r r � __slots__r r r r r r + s r )r r r c s � fdd�}|S )z;Register field_name as a container for unrecognized fields.c s � t | < | S �N)� _UNRECOGNIZED_FIELD_MAPPINGS��cls��
field_namer r �RegisterO s z'MapUnrecognizedFields.<locals>.Registerr )r' r( r r& r �MapUnrecognizedFieldsM s r) c s � �fdd�}|S )z9Register a custom encoder/decoder for this message class.c s t �� d�t| < | S �N)r r )r �_CUSTOM_MESSAGE_CODECSr$ �r r r r r( W s z,RegisterCustomMessageCodec.<locals>.Registerr �r r r( r r, r �RegisterCustomMessageCodecU s r. c s � �fdd�}|S )z1Register a custom encoder/decoder for this field.c s t �� d�t| < | S r* )r �_CUSTOM_FIELD_CODECS�r r, r r r( _ s z*RegisterCustomFieldCodec.<locals>.Registerr r- r r, r �RegisterCustomFieldCodec] s r1 c s � �fdd�}|S )z>Register a custom encoder/decoder for all fields of this type.c s t �� d�t| < | S r* )r �_FIELD_TYPE_CODECS)�
field_typer, r r r( g s �
z(RegisterFieldTypeCodec.<locals>.Registerr r- r r, r �RegisterFieldTypeCodece s r4 c C s t t| �t| ��S )z Make a deep copy of a message.)�
JsonToMessage�type�
MessageToJson��messager r r �CopyProtoMessagen s r: c C s t �� �| �}t|| |�S )z"Convert the given message to JSON.)�_ProtoJsonApiTools�Get�encode_message�_IncludeFields)r9 �include_fields�resultr r r r7 s s r7 c C s t �� �| |�S )z9Convert the given JSON to a message of type message_type.)r; r< �decode_message)� message_typer9 r r r r5 y s r5 c C s t |t�| ��S )z?Convert the given dictionary to a message of type message_type.�r5 �json�dumps)�drB r r r �
DictToMessage s rG c C s t �t| ��S )z*Convert the given message to a dictionary.�rD �loadsr7 r8 r r r �
MessageToDict� s rJ Fc C sD | � � }|rt|�}g }|D ] \}}|�|j||d�� q ||d�S )z>Convert the given dictionary to an AdditionalProperty message.��keyr
)�additionalProperties)�items�sorted�append�AdditionalProperty)Z
propertiesZadditional_property_typeZ
sort_itemsrN Zmap_rL r
r r r � DictToAdditionalPropertyMessage� s �
rR c C s t | t�|��S )zAConvert the given python value to a message of type message_type.rC )rB r
r r r �PyValueToMessage� s rS c C s t �t| ��S )z,Convert the given message to a python value.rH r8 r r r �MessageToPyValue� s rT c
s� �� dd�}dd� }t| t�r�d}| D ]<}|rB|dd|d 7 }|t|fd |i|����d
7 }q&|rx|dd| 7 }|d 7 }|S t| tj��rRt| �jd }�� d
�s�| jd | }t dd� | �
� D ��}|D ]\}| � |�} |r�|dd|d 7 }t | | j
�}
|| j
d t|
fd |i|���� d
7 }q�|�rF|dd| 7 }|d7 }|S t| tj��r��� d��r�t| �dk�r�| dd� } t| tj��r�G � �fdd�dtj�� t�| j| j| j| j| j| j| j� | j�d���} t| �S )a7 Return a repr-style string for a protorpc message.
protorpc.Message.__repr__ does not return anything that could be considered
python code. Adding this function lets us print a protorpc message in such
a way that it could be pasted into code later, and used to compare against
other things.
Args:
msg: protorpc.Message, the message to be repr'd.
multiline: bool, True if the returned string should have each field
assignment on its own line.
**kwargs: {str:str}, Additional flags for how to format the string.
Known **kwargs:
shortstrings: bool, True if all string values should be
truncated at 100 characters, since when mocking the contents
typically don't matter except for IDs, and IDs are usually
less than 100 characters.
no_modules: bool, True if the long module name should not be printed with
each type.
Returns:
str, A string of valid python (assuming the right imports have been made)
that recreates the message passed into this function.
�indentr c S s t | �} | �dd�d | d< | S )NrU r � )�dict�get��kwargsr r r � IndentKwargs� s z#MessageToRepr.<locals>.IndentKwargs�[�
� rV � multiline�,�]�(�
no_modules�.c S s g | ]
}|j �qS r ��name)�.0r r r r �
<listcomp>� � z!MessageToRepr.<locals>.<listcomp>�=�)Z shortstrings�d Nc s* e Zd Z�� fdd�Z�fdd�Z� ZS )z$MessageToRepr.<locals>.SpecialTZInfoc s t � | ��� || _d S r" )�super�__init__�offset)r ro )�
SpecialTZInfo� __class__r r rn � s z-MessageToRepr.<locals>.SpecialTZInfo.__init__c s( dt | j� d }� �d�s$d| }|S )NzTimeZoneOffset(rk rc z apitools.base.protorpclite.util.)�reprro rX )r �srY r r �__repr__� s
z-MessageToRepr.<locals>.SpecialTZInfo.__repr__)r r r rn rt �
__classcell__r �rp rZ �rq r rp � s rp ) rX �
isinstance�list�
MessageToReprr �Messager6 r r rO �
all_fields�
field_by_name�getattrrf �six� string_types�len�datetime�tzinfo�year�month�day�hour�minute�second� microsecond� utcoffsetrr ) �msgr_ rZ rU r[ rs �item�namesrf r r
r rv r rz � sj
����
���� �rz c C s0 |D ]&}|t | �vr td| ��t| |�} q| S )Nz
no field "%s")�dir�KeyErrorr~ )r9 �
field_pathr r r r � _GetField� s
r� c C s. |d d� D ]}| � |i �} q || |d < d S )N���)�
setdefault)Zdictblobr� r
r r r r � _SetField s r� c
C s� |du r | S t �| �}|D ]f}z&t||�d��}d}t|t�rBg }W n( tyl t�d|t |�f ��Y n0 t
||�d�|� qt � |�S )z0Add the requested fields to the encoded message.Nrd z'No field named %s in message of type %s) rD rI r� �splitrx ry r� r �InvalidDataErrorr6 r� rE )�encoded_messager9 r? r@ r' r
Z nullvaluer r r r> s"
��
r> c C s6 t t�| �|d �t t�t| ��|d �g}dd� |D �S )Nc S s g | ]}|d ur|�qS r" r �rg �xr r r rh ! ri z#_GetFieldCodecs.<locals>.<listcomp>)r~ r/ rX r2 r6 )r �attrr@ r r r �_GetFieldCodecs s �r� c sT e Zd ZdZdZedd� �Z� fdd�Z� fdd�Z� fd d
�Z � fd d �Z
� Z S )
r; z&JSON encoder used by apitools clients.Nc C s | j d u r| � | _ | j S r" )� _INSTANCEr$ r r r r< ) s
z_ProtoJsonApiTools.Getc sP |t v rt | �|�S t||�}tt| ��||�}t||�}t||�}t||�S r" ) r+ r �_DecodeCustomFieldNamesrm r; rA �_ProcessUnknownEnums�_ProcessUnknownMessages�_DecodeUnknownFields)r rB r� r@ rw r r rA / s ��
�
z!_ProtoJsonApiTools.decode_messagec s� t |d�D ]"}|||�}|j}|jr
| S q
t|tj�rP| �|jt� |��}npt|tj
�r�t |j |d�pl|}zt
t| ��||�}W q� tjy� t|tj�s�� d}Y q�0 nt
t| ��||�}|S )z�Decode the given JSON value.
Args:
field: a messages.Field for the field we're decoding.
value: a python value we'd like to decode.
Returns:
A value suitable for assignment to field.
r �� json_nameN)r� r
r rx r � MessageFieldrA rB rD rE � EnumField�GetCustomJsonEnumMappingr6 rm r; � decode_field� DecodeErrorr r� )r r r
r r@ Z field_valuerw r r r� : s>
� ���� ��z _ProtoJsonApiTools.decode_fieldc s| t |tj�r(dd�� fdd�|D �� S t|�tv rFtt|� �|�S t|�}tt � ��
|�}t ||�}t j
t �|�dd�S )Nz[%s]z, c 3 s | ]}� � |�V qd S r" )r= r� r r r � <genexpr>] s �z4_ProtoJsonApiTools.encode_message.<locals>.<genexpr>T)� sort_keys)rx r � FieldList�joinr6 r+ r �_EncodeUnknownFieldsrm r; r= �_EncodeCustomFieldNamesrD rE rI )r r9 r@ rw r r r= [ s �
z!_ProtoJsonApiTools.encode_messagec s� t � d�D ]"}|� |�}|j}|jr
| S q
t� tj�rl� jrT� fdd�|D �}nt� j|j d�}|rl|S t� tj
�r�t� t j �s�t
�| �|��}tt| ��� |�S )z�Encode the given value as JSON.
Args:
field: a messages.Field for the field we're encoding.
value: a value for field.
Returns:
A python value suitable for json.dumps.
r c s" g | ]}t � j|jd �p |j�qS )�� python_name)r� r6 rf )rg �er0 r r rh z s
��z3_ProtoJsonApiTools.encode_field.<locals>.<listcomp>r� )r� r
r rx r r� �repeatedr� r6 rf r� r �
DateTimeFieldrD rI r= rm r; � encode_field)r r r
r r@ Zremapped_valuerw r0 r r� i s(
��
�z _ProtoJsonApiTools.encode_field) r r r r r� � classmethodr< rA r� r= r� ru r r rw r r; $ s
! r; c C s� t �t| ��}|du r| S | �|�}t|tj�s:t�d��|j }t|j
tj�rbt | t �
|�|�}n
t| |�}t| ||� t| di � | S )z;Rewrite unknown fields in message into message.destination.Nz>Unrecognized fields must be mapped to a compound message type.� _Message__unrecognized_fields)r# rX r6 r} rx r r� r �InvalidDataFromServerErrorrB r
�_DecodeUnknownMessagesrD rI �_DecodeUnrecognizedFields�setattr)r9 r� � destinationZ
pair_field� pair_type�
new_valuesr r r r� � s"
� �
r� c
C sp |j j}g }dd� | �� D �}t�|�D ]B\}}||v r:q(t||�}|j jrTt|�}|||d�} |�| � q(|S )z<Process unknown fields in encoded_message of a message type.c S s g | ]
}|j �qS r re r� r r r rh � ri z*_DecodeUnknownMessages.<locals>.<listcomp>rK ) r
r6 r| r � iteritemsrS r� �_AsMessageListrP )
r9 r� r� r3 r� Zall_field_namesrf Z
value_dictr
�new_pairr r r r� � s
r� c C s� g }t �� }| �� D ]�}| �|�\}}|�d�}t|tj�rLt||j j
�}n|� |j |�}z t |�} W n$ t
y� t�� � |j|�} Y n0 || |d�}
|�|
� q|S )z'Process unrecognized fields in message.r
rK )r; r< �all_unrecognized_fields�get_unrecognized_field_infor} rx r r� rG r
rB r� �str�UnicodeEncodeErrorr � ProtoJsonrL rP ) r9 r� r� �codecZ
unknown_fieldr
�_Z
value_type�
decoded_valueZ new_pair_keyr� r r r r� � s&
� �
r� c C s t �� }|�t| �|�| ��S r" )r r� rA r6 r= )r9 r� r r r �!_CopyProtoMessageVanillaProtoJson� s r� c C s� t �t| ��}|du r| S t| �}| �|�}t|tj�sFt� d| ��|j
}|�d�}|j }t | |�}t
�� }|D ]"} |�|| j�}
|�| j|
|� qrt||g � |S )z6Remap unknown fields in message out of message.source.NzInvalid pairs field %sr
)r# rX r6 r� r} rx r r� r ZInvalidUserInputErrorrB �variantr~ r; r< r� r
�set_unrecognized_fieldrL r� ) r9 �sourcer@ Z pairs_fieldZ
pairs_typeZ value_fieldZ
value_variant�pairsr� �pair�
encoded_valuer r r r� � s&
�
r� c C sP z(| j rdd� |D �}n
t�|�}d}W n tyB |}d}Y n0 t||d�S )z,Encode the bytes in value as urlsafe base64.c S s g | ]}t �|��qS r )�base64�urlsafe_b64encode)rg �byter r r rh � ri z$_SafeEncodeBytes.<locals>.<listcomp>TF�r
r )r� r� r� � TypeErrorr )r r
r@ r r r r �_SafeEncodeBytes� s
r� c C s> zt �t|��}d}W n ty0 |}d}Y n0 t||d�S )z+Decode the urlsafe base64 value into bytes.TFr� )r� �urlsafe_b64decoder� r� r )Z unused_fieldr
r@ r r r r �_SafeDecodeBytes� s
r� c C s� |s| S t �t�|��}| �� D ]d}t|tj�r |j|v r | � |j�}|j
rbt |�t ||j �ksj|du r | � |j||j tj
j� q | S )af Add unknown enum values from encoded_message as unknown fields.
ProtoRPC diverges from the usual protocol buffer behavior here and
doesn't allow unknown fields. Throwing on unknown fields makes it
impossible to let servers add new enum values and stay compatible
with older clients, which isn't reasonable for us. We simply store
unrecognized enum values as unknown fields, and all is well.
Args:
message: Proto message we've decoded thus far.
encoded_message: JSON string we're decoding.
Returns:
message, with any unknown enums stored as unrecognized fields.
N)rD rI r �
ensure_strr| rx r r� rf �get_assigned_valuer� r� r� �Variant�ENUM)r9 r� �decoded_messager r
r r r r� s � ��r� c sp |s| S t �t�|��}dd� | �� D �t| �� � � � fdd�|�� D �}|D ]}| �||| t j
j � qP| S )a? Store any remaining unknown fields as strings.
ProtoRPC currently ignores unknown values for which no type can be
determined (and logs a "No variant found" message). For the purposes
of reserializing, this is quite harmful (since it throws away
information). Here we simply add those as unknown fields of type
string (so that they can easily be reserialized).
Args:
message: Proto message we've decoded thus far.
encoded_message: JSON string we're decoding.
Returns:
message, with any remaining unrecognized fields saved.
c S s g | ]
}|j �qS r re r� r r r rh 2 ri z+_ProcessUnknownMessages.<locals>.<listcomp>c s g | ]}|� vr|�qS r r r� �Zmessage_fieldsr r rh 4 s �) rD rI r r� r| ry r� �keysr� r r� �STRING)r9 r� r� �missing_fieldsr' r r� r r� s � �r� c C s^ t | tj�st�d| ��|| �� vr8t�d|| f ��t�| i �}t d| ||� |||< dS )a� Add a custom wire encoding for a given enum value.
This is primarily used in generated code, to handle enum values
which happen to be Python keywords.
Args:
enum_type: (messages.Enum) An enum type
python_name: (basestring) Python name for this value.
json_name: (basestring) JSON name to be used on the wire.
package: (NoneType, optional) No effect, exists for legacy compatibility.
z.Cannot set JSON enum mapping for non-enum "%s"z%Enum value %s not a value for type %s�enumN)
�
issubclassr �Enumr �TypecheckErrorr� r� �_JSON_ENUM_MAPPINGSr� �_CheckForExistingMappings)� enum_typer� r� �package�field_mappingsr r r �AddCustomJsonEnumMappingE s
�
� r� c C st t | tj�st�d| ��z| �|�}W n$ tyL t�d|| f ��Y n0 t� | i �}t
d| ||� |||< dS )a� Add a custom wire encoding for a given message field.
This is primarily used in generated code, to handle enum values
which happen to be Python keywords.
Args:
message_type: (messages.Message) A message type
python_name: (basestring) Python name for this value.
json_name: (basestring) JSON name to be used on the wire.
package: (NoneType, optional) No effect, exists for legacy compatibility.
z2Cannot set JSON field mapping for non-message "%s"z#Field %s not recognized for type %sr N) r� r r{ r r� r} r� r� �_JSON_FIELD_MAPPINGSr� r� )rB r� r� r� r� r� r r r �AddCustomJsonFieldMapping] s"
�� ��
r� c C s t | d||td�S )z=Return the appropriate remapping for the given enum, or None.r� �r� r� �mappings)�_FetchRemappingr� )r� r� r� r r r r� y s �r� c C s t | d||td�S )z>Return the appropriate remapping for the given field, or None.r r� )r� r� )rB r� r� r r r �GetCustomJsonFieldMapping� s �r� c s| |r�rt �d| ��|s.�s.t �d|f ��|�| i �� � rx|rL� �|�S �rx�t� �� �v rx� �fdd�� D �d S dS )z>Common code for fetching a key or value from a remapping dict.z>Cannot specify both python_name and json_name for %s remappingz=Must specify either python_name or json_name for %s remappingc s g | ]}� | �kr|�qS r r )rg �k��field_remappingsr� r r rh � s �z#_FetchRemapping.<locals>.<listcomp>r N)r r� rX ry �values)� type_name� mapping_typer� r� r� r r� r r� � s, ����
�r� c C s~ | dkrt }n | dkrt}|||d�}|durJ||krJt�d| ||f ��|||d�}|durz||krzt�d| ||f ��dS )z5Validate that no mappings exist for the given values.r r� r� Nz6Cannot add mapping for %s "%s", already mapped to "%s"r� )r� r� r r� )r� rB r� r� �getterZ remappingr r r r� � s$ �� ��r� c C sX t t�t| �i ��� �}|rTt�|�}|D ] \}}||v r*|�|�||< q*t�|�}|S r" ) ry r� rX r6 rN rD rI �poprE )r9 r� r� r� r� r� r r r r� � s
r� c C sT t �| i �}|rPt�|�}t|�� �D ] \}}||v r&|�|�||< q&t�|�}|S r" )r� rX rD rI ry rN r� rE )rB r� r� r� r� r� r r r r� � s
r� c sP ddl m� � fdd�}|| �s(td��t| � j�r:| j} t| � j�rL| j} | S )z1Convert the provided list-as-JsonValue to a list.r �� extra_typesc s* t | � j�rdS t | � j�r&| jr&dS dS )z6Return True if msg is a repeated value as a JsonValue.TF)rx � JsonArray� JsonValue� array_value)r� r� r r �_IsRepeatedJsonValue� s
z,_AsMessageList.<locals>._IsRepeatedJsonValuez"invalid argument to _AsMessageList)�apitools.base.pyr� �
ValueErrorrx r� r� r� �entries)r� r� r r� r r� � s r� c C sJ | � |j�}t|tj�s dS z|�d�}W n ty> Y dS 0 |jS dS )z3Returns whether the "field" is actually a map-type.FrM N)r� rf rx r r{ r} r� r� )r9 r r
�additional_propertiesr r r �_IsMap� s r c c s@ t | |�sJ �| �|j�}|�d�}|D ]}|j|jfV q(dS )z/Yields the (key, value) pair of the map values.rM N)r r� rf rL r
)r9 r Z map_messager Zkv_pairr r r � _MapItems� s �r r c c s, t | tj�sdS | �� }|r*||fV dS | �� D ]�}| �|j�}|jr�t|�D ]@\}}t t
j |j|�}t |||f �}|D ]\} }
| |
fV q|qPq2t
| |�r�t| |�D ]@\} }t t
j|j| �} t ||| f �}|D ]\} }
| |
fV q�q�q2t t
j|jd�}
t |||
f �}|D ]\} }
| |
fV �qq2dS )a� Yields the locations of unrecognized fields within "message".
If a sub-message is found to have unrecognized fields, that sub-message
will not be searched any further. We prune the search of the sub-message
because we assume it is malformed and further checks will not yield
productive errors.
Args:
message: The Message instance to search.
_edges: Internal arg for passing state.
Yields:
(edges_to_message, field_names):
edges_to_message: List[ProtoEdge], The edges (relative to "message")
describing the path to the sub-message where the unrecognized
fields were found.
field_names: List[Str], The names of the field(s) that were
unrecognized in the sub-message.
N)rx r r{ r� r| r� rf r� � enumerater r r �UnrecognizedFieldIterr r r r )r9 Z_edges� field_namesr r
�ir� Z
repeated_edgeZiter_r� �yrL Zmap_edgeZ scalar_edger r r r � s0
r )N)F)F)N)N)NN)NN)NNN)r )Ar r� � collectionsr� rD r �apitools.base.protorpcliter r r r� r �
namedtupler r �objectr r r# r+ r/ r2 r) r. r1 r4 r: r7 r5 rG rJ rR rS rT rz r� r� r> r� r� r; r� r� r� r� r� r� r� r� r� �
BytesFieldr� r� r� r� r� r� r� r� r� r� r� r r r r r r r �<module> s� �
�
[d �
�
�