App Engine Python SDK  v1.6.9 rev.445
The Python runtime is available as an experimental Preview feature.
Public Member Functions | Public Attributes | List of all members
google.appengine.cron.groctimespecification.SpecificTimeSpecification Class Reference
Inheritance diagram for google.appengine.cron.groctimespecification.SpecificTimeSpecification:
google.appengine.cron.groctimespecification.TimeSpecification

Public Member Functions

def __init__
 
def GetMatch
 
- Public Member Functions inherited from google.appengine.cron.groctimespecification.TimeSpecification
def GetMatches
 
def GetMatch
 

Public Attributes

 ordinals
 
 weekdays
 
 months
 
 monthdays
 
 time
 
 timezone
 

Detailed Description

Specific time specification.

A Specific interval is more complex, but defines a certain time to run and
the days that it should run. It has the following attributes:
time     - the time of day to run, as 'HH:MM'
ordinals - first, second, third &c, as a set of integers in 1..5
months   - the months that this should run, as a set of integers in 1..12
weekdays - the days of the week that this should run, as a set of integers,
           0=Sunday, 6=Saturday
timezone - the optional timezone as a string for this specification.
           Defaults to UTC - valid entries are things like Australia/Victoria
           or PST8PDT.

A specific time schedule can be quite complex. A schedule could look like
this:
'1st,third sat,sun of jan,feb,mar 09:15'

In this case, ordinals would be {1,3}, weekdays {0,6}, months {1,2,3} and
time would be '09:15'.

Member Function Documentation

def google.appengine.cron.groctimespecification.SpecificTimeSpecification.GetMatch (   self,
  start 
)
Returns the next match after time start.

Must be implemented in subclasses.

Arguments:
  start: a datetime to start from. Matches will start from after this time.
  This may be in any pytz time zone, or it may be timezone-naive
  (interpreted as UTC).

Returns:
  a datetime object in the timezone of the input 'start'

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