google.appengine.api.validation.Repeated

Repeated field validator.

Inherits From: Validator, expected_type

google.appengine.api.validation.Repeated(
    constructor, default=None
)

Indicates that attribute is expected to be a repeated value, ie, a sequence. This adds additional validation over just Type(list) in that it retains information about what can be stored in the list by use of its constructor field.

constructor Type used for verifying elements of sequence attribute.

Child Classes

class expected_type

Methods

CheckFieldInitialized

View source

CheckFieldInitialized(
    value, key, obj
)

Check for missing fields or conflicts between fields.

Default behavior performs a simple None-check, but this can be overridden. If the intent is to allow optional fields, then use the Optional validator instead.

Args
value Value to validate.
key Name of the field being validated.
obj The object to validate against.

Raises
ValidationError When there are missing or conflicting fields.

GetWarnings

View source

GetWarnings(
    value, key, obj
)

Return any warnings on this attribute.

Validates the value with an eye towards things that aren't fatal problems.

Args
value Value to validate.
key Name of the field being validated.
obj The object to validate against.

Returns
A list of tuples (context, warning) where

  • Context is the field (or dotted field path, if a sub-field)
  • Warning is the string warning text

ToValue

View source

ToValue(
    value
)

Convert value to a simplified collection or basic type.

Subclasses of Validator should override this method when the dumped representation of value is not a simple <type>(value) (e.g., a regex).

Args
value An object of the same type that was returned from Validate().

Returns
An instance of a builtin type (e.g., int, str, dict, etc). By default it returns value unmodified.

Validate

View source

Validate(
    value, key
)

Do validation of sequence.

Value must be a list and all elements must be of type constructor.

Args
value Value to validate.
key Name of the field being validated.

Raises
ValidationError if value is None, not a list or one of its elements is the wrong type.

__call__

View source

__call__(
    value, key='???'
)

Main interface to validator is call mechanism.