File manager - Edit - /opt/gsutil/third_party/apitools/apitools/base/protorpclite/__pycache__/messages.cpython-39.pyc
Back
a vyg� � @ sL d Z ddlZddlZddlZddlmZ g d�ZejZG dd� de�ZG dd� de�Z G d d � d e �Z G d d � d e �Z G d d� de �Z G dd� de�Z G dd� de�ZG dd� de�ZG dd� de�ZG dd� de�ZG dd� de�Zeg d��Zeg d ��Zed g�Zd Zd Zd Zd ZG d!d"� d"e�Z G d#d$� d$e �Z G d%d&� d&e� e e ��Z G d'd(� d(e �Z!G d)d*� d*e �Z"G d+d,� d,e� e"e ��Z#G d-d.� d.e$�Z%G d/d0� d0e�Z&G d1d2� d2e� e&e ��Z'G d3d4� d4e'�Z(G d5d6� d6e'�Z)G d7d8� d8e'�Z*G d9d:� d:e'�Z+G d;d<� d<e'�Z,G d=d>� d>e'�Z-G d?d@� d@e'�Z.e�/dA�de0fdBdC��Z1dS )Da� Stand-alone implementation of in memory protocol messages. Public Classes: Enum: Represents an enumerated type. Variant: Hint for wire format to determine how to serialize. Message: Base class for user defined messages. IntegerField: Field for integer values. FloatField: Field for float values. BooleanField: Field for boolean values. BytesField: Field for binary string values. StringField: Field for UTF-8 string values. MessageField: Field for other message type values. EnumField: Field for enumerated type values. Public Exceptions (indentation indications class hierarchy): EnumDefinitionError: Raised when enumeration is incorrectly defined. FieldDefinitionError: Raised when field is incorrectly defined. InvalidVariantError: Raised when variant is not compatible with field type. InvalidDefaultError: Raised when default is not compatiable with field. InvalidNumberError: Raised when field number is out of range or reserved. MessageDefinitionError: Raised when message is incorrectly defined. DuplicateNumberError: Raised when field has duplicate number with another. ValidationError: Raised when a message or field is not valid. DefinitionNotFoundError: Raised when definition not found. � N)�util) �MAX_ENUM_VALUE�MAX_FIELD_NUMBER�FIRST_RESERVED_FIELD_NUMBER�LAST_RESERVED_FIELD_NUMBER�Enum�Field� FieldList�Variant�Message� IntegerField� FloatField� BooleanField� BytesField� StringField� MessageField� EnumField�find_definition�Error� DecodeError� EncodeError�EnumDefinitionError�FieldDefinitionError�InvalidVariantError�InvalidDefaultError�InvalidNumberError�MessageDefinitionError�DuplicateNumberError�ValidationError�DefinitionNotFoundErrorc @ s e Zd ZdZdS )r z Enumeration definition error.N��__name__� __module__� __qualname__�__doc__� r% r% �G/opt/gsutil/third_party/apitools/apitools/base/protorpclite/messages.pyr _ s r c @ s e Zd ZdZdS )r zField definition error.Nr r% r% r% r& r c s r c @ s e Zd ZdZdS )r z"Invalid variant provided to field.Nr r% r% r% r& r g s r c @ s e Zd ZdZdS )r z"Invalid default provided to field.Nr r% r% r% r& r k s r c @ s e Zd ZdZdS )r z!Invalid number provided to field.Nr r% r% r% r& r o s r c @ s e Zd ZdZdS )r zMessage definition error.Nr r% r% r% r& r s s r c @ s e Zd ZdZdS )r z#Duplicate number assigned to field.Nr r% r% r% r& r w s r c @ s e Zd ZdZdS )r z$Raised when definition is not found.Nr r% r% r% r& r { s r c @ s e Zd ZdZdS )r z/Error found decoding message from encoded form.Nr r% r% r% r& r s r c @ s e Zd ZdZdS )r z"Error found when encoding message.Nr r% r% r% r& r � s r c @ s e Zd ZdZdd� ZdS )r z Invalid value for message error.c C s t �| �S )z6Prints string with field name if present on exception.)r �__str__��selfr% r% r& r' � s zValidationError.__str__N)r! r" r# r$ r' r% r% r% r& r � s r )r" r$ r# Z__static_attributes__Z__firstlineno__)�name�_message_definition�_MessageField__type�_EnumField__type� _EnumField__resolved_defaultr+ i��� i8J i N c @ sL e Zd ZdZdZdd� Zdd� Zdd� Zd d � Zd d � Z d d� Z dd� Z dS )�_DefinitionClassau Base meta-class used for definition meta-classes. The Enum and Message definition classes share some basic functionality. Both of these classes may be contained by a Message definition. After initialization, neither class may have attributes changed except for the protected _message_definition attribute, and that attribute may change only once. Fc C s& t �| |||� | jtfkr"d| _dS )z Constructor.TN)�type�__init__� __bases__�object� _DefinitionClass__initialized��clsr* �bases�dctr% r% r& r1 � s z_DefinitionClass.__init__c C s$ z | � � W S ty Y dS 0 dS )z�Get outer Message definition that contains this definition. Returns: Containing Message definition if definition is contained within one, else None. N�r+ �AttributeError�r6 r% r% r& �message_definition� s z#_DefinitionClass.message_definitionc C s. | j r |tvr td| ��nt�| ||� dS )a� Overridden to avoid setting variables after init. Setting attributes on a class must work during the period of initialization to set the enumation value class variables and build the name/number maps. Once __init__ has set the __initialized flag to True prohibits setting any more values on the class. The class is in effect frozen. Args: name: Name of value to set. value: Value to set. zMay not change values: %sN)r4 �_POST_INIT_ATTRIBUTE_NAMESr: r0 � __setattr__)r6 r* �valuer% r% r& r> � s z _DefinitionClass.__setattr__c C s t d��dS )zAOverridden so that cannot delete varaibles on definition classes.z-May not delete attributes on definition classN�� TypeError�r6 r* r% r% r& � __delattr__� s z _DefinitionClass.__delattr__c C s* | � � }|du r t�| j�S d|| jf S )a� Helper method for creating definition name. Names will be generated to include the classes package name, scope (if the class is nested in another definition) and class name. By default, the package name for a definition is derived from its module name. However, this value can be overriden by placing a 'package' attribute in the module that contains the definition class. For example: package = 'some.alternate.package' class MyMessage(Message): ... >>> MyMessage.definition_name() some.alternate.package.MyMessage Returns: Dot-separated fully qualified name of definition. N�%s.%s)�outer_definition_name�six� text_typer! )r6 rE r% r% r& �definition_name� s z _DefinitionClass.definition_namec C s | � � }|st�| j�S |�� S )z�Helper method for creating outer definition name. Returns: If definition is nested, will return the outer definitions name, else the package name. )r< r �get_package_for_moduler" rH �r6 Zouter_definitionr% r% r& rE s z&_DefinitionClass.outer_definition_namec C s | � � }|st�| j�S |�� S )z�Helper method for creating creating the package of a definition. Returns: Name of package that definition belongs to. )r< r rI r" �definition_packagerJ r% r% r& rK s z#_DefinitionClass.definition_packageN) r! r" r# r$ r4 r1 r< r> rC rH rE rK r% r% r% r& r/ � s r/ c @ sH e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd d � Z dd� Z dS )� _EnumClassaF Meta-class used for defining the Enum base class. Meta-class enables very specific behavior for any defined Enum class. All attributes defined on an Enum sub-class must be integers. Each attribute defined on an Enum sub-class is translated into an instance of that sub-class, with the name of the attribute as its name, and the number provided as its value. It also ensures that only one level of Enum class hierarchy is possible. In other words it is not possible to delcare sub-classes of sub-classes of Enum. This class also defines some functions in order to restrict the behavior of the Enum class and its sub-classes. It is not possible to change the behavior of the Enum class in later classes since any new classes may be defined with only integer values, and no methods. c C s |t fks |tfks td| ��i | _i | _|t fk�r|�� D ]�\}}|tv rRq@t|tj �sntd||f ��|dk r�td||f ��|t kr�tdt ||f ��|| jv r�td||| j| j f ��t � | �}| � |||� || j|j < || j|j< t| ||� q@t� | |||� d S )Nz'Enum type %s may only inherit from Enumz:May only use integers in Enum definitions. Found: %s = %sr z2Must use non-negative enum values. Found: %s = %dz;Must use enum values less than or equal %d. Found: %s = %dz(Value for %s = %d is already defined: %s)r3 r r �_EnumClass__by_number�_EnumClass__by_name�items�_RESERVED_ATTRIBUTE_NAMES� isinstancerF � integer_typesr r* �__new__r1 �number�setattrr/ )r6 r* r7 r8 � attributer? �instancer% r% r& r1 + sP � ������ �� z_EnumClass.__init__c C s t | j�� �S )z�Iterate over all values of enum. Yields: Enumeration instances of the Enum class in arbitrary order. )�iterrM �valuesr; r% r% r& �__iter__` s z_EnumClass.__iter__c C s | j �� S )zyGet all names for Enum. Returns: An iterator for names of the enumeration in arbitrary order. )rN �keysr; r% r% r& �namesh s z_EnumClass.namesc C s | j �� S )z�Get all numbers for Enum. Returns: An iterator for all numbers of the enumeration in arbitrary order. )rM r[ r; r% r% r& �numbersp s z_EnumClass.numbersc C s | j | S )z�Look up Enum by name. Args: name: Name of enum to find. Returns: Enum sub-class instance of that value. )rN rB r% r% r& �lookup_by_namex s z_EnumClass.lookup_by_namec C s | j | S )z�Look up Enum by number. Args: number: Number of enum to find. Returns: Enum sub-class instance of that value. )rM �r6 rT r% r% r& �lookup_by_number� s z_EnumClass.lookup_by_numberc C s t | j�S �N)�lenrN r; r% r% r& �__len__� s z_EnumClass.__len__N) r! r" r# r$ r1 rZ r\ r] r^ r` rc r% r% r% r& rL s 5 rL c @ s� e Zd ZdZed�Zdd� Zd&dd�Zdd � Zd d � Z d d � Z dd� Z dd� Z dd� Z dd� Zdd� Zdd� Zdd� Zd d � Zd d � Zd d!� Zed"d#� �Zed$d%� �ZdS )'r z$Base class for all enumerated types.�r* rT c C s| t || �r|S t |tj�r:z | �|�W S ty8 Y n0 t |tj�rfz | �|�W S tyd Y n0 td|| jf ��dS )aG Acts as look-up routine after class is initialized. The purpose of overriding __new__ is to provide a way to treat Enum subclasses as casting types, similar to how the int type functions. A program can pass a string or an integer and this method with "convert" that value in to an appropriate Enum instance. Args: index: Name or number to look up. During initialization this is always the name of the new enum value. Raises: TypeError: When an inappropriate index value is passed provided. z No such value for %s in Enum %sN) rQ rF rR r` �KeyError� string_typesr^ rA r! )r6 �indexr% r% r& rS � s �z Enum.__new__Nc C s2 t t| �d�rdS t�| d|� t�| d|� dS )z�Initialize new Enum instance. Since this should only be called during class initialization any calls that happen after the class is frozen raises an exception. r4 Nr* rT )�getattrr0 r3 r> )r) r* rT r% r% r& r1 � s z Enum.__init__c C s t d��d S )NzMay not change enum valuesr@ �r) r* r? r% r% r& r> � s zEnum.__setattr__c C s | j S ra )r* r( r% r% r& r' � s z Enum.__str__c C s | j S ra �rT r( r% r% r& �__int__� s z Enum.__int__c C s dt | �j| j| jf S )Nz %s(%s, %d))r0 r! r* rT r( r% r% r& �__repr__� s z Enum.__repr__c C s | j | jffS )z�Enable pickling. Returns: A 2-tuple containing the class and __new__ args to be used for restoring a pickled instance. )� __class__rT r( r% r% r& � __reduce__� s zEnum.__reduce__c C s t |t| ��r t| j|j�S tS �zOrder is by number.)rQ r0 �cmprT �NotImplemented�r) �otherr% r% r& �__cmp__� s z Enum.__cmp__c C s t |t| ��r| j|jk S tS ro �rQ r0 rT rq rr r% r% r& �__lt__� s z Enum.__lt__c C s t |t| ��r| j|jkS tS ro ru rr r% r% r& �__le__� s z Enum.__le__c C s t |t| ��r| j|jkS tS ro ru rr r% r% r& �__eq__� s z Enum.__eq__c C s t |t| ��r| j|jkS tS ro ru rr r% r% r& �__ne__� s z Enum.__ne__c C s t |t| ��r| j|jkS tS ro ru rr r% r% r& �__ge__� s z Enum.__ge__c C s t |t| ��r| j|jkS tS ro ru rr r% r% r& �__gt__ s z Enum.__gt__c C s t | j�S )zHash by number.)�hashrT r( r% r% r& �__hash__ s z Enum.__hash__c C s t dd� t| �D ��S )z�Make dictionary version of enumerated class. Dictionary created this way can be used with def_num. Returns: A dict (name) -> number c s s | ]}|j |jfV qd S ra rd )�.0�itemr% r% r& � <genexpr> � z Enum.to_dict.<locals>.<genexpr>)�dictrX r; r% r% r& �to_dict s z Enum.to_dictc C s t |tf| �S )z�Define enum class from dictionary. Args: dct: Dictionary of enumerated values for type. name: Name of enum. )r0 r )r8 r* r% r% r& �def_enum s z Enum.def_enum)N)r! r" r# r$ �set� __slots__rS r1 r> r' rk rl rn rt rv rw rx ry rz r{ r} � classmethodr� � staticmethodr� r% r% r% r& r � s* $ r c @ sD e Zd ZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdS )r a( Wire format variant. Used by the 'protobuf' wire format to determine how to transmit a single piece of data. May be used by other formats. See: http://code.google.com/apis/protocolbuffers/docs/encoding.html Values: DOUBLE: 64-bit floating point number. FLOAT: 32-bit floating point number. INT64: 64-bit signed integer. UINT64: 64-bit unsigned integer. INT32: 32-bit signed integer. BOOL: Boolean value (True or False). STRING: String of UTF-8 encoded text. MESSAGE: Embedded message as byte string. BYTES: String of 8-bit bytes. UINT32: 32-bit unsigned integer. ENUM: Enum value as integer. SINT32: 32-bit signed integer. Uses "zig-zag" encoding. SINT64: 64-bit signed integer. Uses "zig-zag" encoding. � � � � � � � � � � � � � N)r! r" r# r$ �DOUBLE�FLOAT�INT64�UINT64�INT32�BOOL�STRING�MESSAGE�BYTES�UINT32�ENUM�SINT32�SINT64r% r% r% r& r % s r c @ s e Zd ZdZdd� Zdd� ZdS )� _MessageClassa Meta-class used for defining the Message base class. For more details about Message classes, see the Message class docstring. Information contained there may help understanding this class. Meta-class enables very specific behavior for any defined Message class. All attributes defined on an Message sub-class must be field instances, Enum class definitions or other Message class definitions. Each field attribute defined on an Message sub-class is added to the set of field definitions and the attribute is translated in to a slot. It also ensures that only one level of Message class hierarchy is possible. In other words it is not possible to declare sub-classes of sub-classes of Message. This class also defines some functions in order to restrict the behavior of the Message class and its sub-classes. It is not possible to change the behavior of the Message class in later classes since any new classes may be defined with only field, Enums and Messages, and no methods. c C s4 i }i }i }|t fk�r|tfkr*td��g }g }|�� D ]�\} } | tv rLq:t| t�rlt| t�rl|� | � q:t| t�r�t| t�r�| tur�|� | � q:t| �t u s�t| t �s�td| | f ��| j |v r�t d| j |f ��| | _ | || < | || j < q:|�rt|�|d< |�rt|�|d< ||d< ||d< t�| |||�S )z�Create new Message class instance. The __new__ method of the _MessageClass type is overridden so as to allow the translation of Field instances to slots. z+Message types may only inherit from Messagez;May only use fields in message definitions. Found: %s = %sz2Field with number %d declared more than once in %sZ __enums__Z __messages__�_Message__by_number�_Message__by_name)r3 r r rO rP rQ r0 � issubclassr �appendr rT r r* �sortedr/ rS ) r6 r* r7 r8 Z by_numberZby_nameZ variant_mapZenums�messages�key�fieldr% r% r& rS c sZ � �� �� �� z_MessageClass.__new__c C sd |t fkrP|�� D ]"}t|t�r|turt�| �|_q| �� D ]}t�| �|_q>t� | |||� dS )z7Initializer required to assign references to new class.N) r3 rY rQ r/ r �weakref�refr+ � all_fieldsr1 )r6 r* r7 r8 �vr� r% r% r& r1 � s z_MessageClass.__init__N)r! r" r# r$ rS r1 r% r% r% r& r� K s Dr� c @ s� e Zd ZdZdd� Zdd� Zdd� Zedd � �Zed d � �Z ed d � �Z dd� Z dd� Z dd� Z d!dd�Zdd� Zdd� Zdd � Zd d � Zd d � ZdS )"r a� Base class for user defined message objects. Used to define messages for efficient transmission across network or process space. Messages are defined using the field classes (IntegerField, FloatField, EnumField, etc.). Messages are more restricted than normal classes in that they may only contain field attributes and other Message and Enum definitions. These restrictions are in place because the structure of the Message class is intentended to itself be transmitted across network or process space and used directly by clients or even other servers. As such methods and non-field attributes could not be transmitted with the structural information causing discrepancies between different languages and implementations. Initialization and validation: A Message object is considered to be initialized if it has all required fields and any nested messages are also initialized. Calling 'check_initialized' will raise a ValidationException if it is not initialized; 'is_initialized' returns a boolean value indicating if it is valid. Validation automatically occurs when Message objects are created and populated. Validation that a given value will be compatible with a field that it is assigned to can be done through the Field instances validate() method. The validate method used on a message will check that all values of a message and its sub-messages are valid. Assingning an invalid value to a field will raise a ValidationException. Example: # Trade type. class TradeType(Enum): BUY = 1 SELL = 2 SHORT = 3 CALL = 4 class Lot(Message): price = IntegerField(1, required=True) quantity = IntegerField(2, required=True) class Order(Message): symbol = StringField(1, required=True) total_quantity = IntegerField(2, required=True) trade_type = EnumField(TradeType, 3, required=True) lots = MessageField(Lot, 4, repeated=True) limit = IntegerField(5) order = Order(symbol='GOOG', total_quantity=10, trade_type=TradeType.BUY) lot1 = Lot(price=304, quantity=7) lot2 = Lot(price = 305, quantity=3) order.lots = [lot1, lot2] # Now object is initialized! order.check_initialized() c K sj i | _ i | _t� }|�� D ] \}}t| ||� |�|� q| �� D ]"}|jrB|j|vrBt| |jg � qBdS )a. Initialize internal messages state. Args: A message can be initialized via the constructor by passing in keyword arguments corresponding to fields. For example: class Date(Message): day = IntegerField(1) month = IntegerField(2) year = IntegerField(3) Invoking: date = Date(day=6, month=6, year=1911) is the same as doing: date = Date() date.day = 6 date.month = 6 date.year = 1911 N) �_Message__tags� _Message__unrecognized_fieldsr� rO rU �addr� �repeatedr* )r) �kwargs�assignedr* r? r� r% r% r& r1 � s zMessage.__init__c C s� | j �� D ]�\}}t| |�}|du rB|jr�tdt| �j|f ��q zPt|t�r�t |j t �r�|j r~|D ]}|� |�}|�� qdn|� |�}|�� W q ty� } z$t|d�s�t| �j|_� W Y d}~q d}~0 0 q dS )z�Check class for initialization status. Check that all required fields are initialized Raises: ValidationError: If message is not initialized. Nz'Message %s is missing required field %s� message_name)r� rO rh �requiredr r0 r! rQ r r� � message_typer r� �value_to_message�check_initialized�hasattrr� )r) r* r� r? r Zitem_message_valueZ message_value�errr% r% r& r� s2 �� �� zMessage.check_initializedc C s* z | � � W n ty Y dS 0 dS dS )zeGet initialization status. Returns: True if message is valid, else False. FTN)r� r r( r% r% r& �is_initialized? s zMessage.is_initializedc C s | j �� S )z�Get all field definition objects. Ordering is arbitrary. Returns: Iterator over all values in arbitrary order. )r� rY r; r% r% r& r� L s zMessage.all_fieldsc C s | j | S )z�Get field by name. Returns: Field object associated with name. Raises: KeyError if no field found by that name. )r� rB r% r% r& � field_by_nameW s zMessage.field_by_namec C s | j | S )z�Get field by number. Returns: Field object associated with number. Raises: KeyError if no field found by that number. )r� r_ r% r% r& �field_by_numberc s zMessage.field_by_numberc C sJ t | �}z|�|�}W n$ ty: td|j|f ��Y n0 | j�|j�S )a8 Get the assigned value of an attribute. Get the underlying value of an attribute. If value has not been set, will not return the default for the field. Args: name: Name of attribute to get. Returns: Value of attribute, None if it has not been set. �Message %s has no field %s)r0 r� re r: r! r� �getrT �r) r* r� r� r% r% r& �get_assigned_valueo s �zMessage.get_assigned_valuec C st t | �}z|�|�}W n. tyD ||jvr@td|j|f ��Y n0 |jr`t|g �| j|j < n| j� |j d� dS )z�Reset assigned value for field. Resetting a field will return it to its default value or None. Args: name: Name of field to reset. r� N) r0 r� re r� r: r! r� r r� rT �popr� r% r% r& �reset� s �z Message.resetc C s t | j�� �S )z9Get the names of all unrecognized fields in this message.)�listr� r[ r( r% r% r& �all_unrecognized_fields� s z Message.all_unrecognized_fieldsNc C s | j �|||f�\}}||fS )a� Get the value and variant of an unknown field in this message. Args: key: The name or number of the field to retrieve. value_default: Value to be returned if the key isn't found. variant_default: Value to be returned as variant if the key isn't found. Returns: (value, variant), where value and variant are whatever was passed to set_unrecognized_field. )r� r� )r) r� Z value_defaultZvariant_defaultr? �variantr% r% r& �get_unrecognized_field_info� s � z#Message.get_unrecognized_field_infoc C s( t |t�std| ��||f| j|< dS )a| Set an unrecognized field, used when decoding a message. Args: key: The name or number used to refer to this unknown value. value: The value of the field. variant: Type information needed to interpret the value or re-encode it. Raises: TypeError: If the variant is not an instance of messages.Variant. z Variant type %s is not valid.N)rQ r rA r� )r) r� r? r� r% r% r& �set_unrecognized_field� s z Message.set_unrecognized_fieldc C s> || j v s|�d�r$t�| ||� ntd|t| �jf ��dS )a\ Change set behavior for messages. Messages may only be assigned values that are fields. Does not try to validate field when set. Args: name: Name of field to assign to. value: Value to assign to field. Raises: AttributeError when trying to assign value that is not a field. Z _Message__z/May not assign arbitrary value %s to message %sN)r� � startswithr3 r> r: r0 r! ri r% r% r& r> � s �zMessage.__setattr__c C sl dt | �jg}t| �� dd� d�D ]4}|j}| �|j�}|dur"|�d|t|�f � q"|�d� d�|�S ) a\ Make string representation of message. Example: class MyMessage(messages.Message): integer_value = messages.IntegerField(1) string_value = messages.StringField(2) my_message = MyMessage() my_message.integer_value = 42 my_message.string_value = u'A string' print my_message >>> <MyMessage ... integer_value: 42 ... string_value: u'A string'> Returns: String representation of message, including the values of all fields and repr of all sub-messages. �<c S s | j S ra rj )�fr% r% r& �<lambda>� r� z"Message.__repr__.<locals>.<lambda>)r� Nz %s: %s�>� ) r0 r! r� r� r* r� r� �repr�join)r) �bodyr� rV r? r% r% r& rl � s � zMessage.__repr__c C s, | |u r dS t | �t |�ur dS | j|jkS )a� Equality operator. Does field by field comparison with other message. For equality, must be same type and values of all fields must be equal. Messages not required to be initialized for comparison. Does not attempt to determine equality for values that have default values that are not set. In other words: class HasDefault(Message): attr1 = StringField(1, default='default value') message1 = HasDefault() message2 = HasDefault() message2.attr1 = 'default value' message1 != message2 Does not compare unknown values. Args: other: Other message to compare with. TF)r0 r� rr r% r% r& rx � s zMessage.__eq__c C s | � |� S )af Not equals operator. Does field by field comparison with other message. For non-equality, must be different type or any value of a field must be non-equal to the same field in the other instance. Messages not required to be initialized for comparison. Args: other: Other message to compare with. )rx rr r% r% r& ry s zMessage.__ne__)NN)r! r" r# r$ r1 r� r� r� r� r� r� r� r� r� r� r� r> rl rx ry r% r% r% r& r � s* D& � %r c @ s\ e Zd ZdZdd� Zdd� Zdd� Zedd � �Zd d � Z d d � Z dd� Z dd� Z dd� Z dS )r a List implementation that validates field values. This list implementation overrides all methods that add values in to a list in order to validate those new elements. Attempting to add or set list values that are not of the correct type will raise ValidationError. c C s0 |j std��|| _| j�|� t�| |� dS )z�Constructor. Args: field_instance: Instance of field that validates the list. sequence: List or tuple to construct list from. z)FieldList may only accept repeated fieldsN)r� r �_FieldList__field�validater� r1 )r) �field_instance�sequencer% r% r& r1 0 s � zFieldList.__init__c C s, | j �� }|du r | j ddfS d|| j jfS )a Enable pickling. The assigned field instance can't be pickled if it belongs to a Message definition (message_definition uses a weakref), so the Message class and field number are returned in that case. Returns: A 3-tuple containing: - The field instance, or None if it belongs to a Message class. - The Message class that the field instance belongs to, or None. - The field instance number of the Message class it belongs to, or None. N)r� r< rT )r) � message_classr% r% r& � __getstate__> s zFieldList.__getstate__c C s* |\}}}|du r |� |�| _n|| _dS )aO Enable unpickling. Args: state: A 3-tuple containing: - The field instance, or None if it belongs to a Message class. - The Message class that the field instance belongs to, or None. - The field instance number of the Message class it belongs to, or None. N)r� r� )r) �stater� r� rT r% r% r& � __setstate__R s zFieldList.__setstate__c C s | j S )zField that validates list.)r� r( r% r% r& r� b s zFieldList.fieldc C s | j �|� t�| |||� dS )z"Validate slice assignment to list.N)r� r� r� � __setslice__)r) �i�jr� r% r% r& r� g s zFieldList.__setslice__c C s6 t |t�r| j�|� n | j�|� t�| ||� dS )z!Validate item assignment to list.N)rQ �slicer� r� �validate_elementr� � __setitem__�r) rg r? r% r% r& r� l s zFieldList.__setitem__c C s$ t | dd�r| j�|� t�| |�S )z Validate item appending to list.r� N)rh r� r� r� r� �r) r? r% r% r& r� t s zFieldList.appendc C s$ t | dd�r| j�|� t�| |�S )zValidate extension of list.r� N)rh r� r� r� �extend)r) r� r% r% r& r� z s zFieldList.extendc C s | j �|� t�| ||�S )z Validate item insertion to list.)r� r� r� �insertr� r% r% r& r� � s zFieldList.insertN)r! r" r# r$ r1 r� r� �propertyr� r� r� r� r� r� r% r% r% r& r & s r c @ s e Zd Zdd� ZdS )� _FieldMetac s: t � d��� fdd�|�dg �D �� t�� |||� d S )N�_Field__variant_to_typec 3 s | ]}|� fV qd S ra r% )r~ r� r; r% r& r� � s z&_FieldMeta.__init__.<locals>.<genexpr>�VARIANTS)rh �updater� r0 r1 r5 r% r; r& r1 � s �z_FieldMeta.__init__N)r! r" r# r1 r% r% r% r& r� � s r� c @ s� e Zd ZdZdZi Ze�d�d dd��Zdd� Z d d � Z d d � Z d d� Z dd� Z dd� Zdd� Zdd� Zdd� Zedd� �Zedd � �ZdS ) r z Definition for message field.Fr� Nc C sd t |t�r d| kr tks0n td|tf ��t| krDtkrZn ntd|ttf ��|rj|rjtd��|du rx| j}|r�|dur�td��|| jvr�t d|t | �j t | j�f ��|| _ || _|| _|| _|du�rTz| �|� W nn t�yR } zTz | j}W n* t�y* td| jj ||f ��Y n0 td |||f ��W Y d}~n d}~0 0 || _d | _dS ) a� Constructor. The required and repeated parameters are mutually exclusive. Setting both to True will raise a FieldDefinitionError. Sub-class Attributes: Each sub-class of Field must define the following: VARIANTS: Set of variant types accepted by that field. DEFAULT_VARIANT: Default variant type if not specified in constructor. Args: number: Number of field. Must be unique per message class. required: Whether or not field is required. Mutually exclusive with 'repeated'. repeated: Whether or not field is repeated. Mutually exclusive with 'required'. variant: Wire-format variant hint. default: Default value for field if not found in stream. Raises: InvalidVariantError when invalid variant for field is provided. InvalidDefaultError when invalid default for field is provided. FieldDefinitionError when invalid number provided or mutually exclusive fields are used. InvalidNumberError when the field number is out of range or reserved. r� zGInvalid number for field: %s Number must be 1 or greater and %d or lesszATag number %d is a reserved number. Numbers %d to %d are reservedz%Cannot set both repeated and requiredNz%Repeated fields may not have defaultsz0Invalid variant: %s Valid variants for %s are %rz$Invalid default value for %s: %r: %sz*Invalid default value for field %s: %r: %sT)rQ �intr r r r r �DEFAULT_VARIANTr� r r0 r! r� rT r� r� r� �validate_defaultr r* r: r rm �_Field__default�_Field__initialized)r) rT r� r� r� �defaultr� r* r% r% r& r1 � s^ # ���� �� �� ��zField.__init__c C s< |t v rt�| ||� dS | js0t�| ||� ntd��dS )z�Setter overidden to prevent assignment to fields after creation. Args: name: Name of attribute to set. value: Value to assign. NzField objects are read-only)� _POST_INIT_FIELD_ATTRIBUTE_NAMESr3 r> r� r: ri r% r% r& r> � s zField.__setattr__c C s\ |du r0| j r td| j ��qX|j�| jd� n(| j rBt| |�}n | �|�}||j| j< dS )��Set value on message. Args: message_instance: Message instance to set value on. value: Value to set on message. Nz(May not assign None to repeated field %s)r� r r* r� r� rT r r� �r) �message_instancer? r% r% r& �__set__� s � z Field.__set__c C s, |d u r | S |j �| j�}|d u r(| jS |S ra )r� r� rT r� )r) r� r� �resultr% r% r& �__get__ s z Field.__get__c C s� t || j�s�t |tj�r*| jtkr*t|�S |du rB| jr�td��nVz | j}W n0 ty| td| j| j j |t|�f ��Y n 0 td| j||t|�f ��|S )aW Validate single element of field. This is different from validate in that it is used on individual values of repeated fields. Args: value: Value to validate. Returns: The value casted in the expected type. Raises: ValidationError if value is not expected type. NzRequired field is missingz+Expected type %s for %s, found %s (type %s)z1Expected type %s for field %s, found %s (type %s)) rQ r0 rF rR �floatr� r r* r: rm r! )r) r? r* r% r% r& r� s( �� ��zField.validate_elementc C s� | j s||�S t|ttf�r~g }|D ]T}|du rjz | j}W n" ty\ td| jj ��Y n0 td| ��|� ||�� q$|S |dur�z | j}W n& ty� td| jj|f ��Y n0 td||f ��|S )aO Internal validation function. Validate an internal value using a function to validate individual elements. Args: value: Value to validate. validate_element: Function to use to validate individual elements. Raises: ValidationError if value is not expected type. Nz&Repeated values for %s may not be Nonez,Repeated values for field %s may not be Nonez%s is repeated. Found: %sz Field %s is repeated. Found: %s) r� rQ r� �tupler* r: r rm r! r� )r) r? r� r� �elementr* r% r% r& Z __validateA s@ �� �� � �zField.__validatec C s | � || j�S )z�Validate value assigned to field. Args: value: Value to validate. Returns: the value in casted in the correct type. Raises: ValidationError if value is not expected type. )�_Field__validater� r� r% r% r& r� n s zField.validatec C s | � |�S )a& Validate value as assigned to field default field. Some fields may allow for delayed resolution of default types necessary in the case of circular definition references. In this case, the default value might be a place holder that is resolved when needed after all the message classes are defined. Args: value: Default value to validate. Returns: the value in casted in the correct type. Raises: ValidationError if value is not expected type. )r� r� r% r% r& �validate_default_element| s z Field.validate_default_elementc C s | � || j�S )z�Validate default value assigned to field. Args: value: Value to validate. Returns: the value in casted in the correct type. Raises: ValidationError if value is not expected type. )r� r� r� r% r% r& r� � s zField.validate_defaultc C s$ z | � � W S ty Y dS 0 dS )z�Get Message definition that contains this Field definition. Returns: Containing Message definition for Field. Will return None if for some reason Field is defined outside of a Message class. Nr9 r( r% r% r& r< � s zField.message_definitionc C s | j S )z Get default value for field.)r� r( r% r% r& r� � s z Field.defaultc C s | j | S ra )r� )r6 r� r% r% r& � lookup_field_type_by_variant� s z"Field.lookup_field_type_by_variant)FFNN)r! r" r# r$ r� r� r � positionalr1 r> r� r� r� r� r� r� r� r< r� r� r� r� r% r% r% r& r � s, � T &- r c @ s< e Zd ZdZeejejejej ej ej g�Z ejZ ejZdS )r z$Field definition for integer values.N)r! r" r# r$ � frozensetr r� r� r� r� r� r� r� r� rF rR r0 r% r% r% r& r � s � r c @ s* e Zd ZdZeejejg�ZejZ e Z dS )r z"Field definition for float values.N) r! r" r# r$ r� r r� r� r� r� r� r0 r% r% r% r& r � s �r c @ s& e Zd ZdZeejg�ZejZe Z dS )r z$Field definition for boolean values.N) r! r" r# r$ r� r r� r� r� �boolr0 r% r% r% r& r � s r c @ s& e Zd ZdZeejg�ZejZe Z dS )r z(Field definition for byte string values.N) r! r" r# r$ r� r r� r� r� �bytesr0 r% r% r% r& r � s r c s8 e Zd ZdZeejg�ZejZe j Z � fdd�Z � Z S )r z+Field definition for unicode string values.c s� t |t�r�zt�|d� W q� ty� } zZz | j}W n" tyV td||f �}Y n 0 td| j||f �}| j|_|�W Y d}~q�d}~0 0 nt t | �� |�S |S )z�Validate StringField allowing for str and unicode. Raises: ValidationError if a str value is not UTF-8. zUTF-8z)Field encountered non-UTF-8 string %r: %sz,Field %s encountered non-UTF-8 string %r: %sN) rQ r rF rG �UnicodeDecodeErrorr* r: r � field_name�superr r� )r) r? r� �_Zvalidation_error�rm r% r& r� � s* �� �� z StringField.validate_element)r! r" r# r$ r� r r� r� r� rF rG r0 r� � __classcell__r% r% r r& r � s r c sr e Zd ZdZeejg�ZejZe � d�d� fdd� �Z � fdd�Z e d d � �Ze d d � �Zd d� Zdd� Z� ZS )r a Field definition for sub-message values. Message fields contain instance of other messages. Instances stored on messages stored on message fields are considered to be owned by the containing message instance and should not be shared between owning instances. Message fields must be defined to reference a single type of message. Normally message field are defined by passing the referenced message class in to the constructor. It is possible to define a message field for a type that does not yet exist by passing the name of the message in to the constructor instead of a message class. Resolution of the actual type of the message is deferred until it is needed, for example, during message verification. Names provided to the constructor must refer to a class within the same python module as the class that is using it. Names refer to messages relative to the containing messages scope. For example, the two fields of OuterMessage refer to the same message type: class Outer(Message): inner_relative = MessageField('Inner', 1) inner_absolute = MessageField('Outer.Inner', 2) class Inner(Message): ... When resolving an actual type, MessageField will traverse the entire scope of nested messages to match a message name. This makes it easy for siblings to reference siblings: class Outer(Message): class Inner(Message): sibling = MessageField('Sibling', 1) class Sibling(Message): ... r� FNc st t |tj�p&|tuo&t |t�o&t|t�}|s8td| ��t |tj�rR|| _d| _n|| _t t | �j ||||d� dS )a Constructor. Args: message_type: Message type for field. Must be subclass of Message. number: Number of field. Must be unique per message class. required: Whether or not field is required. Mutually exclusive to 'repeated'. repeated: Whether or not field is repeated. Mutually exclusive to 'required'. variant: Wire-format variant hint. Raises: FieldDefinitionError when invalid message_type is provided. �Invalid message class: %sN)r� r� r� ) rQ rF rf r r0 r� r �_MessageField__type_namer, r r r1 )r) r� rT r� r� r� � valid_typer r% r& r1 > s& ��� �zMessageField.__init__c st | j � t� t �r^t� t�r^| jrF|r^t|ttf�r^� fdd�|D �}nt|t�r^� f i |��}tt | �� ||� dS )r� c s( g | ] }t |t�r � f i |��n|�qS r% )rQ r� )r~ r� ��tr% r& � <listcomp>r s �z(MessageField.__set__.<locals>.<listcomp>N) r0 rQ r� r r� r� r� r� r r r� r� r r r& r� g s � zMessageField.__set__c C sN | j du rHt| j| �� �}|tur6t|t�r6t|t�sBtd| ��|| _ | j S )z Message type used for field.Nr ) r, r r r< r rQ r0 r� r )r) r� r% r% r& r0 x s ����zMessageField.typec C s | j S )z�Underlying message type used for serialization. Will always be a sub-class of Message. This is different from type which represents the python value that message_type is mapped to for use by the user. )r0 r( r% r% r& r� � s zMessageField.message_typec C s, t || j�s(td| jjt|�j|f ��|S )a" Convert a message to a value instance. Used by deserializers to convert from underlying messages to value of expected user type. Args: message: A message instance of type self.message_type. Returns: Value of self.message_type. � Expected type %s, got %s: %r)rQ r� r r! r0 )r) �messager% r% r& �value_from_message� s ��z MessageField.value_from_messagec C s, t || j�s(td| jjt|�j|f ��|S )a Convert a value instance to a message. Used by serializers to convert Python user types to underlying messages for transmission. Args: value: A value of type self.type. Returns: An instance of type self.message_type. r )rQ r0 r r! r� r% r% r& r� � s ��z MessageField.value_to_message)FFN)r! r" r# r$ r� r r� r� r� r r� r1 r� r� r0 r� r r� r r% r% r r& r s , �( r c sZ e Zd ZdZeejg�ZejZ� fdd�Z � fdd�Z e dd� �Z e � fdd ��Z � ZS ) r a Field definition for enum values. Enum fields may have default values that are delayed until the associated enum type is resolved. This is necessary to support certain circular references. For example: class Message1(Message): class Color(Enum): RED = 1 GREEN = 2 BLUE = 3 # This field default value will be validated when default is accessed. animal = EnumField('Message2.Animal', 1, default='HORSE') class Message2(Message): class Animal(Enum): DOG = 1 CAT = 2 HORSE = 3 # This fields default value will be validated right away since Color # is already fully resolved. color = EnumField(Message1.Color, 1, default='RED') c st t |tj�p&|tuo&t |t�o&t|t�}|s8td| ��t |tj�rR|| _d| _n|| _t t | �j |fi |�� dS )a= Constructor. Args: enum_type: Enum type for field. Must be subclass of Enum. number: Number of field. Must be unique per message class. required: Whether or not field is required. Mutually exclusive to 'repeated'. repeated: Whether or not field is repeated. Mutually exclusive to 'required'. variant: Wire-format variant hint. default: Default value for field if not found in stream. Raises: FieldDefinitionError when invalid enum_type is provided. �Invalid enum type: %sN) rQ rF rf r r0 r� r �_EnumField__type_namer- r r r1 )r) Z enum_typerT r� r r r% r& r1 � s �� zEnumField.__init__c s6 t |tjtjf�r&| jr"| �|� |S tt| ��|�S )a� Validate default element of Enum field. Enum fields allow for delayed resolution of default values when the type of the field has not been resolved. The default value of a field may be a string or an integer. If the Enum type of the field has been resolved, the default value is validated against that type. Args: value: Value to validate. Raises: ValidationError if value is not expected message type. )rQ rF rf rR r- r r r� r� r r% r& r� � s z"EnumField.validate_default_elementc C sN | j du rHt| j| �� �}|tur6t|t�r6t|t�sBtd| ��|| _ | j S )zEnum type used for field.Nr ) r- r r r< r rQ r0 r� r )r) Z found_typer% r% r& r0 s ����zEnumField.typec sT z| j W S tyN tt| �j}t|tjtjf�r>| � |�}|| _ | j Y S 0 dS )zjDefault for enum field. Will cause resolution of Enum type and unresolved default value. N) r. r: r r r� rQ rF rf rR r0 )r) Zresolved_defaultr r% r& r� $ s � zEnumField.default)r! r" r# r$ r� r r� r� r� r1 r� r� r0 r� r r% r% r r& r � s r r� c s8 �du s4t �tj�s4t �t�r(t�t�s4td� ��| �d���d sVd��dd� �� ��fdd�}|� }t |t�r�t|ttf�r�|S �du r�t d| ��qft �tj�r�j �d�dd � }|s�d�n� d� |�d d |d g��qft �t�rft�t�rf�� � }|du �r.�j �d�d }� �j d d |g��qf|�qfdS ) az Find definition by name in module-space. The find algorthm will look for definitions by name relative to a message definition or by fully qualfied name. If no definition is found relative to the relative_to parameter it will do the same search against the container of relative_to. If relative_to is a nested Message, it will search its message_definition(). If that message has no message_definition() it will search its module. If relative_to is a module, it will attempt to look for the containing module and search relative to it. If the module is a top-level module, it will look for the a message using a fully qualified name. If no message is found then, the search fails and DefinitionNotFoundError is raised. For example, when looking for any definition 'foo.bar.ADefinition' relative to an actual message definition abc.xyz.SomeMessage: find_definition('foo.bar.ADefinition', SomeMessage) It is like looking for the following fully qualified names: abc.xyz.SomeMessage. foo.bar.ADefinition abc.xyz. foo.bar.ADefinition abc. foo.bar.ADefinition foo.bar.ADefinition When resolving the name relative to Message definitions and modules, the algorithm searches any Messages or sub-modules found in its path. Non-Message values are not searched. A name that begins with '.' is considered to be a fully qualified name. The name is always searched for from the topmost package. For example, assume two message types: abc.xyz.SomeMessage xyz.SomeMessage Searching for '.xyz.SomeMessage' relative to 'abc' will resolve to 'xyz.SomeMessage' and not 'abc.xyz.SomeMessage'. For this kind of name, the relative_to parameter is effectively ignored and always set to None. For more information about package name resolution, please see: http://code.google.com/apis/protocolbuffers/docs/proto.html#packages Args: name: Name of definition to find. May be fully qualified or relative name. relative_to: Search for definition relative to message definition or module. None will cause a fully qualified name search. importer: Import function to use for resolving modules. Returns: Enum or Message class definition associated with name. Raises: DefinitionNotFoundError if no definition is found in any search path. NzBrelative_to must be None, Message definition or module. Found: %s�.r r� c s� �} �D ]�}t | |d�}|dur&|} nv| du s:t| tj�r�| du rH|}nd| j|f }z&|�d�d }� |ddt|�g�} W q� ty� Y dS 0 n dS t| tj�st| t�r�t | t t f�s dS q| S )a Performs a single iteration searching the path from relative_to. This is the function that searches up the path from a relative object. fully.qualified.object . relative.or.nested.Definition ----------------------------> ^ | this part of search --+ Returns: Message or Enum at the end of name_path, else None. NrD r ���r� ) rh rQ �types� ModuleTyper! �split�str� ImportErrorr0 r� r r )Z next_part�noderV � module_nameZfromitem��importerZ name_path� relative_tor% r& � search_path� s2 �� �z$find_definition.<locals>.search_pathz Could not find definition for %sr r� )rQ r r r0 r� r rA r r r r! r� r< r" )r* r r r �foundZ module_path�parentZlast_module_namer% r r& r 6 sZ > ����� / � � � �� �r )2r$ r r� rF �apitools.base.protorpcliter �__all__r r r r r r r r r r r r r� rP r� r= r r r r r0 r/ rL �with_metaclassr3 r r r� r r� r r� r r r r r r r r r� � __import__r r% r% r% r& �<module> sl ( ���ly &i t` ) % +
| ver. 1.4 |
Github
|
.
| PHP 8.2.28 | Generation time: 0.05 |
proxy
|
phpinfo
|
Settings