o @sLdZddlZddlZddlZddlmZgdZejZGdddeZGdddeZ Gd d d e Z Gd d d e Z Gd dde Z GdddeZ GdddeZGdddeZGdddeZGdddeZGdddeZegdZegdZedgZdZdZdZd ZGd!d"d"eZGd#d$d$eZGd%d&d&eeeZ Gd'd(d(e Z!Gd)d*d*eZ"Gd+d,d,ee"eZ#Gd-d.d.e$Z%Gd/d0d0eZ&Gd1d2d2ee&eZ'Gd3d4d4e'Z(Gd5d6d6e'Z)Gd7d8d8e'Z*Gd9d:d:e'Z+Gd;d<dd>e'Z-Gd?d@d@e'Z.e/dAde0fdBdCZ1dS)DaStand-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_VALUEMAX_FIELD_NUMBERFIRST_RESERVED_FIELD_NUMBERLAST_RESERVED_FIELD_NUMBEREnumField FieldListVariantMessage IntegerField FloatField BooleanField BytesField StringField MessageField EnumFieldfind_definitionError DecodeError EncodeErrorEnumDefinitionErrorFieldDefinitionErrorInvalidVariantErrorInvalidDefaultErrorInvalidNumberErrorMessageDefinitionErrorDuplicateNumberErrorValidationErrorDefinitionNotFoundErrorc@eZdZdZdS)rzEnumeration definition error.N__name__ __module__ __qualname____doc__r&r&L/tmp/google-cloud-sdk/lib/third_party/apitools/base/protorpclite/messages.pyr_rc@r )rzField definition error.Nr!r&r&r&r'rcr(rc@r )rz"Invalid variant provided to field.Nr!r&r&r&r'rgr(rc@r )rz"Invalid default provided to field.Nr!r&r&r&r'rkr(rc@r )rz!Invalid number provided to field.Nr!r&r&r&r'ror(rc@r )rzMessage definition error.Nr!r&r&r&r'rsr(rc@r )rz#Duplicate number assigned to field.Nr!r&r&r&r'rwr(rc@r )rz$Raised when definition is not found.Nr!r&r&r&r'r{r(rc@r )rz/Error found decoding message from encoded form.Nr!r&r&r&r'rr(rc@r )rz"Error found when encoding message.Nr!r&r&r&r'rr(rc@seZdZdZddZdS)rz Invalid value for message error.cCs t|S)z6Prints string with field name if present on exception.)r__str__selfr&r&r'r) zValidationError.__str__N)r"r#r$r%r)r&r&r&r'rs r)r#r%r$__static_attributes____firstlineno__)name_message_definition_MessageField__type_EnumField__type_EnumField__resolved_defaultr0ii8JiNc@sLeZdZdZdZddZddZddZd d Zd d Z d dZ ddZ dS)_DefinitionClassauBase 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. FcCs*t|||||jtfkrd|_dSdS)z Constructor.TN)type__init__ __bases__object_DefinitionClass__initializedclsr/basesdctr&r&r'r6s  z_DefinitionClass.__init__cC z|WStyYdSw)zGet outer Message definition that contains this definition. Returns: Containing Message definition if definition is contained within one, else None. Nr0AttributeErrorr;r&r&r'message_definitions   z#_DefinitionClass.message_definitioncCs,|jr |tvr td|t|||dS)aOverridden 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)r9_POST_INIT_ATTRIBUTE_NAMESr@r5 __setattr__)r;r/valuer&r&r'rDs z_DefinitionClass.__setattr__cCtd)zAOverridden so that cannot delete varaibles on definition classes.z-May not delete attributes on definition class TypeErrorr;r/r&r&r' __delattr__sz_DefinitionClass.__delattr__cCs*|}|durt|jSd||jfS)aHelper 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_namesix text_typer")r;rLr&r&r'definition_names z _DefinitionClass.definition_namecC |}|s t|jS|S)zHelper method for creating outer definition name. Returns: If definition is nested, will return the outer definitions name, else the package name. )rBrget_package_for_moduler#rOr;outer_definitionr&r&r'rLs z&_DefinitionClass.outer_definition_namecCrP)zHelper method for creating creating the package of a definition. Returns: Name of package that definition belongs to. )rBrrQr#definition_packagerRr&r&r'rT s z#_DefinitionClass.definition_packageN) r"r#r$r%r9r6rBrDrJrOrLrTr&r&r&r'r4s   r4c@sHeZdZdZddZddZddZdd Zd d Zd d Z ddZ dS) _EnumClassaFMeta-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. cCs|tfks|tfkstd|i|_i|_|tfkr|D]`\}}|tvr(qt|tj s6td||f|dkrBtd||f|t krOtdt ||f||jvratd|||j|j ft |}| |||||j|j <||j|j<t|||qt ||||dS)Nz'Enum type %s may only inherit from Enumz:May only use integers in Enum definitions. Found: %s = %srz2Must 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)r8rr_EnumClass__by_number_EnumClass__by_nameitems_RESERVED_ATTRIBUTE_NAMES isinstancerM integer_typesrr/__new__r6numbersetattrr4)r;r/r<r= attributerEinstancer&r&r'r6+sP      z_EnumClass.__init__cCt|jS)zIterate over all values of enum. Yields: Enumeration instances of the Enum class in arbitrary order. )iterrVvaluesrAr&r&r'__iter__`sz_EnumClass.__iter__cC |jS)zyGet all names for Enum. Returns: An iterator for names of the enumeration in arbitrary order. )rWkeysrAr&r&r'namesh z_EnumClass.namescCre)zGet all numbers for Enum. Returns: An iterator for all numbers of the enumeration in arbitrary order. )rVrfrAr&r&r'numbersprhz_EnumClass.numberscC |j|S)zLook up Enum by name. Args: name: Name of enum to find. Returns: Enum sub-class instance of that value. )rWrIr&r&r'lookup_by_namex z_EnumClass.lookup_by_namecCrj)zLook up Enum by number. Args: number: Number of enum to find. Returns: Enum sub-class instance of that value. )rVr;r]r&r&r'lookup_by_numberrlz_EnumClass.lookup_by_numbercC t|jSN)lenrWrAr&r&r'__len__s z_EnumClass.__len__N) r"r#r$r%r6rdrgrirkrnrrr&r&r&r'rUs5 rUc@seZdZdZedZddZd&ddZdd Zd d Z d d Z ddZ ddZ ddZ ddZddZddZddZddZddZd d!Zed"d#Zed$d%ZdS)'rz$Base class for all enumerated types.r/r]cCsxt||r|St|tjrz||WStyYnwt|tjr3z||WSty2Ynwtd||jf)aGActs 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. zNo such value for %s in Enum %s) rZrMr[rnKeyError string_typesrkrHr")r;indexr&r&r'r\s"       z Enum.__new__NcCs2tt|dr dSt|d|t|d|dS)zInitialize new Enum instance. Since this should only be called during class initialization any calls that happen after the class is frozen raises an exception. r9Nr/r])getattrr5r8rD)r+r/r]r&r&r'r6s z Enum.__init__cCrF)NzMay not change enum valuesrGr+r/rEr&r&r'rDszEnum.__setattr__cC|jSrp)r/r*r&r&r'r)z Enum.__str__cCryrpr]r*r&r&r'__int__rzz Enum.__int__cCsdt|j|j|jfS)Nz %s(%s, %d))r5r"r/r]r*r&r&r'__repr__sz Enum.__repr__cCs|j|jffS)zEnable pickling. Returns: A 2-tuple containing the class and __new__ args to be used for restoring a pickled instance. ) __class__r]r*r&r&r' __reduce__zEnum.__reduce__cCs t|t|rt|j|jStSzOrder is by number.)rZr5cmpr]NotImplementedr+otherr&r&r'__cmp__sz Enum.__cmp__cCst|t|r |j|jkStSrrZr5r]rrr&r&r'__lt__ z Enum.__lt__cCst|t|r |j|jkStSrrrr&r&r'__le__rz Enum.__le__cCst|t|r |j|jkStSrrrr&r&r'__eq__rz Enum.__eq__cCst|t|r |j|jkStSrrrr&r&r'__ne__rz Enum.__ne__cCst|t|r |j|jkStSrrrr&r&r'__ge__rz Enum.__ge__cCst|t|r |j|jkStSrrrr&r&r'__gt__rz Enum.__gt__cCro)zHash by number.)hashr]r*r&r&r'__hash__ r,z Enum.__hash__cCstddt|DS)zMake dictionary version of enumerated class. Dictionary created this way can be used with def_num. Returns: A dict (name) -> number css|] }|j|jfVqdSrprs).0itemr&r&r' szEnum.to_dict..)dictrbrAr&r&r'to_dict s z Enum.to_dictcCst|tf|S)zDefine enum class from dictionary. Args: dct: Dictionary of enumerated values for type. name: Name of enum. )r5r)r=r/r&r&r'def_enumrz Enum.def_enumrp)r"r#r$r%set __slots__r\r6rDr)r|r}rrrrrrrrr classmethodr staticmethodrr&r&r&r'rs, $   rc@sDeZdZdZdZdZdZdZdZdZ 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%DOUBLEFLOATINT64UINT64INT32BOOLSTRINGMESSAGEBYTESUINT32ENUMSINT32SINT64r&r&r&r'r %sr c@s eZdZdZddZddZdS) _MessageClassaMeta-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 Cs.i}i}i}|tfkr|tfkrtdg}g}|D]Z\} } | tvr%qt| tr5t| tr5| | qt| trIt| trI| turI| | qt| t usTt| t s\td| | f| j |vrjt d| j |f| | _ | || <| || j <q|rt||d<|rt||d<||d<||d<t||||S)zCreate 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 %s __enums__ __messages___Message__by_number_Message__by_name)r8r rrXrYrZr5 issubclassrappendrr]rr/sortedr4r\) r;r/r<r= by_numberby_name variant_mapenumsmessageskeyfieldr&r&r'r\csX         z_MessageClass.__new__cCsd|tfkr(|D]}t|tr|turt||_q |D]}t||_qt ||||dS)z7Initializer required to assign references to new class.N) r8rcrZr4r weakrefrefr0 all_fieldsr6)r;r/r<r=vrr&r&r'r6s    z_MessageClass.__init__N)r"r#r$r%r\r6r&r&r&r'rKs Drc@seZdZdZddZddZddZedd Zed d Z ed d Z ddZ ddZ ddZ  d!ddZddZddZddZddZdd 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() cKsji|_i|_t}|D]\}}t|||||q |D]}|jr2|j|vr2t||jgq!dS)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_fieldsrrXr^addrrepeatedr/)r+kwargsassignedr/rErr&r&r'r6s   zMessage.__init__c Cs|jD]\\}}t||}|dur!|jr tdt|j|fqz(t|trHt |j t rH|j r?|D] }| |}|q2n | |}|Wqtya}z t|ds\t|j|_d}~wwdS)zCheck 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)rrXrwrequiredrr5r"rZrr message_typer rvalue_to_messagecheck_initializedhasattrr)r+r/rrEritem_message_value message_valueerrr&r&r'rs>        zMessage.check_initializedcCs$z|WdStyYdSw)zeGet initialization status. Returns: True if message is valid, else False. FT)rrr*r&r&r'is_initialized?s   zMessage.is_initializedcCre)zGet all field definition objects. Ordering is arbitrary. Returns: Iterator over all values in arbitrary order. )rrcrAr&r&r'rLrlzMessage.all_fieldscCrj)zGet field by name. Returns: Field object associated with name. Raises: KeyError if no field found by that name. )rrIr&r&r' field_by_nameW zMessage.field_by_namecCrj)zGet field by number. Returns: Field object associated with number. Raises: KeyError if no field found by that number. )rrmr&r&r'field_by_numbercrzMessage.field_by_numbercCsFt|}z||}Wntytd|j|fw|j|jS)a8Get 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)r5rrtr@r"rgetr]r+r/rrr&r&r'get_assigned_valueos  zMessage.get_assigned_valuecCsvt|}z||}Wnty"||jvr td|j|fYnw|jr1t|g|j|j <dS|j |j ddS)zReset assigned value for field. Resetting a field will return it to its default value or None. Args: name: Name of field to reset. rN) r5rrtrr@r"rr rr]poprr&r&r'resets  z Message.resetcCra)z9Get the names of all unrecognized fields in this message.)listrrfr*r&r&r'all_unrecognized_fieldsszMessage.all_unrecognized_fieldsNcCs|j|||f\}}||fS)aGet 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. )rr)r+r value_defaultvariant_defaultrEvariantr&r&r'get_unrecognized_field_infos  z#Message.get_unrecognized_field_infocCs(t|ts td|||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. zVariant type %s is not valid.N)rZr rHr)r+rrErr&r&r'set_unrecognized_fields zMessage.set_unrecognized_fieldcCs<||jvs |drt|||dStd|t|jf)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. _Message__z/May not assign arbitrary value %s to message %sN)r startswithr8rDr@r5r"rxr&r&r'rDs  zMessage.__setattr__cCsldt|jg}t|dddD]}|j}||j}|dur+|d|t|fq|dd|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 >>> Returns: String representation of message, including the values of all fields and repr of all sub-messages. sz"Message.__repr__..)rNz %s: %s>) r5r"rrr/rrreprjoin)r+bodyrr_rEr&r&r'r}s    zMessage.__repr__cCs,||urdSt|t|urdS|j|jkS)aEquality 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)r5rrr&r&r'rs  zMessage.__eq__cCs || S)afNot 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. )rrr&r&r'rs zMessage.__ne__)NN)r"r#r$r%r6rrrrrrrrrrrrDr}rrr&r&r&r'r s,D&       %r c@s\eZdZdZddZddZddZedd Zd d Z d d Z ddZ ddZ ddZ dS)r aList 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. cCs0|jstd||_|j|t||dS)zConstructor. 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)rr_FieldList__fieldvalidaterr6)r+field_instancesequencer&r&r'r60s zFieldList.__init__cCs,|j}|dur|jddfSd||jjfS)aEnable 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)rrBr])r+ message_classr&r&r' __getstate__>s  zFieldList.__getstate__cCs,|\}}}|dur|||_dS||_dS)aOEnable 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)rr)r+staterrr]r&r&r' __setstate__Rs  zFieldList.__setstate__cCry)zField that validates list.)rr*r&r&r'rbzFieldList.fieldcCs |j|t||||dS)z"Validate slice assignment to list.N)rrr __setslice__)r+ijrr&r&r'rgs zFieldList.__setslice__cCs6t|tr |j|n|j|t|||dS)z!Validate item assignment to list.N)rZslicerrvalidate_elementr __setitem__r+rvrEr&r&r'rls  zFieldList.__setitem__cC$t|ddr |j|t||S)z Validate item appending to list.rN)rwrrrrr+rEr&r&r'rt   zFieldList.appendcCr)zValidate extension of list.rN)rwrrrextend)r+rr&r&r'rzrzFieldList.extendcCs|j|t|||S)z Validate item insertion to list.)rrrinsertrr&r&r'rs zFieldList.insertN)r"r#r$r%r6rrpropertyrrrrrrr&r&r&r'r &s   r c@seZdZddZdS) _FieldMetacs:tdfdd|dgDt|||dS)N_Field__variant_to_typec3s|]}|fVqdSrpr&)rrrAr&r'rs z&_FieldMeta.__init__..VARIANTS)rwupdaterr5r6r:r&rAr'r6s z_FieldMeta.__init__N)r"r#r$r6r&r&r&r'rs rc@seZdZdZdZiZed    dddZddZ d d Z d d Z d dZ ddZ ddZddZddZddZeddZeddZdS)rzDefinition for message field.FrNc CsNt|trd|krtksntd|tft|kr"tkr-nn td|ttf|r5|r5td|dur<|j}|rF|durFtd||jvrZt d|t |j t |jf||_ ||_||_||_|durz||Wn-ty}z!z|j}Wntytd|jj ||fwtd |||fd}~ww||_d |_dS) aConstructor. 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. rzGInvalid 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)rZintrrrrrDEFAULT_VARIANTr rr5r"rr]rrrvalidate_defaultrr/r@rr~_Field__default_Field__initialized)r+r]rrrdefaultrr/r&r&r'r6sd #      zField.__init__cCs:|tvr t|||dS|jst|||dStd)zSetter 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_NAMESr8rDrr@rxr&r&r'rDs zField.__setattr__cCs\|dur|jrtd|j|j|jddS|jr!t||}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)rrr/rrr]r rr+message_instancerEr&r&r'__set__s  z Field.__set__cCs,|dur|S|j|j}|dur|jS|Srp)rrr]r)r+rrresultr&r&r'__get__s z Field.__get__c Cst||jsKt|tjr|jtkrt|S|dur"|jr td|Sz|j}Wnty=td|j|j j |t|fwtd|j||t|f|S)aWValidate 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)) rZr5rMr[floatrrr/r@r~r")r+rEr/r&r&r'rs,     zField.validate_elementc Cs|js||St|ttfr=g}|D](}|dur3z|j}Wnty,td|jjwtd|| ||q|S|dur`z|j}WntyWtd|jj|fwtd||f|S)aOInternal 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: %szField %s is repeated. Found: %s) rrZrtupler/r@rr~r"r)r+rErrelementr/r&r&r' __validateAsD     zField.__validatecC|||jS)zValidate 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__validaterrr&r&r'rn zField.validatecCs ||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. )rrr&r&r'validate_default_element|s zField.validate_default_elementcCr)zValidate 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. )rr rr&r&r'rrzField.validate_defaultcCr>)zGet 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. Nr?r*r&r&r'rBs   zField.message_definitioncCry)zGet default value for field.)rr*r&r&r'rrz Field.defaultcCrjrp)r )r;rr&r&r'lookup_field_type_by_variantr,z"Field.lookup_field_type_by_variant)FFNN)r"r#r$r%rr r positionalr6rDrrrrrr rrBrrrr!r&r&r&r'rs. T &- rc@s<eZdZdZeejejejej ej ej gZ ejZ ejZdS)r z$Field definition for integer values.N)r"r#r$r% frozensetr rrrrrrr r rMr[r5r&r&r&r'r s r c@s*eZdZdZeejejgZejZ e Z dS)r z"Field definition for float values.N) r"r#r$r%r#r rrr r rr5r&r&r&r'r sr c@&eZdZdZeejgZejZe Z dS)rz$Field definition for boolean values.N) r"r#r$r%r#r rr r boolr5r&r&r&r'r  rc@r$)rz(Field definition for byte string values.N) r"r#r$r%r#r rr r bytesr5r&r&r&r'rr&rcs8eZdZdZeejgZejZe j Z fddZ Z S)rz+Field definition for unicode string values.c st|trCz t|dW|StyB}z(z|j}Wnty-td||f}Y|wtd|j||f}|j|_|d}~wwt t | |S)zValidate 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) rZr'rMrNUnicodeDecodeErrorr/r@r field_namesuperrr)r+rEr_validation_errorr~r&r'rs2   zStringField.validate_element)r"r#r$r%r#r rr r rMrNr5r __classcell__r&r&r-r'rs  rcsxeZdZdZeejgZejZe d   dfdd Z fddZ e d d Ze d d Zd dZddZZS)raField 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): ... rFNcstt|tjp|tuot|tot|t}|std|t|tjr)||_d|_n||_t t |j ||||ddS)aConstructor. 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)rrr) rZrMrur r5rr_MessageField__type_namer1r*rr6)r+rr]rrr valid_typer-r&r'r6>s&    zMessageField.__init__cst|jttr/ttr/|jr#|r"t|ttfr"fdd|D}n t|tr/di|}tt | ||dS)rcs(g|]}t|trdi|n|qS)r&)rZr)rrtr&r' rs z(MessageField.__set__..Nr&) r5rZrr rrrrr*rrrr-r2r'rgs  zMessageField.__set__cCN|jdur$t|j|}|turt|trt|ts!td|||_|jS)zMessage type used for field.Nr/) r1rr0rBr rZr5rr)r+rr&r&r'r5xs  zMessageField.typecCry)zUnderlying 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. )r5r*r&r&r'rszMessageField.message_typecCs,t||jstd|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)rZrrr"r5)r+messager&r&r'value_from_message zMessageField.value_from_messagecCs,t||jstd|jjt|j|f|S)aConvert 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. r6)rZr5rr"rr&r&r'rr9zMessageField.value_to_message)FFN)r"r#r$r%r#r rr r rr"r6rrr5rr8rr.r&r&r-r'r s  , (   rcsZeZdZdZeejgZejZfddZ fddZ e ddZ e fdd Z ZS) raField 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 stt|tjp|tuot|tot|t}|std|t|tjr)||_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) rZrMrurr5rr_EnumField__type_namer2r*rr6)r+ enum_typer]rr1r-r&r'r6s   zEnumField.__init__cs6t|tjtjfr|jr|||Stt||S)aValidate 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. )rZrMrur[r2r*rr rr-r&r'r s  z"EnumField.validate_default_elementcCr5)zEnum type used for field.Nr:) r2rr;rBrrZr5rr)r+ found_typer&r&r'r5s  zEnumField.typecsPz|jWSty'tt|j}t|tjtjfr| |}||_|jYSw)zjDefault for enum field. Will cause resolution of Enum type and unresolved default value. ) r3r@r*rrrZrMrur[r5)r+resolved_defaultr-r&r'r$s    zEnumField.default)r"r#r$r%r#r rr r r6r rr5rr.r&r&r-r'rs    rrcs2dusttjsttrttstd|dds+dddfdd} |}t|trEt|ttfrE|SdurOt d |ttjrrj ddd }|sddn4d |d d |d gn&ttrttr }|durj dd }j d d |gn|q4) 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.rrc s}D]^}t||d}|dur|}n:|dust|tjrJ|dur$|}nd|j|f}z|dd}|ddt|g}WntyIYdSwdSt|tjsbt|tr_t |t t fsbdSq|S)aPerforms 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. NrKr?r) rwrZtypes ModuleTyper"splitstr ImportErrorr5rr r) next_partnoder_ module_namefromitemimporter name_path relative_tor&r' search_paths6      z$find_definition..search_pathTz Could not find definition for %sr@r)rZrArBr5rr rHrCrrr"rrBr#)r/rMrKrNfound module_pathparentlast_module_namer&rJr'r6s^>   .    r)2r%rArrMapitools.base.protorpcliter__all__rrrrrrrrrrrrr#rYrrCrrrrr5r4rUwith_metaclassr8rr rr rr rrr r rrrrrr" __import__rr&r&r&r'sn ( ly&it` )   %+