Package s3 :: Module s3validators :: Class IS_UTC_DATETIME

Class IS_UTC_DATETIME

gluon.validators.Validator --+
                             |
                            IS_UTC_DATETIME

Validates a given date/time and returns it as timezone-naive datetime object in UTC. Accepted input types are strings (in local format), datetime.datetime and datetime.date.

Example:

INPUT(_type="text", _name="name", requires=IS_UTC_DATETIME())

Notes:

a date/time string must be in local format, and can have an optional trailing UTC offset specified as +/-HHMM (+ for eastern, - for western timezones)
dates stretch 8 hours West and 16 hours East of the current time zone, i.e. the most Eastern timezones are on the next day.

Instance Methods

__init__(self, format=None, error_message=None, offset_error=None, utc_offset=None, calendar=None, minimum=None, maximum=None)
Constructor

source code

delta(self, utc_offset=None)
Compute the delta in seconds for the current UTC offset

source code

__call__(self, value)
Validate a value, and convert it into a timezone-naive datetime.datetime object as necessary

source code

formatter(self, value)
Format a datetime as string.

source code

Method Details

init(self, format=None, error_message=None, offset_error=None, utc_offset=None, calendar=None, minimum=None, maximum=None)
(Constructor)

source code

Constructor

Parameters:

format - strptime/strftime format template string, for directives refer to your strptime implementation
error_message - error message for invalid date/times
offset_error - error message for invalid UTC offset
utc_offset - offset to UTC in hours, defaults to the current session's UTC offset
calendar - calendar to use for string evaluation, defaults to current.calendar
minimum - the minimum acceptable date/time
maximum - the maximum acceptable date/time

delta(self, utc_offset=None)

source code

Compute the delta in seconds for the current UTC offset

Parameters:

utc_offset - the offset (override defaults)

Returns:

the offset in seconds

call(self, value)
(Call operator)

source code

Validate a value, and convert it into a timezone-naive datetime.datetime object as necessary

Parameters:

value - the value to validate

Returns:

tuple (value, error)

formatter(self, value)

source code

Format a datetime as string.

Parameters:

value - the value

Class IS_UTC_DATETIME

__init__(self, format=None, error_message=None, offset_error=None, utc_offset=None, calendar=None, minimum=None, maximum=None) (Constructor)

delta(self, utc_offset=None)

__call__(self, value) (Call operator)

formatter(self, value)

init(self, format=None, error_message=None, offset_error=None, utc_offset=None, calendar=None, minimum=None, maximum=None)
(Constructor)

call(self, value)
(Call operator)