Notice: Over the next few months, we're reorganizing the App Engine documentation site to make it easier to find content and better align with the rest of Google Cloud products. The same content will be available, but the navigation will now match the rest of the Cloud products.

Python 3.10 is now available in preview.

google.appengine.api.validation.StringValidator

Verifies property is a valid text string.

Inherits From: Validator, expected_type

  • In python 2: inherits from basestring.
  • In python 3: inherits from str.

default Default assignment is made during initialization and will not pass through validation.

Child Classes

class expected_type

Methods

CheckFieldInitialized

View source

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

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

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 this field. Override to customize subclass behavior.

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

Returns
Value if value is valid, or a valid representation of value.

__call__

View source

Main interface to validator is call mechanism.