App Engine Python SDK  v1.6.9 rev.445
The Python runtime is available as an experimental Preview feature.
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
google.appengine.ext.db.UserProperty Class Reference
Inheritance diagram for google.appengine.ext.db.UserProperty:
google.appengine.ext.db.Property google.appengine.ext.db.djangoforms.UserProperty

Public Member Functions

def __init__
 
def validate
 
def default_value
 
def get_updated_value_for_datastore
 
- Public Member Functions inherited from google.appengine.ext.db.Property
def __init__
 
def __property_config__
 
def __get__
 
def __set__
 
def default_value
 
def validate
 
def empty
 
def get_value_for_datastore
 
def get_updated_value_for_datastore
 
def make_value_from_datastore_index_value
 
def make_value_from_datastore
 
def datastore_type
 

Public Attributes

 auto_current_user
 
 auto_current_user_add
 
- Public Attributes inherited from google.appengine.ext.db.Property
 verbose_name
 
 name
 
 default
 
 required
 
 validator
 
 choices
 
 indexed
 
 creation_counter
 
 model_class
 

Static Public Attributes

 data_type = users.User
 
- Static Public Attributes inherited from google.appengine.ext.db.Property
int creation_counter = 0
 
 data_type = str
 

Detailed Description

A user property.

Constructor & Destructor Documentation

def google.appengine.ext.db.UserProperty.__init__ (   self,
  verbose_name = None,
  name = None,
  required = False,
  validator = None,
  choices = None,
  auto_current_user = False,
  auto_current_user_add = False,
  indexed = True 
)
Initializes this Property with the given options.

Note: this does *not* support the 'default' keyword argument.
Use auto_current_user_add=True instead.

Args:
  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.
  required: Whether property is required.
  validator: User provided method used for validation.
  choices: User provided set of valid property values.
  auto_current_user: If true, the value is set to the current user
each time the entity is written to the datastore.
  auto_current_user_add: If true, the value is set to the current user
the first time the entity is written to the datastore.
  indexed: Whether property is indexed.

Member Function Documentation

def google.appengine.ext.db.UserProperty.default_value (   self)
Default value for user.

Returns:
  Value of users.get_current_user() if auto_current_user or
  auto_current_user_add is set; else None. (But *not* the default
  implementation, since we don't support the 'default' keyword
  argument.)
def google.appengine.ext.db.UserProperty.get_updated_value_for_datastore (   self,
  model_instance 
)
Get new value for property to send to datastore.

Returns:
  Value of users.get_current_user() if auto_current_user is set;
  else AUTO_UPDATE_UNCHANGED.
def google.appengine.ext.db.UserProperty.validate (   self,
  value 
)
Validate user.

Returns:
  A valid value.

Raises:
  BadValueError if property is not instance of 'User'.

The documentation for this class was generated from the following file: