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

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
 

Static Public Member Functions

def now
 

Public Attributes

 auto_now
 
 auto_now_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 = datetime.datetime
 
- Static Public Attributes inherited from google.appengine.ext.db.Property
int creation_counter = 0
 
 data_type = str
 

Detailed Description

The base class of all of our date/time properties.

We handle common operations, like converting between time tuples and
datetime instances.

Constructor & Destructor Documentation

def google.appengine.ext.db.DateTimeProperty.__init__ (   self,
  verbose_name = None,
  auto_now = False,
  auto_now_add = False,
  kwds 
)
Construct a DateTimeProperty

Args:
  verbose_name: Verbose name is always first parameter.
  auto_now: Date/time property is updated with the current time every time
it is saved to the datastore.  Useful for properties that want to track
the modification time of an instance.
  auto_now_add: Date/time is set to the when its instance is created.
Useful for properties that record the creation time of an entity.

Member Function Documentation

def google.appengine.ext.db.DateTimeProperty.default_value (   self)
Default value for datetime.

Returns:
  value of now() as appropriate to the date-time instance if auto_now
  or auto_now_add is set, else user configured default value implementation.
def google.appengine.ext.db.DateTimeProperty.get_updated_value_for_datastore (   self,
  model_instance 
)
Get new value for property to send to datastore.

Returns:
  now() as appropriate to the date-time instance in the odd case where
  auto_now is set to True, else AUTO_UPDATE_UNCHANGED.
def google.appengine.ext.db.DateTimeProperty.now ( )
static
Get now as a full datetime value.

Returns:
  'now' as a whole timestamp, including both time and date.
def google.appengine.ext.db.DateTimeProperty.validate (   self,
  value 
)
Validate datetime.

Returns:
  A valid value.

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

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