google.appengine.api.datastore_types module

Bases: google.appengine.api.datastore_types._BaseByteType

A blob type, appropriate for storing binary data of any length.

This behaves identically to the Python str type, except for the constructor, which only accepts str arguments.

Bases: object

Key used to identify a blob in Blobstore.

This object wraps a string that gets used internally by the Blobstore API to identify application blobs. The BlobKey corresponds to the entity name of the underlying BlobReference entity.

This class is exposed in the API in both google.appengine.ext.db and google.appengine.ext.blobstore.

Bases: google.appengine.api.datastore_types._BaseByteType

A byte-string type, appropriate for storing short amounts of indexed data.

This behaves identically to Blob, except it’s used only for short, indexed byte strings.

Bases: unicode

A tag, ie a descriptive word or phrase. Entities may be tagged by users, and later returned by a queries for that tag. Tags can also be used for ranking results (frequency), photo captions, clustering, activity, etc.

Here’s a more in-depth description: http://www.zeldman.com/daily/0405d.shtml

This is the Atom “category” element. In XML output, the tag is provided as the term attribute. See: http://www.atomenabled.org/developers/syndication/#category

Raises BadValueError if tag is not a string or subtype.

Converts a datetime.datetime to microseconds since the epoch, as a float. :param value: datetime.datetime

Returns: value as a long

Decodes app_namespace_str into an (app_id, namespace) pair.

This method is the reverse of EncodeAppIdNamespace and is needed for datastore_file_stub.

app_namespace_str – An encoded app_id, namespace pair created by EncodeAppIdNamespace

(app_id, namespace) pair encoded in app_namespace_str

Bases: unicode

An RFC2822 email address. Makes no attempt at validation; apart from checking MX records, email address validation is a rathole.

This is the gd:email element. In XML output, the email address is provided as the address attribute. See: https://developers.google.com/gdata/docs/1.0/elements#gdEmail

Raises BadValueError if email is not a valid email address.

Bases: google.appengine.api.datastore_types._BaseByteType

A proto encoded EntityProto.

This behaves identically to Blob, except for the constructor, which accepts a str or EntityProto argument.

Can be decoded using datastore.Entity.FromProto(), db.model_from_protobuf() or ndb.LocalStructuredProperty.

Concatenates app id and namespace into a single string.

This method is needed for xml and datastore_file_stub.

• app_id – The application id to encode

• namespace – The namespace to encode

The string encoding for the app_id, namespace pair.

Converts a property PB to a python value.

pb – entity_pb.Property

# return type is determined by the type of the argument string, int, bool, double, users.User, or one of the atom or gd types

Returns the python type given a type name.

type_name – A string representation of a datastore type name.

A python type.

Converts a reference PropertyValue to a Key.

value – entity_pb.PropertyValue

Key

BadValueError if the value is not a PropertyValue.

Bases: object

A geographical point, specified by floating-point latitude and longitude coordinates. Often used to integrate with mapping sites like Google Maps. May also be used as ICBM coordinates.

This is the georss:point element. In XML output, the coordinates are provided as the lat and lon attributes. See: http://georss.org/

Serializes to ‘<lat>,<lon>’. Raises BadValueError if it’s passed an invalid serialized string, or if lat and lon are not valid floating points in the ranges [-90, 90] and [-180, 180], respectively.

Returns the tag constant associated with the given entity_pb.PropertyValue.

Bases: object

An instant messaging handle. Includes both an address and its protocol. The protocol value is either a standard IM scheme or a URL identifying the IM network for the protocol. Possible values include:

Value Description sip SIP/SIMPLE unknown Unknown or unspecified xmpp XMPP/Jabber http://aim.com/ AIM http://icq.com/ ICQ http://talk.google.com/ Google Talk http://messenger.msn.com/ MSN Messenger http://messenger.yahoo.com/ Yahoo Messenger http://sametime.com/ Lotus Sametime http://gadu-gadu.pl/ Gadu-Gadu

This is the gd:im element. In XML output, the address and protocol are provided as the address and protocol attributes, respectively. See: https://developers.google.com/gdata/docs/1.0/elements#gdIm

Serializes to ‘<protocol> <address>’. Raises BadValueError if tag is not a standard IM scheme or a URL.

Bases: object

The primary key for a datastore entity.

A datastore GUID. A Key instance uniquely identifies an entity across all apps, and includes all information necessary to fetch the entity from the datastore with Get().

