U Zf;e@s8dZddlmZmZddlZddlZddlZddlZddlZddl m Z m Z ddl Z dZ e rdddlZe jrteefZneefZGdddeZdd Zd d ZGd d d e e eZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZ GdddeZ!GdddeZ"Gddde"Z#Gd d!d!e"Z$Gd"d#d#eZ%Gd$d%d%eZ&Gd&d'd'eZ'Gd(d)d)eZ(Gd*d+d+e(Z)Gd,d-d-e(Z*Gd.d/d/e(Z+Gd0d1d1e+Z,Gd2d3d3e(Z-Gd4d5d5eZ.Gd6d7d7eZ/Gd8d9d9eZ0Gd:d;d;e0Z1Gdz Defines classes to represent each Stone type in Python. These classes should be used to validate Python objects and normalize them for a given type. The data types defined here should not be specific to an RPC or serialization format. )absolute_importunicode_literalsN)ABCMetaabstractmethodFcs:eZdZdZd fdd ZddZddZd d ZZS) ValidationErrorz=Raised when a value doesn't pass validation by its validator.Ncs0tt||||_g|_|r,|j|dS)z Args: message (str): Error message detailing validation failure. parent (str): Adds the parent as the closest reference point for the error. Use :meth:`add_parent` to add more. N)superr__init__message_parentsappend)selfr parent __class__O/tmp/pip-unpacked-wheel-vqb3mfeu/stone/backends/python_rsrc/stone_validators.pyr#s zValidationError.__init__cCs|j|dS)z Args: parent (str): Adds the parent to the top of the tree of references that lead to the validator that failed. N)r r )r r rrr add_parent0szValidationError.add_parentcCs0|jr&dd|jddd|jS|jSdS)z Returns: str: A descriptive message of the validation error that may also include the path to the validator that failed. z{}: {}.N)r formatjoinr r rrr__str__8s zValidationError.__str__cCsdt|S)NzValidationError(%r))six text_typerrrr__repr__CszValidationError.__repr__)N) __name__ __module__ __qualname____doc__rrrr __classcell__rrrrr s   rcCsd|j|jfS)Nz%s.%s)rr)trrrtype_name_with_moduleHsr"cCslt|trdSt|tjrdSt|tjr.dSt|ttfr@dSt|tjrPdS|dkr\dSt t |SdS)zReturn a descriptive type name that isn't Python specific. For example, an int value will return 'integer' rather than 'int'.booleanintegerfloatliststringNnull) isinstanceboolnumbersIntegralRealtupler&r string_typesr"type)vrrrgeneric_type_nameMs    r2c@s0eZdZdZdZeddZddZddZd S) ValidatorzDAll primitive and composite data types should be a subclass of this.)Z_redactcCsdS)zValidates that val is of this data type. Returns: A normalized value if validation succeeds. Raises: ValidationError Nrr valrrrvalidategszValidator.validatecCsdS)NFrrrrr has_defaultoszValidator.has_defaultcCs tddSNzNo default available.)AssertionErrorrrrr get_defaultrszValidator.get_defaultN) rrrr __slots__rr6r7r:rrrrr3cs  r3c@seZdZdZdZdS) Primitivez&A basic type that is defined by Stone.rNrrrrr;rrrrr<vsr<c@seZdZdZddZdS)BooleanrcCst|tstd||S)Nz%r is not a valid boolean)r)r*rr4rrrr6~s  zBoolean.validateN)rrrr;r6rrrrr>{sr>c@s6eZdZdZdZdZdZd ddZddZdd Z dS) Integerz Do not use this class directly. Extend it and specify a 'default_minimum' and 'default_maximum' value as class variables for a more restrictive integer range. minimummaximumNcCs|dk r@t|tjstd||jks8td||jf||_n|j|_|dk rt|tjsdtd||jkstd||jf||_n|j|_dS) A more restrictive minimum or maximum value can be specified than the range inherent to the defined type. Nz$min_value must be an integral numberzGmin_value cannot be less than the minimum value for this type (%d < %d)z$max_value must be an integral numberzJmax_value cannot be greater than the maximum value for this type (%d < %d))r)r+r,r9default_minimumrAdefault_maximumrBr Z min_valueZ max_valuerrrrs,  zInteger.__init__cCsRt|tjstdt|n0|j|kr6|jksNntd||j|jf|S)Nzexpected integer, got %sz%d is not within range [%d, %d])r)r+r,rr2rArBr4rrrr6s  zInteger.validatecCs d|jjSNz%s()rrrrrrrszInteger.__repr__)NN rrrrr;rDrErr6rrrrrr?s  r?c@seZdZdZdZdZdS)Int32riiNrrrr;rDrErrrrrJsrJc@seZdZdZdZdZdS)UInt32rrlNrKrrrrrLsrLc@seZdZdZdZdZdS)Int64rllNrKrrrrrMsrMc@seZdZdZdZdZdS)UInt64rrlNrKrrrrrNsrNc@s6eZdZdZdZdZdZd ddZddZdd Z dS) r-z Do not use this class directly. Extend it and optionally set a 'default_minimum' and 'default_maximum' value to enforce a range that's a subset of the Python float implementation. Python floats are doubles. r@NcCs|dk r~t|tjstdt|tsPz t|}Wntk rNtdYnX|jdk rv||jkrvtd||jf||_n|j|_|dk rt|tjstdt|tsz t|}Wntk rtdYnX|jdk r||jkrtd||jf||_ n|j|_ dS)rCNzmin_value must be a real numberz"min_value is too small for a floatzGmin_value cannot be less than the minimum value for this type (%f < %f)zmax_value must be a real numberz"max_value is too large for a floatzJmax_value cannot be greater than the maximum value for this type (%f < %f)) r)r+r-r9r% OverflowErrorrDrArErBrFrrrrs<     z Real.__init__cCst|tjstdt|t|tsPz t|}Wntk rNtdYnXt|sdt |rptd||j dk r||j krtd||j f|j dk r||j krtd||j f|S)Nzexpected real number, got %sztoo large for floatz%f values are not supportedz%f is not greater than %fz%f is not less than %f) r)r+r-rr2r%rOmathisnanisinfrArBr4rrrr6s(    z Real.validatecCs d|jjSrGrHrrrrrsz Real.__repr__)NNrIrrrrr-s $r-c@s(eZdZdZdddZdddZdS)Float32rge18 &ge18 @NrKrrrrrSs rSc@seZdZdZdS)Float64rN)rrrr;rrrrrVsrVc@s&eZdZdZdZdddZddZdS) StringzRepresents a unicode string.) min_length max_lengthpattern pattern_reNc Cs|dk r,t|tjstd|dks,td|dk rXt|tjsHtd|dksXtd|rp|rp||ksptd|dk rt|tjstd||_||_||_d|_ |rzt d|d |_ Wn:t j k r}ztd ||jdW5d}~XYnXdS) N%min_length must be an integral numberrmin_length must be >= 0%max_length must be an integral numbermax_length must be > 0 max_length must be >= min_lengthzpattern must be a stringz\A(?:z)\ZzRegex {!r} failed: {})r)r+r,r9rr/rXrYrZr[recompileerrorrargs)r rXrYrZerrrr's8zString.__init__cCst|tjs td|t|ftjs\t|tr\z|d}Wntk rZtdYnX|j dk rt ||j krtd||j t |f|j dk rt ||j krtd||j t |f|j r|j |std||j f|S)z A unicode string of the correct length and pattern will pass validation. In PY2, we enforce that a str type must be valid utf-8, and a unicode string will be returned. z$'%s' expected to be a string, got %sutf-8z'%s' was not valid utf-8Nz*'%s' must be at most %d characters, got %dz+'%s' must be at least %d characters, got %dz'%s' did not match pattern '%s')r)rr/rr2PY3strdecodeUnicodeDecodeErrorrYlenrXrZr[matchr4rrrr6Bs,  zString.validate)NNNrrrrr;rr6rrrrrW#s rWc@s"eZdZdZdddZddZdS)Bytes)rXrYNcCs|dk r,t|tjstd|dks,td|dk rXt|tjsHtd|dksXtd|dk rx|dk rx||ksxtd||_||_dS)Nr\rr]r^r_r`)r)r+r,r9rXrY)r rXrYrrrraszBytes.__init__cCst|tstdt|nb|jdk rNt||jkrNtd||jt|fn0|jdk r~t||jkr~td||jt|f|S)Nzexpected bytes type, got %sz''%s' must have at most %d bytes, got %dz$'%s' has fewer than %d bytes, got %d)r) _binary_typesrr2rYrkrXr4rrrr6ps zBytes.validate)NN)rrrr;rr6rrrrrn^s rnc@s$eZdZdZdZddZddZdS) TimestampzNote that while a format is specified, it isn't used in validation since a native Python datetime object is preferred. The format, however, can and should be used by serializers.)rcCst|tjstd||_dS)zzfmt must be composed of format codes that the C standard (1989) supports, most notably in its strftime() function.zformat must be a stringN)r)rrr9r)r fmtrrrrszTimestamp.__init__cCsHt|tjstdt|n&|jdk rD|j|dkrDtd|S)Nzexpected timestamp, got %srz>timestamp should have either a UTC timezone or none set at all)r)datetimerr2tzinfo utcoffset total_secondsr4rrrr6s  zTimestamp.validateNrmrrrrrp}srpc@seZdZdZdZdS) CompositezLValidator for a type that builds on other primitive and composite types.rNr=rrrrrvsrvc@s&eZdZdZdZdddZddZdS) Listz= 0z$max_items must be an integral numberzmax_items must be > 0zmax_items must be >= min_items)rxr)r+r,r9ryrz)r rxryrzrrrrsz List.__init__cst|ttfstd|nVjdk rHt|jkrHtd|jfn*jdk rrt|jkrrtd|jffdd|DS)Nz%r is not a valid listz%r has more than %s itemsz%r has fewer than %s itemscsg|]}j|qSr)rxr6).0itemrrr sz!List.validate..)r)r.r&rrzrkryr4rrrr6sz List.validate)NNrmrrrrrws rwc@s$eZdZdZdZddZddZdS)MapzBAssumes map keys and values are homogeneous with respect to types. key_validatorvalue_validatorcCs||_||_dS)z Every Map key/value pair will be validated with item_validator. key validators must be a subclass of a String validator Nr)r rrrrrrsz Map.__init__cs,t|tstd|fdd|DS)Nz%r is not a valid dictcs&i|]\}}j|j|qSr)rr6r)r{keyvaluerrr s z Map.validate..)r)dictritemsr4rrrr6s    z Map.validateNrmrrrrr~sr~csXeZdZdZfddZddZddZdd Zd d Zd d Z ddZ ddZ Z S)Struct definitioncstt|||_dS)a Args: definition (class): A generated class representing a Stone struct from a spec. Must have a _fields_ attribute with the following structure: _fields_ = [(field_name, validator), ...] where field_name: Name of the field (str). validator: Validator object. N)rrrrr rrrrrs zStruct.__init__cCs|||||S)z} For a val to pass validation, val must be of the correct type and have all required fields present. )validate_type_onlyvalidate_fields_onlyr4rrrr6s  zStruct.validatecCs||||||S)z For a val to pass validation, val must be of the correct type and have all required permissioned fields present. Should only be called for callers with extra permissions. )r6%validate_fields_only_with_permissions)r r5caller_permissionsrrrvalidate_with_permissionss  z Struct.validate_with_permissionscCs(|jjD]}t||std|qdS)ao To pass field validation, no required field should be missing. This method assumes that the contents of each field have already been validated on assignment, so it's merely a presence check. FIXME(kelkabany): Since the definition object does not maintain a list of which fields are required, all fields are scanned. missing required field '%s'N)rZ_all_field_names_hasattrr)r r5 field_namerrrrs  zStruct.validate_fields_onlycCsP|||jD]:}d|}t|j|tD]}t||s.td|q.qdS)a" To pass field validation, no required field should be missing. This method assumes that the contents of each field have already been validated on assignment, so it's merely a presence check. Should only be called for callers with extra permissions. z_all_{}_field_names_rN)r permissionsrgetattrrsetrr)r r5rZextra_permissionZall_field_namesrrrrrs     z,Struct.validate_fields_only_with_permissionscCs*t||js&tdt|jt|fdS)z Use this when you only want to validate that the type of an object is correct, but not yet validate each field. zexpected type %s, got %sN)r)rrr"r2r4rrrrs zStruct.validate_type_onlycCs |jj SN)r_has_required_fieldsrrrrr7&szStruct.has_defaultcCs|jjrtd|Sr8)rrr9rrrrr:)szStruct.get_default) rrrr;rr6rrrrr7r:r rrrrrs   rcs$eZdZdZdZfddZZS) StructTreezValidator for structs with enumerated subtypes. NOTE: validate_fields_only() validates the fields known to this base struct, but does not do any validation specific to the subtype. rcstt||dSr)rrrrrrrr8szStructTree.__init__)rrrrr;rr rrrrr.src@s(eZdZdZddZddZddZdS) UnionrcCs ||_dS)a Args: definition (class): A generated class representing a Stone union from a spec. Must have a _tagmap attribute with the following structure: _tagmap = {field_name: validator, ...} where field_name (str): Tag name. validator (Validator): Tag value validator. Nrrrrrr?s zUnion.__init__cCs*||t|dr|jdkr&td|S)z For a val to pass validation, it must have a _tag set. This assumes that the object validated that _tag is a valid tag, and that any associated value has also been validated. _tagNz no tag set)rrrrr4rrrr6Ns zUnion.validatecCs.t|jt|s*tdt|jt|fdS)a Use this when you only want to validate that the type of an object is correct, but not yet validate each field. We check whether val is a Python parent class of the definition. This is because Union subtyping works in the opposite direction of Python inheritance. For example, if a union U2 extends U1 in Python, this validator will accept U1 in places where U2 is expected. z#expected type %s or subtype, got %sN) issubclassrr0rr"r2r4rrrrYs zUnion.validate_type_onlyN)rrrr;rr6rrrrrr<s rc@s(eZdZdZddZddZddZdS) VoidrcCs|dk rtdt|dS)Nzexpected NoneType, got %s)rr2r4rrrr6osz Void.validatecCsdSNTrrrrrr7tszVoid.has_defaultcCsdSrrrrrrr:wszVoid.get_defaultN)rrrr;r6r7r:rrrrrlsrcs@eZdZdZfddZddZddZdd Zd d ZZ S) Nullable) validatorcsRtt|t|ttfs$tdt|tr6tdt|trHtd||_dS)Nz3validator must be for a primitive or composite typeznullables cannot be stackedzvoid cannot be made nullable) rrrr)r<rvr9rr)r rrrrr~s  zNullable.__init__cCs|dkr dS|j|SdSr)rr6r4rrrr6szNullable.validatecCs|dkr dS|j|SdS)z2Use this only if Nullable is wrapping a Composite.N)rrr4rrrrszNullable.validate_type_onlycCsdSrrrrrrr7szNullable.has_defaultcCsdSrrrrrrr:szNullable.get_default) rrrr;rr6rr7r:r rrrrr{s  rc@s,eZdZdZddZeddZddZdS) RedactorregexcCs ||_dS)zM Args: regex: What parts of the field to redact. Nr)r rrrrrszRedactor.__init__cCsdS)znRedacts information from annotated field. Returns: A redacted version of the string provided. Nrr4rrrapplyszRedactor.applycCs6|js dSzt|j|WStk r0YdSXdSr)rrasearch TypeErrorr4rrr _get_matchess zRedactor._get_matchesN)rrrr;rrrrrrrrrs  rc@seZdZdZddZdS) HashRedactorrc Cs||}t|tst|tr&t|n|}zt|dd}Wnt t gk rbd}YnX|rd | }|rd ||S|S|S)Nrf***z{} ({}))rr)intr%rhhashlibmd5encode hexdigestAttributeError ValueErrorrgroupsr)r r5matchesZ val_to_hashhashedZblottedrrrrs    zHashRedactor.applyNrrrr;rrrrrrsrc@seZdZdZddZdS) BlotRedactorrcCs ||}|rd|SdS)Nrz********)rrr)r r5rrrrrs zBlotRedactor.applyNrrrrrrsr)3r __future__rrrrrrPr+raabcrrrZ_MYPYtypingrgbytes memoryviewrobuffer Exceptionrr"r2with_metaclassobjectr3r<r>r?rJrLrMrNr-rSrVrWrnrprvrwr~rrrrrrrrrrrrsT ( /H;!^0!