Skip to content

Z
Zope
Commit ecd8674c authored by Philipp von Weitershausen's avatar Philipp von Weitershausen
Browse files
Options

Convert DateTime.txt to reST and a (pretty extensive) doctest.

parent 3159cf5b
Hide whitespace changes
Inline Side-by-side
Showing with 772 additions and 536 deletions
lib/python/DateTime/DateTime.txt
View file @ ecd8674c
DateTime ====================
The DateTime package
Encapsulation of date/time values ====================
Encapsulation of date/time values.
Function Timezones()
====================
Returns the list of recognized timezone names:
>>> from DateTime import Timezones
>>> Timezones() # doctest: +ELLIPSIS
['Brazil/Acre', 'Brazil/DeNoronha', ..., 'NZST', 'IDLE']
Module Functions
Timezones()
Return the list of recognized timezone names
Class DateTime Class DateTime
==============
DateTime objects represent instants in time and provide interfaces for DateTime objects represent instants in time and provide interfaces for
controlling its representation without affecting the absolute value of the controlling its representation without affecting the absolute value of
object. the object.
DateTime objects may be created from a wide variety of string or numeric data, DateTime objects may be created from a wide variety of string or
or may be computed from other DateTime objects. DateTimes support the ability numeric data, or may be computed from other DateTime objects.
to convert their representations to many major timezones, as well as the DateTimes support the ability to convert their representations to many
ablility to create a DateTime object in the context of a given timezone. major timezones, as well as the ablility to create a DateTime object
in the context of a given timezone.
DateTime objects provide partial numerical behavior: DateTime objects provide partial numerical behavior:
* Two date-time objects can be subtracted to obtain a time, in days between * Two date-time objects can be subtracted to obtain a time, in days
the two. between the two.
* A date-time object and a positive or negative number may be added to obtain * A date-time object and a positive or negative number may be added to
a new date-time object that is the given number of days later than the obtain a new date-time object that is the given number of days later
input date-time object. than the input date-time object.
* A positive or negative number and a date-time object may be added to obtain * A positive or negative number and a date-time object may be added to
a new date-time object that is the given number of days later than the obtain a new date-time object that is the given number of days later
input date-time object. than the input date-time object.
* A positive or negative number may be subtracted from a date-time object to * A positive or negative number may be subtracted from a date-time
obtain a new date-time object that is the given number of days earlier than object to obtain a new date-time object that is the given number of
the input date-time object. days earlier than the input date-time object.
DateTime objects may be converted to integer, long, or float numbers of days DateTime objects may be converted to integer, long, or float numbers
since January 1, 1901, using the standard int, long, and float functions of days since January 1, 1901, using the standard int, long, and float
(Compatibility Note: int, long and float return the number of days since 1901 functions (Compatibility Note: int, long and float return the number
in GMT rather than local machine timezone). DateTime objects also provide of days since 1901 in GMT rather than local machine timezone).
access to their value in a float format usable with the python time module, DateTime objects also provide access to their value in a float format
provided that the value of the object falls in the range of the epoch-based usable with the python time module, provided that the value of the
time module. object falls in the range of the epoch-based time module.
A DateTime object should be considered immutable; all conversion and numeric A DateTime object should be considered immutable; all conversion and numeric
operations return a new DateTime object rather than modify the current object. operations return a new DateTime object rather than modify the current object.
Constructor For DateTime A DateTime object always maintains its value as an absolute UTC time,
and is represented in the context of some timezone based on the
DateTime() arguments used to create the object. A DateTime object's methods
return values based on the timezone context.
Return a new date-time object
Note that in all cases the local machine timezone is used for
A DateTime object always maintains its value as an absolute UTC time, representation if no timezone is specified.
and is represented in the context of some timezone based on the
arguments used to create the object. A DateTime object's methods return Constructor for DateTime
values based on the timezone context. ------------------------
Note that in all cases the local machine timezone is used for DateTime() returns a new date-time object. DateTimes may be created
representation if no timezone is specified. with from zero to seven arguments:
DateTimes may be created with from zero to seven arguments. * If the function is called with no arguments, then the current date/
time is returned, represented in the timezone of the local machine.
o If the function is called with no arguments, then the current date/
time is returned, represented in the timezone of the local machine. * If the function is invoked with a single string argument which is a
recognized timezone name, an object representing the current time is
o If the function is invoked with a single string argument which is a returned, represented in the specified timezone.
recognized timezone name, an object representing the current time
is returned, represented in the specified timezone. * If the function is invoked with a single string argument
representing a valid date/time, an object representing that date/
o If the function is invoked with a single string argument time will be returned.
representing a valid date/time, an object representing that date/
time will be returned. As a general rule, any date-time representation that is recognized
and unambigous to a resident of North America is acceptable. (The
As a general rule, any date-time representation that is recognized reason for this qualification is that in North America, a date like:
and unambigous to a resident of North America is acceptable.(The 2/1/1994 is interpreted as February 1, 1994, while in some parts of
reason for this qualification is that in North America, a date the world, it is interpreted as January 2, 1994.) A date/ time
like: 2/1/1994 is interpreted as February 1, 1994, while in some string consists of two components, a date component and an optional
parts of the world, it is interpreted as January 2, 1994.) A date/ time component, separated by one or more spaces. If the time
time string consists of two components, a date component and an component is omited, 12:00am is assumed. Any recognized timezone
optional time component, separated by one or more spaces. If the name specified as the final element of the date/time string will be
time component is omited, 12:00am is assumed. Any recognized used for computing the date/time value. (If you create a DateTime
timezone name specified as the final element of the date/time with the string "Mar 9, 1997 1:45pm US/Pacific", the value will
string will be used for computing the date/time value. (If you essentially be the same as if you had captured time.time() at the
create a DateTime with the string Mar 9, 1997 1:45pm US/Pacific, specified date and time on a machine in that timezone).
the value will essentially be the same as if you had captured
time.time() at the specified date and time on a machine in that o Returns current date/time, represented in US/Eastern:
timezone)
>>> from DateTime import DateTime
>>> e = DateTime('US/Eastern')
>>> e.timezone()
e=DateTime(US/Eastern) 'US/Eastern'
# returns current date/time, represented in US/Eastern.
o Returns specified time, represented in local machine zone:
>>> x = DateTime('1997/3/9 1:45pm')
>>> x.parts() # doctest: +ELLIPSIS
(1997, 3, 9, 13, 45, 0.0, ...)
x=DateTime(1997/3/9 1:45pm)
# returns specified time, represented in local machine zone. o Specified time in local machine zone, verbose format:
>>> y = DateTime('Mar 9, 1997 13:45:00')
>>> y.parts() # doctest: +ELLIPSIS
(1997, 3, 9, 13, 45, 0.0, ...)
>>> y == x
y=DateTime(Mar 9, 1997 13:45:00) True
# y is equal to x
The date component consists of year, month, and day values. The
year value must be a one-, two-, or four-digit integer. If a one-
or two-digit year is used, the year is assumed to be in the
twentieth century. The month may an integer, from 1 to 12, a month
name, or a month abreviation, where a period may optionally follow
the abreviation. The day must be an integer from 1 to the number of
days in the month. The year, month, and day values may be separated
The date component consists of year, month, and day values. The by periods, hyphens, forward, shashes, or spaces. Extra spaces are
year value must be a one-, two-, or four-digit integer. If a one- permitted around the delimiters. Year, month, and day values may be
or two-digit year is used, the year is assumed to be in the given in any order as long as it is possible to distinguish the
twentieth century. The month may an integer, from 1 to 12, a month components. If all three components are numbers that are less than
name, or a month abreviation, where a period may optionally follow 13, then a a month-day-year ordering is assumed.
the abreviation. The day must be an integer from 1 to the number of
days in the month. The year, month, and day values may be separated The time component consists of hour, minute, and second values
by periods, hyphens, forward, shashes, or spaces. Extra spaces are separated by colons. The hour value must be an integer between 0
permitted around the delimiters. Year, month, and day values may be and 23 inclusively. The minute value must be an integer between 0
given in any order as long as it is possible to distinguish the and 59 inclusively. The second value may be an integer value
components. If all three components are numbers that are less than between 0 and 59.999 inclusively. The second value or both the
13, then a a month-day-year ordering is assumed. minute and second values may be ommitted. The time may be followed
by am or pm in upper or lower case, in which case a 12-hour clock is
The time component consists of hour, minute, and second values assumed.
separated by colons. The hour value must be an integer between 0
and 23 inclusively. The minute value must be an integer between 0 * If the DateTime function is invoked with a single Numeric argument,
and 59 inclusively. The second value may be an integer value the number is assumed to be either a floating point value such as
between 0 and 59.999 inclusively. The second value or both the that returned by time.time() , or a number of days after January 1,
minute and second values may be ommitted. The time may be followed 1901 00:00:00 UTC.
by am or pm in upper or lower case, in which case a 12-hour clock
is assumed. A DateTime object is returned that represents either the gmt value
of the time.time() float represented in the local machine's
o If the DateTime function is invoked with a single Numeric argument, timezone, or that number of days after January 1, 1901. Note that
the number is assumed to be either a floating point value such as the number of days after 1901 need to be expressed from the
that returned by time.time() , or a number of days after January 1, viewpoint of the local machine's timezone. A negative argument will
1901 00:00:00 UTC. yield a date-time value before 1901.
A DateTime object is returned that represents either the gmt value * If the function is invoked with two numeric arguments, then the
of the time.time() float represented in the local machine's first is taken to be an integer year and the second argument is
timezone, or that number of days after January 1, 1901. Note that taken to be an offset in days from the beginning of the year, in the
the number of days after 1901 need to be expressed from the context of the local machine timezone. The date-time value returned
viewpoint of the local machine's timezone. A negative argument will is the given offset number of days from the beginning of the given
yield a date-time value before 1901. year, represented in the timezone of the local machine. The offset
may be positive or negative. Two-digit years are assumed to be in
o If the function is invoked with two numeric arguments, then the the twentieth century.
first is taken to be an integer year and the second argument is
taken to be an offset in days from the beginning of the year, in * If the function is invoked with two arguments, the first a float
the context of the local machine timezone. The date-time value representing a number of seconds past the epoch in gmt (such as
returned is the given offset number of days from the beginning of those returned by time.time()) and the second a string naming a
the given year, represented in the timezone of the local machine. recognized timezone, a DateTime with a value of that gmt time will
The offset may be positive or negative. Two-digit years are assumed be returned, represented in the given timezone.
to be in the twentieth century.
>>> import time
o If the function is invoked with two arguments, the first a float >>> t = time.time()
representing a number of seconds past the epoch in gmt (such as
those returned by time.time()) and the second a string naming a Time t represented as US/Eastern:
recognized timezone, a DateTime with a value of that gmt time will
be returned, represented in the given timezone. >>> now_east = DateTime(t, 'US/Eastern')
import time
t=time.time() Time t represented as US/Pacific:
>>> now_west = DateTime(t, 'US/Pacific')
now_east=DateTime(t,'US/Eastern') Only their representations are different:
# Time t represented as US/Eastern
>>> now_east == now_west
True
* If the function is invoked with three or more numeric arguments,
then the first is taken to be an integer year, the second is taken
now_west=DateTime(t,'US/Pacific') to be an integer month, and the third is taken to be an integer day.
# Time t represented as US/Pacific If the combination of values is not valid, then a DateTimeError is
raised. Two-digit years are assumed to be in the twentieth century.
The fourth, fifth, and sixth arguments are floating point, positive
or negative offsets in units of hours, minutes, and days, and
default to zero if not given. An optional string may be given as
the final argument to indicate timezone (the effect of this is as if
# now_east == now_west you had taken the value of time.time() at that time on a machine in
# only their representations are different the specified timezone).
If a string argument passed to the DateTime constructor cannot be
parsed, it will raise DateTime.SyntaxError. Invalid date, time, or
timezone components will raise a DateTime.DateTimeError.
The module function Timezones() will return a list of the timezones
recognized by the DateTime module. Recognition of timezone names is
o If the function is invoked with three or more numeric arguments, case-insensitive.
then the first is taken to be an integer year, the second is taken
to be an integer month, and the third is taken to be an integer Instance Methods for DateTime (IDateTime interface)
day. If the combination of values is not valid, then a ---------------------------------------------------
DateTimeError is raised. Two-digit years are assumed to be in the
twentieth century. The fourth, fifth, and sixth arguments are Conversion and comparison methods
floating point, positive or negative offsets in units of hours, ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
minutes, and days, and default to zero if not given. An optional
string may be given as the final argument to indicate timezone (the * ``timeTime()`` returns the date/time as a floating-point number in
effect of this is as if you had taken the value of time.time() at UTC, in the format used by the python time module. Note that it is
that time on a machine in the specified timezone). possible to create date /time values with DateTime that have no
meaningful value to the time module, and in such cases a
If a string argument passed to the DateTime constructor cannot be DateTimeError is raised. A DateTime object's value must generally
parsed, it will raise DateTime.SyntaxError. Invalid date, time, or be between Jan 1, 1970 (or your local machine epoch) and Jan 2038 to
timezone components will raise a DateTime.DateTimeError. produce a valid time.time() style value.
The module function Timezones() will return a list of the timezones >>> dt = DateTime('Mar 9, 1997 13:45:00 US/Eastern')
recognized by the DateTime module. Recognition of timezone names is >>> dt.timeTime()
case-insensitive. 857933100.0
Instance Methods For DateTime >>> DateTime('2040/01/01').timeTime()
2208985200.0
aMonth()
>>> DateTime('1900/01/01').timeTime()
Return the abreviated month name. -2208992400.0
pCommon() * ``toZone(z)`` returns a DateTime with the value as the current
object, represented in the indicated timezone:
Return a string representing the object's value in the format: Mar. 1,
1997 1:45 pm >>> dt.toZone('UTC')
DateTime('1997/03/09 18:45:00 Universal')
minute()
>>> dt.toZone('UTC') == dt
Return the minute True
isLeapYear() * ``isFuture()`` returns true if this object represents a date/time
later than the time of the call:
Return true if the current year (in the context of the object's
timezone) is a leap year >>> dt.isFuture()
False
pMonth() >>> DateTime('Jan 1 3000').isFuture() # not time-machine safe!
True
Return the abreviated (with period) month name.
* ``isPast()`` returns true if this object represents a date/time
DayOfWeek() earlier than the time of the call:
Compatibility: see Day >>> dt.isPast()
True
Day_() >>> DateTime('Jan 1 3000').isPast() # not time-machine safe!
False
Compatibility: see pDay
* ``isCurrentYear()`` returns true if this object represents a
isCurrentDay() date/time that falls within the current year, in the context of this
object's timezone representation:
Return true if this object represents a date/time that falls within the
current day, in the context of this object's timezone representation >>> dt.isCurrentYear()
False
Mon() >>> DateTime().isCurrentYear()
True
Compatibility: see aMonth
* ``isCurrentMonth()`` returns true if this object represents a
hour() date/time that falls within the current month, in the context of
this object's timezone representation:
Return the 24-hour clock representation of the hour
>>> dt.isCurrentMonth()
Date() False
>>> DateTime().isCurrentMonth()
Return the date string for the object. True
aCommonZ() * ``isCurrentDay()`` returns true if this object represents a
date/time that falls within the current day, in the context of this
Return a string representing the object's value in the format: Mar 1, object's timezone representation:
1997 1:45 pm US/Eastern
>>> dt.isCurrentDay()
fCommonZ() False
>>> DateTime().isCurrentDay()
Return a string representing the object's value in the format: March 1, True
1997 1:45 pm US/Eastern
* ``isCurrentHour()`` returns true if this object represents a
isCurrentYear() date/time that falls within the current hour, in the context of this
object's timezone representation:
Return true if this object represents a date/time that falls within the
current year, in the context of this object's timezone representation >>> dt.isCurrentHour()
False
AMPMMinutes()
>>> DateTime().isCurrentHour()
Return the time string for an object not showing seconds. True
dd() * ``isCurrentMinute()`` returns true if this object represents a
date/time that falls within the current minute, in the context of
Return day as a 2 digit string this object's timezone representation:
TimeMinutes() >>> dt.isCurrentMinute()
False
Return the time string for an object not showing seconds. >>> DateTime().isCurrentMinute()
True
h_24()
* ``isLeapYear()`` returns true if the current year (in the context of
Return the 24-hour clock representation of the hour the object's timezone) is a leap year:
isPast() >>> dt.isLeapYear()
False
Return true if this object represents a date/time earlier than the time >>> DateTime('Mar 8 2004').isLeapYear()
of the call True
dow() * ``earliestTime()`` returns a new DateTime object that represents the
earliest possible time (in whole seconds) that still falls within
Return the integer day of the week, where sunday is 0 the current object's day, in the object's timezone context:
isFuture() >>> dt.earliestTime()
DateTime('1997/03/09')
Return true if this object represents a date/time later than the time
of the call * ``latestTime()`` return a new DateTime object that represents the
latest possible time (in whole seconds) that still falls within the
pCommonZ() current object's day, in the object's timezone context
Return a string representing the object's value in the format: Mar. 1, >>> dt.latestTime()
1997 1:45 pm US/Eastern DateTime('1997/03/09 23:59:59 US/Eastern')
timezone() Component access
~~~~~~~~~~~~~~~~
Return the timezone in which the object is represented.
* ``parts()`` returns a tuple containing the calendar year, month,
h_12() day, hour, minute second and timezone of the object
Return the 12-hour clock representation of the hour >>> dt.parts()
(1997, 3, 9, 13, 45, 0.0, 'US/Eastern')
PreciseTime()
* ``timezone()`` returns the timezone in which the object is represented:
Return the time string for the object.
>>> dt.timezone() in Timezones()
isCurrentMinute() True
Return true if this object represents a date/time that falls within the * ``tzoffset()`` returns the timezone offset for the objects timezone:
current minute, in the context of this object's timezone representation
>>> dt.tzoffset()
rfc822() -18000
Return the date in RFC 822 format * ``year()`` returns the calendar year of the object:
equalTo(t) >>> dt.year()
1997
Compare this DateTime object to another DateTime object OR a floating
point number such as that which is returned by the python time module. * ``month()`` retursn the month of the object as an integer:
Returns true if the object represents a date/time equal to the
specified DateTime or time module style time. >>> dt.month()
3
yy()
* ``Month()`` returns the full month name:
Return calendar year as a 2 digit string
>>> dt.Month()
mm() 'March'
Return month as a 2 digit string * ``aMonth()`` returns the abreviated month name:
Mon_() >>> dt.aMonth()
'Mar'
Compatibility: see pMonth
* ``pMonth()`` returns the abreviated (with period) month name:
toZone(z)
>>> dt.pMonth()
Return a DateTime with the value as the current object, represented in 'Mar.'
the indicated timezone.
* ``day()`` returns the integer day:
earliestTime()
>>> dt.day()
Return a new DateTime object that represents the earliest possible time 9
(in whole seconds) that still falls within the current object's day, in
the object's timezone context * ``Day()`` returns the full name of the day of the week:
aDay() >>> dt.Day()
'Sunday'
Return the abreviated name of the day of the week
* ``dayOfYear()`` returns the day of the year, in context of the
dayOfYear() timezone representation of the object:
Return the day of the year, in context of the timezone representation >>> dt.dayOfYear()
of the object 68
latestTime() * ``aDay()`` returns the abreviated name of the day of the week:
Return a new DateTime object that represents the latest possible time >>> dt.aDay()
(in whole seconds) that still falls within the current object's day, in 'Sun'
the object's timezone context
* ``pDay()`` returns the abreviated (with period) name of the day of
notEqualTo(t) the week:
Compare this DateTime object to another DateTime object OR a floating >>> dt.pDay()
point number such as that which is returned by the python time module. 'Sun.'
Returns true if the object represents a date/time not equal to the
specified DateTime or time module style time. * ``dow()`` returns the integer day of the week, where Sunday is 0:
PreciseAMPM() >>> dt.dow()
0
Return the time string for the object.
* ``dow_1()`` returns the integer day of the week, where sunday is 1:
day()
>>> dt.dow_1()
Return the integer day 1
timeTime() * ``h_12()`` returns the 12-hour clock representation of the hour:
Return the date/time as a floating-point number in UTC, in the format >>> dt.h_12()
used by the python time module. Note that it is possible to create date 1
/time values with DateTime that have no meaningful value to the time
module, and in such cases a DateTimeError is raised. A DateTime * ``h_24()`` returns the 24-hour clock representation of the hour:
object's value must generally be between Jan 1, 1970 (or your local
machine epoch) and Jan 2038 to produce a valid time.time() style value. >>> dt.h_24()
13
ampm()
* ``ampm()`` returns the appropriate time modifier (am or pm):
Return the appropriate time modifier (am or pm)
>>> dt.ampm()
greaterThan(t) 'pm'
Compare this DateTime object to another DateTime object OR a floating * ``hour()`` returns the 24-hour clock representation of the hour:
point number such as that which is returned by the python time module.
Returns true if the object represents a date/time greater than the >>> dt.hour()
specified DateTime or time module style time. 13
month() * ``minute()`` returns the minute:
Return the month of the object as an integer >>> dt.minute()
45
AMPM()
* ``second()`` returns the second:
Return the time string for an object to the nearest second.
>>> dt.second()
second() 0.0
Return the second * ``millis()`` returns the milliseconds since the epoch in GMT.
parts() >>> dt.millis()
857933100000L
Return a tuple containing the calendar year, month, day, hour, minute
second and timezone of the object strftime()
~~~~~~~~~~
greaterThanEqualTo(t)
See ``tests/testDateTime.py``.
Compare this DateTime object to another DateTime object OR a floating
point number such as that which is returned by the python time module. General formats from previous DateTime
Returns true if the object represents a date/time greater than or equal ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
to the specified DateTime or time module style time.
* ``Date()`` return the date string for the object:
lessThanEqualTo(t)
>>> dt.Date()
Compare this DateTime object to another DateTime object OR a floating '1997/03/09'
point number such as that which is returned by the python time module.
Returns true if the object represents a date/time less than or equal to * ``Time()`` returns the time string for an object to the nearest
the specified DateTime or time module style time. second:
isCurrentHour() >>> dt.Time()
'13:45:00'
Return true if this object represents a date/time that falls within the
current hour, in the context of this object's timezone representation * ``TimeMinutes()`` returns the time string for an object not showing
seconds:
aCommon()
>>> dt.TimeMinutes()
Return a string representing the object's value in the format: Mar 1, '13:45'
1997 1:45 pm
* ``AMPM()`` returns the time string for an object to the nearest second:
dow_1()
>>> dt.AMPM()
Return the integer day of the week, where sunday is 1 '01:45:00 pm'
Day() * ``AMPMMinutes()`` returns the time string for an object not showing
seconds:
Return the full name of the day of the week
>>> dt.AMPMMinutes()
fCommon() '01:45 pm'
Return a string representing the object's value in the format: March 1, * ``PreciseTime()`` returns the time string for the object:
1997 1:45 pm
>>> dt.PreciseTime()
Month() '13:45:00.000'
Return the full month name * ``PreciseAMPM()``return the time string for the object:
isCurrentMonth() >>> dt.PreciseAMPM()
'01:45:00.000 pm'
Return true if this object represents a date/time that falls within the
current month, in the context of this object's timezone representation * ``yy()`` returns the calendar year as a 2 digit string
year() >>> dt.yy()
'97'
Return the calendar year of the object
* ``mm()`` returns the month as a 2 digit string
lessThan(t)
>>> dt.mm()
Compare this DateTime object to another DateTime object OR a floating '03'
point number such as that which is returned by the python time module.
Returns true if the object represents a date/time less than the * ``dd()`` returns the day as a 2 digit string:
specified DateTime or time module style time.
>>> dt.dd()
Time() '09'
Return the time string for an object to the nearest second. * ``rfc822()`` returns the date in RFC 822 format:
pDay() >>> dt.rfc822()
'Sun, 09 Mar 1997 13:45:00 -0500'
Return the abreviated (with period) name of the day of the week
New formats
~~~~~~~~~~~
* ``fCommon()`` returns a string representing the object's value in
the format: March 9, 1997 1:45 pm:
>>> dt.fCommon()
'March 9, 1997 1:45 pm'
* ``fCommonZ()`` returns a string representing the object's value in
the format: March 9, 1997 1:45 pm US/Eastern:
>>> dt.fCommonZ()
'March 9, 1997 1:45 pm US/Eastern'
* ``aCommon()`` returns a string representing the object's value in
the format: Mar 9, 1997 1:45 pm:
>>> dt.aCommon()
'Mar 9, 1997 1:45 pm'
* ``aCommonZ()`` return a string representing the object's value in
the format: Mar 9, 1997 1:45 pm US/Eastern:
>>> dt.aCommonZ()
'Mar 9, 1997 1:45 pm US/Eastern'
* ``pCommon()`` returns a string representing the object's value in
the format Mar. 9, 1997 1:45 pm:
>>> dt.pCommon()
'Mar. 9, 1997 1:45 pm'
* ``pCommonZ()`` returns a string representing the object's value in
the format: Mar. 9, 1997 1:45 pm US/Eastern:
>>> dt.pCommonZ()
'Mar. 9, 1997 1:45 pm US/Eastern'
* ``ISO()`` returns a string with the date/time in ISO format. Note:
this is not ISO 8601-format! See the ISO8601 and HTML4 methods below
for ISO 8601-compliant output. Dates are output as: YYYY-MM-DD HH:MM:SS
>>> dt.ISO()
'1997-03-09 13:45:00'
* ``ISO8601()`` returns the object in ISO 8601-compatible format
containing the date, time with seconds-precision and the time zone
identifier - see http://www.w3.org/TR/NOTE-datetime. Dates are
output as: YYYY-MM-DDTHH:MM:SSTZD (T is a literal character, TZD is
Time Zone Designator, format +HH:MM or -HH:MM).
The ``HTML4()`` method below offers the same formatting, but
converts to UTC before returning the value and sets the TZD"Z"
>>> dt.ISO8601()
'1997-03-09T13:45:00-05:00'
* ``HTML4()`` returns the object in the format used in the HTML4.0
specification, one of the standard forms in ISO8601. See
http://www.w3.org/TR/NOTE-datetime. Dates are output as:
YYYY-MM-DDTHH:MM:SSZ (T, Z are literal characters, the time is in
UTC.):
>>> dt.HTML4()
'1997-03-09T18:45:00Z'
* ``JulianDay()`` returns the Julian day according to
http://www.tondering.dk/claus/cal/node3.html#sec-calcjd
>>> dt.JulianDay()
2450517
* ``week()`` returns the week number according to ISO
see http://www.tondering.dk/claus/cal/node6.html#SECTION00670000000000000000
>>> dt.week()
10
Deprecated API
~~~~~~~~~~~~~~
* DayOfWeek(): see Day()
* Day_(): see pDay()
* Mon(): see aMonth()
* Mon_(): see pMonth
General Services Provided by DateTime General Services Provided by DateTime
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
`aDateTime`
DateTimes can be repr()'ed; the result will be a string indicating how
Convert a DateTime to a string that looks like a Python expression. to make a DateTime object like this:
str(aDateTime) >>> `dt`
"DateTime('1997/03/09 13:45:00 US/Eastern')"
Convert a DateTime to a string.
When we convert them into a string, we get a nicer string that could
cmp(aDateTime, other) actually be shown to a user:
Compare a DateTime with another DateTime object, or a float such as >>> str(dt)
those returned by time.time(). '1997/03/09 13:45:00 US/Eastern'
NOTE: __cmp__ support is provided for backward compatibility only, and The hash value of a DateTime is based on the date and time and is
mixing DateTimes with ExtensionClasses could cause __cmp__ to break. equal for different representations of the DateTime:
You should use the methods lessThan, greaterThan, lessThanEqualTo,
greaterThanEqualTo, equalTo and notEqualTo to avoid potential problems >>> hash(dt)
later!! 3618678
>>> hash(dt.toZone('UTC'))
hash(aDateTime) 3618678
Compute a hash value for a DateTime A DateTime can be compared with another DateTime or float via
``cmp()``. NOTE: __cmp__ support is provided for backward
compatibility only, and mixing DateTimes with ExtensionClasses could
cause __cmp__ to break. You should use the methods lessThan,
greaterThan, lessThanEqualTo, greaterThanEqualTo, equalTo and
notEqualTo to avoid potential problems later!
>>> cmp(dt, dt)
0
>>> cmp(dt, dt.toZone('UTC'))
0
>>> cmp(dt, dt.timeTime())
0
>>> cmp(dt, DateTime('2000/01/01'))
-1
>>> cmp(dt, DateTime('1900/01/01'))
1
DateTime objects can be compared to other DateTime objects OR floating
point numbers such as the ones which are returned by the python time
module. On comparison for equality, True is returned if the object
represents a date/time equal to the specified DateTime or time module
style time:
>>> dt == dt
True
>>> dt == dt.toZone('UTC')
True
>>> dt == dt.timeTime()
True
>>> dt == DateTime()
False
>>> dt.equalTo(dt)
True
>>> dt.equalTo(dt.toZone('UTC'))
True
>>> dt.equalTo(dt.timeTime())
True
>>> dt.equalTo(DateTime())
False
Same goes for inequalities:
>>> dt != dt
False
>>> dt != dt.toZone('UTC')
False
>>> dt != dt.timeTime()
False
>>> dt != DateTime()
True
>>> dt.notEqualTo(dt)
False
>>> dt.notEqualTo(dt.toZone('UTC'))
False
>>> dt.notEqualTo(dt.timeTime())
False
>>> dt.notEqualTo(DateTime())
True
>>> dt > dt
False
>>> DateTime() > dt
True
>>> dt > DateTime().timeTime()
False
>>> DateTime().timeTime() > dt
True
>>> dt.greaterThan(dt)
False
>>> DateTime().greaterThan(dt)
True
>>> dt.greaterThan(DateTime().timeTime())
False
>>> dt >= dt
True
>>> DateTime() >= dt
True
>>> dt >= DateTime().timeTime()
False
>>> DateTime().timeTime() >= dt
True
>>> dt.greaterThanEqualTo(dt)
True
>>> DateTime().greaterThanEqualTo(dt)
True
>>> dt.greaterThanEqualTo(DateTime().timeTime())
False
>>> dt < dt
False
>>> DateTime() < dt
False
>>> dt < DateTime().timeTime()
True
>>> DateTime().timeTime() < dt
False
>>> dt.lessThan(dt)
False
>>> DateTime().lessThan(dt)
False
>>> dt.lessThan(DateTime().timeTime())
True
>>> dt <= dt
True
>>> DateTime() <= dt
False
>>> dt <= DateTime().timeTime()
True
>>> DateTime().timeTime() <= dt
False
>>> dt.lessThanEqualTo(dt)
True
>>> DateTime().lessThanEqualTo(dt)
False
>>> dt.lessThanEqualTo(DateTime().timeTime())
True
Numeric Services Provided by DateTime Numeric Services Provided by DateTime
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
aDateTime + other
A DateTime may be added to a number and a number may be added to a
A DateTime may be added to a number and a number may be added to a DateTime:
DateTime; two DateTimes cannot be added.
>>> dt + 5
aDateTime - other DateTime('1997/03/14 13:45:00 US/Eastern')
>>> 5 + dt
Either a DateTime or a number may be subtracted from a DateTime, DateTime('1997/03/14 13:45:00 US/Eastern')
however, a DateTime may not be subtracted from a number.
Two DateTimes cannot be added:
other + aDateTimeAdd aDateTime to other.
>>> dt + dt
A DateTime may be added to a number and a number may be added to a Traceback (most recent call last):
DateTime; two DateTimes cannot be added. ...
DateTimeError: Cannot add two DateTimes
int(aDateTime)
Either a DateTime or a number may be subtracted from a DateTime,
Convert to an integer number of days since Jan. 1, 1901 (gmt) however, a DateTime may not be subtracted from a number:
long(aDateTime) >>> DateTime('1997/03/10 13:45 US/Eastern') - dt
1.0
Convert to a long-int number of days since Jan. 1, 1901 (gmt) >>> dt - 1
DateTime('1997/03/08 13:45:00 US/Eastern')
float(aDateTime) >>> 1 - dt
Traceback (most recent call last):
Convert to floating-point number of days since Jan. 1, 1901 (gmt) ...
TypeError: unsupported operand type(s) for -: 'int' and 'instance'
-------------------------------------------------------------------------------
Last Modified: 14 March 1997 DateTimes can also be converted to integers (number of seconds since
the epoch), longs (not too long ;)) and floats:
>>> int(dt)
857933100
>>> long(dt)
857933100L
>>> float(dt)
857933100.0
lib/python/DateTime/tests/testDateTime.py
View file @ ecd8674c
...@@ -379,7 +379,11 @@ class DateTimeTests(unittest.TestCase): ...@@ -379,7 +379,11 @@ class DateTimeTests(unittest.TestCase):
self.assertEqual(dt.strftime(u'Le %d/%m/%Y \xe0 %Hh%M'), ok) self.assertEqual(dt.strftime(u'Le %d/%m/%Y \xe0 %Hh%M'), ok)
def test_suite(): def test_suite():
return unittest.makeSuite(DateTimeTests) from zope.testing import doctest
return unittest.TestSuite([
unittest.makeSuite(DateTimeTests),
doctest.DocFileSuite('DateTime.txt', package='DateTime')
])
if __name__=="__main__": if __name__=="__main__":
unittest.main(defaultTest='test_suite') unittest.main(defaultTest='test_suite')
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7