Key implements __hash__, and key instances are immutable, so Keys may be used in sets and as dictionary keys.

Bases: unicode

A fully qualified URL. Usually http: scheme, but may also be file:, ftp:, news:, among others.

If you have email (mailto:) or instant messaging (aim:, xmpp:) links, consider using the Email or IM classes instead.

This is the Atom “link” element. In XML output, the link is provided as the href attribute. See: http://www.atomenabled.org/developers/syndication/#link

Raises BadValueError if link is not a fully qualified, well-formed URL.

Packs a Blob property into a entity_pb.PropertyValue.

• name – The name of the property as a string.

• value – A Blob instance.

• pbvalue – The entity_pb.PropertyValue to pack this value into.

Packs a boolean property into a entity_pb.PropertyValue.

• name – The name of the property as a string.

• value – A boolean instance.

• pbvalue – The entity_pb.PropertyValue to pack this value into.

Packs a datetime-typed property into a entity_pb.PropertyValue.

• name – The name of the property as a string.

• value – A datetime.datetime instance.

• pbvalue – The entity_pb.PropertyValue to pack this value into.

Packs a float property into a entity_pb.PropertyValue.

• name – The name of the property as a string.

• value – A float instance.

• pbvalue – The entity_pb.PropertyValue to pack this value into.

Packs a GeoPt property into a entity_pb.PropertyValue.

• name – The name of the property as a string.

• value – A GeoPt instance.

• pbvalue – The entity_pb.PropertyValue to pack this value into.

Packs an integer property into a entity_pb.PropertyValue.

• name – The name of the property as a string.

• value – An int or long instance.

• pbvalue – The entity_pb.PropertyValue to pack this value into.

Packs a reference property into a entity_pb.PropertyValue.

• name – The name of the property as a string.

• value – A Key instance.

• pbvalue – The entity_pb.PropertyValue to pack this value into.

Packs a string-typed property into a entity_pb.PropertyValue.

• name – The name of the property as a string.

• value – A string, unicode, or string-like value instance.

• pbvalue – The entity_pb.PropertyValue to pack this value into.

Packs a User property into a entity_pb.PropertyValue.

• name – The name of the property as a string.

• value – A users.User instance.

• pbvalue – The entity_pb.PropertyValue to pack this value into.

Equivalent to python2.5 str.partition()

TODO use str.partition() when python 2.5 is adopted.

• value – String to be partitioned

• separator – Separator string

Bases: unicode

A human-readable phone number or address.

No validation is performed. Phone numbers have many different formats - local, long distance, domestic, international, internal extension, TTY, VOIP, SMS, and alternative networks like Skype, XFire and Roger Wilco. They all have their own numbering and addressing formats.

This is the gd:phoneNumber element. In XML output, the phone number is provided as the text of the element. See: https://developers.google.com/gdata/docs/1.0/elements#gdPhoneNumber

Raises BadValueError if phone is not a string or subtype.

Bases: unicode

A human-readable mailing address. Again, mailing address formats vary widely, so no validation is performed.

This is the gd:postalAddress element. In XML output, the address is provided as the text of the element. See: https://developers.google.com/gdata/docs/1.0/elements#gdPostalAddress

Raises BadValueError if address is not a string or subtype.

Returns the name of the type of the given property value, as a string.

Raises BadValueError if the value is not a valid property type.

value – any valid property value

string

Returns an instance of a property value given a type and string value.

The reverse of this method is just str() and type() of the python value.

Note that this does not support non-UTC offsets in ISO 8601-formatted datetime strings, e.g. the -08:00 suffix in ‘2002-12-25 00:00:00-08:00’. It only supports -00:00 and +00:00 suffixes, which are UTC.

• type – A python class.

• value_string – A string representation of the value of the property.

An instance of ‘type’.

ValueError if type_ is datetime and value_string has a timezone offset.

Converts a entity_pb.PropertyValue into a comparable hashable “key” value.

The values produces by this function mimic the native ording of the datastore and uniquely identify the given PropertyValue.

prop_value – The entity_pb.PropertyValue from which to construct the key value.

A comparable and hashable representation of the given property value.

Bases: long

A user-provided integer rating for a piece of content. Normalized to a 0-100 scale.

This is the gd:rating element. In XML output, the address is provided as the text of the element. See: https://developers.google.com/gdata/docs/1.0/elements#gdRating

