Python 3.9 is now generally available.

google.appengine.ext.db.IntegerProperty

An integer property.

Inherits From: Property, expected_type

verbose_name User friendly name of property.
name Storage name for property. By default, uses attribute name as it is assigned in the Model sub-class.
default Default value for property if none is assigned.
required Whether property is required.
validator User provided method used for validation.
choices User provided set of valid property values.
indexed Whether property is indexed.

Child Classes

class data_type

Methods

datastore_type

View source

Deprecated backwards-compatible accessor method for self.data_type.

default_value

View source

Default value for unassigned values.

Returns
Default value as provided by __init__(default).

empty

View source

Is integer property empty.

0 is not an empty value.

Returns
True if value is None, else False.

get_updated_value_for_datastore

View source

Determine new value for auto-updated property.

Some properies (e.g. DateTimeProperty, UserProperty) optionally update their value on every put(). This call must return the new desired value for such properties. For all other properties, this call must return AUTO_UPDATE_UNCHANGED.

Args
model_instance Instance to get new value for.

Returns
Datastore representation of the new model value in a form that is appropriate for storing in the datastore, or AUTO_UPDATE_UNCHANGED.

get_value_for_datastore

View source

Datastore representation of this property.

Looks for this property in the given model instance, and returns the proper datastore representation of the value that can be stored in a datastore entity. Most critically, it will fetch the datastore key value for reference properties.

Some properies (e.g. DateTimeProperty, UserProperty) optionally update their value on every put(). This call must return the current value for such properties (get_updated_value_for_datastore returns the new value).

Args
model_instance Instance to fetch datastore value from.

Returns
Datastore representation of the model value in a form that is appropriate for storing in the datastore.

make_value_from_datastore

View source

Native representation of this property.

Given a value retrieved from a datastore entity, return a value, possibly converted, to be stored on the model instance. Usually this returns the value unchanged, but a property class may override this when it uses a different datatype on the model instance than on the entity.

This API is not quite symmetric with get_value_for_datastore(), because the model instance on which to store the converted value may not exist yet -- we may be collecting values to be passed to a model constructor.

Args
value Value retrieved from the datastore entity.

Returns
The value converted for use as a model instance attribute.

make_value_from_datastore_index_value

View source

validate

View source

Validate integer property.

Returns
A valid value.

Raises
BadValueError if value is not an integer or long instance.

creation_counter 2