Serializes to the decimal string representation of the rating. Raises BadValueError if the rating is not an integer in the range [0, 100].

Converts a key into a comparable hashable “key” value.

• key – The entity_pb.Reference or googledatastore.Key from which to construct the key value.

• id_resolver – An optional datastore_pbs.IdResolver. Only necessary for googledatastore.Key values.

A comparable and hashable representation of the given key that is compatible with one derived from a key property value.

Validate app id, providing a default.

If the argument is None, $APPLICATION_ID is substituted.

app – The app id argument value to be validated.

The value of app, or the substituted default. Always a non-empty string.

BadArgumentError if the value is empty or not a string.

Validate app namespace, providing a default.

If the argument is None, namespace_manager.get_namespace() is substituted.

namespace – The namespace argument value to be validated.

The value of namespace, or the substituted default. The empty string is used to denote the empty namespace.

BadArgumentError if the value is not a string.

Restores a index value to the correct datastore type.

Projection queries return property values direclty from a datastore index. These values are the native datastore values, one of str, bool, long, float, GeoPt, Key or User. This function restores the original value when the original type is known.

This function returns the value type returned when decoding a normal entity, not necessarily of type data_type. For example, data_type=int returns a long instance.

• index_value – The value returned by FromPropertyPb for the projected property.

• data_type – The type of the value originally given to ToPropertyPb

The restored property value.

datastore_errors.BadValueError if the value cannot be restored.

Sets the namespace for a protocol buffer or clears the field.

• proto – the protocol buffer to update

• namespace – the new namespace (None or an empty string will clear out the field).

Bases: unicode

A long string type.

Strings of any length can be stored in the datastore using this type. It behaves identically to the Python unicode type, except for the constructor, which only accepts str and unicode arguments.

Creates type-specific entity_pb.PropertyValues.

Determines the type and meaning of the PropertyValue based on the Python type of the input value(s).

NOTE: This function does not validate anything!

• name – string or unicode; the property name

• values – The values for this property, either a single one or a list of them. All values must be a supported type. Lists of values must all be of the same type.

A list of entity_pb.Property instances.

Bases: datetime.tzinfo

Raises an exception if value is not a valid integer.

An integer is valid if it’s not negative or empty and is an integer (either int or long). The exception type raised can be specified with the exception argument; it defaults to BadValueError.

• value – the value to validate.

• name – the name of this value; used in the exception message.

• exception – the type of exception to raise.

• empty_ok – allow None value.

• zero_ok – allow zero value.

• negative_ok – allow negative value.

Helper function for validating property values.

• name – Name of the property this is for.

• value – Value for the property as a Python native type.

• read_only – deprecated

• BadPropertyError if the property name is invalid. BadValueError if the

• property did not validate correctly or the value was an empty list. Other

• exception types (like OverflowError) if the property value does not meet

• type-specific criteria.

Raises an exception if the supplied integer is invalid.

• name – Name of the property this is for.

• value – Integer value.

OverflowError if the value does not fit within a signed int64.

Raises an exception if the supplied datastore.Key instance is invalid.

• name – Name of the property this is for.

• value – A datastore.Key instance.

datastore_errors.BadValueError if the value is invalid.

Validates the length of an indexed Link property.

• name – Name of the property this is for.

• value – String value.

No-op validation function.

• name – Name of the property this is for.

• value – Not used.

Validates the length of an indexed string property.

• name – Name of the property this is for.

• value – String value.

Helper function for validating property values.

• name – Name of the property this is for.

• value – Value for the property as a Python native type.

• read_only – deprecated

• BadPropertyError if the property name is invalid. BadValueError if the

• property did not validate correctly or the value was an empty list. Other

• exception types (like OverflowError) if the property value does not meet

• type-specific criteria.

Raises an exception if value is not a valid string or a subclass thereof.

A string is valid if it’s not empty, no more than _MAX_STRING_LENGTH bytes, and not a Blob. The exception type can be specified with the exception argument; it defaults to BadValueError.

• value – the value to validate.

• name – the name of this value; used in the exception message.

• exception – the type of exception to raise.

• max_len – the maximum allowed length, in bytes.

• empty_ok – allow empty value.

Raises an exception if the supplied string is too long.

• name – Name of the property this is for.

• value – String value.

• max_len – Maximum length the string may be.

OverflowError if the value is larger than the maximum length.

Returns the type of obj as a string. More descriptive and specific than type(obj), and safe for any object, unlike __class__.