| Name | DateTime JSON |
| Version |
5.5
JSON |
| download |
| home_page | https://github.com/zopefoundation/DateTime |
| Summary | This package provides a DateTime data type, as known from Zope. Unless you need to communicate with Zope APIs, you're probably better off using Python's built-in datetime module. |
| upload_time | 2024-03-21 07:26:50 |
| maintainer | None |
| docs_url | None |
| author | Zope Foundation and Contributors |
| requires_python | >=3.7 |
| license | ZPL 2.1 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
.. image:: https://github.com/zopefoundation/DateTime/workflows/tests/badge.svg
:target: https://github.com/zopefoundation/DateTime/actions?query=workflow%3Atests
:alt: CI status
.. image:: https://img.shields.io/pypi/v/DateTime.svg
:target: https://pypi.org/project/DateTime/
:alt: Current version on PyPI
.. image:: https://img.shields.io/pypi/pyversions/DateTime.svg
:target: https://pypi.org/project/DateTime/
:alt: Supported Python versions
DateTime
========
This package provides a DateTime data type, as known from Zope.
Unless you need to communicate with Zope APIs, you're probably better
off using Python's built-in datetime module.
For further documentation, please have a look at `src/DateTime/DateTime.txt`.
.. contents::
The DateTime package
====================
Encapsulation of date/time values.
Function Timezones()
--------------------
Returns the list of recognized timezone names:
>>> from DateTime import Timezones
>>> zones = set(Timezones())
Almost all of the standard pytz timezones are included, with the exception
of some commonly-used but ambiguous abbreviations, where historical Zope
usage conflicts with the name used by pytz:
>>> import pytz
>>> [x for x in pytz.all_timezones if x not in zones]
['CET', 'EET', 'EST', 'MET', 'MST', 'WET']
Class DateTime
--------------
DateTime objects represent instants in time and provide interfaces for
controlling its representation without affecting the absolute value of
the object.
DateTime objects may be created from a wide variety of string or
numeric data, or may be computed from other DateTime objects.
DateTimes support the ability to convert their representations to many
major timezones, as well as the ability to create a DateTime object
in the context of a given timezone.
DateTime objects provide partial numerical behavior:
* Two date-time objects can be subtracted to obtain a time, in days
between the two.
* A date-time object and a positive or negative number may be added to
obtain a new date-time object that is the given number of days later
than the input date-time object.
* A positive or negative number and a date-time object may be added to
obtain a new date-time object that is the given number of days later
than the input date-time object.
* A positive or negative number may be subtracted from a date-time
object to obtain a new date-time object that is the given number of
days earlier than the input date-time object.
DateTime objects may be converted to integer, long, or float numbers
of days since January 1, 1901, using the standard int, long, and float
functions (Compatibility Note: int, long and float return the number
of days since 1901 in GMT rather than local machine timezone).
DateTime objects also provide access to their value in a float format
usable with the Python time module, provided that the value of the
object falls in the range of the epoch-based time module.
A DateTime object should be considered immutable; all conversion and numeric
operations return a new DateTime object rather than modify the current object.
A DateTime object always maintains its value as an absolute UTC time,
and is represented in the context of some timezone based on the
arguments used to create the object. A DateTime object's methods
return values based on the timezone context.
Note that in all cases the local machine timezone is used for
representation if no timezone is specified.
Constructor for DateTime
------------------------
DateTime() returns a new date-time object. 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.
* If the function is invoked with a single string argument which is a
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/
time will be returned.
As a general rule, any date-time representation that is recognized
and unambiguous to a resident of North America is acceptable. (The
reason for this qualification is that in North America, a date like:
2/1/1994 is interpreted as February 1, 1994, while in some parts of
the world, it is interpreted as January 2, 1994.) A date/ time
string consists of two components, a date component and an optional
time component, separated by one or more spaces. If the time
component is omitted, 12:00am is assumed.
Any recognized timezone name specified as the final element of the
date/time string will be used for computing the date/time value.
(If you create a DateTime with the string,
"Mar 9, 1997 1:45pm US/Pacific", 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 timezone). If no timezone is passed, then
the timezone configured on the local machine will be used, **except**
that if the date format matches ISO 8601 ('YYYY-MM-DD'), the instance
will use UTC / GMT+0 as the timezone.
o Returns current date/time, represented in US/Eastern:
>>> from DateTime import DateTime
>>> e = DateTime('US/Eastern')
>>> e.timezone()
'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, ...)
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, ...)
>>> y == x
True
o Specified time in UTC via ISO 8601 rule:
>>> z = DateTime('2014-03-24')
>>> z.parts() # doctest: +ELLIPSIS
(2014, 3, 24, 0, 0, ...)
>>> z.timezone()
'GMT+0'
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 abbreviation, where a period may optionally follow
the abbreviation. 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
by periods, hyphens, forward slashes, or spaces. Extra spaces are
permitted around the delimiters. Year, month, and day values may be
given in any order as long as it is possible to distinguish the
components. If all three components are numbers that are less than
13, then a month-day-year ordering is assumed.
The time component consists of hour, minute, and second values
separated by colons. The hour value must be an integer between 0
and 23 inclusively. The minute value must be an integer between 0
and 59 inclusively. The second value may be an integer value
between 0 and 59.999 inclusively. The second value or both the
minute and second values may be omitted. The time may be followed
by am or pm in upper or lower case, in which case a 12-hour clock is
assumed.
* If the DateTime function is invoked with a single numeric argument,
the number is assumed to be either a floating point value such as
that returned by time.time(), or a number of days after January 1,
1901 00:00:00 UTC.
A DateTime object is returned that represents either the GMT value
of the time.time() float represented in the local machine's
timezone, or that number of days after January 1, 1901. Note that
the number of days after 1901 need to be expressed from the
viewpoint of the local machine's timezone. A negative argument will
yield a date-time value before 1901.
* If the function is invoked with two numeric arguments, then the
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 the
context of the local machine timezone. The date-time value returned
is the given offset number of days from the beginning of the given
year, represented in the timezone of the local machine. The offset
may be positive or negative. Two-digit years are assumed to be in
the twentieth century.
* If the function is invoked with two arguments, the first a float
representing a number of seconds past the epoch in GMT (such as
those returned by time.time()) and the second a string naming a
recognized timezone, a DateTime with a value of that GMT time will
be returned, represented in the given timezone.
>>> import time
>>> t = time.time()
Time t represented as US/Eastern:
>>> now_east = DateTime(t, 'US/Eastern')
Time t represented as US/Pacific:
>>> now_west = DateTime(t, 'US/Pacific')
Only their representations are different:
>>> now_east.equalTo(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
to be an integer month, and the third is taken to be an integer day.
If the combination of values is not valid, then a DateTimeError is
raised. One- or two-digit years up to 69 are assumed to be in the
21st century, whereas values 70-99 are assumed to be 20th 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
you had taken the value of time.time() at that time on a machine in
the specified timezone).
If a string argument passed to the DateTime constructor cannot be
parsed, it will raise SyntaxError. Invalid date, time, or
timezone components will raise a DateTimeError.
The module function Timezones() will return a list of the timezones
recognized by the DateTime module. Recognition of timezone names is
case-insensitive.
Instance Methods for DateTime (IDateTime interface)
---------------------------------------------------
Conversion and comparison methods
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* ``timeTime()`` returns the date/time as a floating-point number in
UTC, in the format used by the Python time module. Note that it is
possible to create date /time values with DateTime that have no
meaningful value to the time module, and in such cases a
DateTimeError is raised. A DateTime 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 = DateTime('Mar 9, 1997 13:45:00 US/Eastern')
>>> dt.timeTime()
857933100.0
>>> DateTime('2040/01/01 UTC').timeTime()
2208988800.0
>>> DateTime('1900/01/01 UTC').timeTime()
-2208988800.0
* ``toZone(z)`` returns a DateTime with the value as the current
object, represented in the indicated timezone:
>>> dt.toZone('UTC')
DateTime('1997/03/09 18:45:00 UTC')
>>> dt.toZone('UTC').equalTo(dt)
True
* ``isFuture()`` returns true if this object represents a date/time
later than the time of the call:
>>> dt.isFuture()
False
>>> DateTime('Jan 1 3000').isFuture() # not time-machine safe!
True
* ``isPast()`` returns true if this object represents a date/time
earlier than the time of the call:
>>> dt.isPast()
True
>>> DateTime('Jan 1 3000').isPast() # not time-machine safe!
False
* ``isCurrentYear()`` returns true if this object represents a
date/time that falls within the current year, in the context of this
object's timezone representation:
>>> dt.isCurrentYear()
False
>>> DateTime().isCurrentYear()
True
* ``isCurrentMonth()`` returns true if this object represents a
date/time that falls within the current month, in the context of
this object's timezone representation:
>>> dt.isCurrentMonth()
False
>>> DateTime().isCurrentMonth()
True
* ``isCurrentDay()`` returns true if this object represents a
date/time that falls within the current day, in the context of this
object's timezone representation:
>>> dt.isCurrentDay()
False
>>> DateTime().isCurrentDay()
True
* ``isCurrentHour()`` returns true if this object represents a
date/time that falls within the current hour, in the context of this
object's timezone representation:
>>> dt.isCurrentHour()
False
>>> DateTime().isCurrentHour()
True
* ``isCurrentMinute()`` returns true if this object represents a
date/time that falls within the current minute, in the context of
this object's timezone representation:
>>> dt.isCurrentMinute()
False
>>> DateTime().isCurrentMinute()
True
* ``isLeapYear()`` returns true if the current year (in the context of
the object's timezone) is a leap year:
>>> dt.isLeapYear()
False
>>> DateTime('Mar 8 2004').isLeapYear()
True
* ``earliestTime()`` returns a new DateTime object that represents the
earliest possible time (in whole seconds) that still falls within
the current object's day, in the object's timezone context:
>>> dt.earliestTime()
DateTime('1997/03/09 00:00:00 US/Eastern')
* ``latestTime()`` return a new DateTime object that represents the
latest possible time (in whole seconds) that still falls within the
current object's day, in the object's timezone context
>>> dt.latestTime()
DateTime('1997/03/09 23:59:59 US/Eastern')
Component access
~~~~~~~~~~~~~~~~
* ``parts()`` returns a tuple containing the calendar year, month,
day, hour, minute second and timezone of the object
>>> dt.parts() # doctest: +ELLIPSIS
(1997, 3, 9, 13, 45, ... 'US/Eastern')
* ``timezone()`` returns the timezone in which the object is represented:
>>> dt.timezone() in Timezones()
True
* ``tzoffset()`` returns the timezone offset for the objects timezone:
>>> dt.tzoffset()
-18000
* ``year()`` returns the calendar year of the object:
>>> dt.year()
1997
* ``month()`` returns the month of the object as an integer:
>>> dt.month()
3
* ``Month()`` returns the full month name:
>>> dt.Month()
'March'
* ``aMonth()`` returns the abbreviated month name:
>>> dt.aMonth()
'Mar'
* ``pMonth()`` returns the abbreviated (with period) month name:
>>> dt.pMonth()
'Mar.'
* ``day()`` returns the integer day:
>>> dt.day()
9
* ``Day()`` returns the full name of the day of the week:
>>> dt.Day()
'Sunday'
* ``dayOfYear()`` returns the day of the year, in context of the
timezone representation of the object:
>>> dt.dayOfYear()
68
* ``aDay()`` returns the abbreviated name of the day of the week:
>>> dt.aDay()
'Sun'
* ``pDay()`` returns the abbreviated (with period) name of the day of
the week:
>>> dt.pDay()
'Sun.'
* ``dow()`` returns the integer day of the week, where Sunday is 0:
>>> dt.dow()
0
* ``dow_1()`` returns the integer day of the week, where sunday is 1:
>>> dt.dow_1()
1
* ``h_12()`` returns the 12-hour clock representation of the hour:
>>> dt.h_12()
1
* ``h_24()`` returns the 24-hour clock representation of the hour:
>>> dt.h_24()
13
* ``ampm()`` returns the appropriate time modifier (am or pm):
>>> dt.ampm()
'pm'
* ``hour()`` returns the 24-hour clock representation of the hour:
>>> dt.hour()
13
* ``minute()`` returns the minute:
>>> dt.minute()
45
* ``second()`` returns the second:
>>> dt.second() == 0
True
* ``millis()`` returns the milliseconds since the epoch in GMT.
>>> dt.millis() == 857933100000
True
strftime()
~~~~~~~~~~
See ``tests/test_datetime.py``.
General formats from previous DateTime
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* ``Date()`` return the date string for the object:
>>> dt.Date()
'1997/03/09'
* ``Time()`` returns the time string for an object to the nearest
second:
>>> dt.Time()
'13:45:00'
* ``TimeMinutes()`` returns the time string for an object not showing
seconds:
>>> dt.TimeMinutes()
'13:45'
* ``AMPM()`` returns the time string for an object to the nearest second:
>>> dt.AMPM()
'01:45:00 pm'
* ``AMPMMinutes()`` returns the time string for an object not showing
seconds:
>>> dt.AMPMMinutes()
'01:45 pm'
* ``PreciseTime()`` returns the time string for the object:
>>> dt.PreciseTime()
'13:45:00.000'
* ``PreciseAMPM()`` returns the time string for the object:
>>> dt.PreciseAMPM()
'01:45:00.000 pm'
* ``yy()`` returns the calendar year as a 2 digit string
>>> dt.yy()
'97'
* ``mm()`` returns the month as a 2 digit string
>>> dt.mm()
'03'
* ``dd()`` returns the day as a 2 digit string:
>>> dt.dd()
'09'
* ``rfc822()`` returns the date in RFC 822 format:
>>> dt.rfc822()
'Sun, 09 Mar 1997 13:45:00 -0500'
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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
DateTimes can be repr()'ed; the result will be a string indicating how
to make a DateTime object like this:
>>> repr(dt)
"DateTime('1997/03/09 13:45:00 US/Eastern')"
When we convert them into a string, we get a nicer string that could
actually be shown to a user:
>>> str(dt)
'1997/03/09 13:45:00 US/Eastern'
The hash value of a DateTime is based on the date and time and is
equal for different representations of the DateTime:
>>> hash(dt)
3618678
>>> hash(dt.toZone('UTC'))
3618678
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 by using the equalTo method. Using this API, True is returned if the
object represents a date/time equal to the specified DateTime or time module
style time:
>>> dt.equalTo(dt)
True
>>> dt.equalTo(dt.toZone('UTC'))
True
>>> dt.equalTo(dt.timeTime())
True
>>> dt.equalTo(DateTime())
False
Same goes for inequalities:
>>> dt.notEqualTo(dt)
False
>>> dt.notEqualTo(dt.toZone('UTC'))
False
>>> dt.notEqualTo(dt.timeTime())
False
>>> dt.notEqualTo(DateTime())
True
Normal equality operations only work with DateTime objects and take the
timezone setting into account:
>>> dt == dt
True
>>> dt == dt.toZone('UTC')
False
>>> dt == DateTime()
False
>>> dt != dt
False
>>> dt != dt.toZone('UTC')
True
>>> dt != DateTime()
True
But the other comparison operations compare the referenced moment in time and
not the representation itself:
>>> 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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A DateTime may be added to a number and a number may be added to a
DateTime:
>>> dt + 5
DateTime('1997/03/14 13:45:00 US/Eastern')
>>> 5 + dt
DateTime('1997/03/14 13:45:00 US/Eastern')
Two DateTimes cannot be added:
>>> from DateTime.interfaces import DateTimeError
>>> try:
... dt + dt
... print('fail')
... except DateTimeError:
... print('ok')
ok
Either a DateTime or a number may be subtracted from a DateTime,
however, a DateTime may not be subtracted from a number:
>>> DateTime('1997/03/10 13:45 US/Eastern') - dt
1.0
>>> dt - 1
DateTime('1997/03/08 13:45:00 US/Eastern')
>>> 1 - dt
Traceback (most recent call last):
...
TypeError: unsupported operand type(s) for -: 'int' and 'DateTime'
DateTimes can also be converted to integers (number of seconds since
the epoch) and floats:
>>> int(dt)
857933100
>>> float(dt)
857933100.0
Changelog
=========
5.5 (2024-03-21)
----------------
- Change pickle format to export the microseconds as an int, to
solve a problem with dates after 2038.
(`#56 <https://github.com/zopefoundation/DateTime/issues/56>`_)
5.4 (2023-12-15)
----------------
- Fix ``UnknownTimeZoneError`` when unpickling ``DateTime.DateTime().asdatetime()``.
(`#58 <https://github.com/zopefoundation/DateTime/issues/58>`_)
- Repair equality comparison between DateTime instances and other types.
(`#60 <https://github.com/zopefoundation/DateTime/issues/60>`_)
5.3 (2023-11-14)
----------------
- Add support for Python 3.12.
- Add preliminary support for Python 3.13a2.
5.2 (2023-07-19)
----------------
- Cast int to float in compare methods.
- Fix compare methods between DateTime instances and None.
(`#52 <https://github.com/zopefoundation/DateTime/issues/52>`_)
5.1 (2023-03-14)
----------------
- Add missing ``python_requires`` to ``setup.py``.
5.0 (2023-01-12)
----------------
- Drop support for Python 2.7, 3.5, 3.6.
4.8 (2022-12-16)
----------------
- Fix insidious buildout configuration bug that prevented tests on Python 2.7
and 3.5, and fix test code that was incompatible with Python 3.5.
(`#44 <https://github.com/zopefoundation/DateTime/issues/44>`_)
- Add support for Python 3.11.
4.7 (2022-09-14)
----------------
- Fix rounding problem with `DateTime` addition beyond the year 2038
(`#41 <https://github.com/zopefoundation/DateTime/issues/41>`_)
4.6 (2022-09-10)
----------------
- Fix ``__format__`` method for DateTime objects
(`#39 <https://github.com/zopefoundation/DateTime/issues/39>`_)
4.5 (2022-07-04)
----------------
- Add ``__format__`` method for DateTime objects
(`#35 <https://github.com/zopefoundation/DateTime/issues/35>`_)
4.4 (2022-02-11)
----------------
- Fix WAT definition
`#31 <https://github.com/zopefoundation/DateTime/issues/31>`_.
- Add support for Python 3.8, 3.9, and 3.10.
- Drop support for Python 3.4.
4.3 (2018-10-05)
----------------
- Add support for Python 3.7.
4.2 (2017-04-26)
----------------
- Add support for Python 3.6, drop support for Python 3.3.
4.1.1 (2016-04-30)
------------------
- Support unpickling instances having a numeric timezone like `+0430`.
4.1 (2016-04-03)
----------------
- Add support for Python 3.4 and 3.5.
- Drop support for Python 2.6 and 3.2.
4.0.1 (2013-10-15)
------------------
- Provide more backward compatible timezones.
[vangheem]
4.0 (2013-02-23)
----------------
- Added support for Python 3.2 and 3.3 in addition to 2.6 and 2.7.
- Removed unused legacy pytz tests and the DateTimeZone module and renamed
some test internals.
3.0.3 (2013-01-22)
------------------
- Allow timezone argument to be a Unicode string while creating a DateTime
object using two arguments.
3.0.2 (2012-10-21)
------------------
- LP #1045233: Respect date format setting for parsing dates like `11-01-2001`.
3.0.1 (2012-09-23)
------------------
- Add `_dt_reconstructor` function introduced in DateTime 2.12.7 to provide
forward compatibility with pickles that might reference this function.
3.0 (2011-12-09)
----------------
- No changes.
Backwards compatibility of DateTime 3
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
DateTime 3 changes its pickle representation. DateTime instances pickled with
former versions of DateTime can be read, but older DateTime versions cannot read
DateTime instances pickled with version 3.
DateTime 3 changes DateTime to be a new-style class with slots instead of being
an old-style class.
DateTime 3 tries to preserve microsecond resolution throughout most of its API's
while former versions were often only accurate to millisecond resolution. Due to
the representation of float values in Python versions before Python 2.7 you
shouldn't compare string or float representations of DateTime instances if you
want high accuracy. The same is true for calculated values returned by methods
like `timeTime()`. You get the highest accuracy of comparing DateTime values by
calling its `micros()` methods. DateTime is not particular well suited to be
used in comparing timestamps of file systems - use the time and datetime objects
from the Python standard library instead.
3.0b3 (2011-10-19)
------------------
- Allow comparison of DateTime objects against None.
3.0b2 (2011-10-19)
------------------
- Reverted the single argument `None` special case handling for unpickling and
continue to treat it as meaning `now`.
3.0b1 (2011-05-07)
------------------
- Restored `strftimeFormatter` as a class.
- Added tests for read-only class attributes and interface.
3.0a2 (2011-05-07)
------------------
- Added back support for reading old DateTime pickles without a `_micros` value.
- Avoid storing `_t` representing the time as a float in seconds since the
epoch, as we already have `_micros` doing the same as a long. Memory use is
down to about 300 bytes per DateTime instance.
- Updated exception raising syntax to current style.
- Avoid storing `_aday`, `_fday`, `_pday`, `_amon`, `_fmon`, `_pmon`, `_pmhour`
and `_pm` in memory for every instance but look them up dynamically based on
`_dayoffset`, `_month` and `_hour`. This saves another 150 bytes of memory
per DateTime instance.
- Moved various internal parsing related class variables to module constants.
- No longer provide the `DateError`, `DateTimeError`, `SyntaxError` and
`TimeError` exceptions as class attributes, import them from their canonical
`DateTime.interfaces` location instead.
- Removed deprecated `_isDST` and `_localzone` class variables.
- Moved pytz cache from `DateTime._tzinfo` to a module global `_TZINFO`.
- Make DateTime a new-style class and limit its available attributes via a
slots definition. The pickle size increases to 110 bytes thanks to the
`ccopy_reg\n_reconstructor` stanza. But the memory size drops from 3kb to
500 bytes for each instance.
3.0a1 (2011-05-06)
------------------
- Reordered some calculations in `_calcIndependentSecondEtc` to preserve more
floating point precision.
- Optimized the pickled data, by only storing a tuple of `_micros` and time
zone information - this reduces the pickle size from an average of 300 bytes
to just 60 bytes.
- Optimized un-pickling, by avoiding the creation of an intermediate DateTime
value representing the current time.
- Removed in-place migration of old DateTime pickles without a `_micros` value.
- Removed deprecated support for using `DateTime.__cmp__`.
- Take time zone settings into account when comparing two date times for
(non-) equality.
- Fixed (possibly unused) _parse_iso8601 function.
- Removed unused import of legacy DateTimeZone, strftime and re.
Remove trailing whitespace.
- Removed reference to missing version section from buildout.
2.12.7 (2012-08-11)
-------------------
- Added forward compatibility with DateTime 3 pickle format. DateTime
instances constructed under version 3 can be read and unpickled by this
version. The pickled data is converted to the current versions format
(old-style class / no slots). Once converted it will be stored again in the
old format. This should allow for a transparent upgrade/downgrade path
between DateTime 2 and 3.
2.12.6 (2010-10-17)
-------------------
- Changed ``testDayOfWeek`` test to be independent of OS locale.
2.12.5 (2010-07-29)
-------------------
- Launchpad #143269: Corrected the documentation for year value
behavior when constructing a DateTime object with three numeric
arguments.
- Launchpad #142521: Removed confusing special case in
DateTime.__str__ where DateTime instances for midnight
(e.g. '2010-07-27 00:00:00 US/Eastern') values would
render only their date and nothing else.
2.12.4 (2010-07-12)
-------------------
- Fixed mapping of EDT (was -> 'GMT-0400', now 'GMT-4').
2.12.3 (2010-07-09)
-------------------
- Added EDT timezone support. Addresses bug #599856.
[vangheem]
2.12.2 (2010-05-05)
-------------------
- Launchpad #572715: Relaxed pin on pytz, after applying a patch from
Marius Gedminus which fixes the apparent API breakage.
2.12.1 (2010-04-30)
-------------------
- Removed an undeclared testing dependency on zope.testing.doctest in favor of
the standard libraries doctest module.
- Added a maximum version requirement on pytz <= 2010b. Later versions produce
test failures related to timezone changes.
2.12.0 (2009-03-04)
-------------------
- Launchpad #290254: Forward-ported fix for '_micros'-less pickles from
the Zope 2.11 branch version.
2.11.2 (2009-02-02)
-------------------
- Include *all* pytz zone names, not just "common" ones.
- Fix one fragile doctest, band-aid another.
- Fix for launchpad #267545: DateTime(DateTime()) should preserve the
correct hour.
2.11.1 (2008-08-05)
-------------------
- DateTime conversion of datetime objects with non-pytz tzinfo. Timezones()
returns a copy of the timezone list (allows tests to run).
- Merged the slinkp-datetime-200007 branch: fix the DateTime(anotherDateTime)
constructor to preserve timezones.
2.11.0b1 (2008-01-06)
---------------------
- Split off from the Zope2 main source code tree.
Raw data
{
"_id": null,
"home_page": "https://github.com/zopefoundation/DateTime",
"name": "DateTime",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Zope Foundation and Contributors",
"author_email": "zope-dev@zope.org",
"download_url": "https://files.pythonhosted.org/packages/2f/66/e284b9978fede35185e5d18fb3ae855b8f573d8c90a56de5f6d03e8ef99e/DateTime-5.5.tar.gz",
"platform": null,
"description": ".. image:: https://github.com/zopefoundation/DateTime/workflows/tests/badge.svg\n :target: https://github.com/zopefoundation/DateTime/actions?query=workflow%3Atests\n :alt: CI status\n\n.. image:: https://img.shields.io/pypi/v/DateTime.svg\n :target: https://pypi.org/project/DateTime/\n :alt: Current version on PyPI\n\n.. image:: https://img.shields.io/pypi/pyversions/DateTime.svg\n :target: https://pypi.org/project/DateTime/\n :alt: Supported Python versions\n\n\nDateTime\n========\n\nThis package provides a DateTime data type, as known from Zope.\n\nUnless you need to communicate with Zope APIs, you're probably better\noff using Python's built-in datetime module.\n\nFor further documentation, please have a look at `src/DateTime/DateTime.txt`.\n\n\n.. contents::\n\nThe DateTime package\n====================\n\nEncapsulation of date/time values.\n\n\nFunction Timezones()\n--------------------\n\nReturns the list of recognized timezone names:\n\n >>> from DateTime import Timezones\n >>> zones = set(Timezones())\n\nAlmost all of the standard pytz timezones are included, with the exception\nof some commonly-used but ambiguous abbreviations, where historical Zope\nusage conflicts with the name used by pytz:\n\n >>> import pytz\n >>> [x for x in pytz.all_timezones if x not in zones]\n ['CET', 'EET', 'EST', 'MET', 'MST', 'WET']\n\nClass DateTime\n--------------\n\nDateTime objects represent instants in time and provide interfaces for\ncontrolling its representation without affecting the absolute value of\nthe object.\n\nDateTime objects may be created from a wide variety of string or\nnumeric data, or may be computed from other DateTime objects.\nDateTimes support the ability to convert their representations to many\nmajor timezones, as well as the ability to create a DateTime object\nin the context of a given timezone.\n\nDateTime objects provide partial numerical behavior:\n\n* Two date-time objects can be subtracted to obtain a time, in days\n between the two.\n\n* A date-time object and a positive or negative number may be added to\n obtain a new date-time object that is the given number of days later\n than the input date-time object.\n\n* A positive or negative number and a date-time object may be added to\n obtain a new date-time object that is the given number of days later\n than the input date-time object.\n\n* A positive or negative number may be subtracted from a date-time\n object to obtain a new date-time object that is the given number of\n days earlier than the input date-time object.\n\nDateTime objects may be converted to integer, long, or float numbers\nof days since January 1, 1901, using the standard int, long, and float\nfunctions (Compatibility Note: int, long and float return the number\nof days since 1901 in GMT rather than local machine timezone).\nDateTime objects also provide access to their value in a float format\nusable with the Python time module, provided that the value of the\nobject falls in the range of the epoch-based time module.\n\nA DateTime object should be considered immutable; all conversion and numeric\noperations return a new DateTime object rather than modify the current object.\n\nA DateTime object always maintains its value as an absolute UTC time,\nand is represented in the context of some timezone based on the\narguments used to create the object. A DateTime object's methods\nreturn values based on the timezone context.\n\nNote that in all cases the local machine timezone is used for\nrepresentation if no timezone is specified.\n\nConstructor for DateTime\n------------------------\n\nDateTime() returns a new date-time object. DateTimes may be created\nwith from zero to seven arguments:\n\n* If the function is called with no arguments, then the current date/\n time is returned, represented in the timezone of the local machine.\n\n* If the function is invoked with a single string argument which is a\n recognized timezone name, an object representing the current time is\n returned, represented in the specified timezone.\n\n* If the function is invoked with a single string argument\n representing a valid date/time, an object representing that date/\n time will be returned.\n\n As a general rule, any date-time representation that is recognized\n and unambiguous to a resident of North America is acceptable. (The\n reason for this qualification is that in North America, a date like:\n 2/1/1994 is interpreted as February 1, 1994, while in some parts of\n the world, it is interpreted as January 2, 1994.) A date/ time\n string consists of two components, a date component and an optional\n time component, separated by one or more spaces. If the time\n component is omitted, 12:00am is assumed.\n \n Any recognized timezone name specified as the final element of the\n date/time string will be used for computing the date/time value.\n (If you create a DateTime with the string,\n \"Mar 9, 1997 1:45pm US/Pacific\", the value will essentially be the\n same as if you had captured time.time() at the specified date and\n time on a machine in that timezone). If no timezone is passed, then\n the timezone configured on the local machine will be used, **except**\n that if the date format matches ISO 8601 ('YYYY-MM-DD'), the instance\n will use UTC / GMT+0 as the timezone.\n\n o Returns current date/time, represented in US/Eastern:\n\n >>> from DateTime import DateTime\n >>> e = DateTime('US/Eastern')\n >>> e.timezone()\n 'US/Eastern'\n\n o Returns specified time, represented in local machine zone:\n\n >>> x = DateTime('1997/3/9 1:45pm')\n >>> x.parts() # doctest: +ELLIPSIS\n (1997, 3, 9, 13, 45, ...)\n\n o Specified time in local machine zone, verbose format:\n\n >>> y = DateTime('Mar 9, 1997 13:45:00')\n >>> y.parts() # doctest: +ELLIPSIS\n (1997, 3, 9, 13, 45, ...)\n >>> y == x\n True\n \n o Specified time in UTC via ISO 8601 rule:\n \n >>> z = DateTime('2014-03-24')\n >>> z.parts() # doctest: +ELLIPSIS\n (2014, 3, 24, 0, 0, ...)\n >>> z.timezone()\n 'GMT+0'\n\n The date component consists of year, month, and day values. The\n year value must be a one-, two-, or four-digit integer. If a one-\n or two-digit year is used, the year is assumed to be in the\n twentieth century. The month may an integer, from 1 to 12, a month\n name, or a month abbreviation, where a period may optionally follow\n the abbreviation. The day must be an integer from 1 to the number of\n days in the month. The year, month, and day values may be separated\n by periods, hyphens, forward slashes, or spaces. Extra spaces are\n permitted around the delimiters. Year, month, and day values may be\n given in any order as long as it is possible to distinguish the\n components. If all three components are numbers that are less than\n 13, then a month-day-year ordering is assumed.\n\n The time component consists of hour, minute, and second values\n separated by colons. The hour value must be an integer between 0\n and 23 inclusively. The minute value must be an integer between 0\n and 59 inclusively. The second value may be an integer value\n between 0 and 59.999 inclusively. The second value or both the\n minute and second values may be omitted. The time may be followed\n by am or pm in upper or lower case, in which case a 12-hour clock is\n assumed.\n\n* If the DateTime function is invoked with a single numeric argument,\n the number is assumed to be either a floating point value such as\n that returned by time.time(), or a number of days after January 1,\n 1901 00:00:00 UTC.\n\n A DateTime object is returned that represents either the GMT value\n of the time.time() float represented in the local machine's\n timezone, or that number of days after January 1, 1901. Note that\n the number of days after 1901 need to be expressed from the\n viewpoint of the local machine's timezone. A negative argument will\n yield a date-time value before 1901.\n\n* If the function is invoked with two numeric arguments, then the\n first is taken to be an integer year and the second argument is\n taken to be an offset in days from the beginning of the year, in the\n context of the local machine timezone. The date-time value returned\n is the given offset number of days from the beginning of the given\n year, represented in the timezone of the local machine. The offset\n may be positive or negative. Two-digit years are assumed to be in\n the twentieth century.\n\n* If the function is invoked with two arguments, the first a float\n representing a number of seconds past the epoch in GMT (such as\n those returned by time.time()) and the second a string naming a\n recognized timezone, a DateTime with a value of that GMT time will\n be returned, represented in the given timezone.\n\n >>> import time\n >>> t = time.time()\n\n Time t represented as US/Eastern:\n\n >>> now_east = DateTime(t, 'US/Eastern')\n\n Time t represented as US/Pacific:\n\n >>> now_west = DateTime(t, 'US/Pacific')\n\n Only their representations are different:\n\n >>> now_east.equalTo(now_west)\n True\n\n* If the function is invoked with three or more numeric arguments,\n then the first is taken to be an integer year, the second is taken\n to be an integer month, and the third is taken to be an integer day.\n If the combination of values is not valid, then a DateTimeError is\n raised. One- or two-digit years up to 69 are assumed to be in the \n 21st century, whereas values 70-99 are assumed to be 20th century.\n The fourth, fifth, and sixth arguments are floating point, positive\n or negative offsets in units of hours, minutes, and days, and\n default to zero if not given. An optional string may be given as\n the final argument to indicate timezone (the effect of this is as if\n you had taken the value of time.time() at that time on a machine in\n the specified timezone).\n\nIf a string argument passed to the DateTime constructor cannot be\nparsed, it will raise SyntaxError. Invalid date, time, or\ntimezone components will raise a DateTimeError.\n\nThe module function Timezones() will return a list of the timezones\nrecognized by the DateTime module. Recognition of timezone names is\ncase-insensitive.\n\nInstance Methods for DateTime (IDateTime interface)\n---------------------------------------------------\n\nConversion and comparison methods\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* ``timeTime()`` returns the date/time as a floating-point number in\n UTC, in the format used by the Python time module. Note that it is\n possible to create date /time values with DateTime that have no\n meaningful value to the time module, and in such cases a\n DateTimeError is raised. A DateTime object's value must generally\n be between Jan 1, 1970 (or your local machine epoch) and Jan 2038 to\n produce a valid time.time() style value.\n\n >>> dt = DateTime('Mar 9, 1997 13:45:00 US/Eastern')\n >>> dt.timeTime()\n 857933100.0\n\n >>> DateTime('2040/01/01 UTC').timeTime()\n 2208988800.0\n\n >>> DateTime('1900/01/01 UTC').timeTime()\n -2208988800.0\n\n* ``toZone(z)`` returns a DateTime with the value as the current\n object, represented in the indicated timezone:\n\n >>> dt.toZone('UTC')\n DateTime('1997/03/09 18:45:00 UTC')\n\n >>> dt.toZone('UTC').equalTo(dt)\n True\n\n* ``isFuture()`` returns true if this object represents a date/time\n later than the time of the call:\n\n >>> dt.isFuture()\n False\n >>> DateTime('Jan 1 3000').isFuture() # not time-machine safe!\n True\n\n* ``isPast()`` returns true if this object represents a date/time\n earlier than the time of the call:\n\n >>> dt.isPast()\n True\n >>> DateTime('Jan 1 3000').isPast() # not time-machine safe!\n False\n\n* ``isCurrentYear()`` returns true if this object represents a\n date/time that falls within the current year, in the context of this\n object's timezone representation:\n\n >>> dt.isCurrentYear()\n False\n >>> DateTime().isCurrentYear()\n True\n\n* ``isCurrentMonth()`` returns true if this object represents a\n date/time that falls within the current month, in the context of\n this object's timezone representation:\n\n >>> dt.isCurrentMonth()\n False\n >>> DateTime().isCurrentMonth()\n True\n\n* ``isCurrentDay()`` returns true if this object represents a\n date/time that falls within the current day, in the context of this\n object's timezone representation:\n\n >>> dt.isCurrentDay()\n False\n >>> DateTime().isCurrentDay()\n True\n\n* ``isCurrentHour()`` returns true if this object represents a\n date/time that falls within the current hour, in the context of this\n object's timezone representation:\n\n >>> dt.isCurrentHour()\n False\n\n >>> DateTime().isCurrentHour()\n True\n\n* ``isCurrentMinute()`` returns true if this object represents a\n date/time that falls within the current minute, in the context of\n this object's timezone representation:\n\n >>> dt.isCurrentMinute()\n False\n >>> DateTime().isCurrentMinute()\n True\n\n* ``isLeapYear()`` returns true if the current year (in the context of\n the object's timezone) is a leap year:\n\n >>> dt.isLeapYear()\n False\n >>> DateTime('Mar 8 2004').isLeapYear()\n True\n\n* ``earliestTime()`` returns a new DateTime object that represents the\n earliest possible time (in whole seconds) that still falls within\n the current object's day, in the object's timezone context:\n\n >>> dt.earliestTime()\n DateTime('1997/03/09 00:00:00 US/Eastern')\n\n* ``latestTime()`` return a new DateTime object that represents the\n latest possible time (in whole seconds) that still falls within the\n current object's day, in the object's timezone context\n\n >>> dt.latestTime()\n DateTime('1997/03/09 23:59:59 US/Eastern')\n\nComponent access\n~~~~~~~~~~~~~~~~\n\n* ``parts()`` returns a tuple containing the calendar year, month,\n day, hour, minute second and timezone of the object\n\n >>> dt.parts() # doctest: +ELLIPSIS\n (1997, 3, 9, 13, 45, ... 'US/Eastern')\n\n* ``timezone()`` returns the timezone in which the object is represented:\n\n >>> dt.timezone() in Timezones()\n True\n\n* ``tzoffset()`` returns the timezone offset for the objects timezone:\n\n >>> dt.tzoffset()\n -18000\n\n* ``year()`` returns the calendar year of the object:\n\n >>> dt.year()\n 1997\n\n* ``month()`` returns the month of the object as an integer:\n\n >>> dt.month()\n 3\n\n* ``Month()`` returns the full month name:\n\n >>> dt.Month()\n 'March'\n\n* ``aMonth()`` returns the abbreviated month name:\n\n >>> dt.aMonth()\n 'Mar'\n\n* ``pMonth()`` returns the abbreviated (with period) month name:\n\n >>> dt.pMonth()\n 'Mar.'\n\n* ``day()`` returns the integer day:\n\n >>> dt.day()\n 9\n\n* ``Day()`` returns the full name of the day of the week:\n\n >>> dt.Day()\n 'Sunday'\n\n* ``dayOfYear()`` returns the day of the year, in context of the\n timezone representation of the object:\n\n >>> dt.dayOfYear()\n 68\n\n* ``aDay()`` returns the abbreviated name of the day of the week:\n\n >>> dt.aDay()\n 'Sun'\n\n* ``pDay()`` returns the abbreviated (with period) name of the day of\n the week:\n\n >>> dt.pDay()\n 'Sun.'\n\n* ``dow()`` returns the integer day of the week, where Sunday is 0:\n\n >>> dt.dow()\n 0\n\n* ``dow_1()`` returns the integer day of the week, where sunday is 1:\n\n >>> dt.dow_1()\n 1\n\n* ``h_12()`` returns the 12-hour clock representation of the hour:\n\n >>> dt.h_12()\n 1\n\n* ``h_24()`` returns the 24-hour clock representation of the hour:\n\n >>> dt.h_24()\n 13\n\n* ``ampm()`` returns the appropriate time modifier (am or pm):\n\n >>> dt.ampm()\n 'pm'\n\n* ``hour()`` returns the 24-hour clock representation of the hour:\n\n >>> dt.hour()\n 13\n\n* ``minute()`` returns the minute:\n\n >>> dt.minute()\n 45\n\n* ``second()`` returns the second:\n\n >>> dt.second() == 0\n True\n\n* ``millis()`` returns the milliseconds since the epoch in GMT.\n\n >>> dt.millis() == 857933100000\n True\n\nstrftime()\n~~~~~~~~~~\n\nSee ``tests/test_datetime.py``.\n\nGeneral formats from previous DateTime\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* ``Date()`` return the date string for the object:\n\n >>> dt.Date()\n '1997/03/09'\n\n* ``Time()`` returns the time string for an object to the nearest\n second:\n\n >>> dt.Time()\n '13:45:00'\n\n* ``TimeMinutes()`` returns the time string for an object not showing\n seconds:\n\n >>> dt.TimeMinutes()\n '13:45'\n\n* ``AMPM()`` returns the time string for an object to the nearest second:\n\n >>> dt.AMPM()\n '01:45:00 pm'\n\n* ``AMPMMinutes()`` returns the time string for an object not showing\n seconds:\n\n >>> dt.AMPMMinutes()\n '01:45 pm'\n\n* ``PreciseTime()`` returns the time string for the object:\n\n >>> dt.PreciseTime()\n '13:45:00.000'\n\n* ``PreciseAMPM()`` returns the time string for the object:\n\n >>> dt.PreciseAMPM()\n '01:45:00.000 pm'\n\n* ``yy()`` returns the calendar year as a 2 digit string\n\n >>> dt.yy()\n '97'\n\n* ``mm()`` returns the month as a 2 digit string\n\n >>> dt.mm()\n '03'\n\n* ``dd()`` returns the day as a 2 digit string:\n\n >>> dt.dd()\n '09'\n\n* ``rfc822()`` returns the date in RFC 822 format:\n\n >>> dt.rfc822()\n 'Sun, 09 Mar 1997 13:45:00 -0500'\n\nNew formats\n~~~~~~~~~~~\n\n* ``fCommon()`` returns a string representing the object's value in\n the format: March 9, 1997 1:45 pm:\n\n >>> dt.fCommon()\n 'March 9, 1997 1:45 pm'\n\n* ``fCommonZ()`` returns a string representing the object's value in\n the format: March 9, 1997 1:45 pm US/Eastern:\n\n >>> dt.fCommonZ()\n 'March 9, 1997 1:45 pm US/Eastern'\n\n* ``aCommon()`` returns a string representing the object's value in\n the format: Mar 9, 1997 1:45 pm:\n\n >>> dt.aCommon()\n 'Mar 9, 1997 1:45 pm'\n\n* ``aCommonZ()`` return a string representing the object's value in\n the format: Mar 9, 1997 1:45 pm US/Eastern:\n\n >>> dt.aCommonZ()\n 'Mar 9, 1997 1:45 pm US/Eastern'\n\n* ``pCommon()`` returns a string representing the object's value in\n the format Mar. 9, 1997 1:45 pm:\n\n >>> dt.pCommon()\n 'Mar. 9, 1997 1:45 pm'\n\n* ``pCommonZ()`` returns a string representing the object's value in\n the format: Mar. 9, 1997 1:45 pm US/Eastern:\n\n >>> dt.pCommonZ()\n 'Mar. 9, 1997 1:45 pm US/Eastern'\n\n* ``ISO()`` returns a string with the date/time in ISO format. Note:\n this is not ISO 8601-format! See the ISO8601 and HTML4 methods below\n for ISO 8601-compliant output. Dates are output as: YYYY-MM-DD HH:MM:SS\n\n >>> dt.ISO()\n '1997-03-09 13:45:00'\n\n* ``ISO8601()`` returns the object in ISO 8601-compatible format\n containing the date, time with seconds-precision and the time zone\n identifier - see http://www.w3.org/TR/NOTE-datetime. Dates are\n output as: YYYY-MM-DDTHH:MM:SSTZD (T is a literal character, TZD is\n Time Zone Designator, format +HH:MM or -HH:MM).\n\n The ``HTML4()`` method below offers the same formatting, but\n converts to UTC before returning the value and sets the TZD\"Z\"\n\n >>> dt.ISO8601()\n '1997-03-09T13:45:00-05:00'\n\n\n* ``HTML4()`` returns the object in the format used in the HTML4.0\n specification, one of the standard forms in ISO8601. See\n http://www.w3.org/TR/NOTE-datetime. Dates are output as:\n YYYY-MM-DDTHH:MM:SSZ (T, Z are literal characters, the time is in\n UTC.):\n\n >>> dt.HTML4()\n '1997-03-09T18:45:00Z'\n\n* ``JulianDay()`` returns the Julian day according to\n http://www.tondering.dk/claus/cal/node3.html#sec-calcjd\n\n >>> dt.JulianDay()\n 2450517\n\n* ``week()`` returns the week number according to ISO\n see http://www.tondering.dk/claus/cal/node6.html#SECTION00670000000000000000\n\n >>> dt.week()\n 10\n\nDeprecated API\n~~~~~~~~~~~~~~\n\n* DayOfWeek(): see Day()\n\n* Day_(): see pDay()\n\n* Mon(): see aMonth()\n\n* Mon_(): see pMonth\n\nGeneral Services Provided by DateTime\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nDateTimes can be repr()'ed; the result will be a string indicating how\nto make a DateTime object like this:\n\n >>> repr(dt)\n \"DateTime('1997/03/09 13:45:00 US/Eastern')\"\n\nWhen we convert them into a string, we get a nicer string that could\nactually be shown to a user:\n\n >>> str(dt)\n '1997/03/09 13:45:00 US/Eastern'\n\nThe hash value of a DateTime is based on the date and time and is\nequal for different representations of the DateTime:\n\n >>> hash(dt)\n 3618678\n >>> hash(dt.toZone('UTC'))\n 3618678\n\nDateTime objects can be compared to other DateTime objects OR floating\npoint numbers such as the ones which are returned by the Python time\nmodule by using the equalTo method. Using this API, True is returned if the\nobject represents a date/time equal to the specified DateTime or time module\nstyle time:\n\n >>> dt.equalTo(dt)\n True\n >>> dt.equalTo(dt.toZone('UTC'))\n True\n >>> dt.equalTo(dt.timeTime())\n True\n >>> dt.equalTo(DateTime())\n False\n\nSame goes for inequalities:\n\n >>> dt.notEqualTo(dt)\n False\n >>> dt.notEqualTo(dt.toZone('UTC'))\n False\n >>> dt.notEqualTo(dt.timeTime())\n False\n >>> dt.notEqualTo(DateTime())\n True\n\nNormal equality operations only work with DateTime objects and take the\ntimezone setting into account:\n\n >>> dt == dt\n True\n >>> dt == dt.toZone('UTC')\n False\n >>> dt == DateTime()\n False\n\n >>> dt != dt\n False\n >>> dt != dt.toZone('UTC')\n True\n >>> dt != DateTime()\n True\n\nBut the other comparison operations compare the referenced moment in time and\nnot the representation itself:\n\n >>> dt > dt\n False\n >>> DateTime() > dt\n True\n >>> dt > DateTime().timeTime()\n False\n >>> DateTime().timeTime() > dt\n True\n\n >>> dt.greaterThan(dt)\n False\n >>> DateTime().greaterThan(dt)\n True\n >>> dt.greaterThan(DateTime().timeTime())\n False\n\n >>> dt >= dt\n True\n >>> DateTime() >= dt\n True\n >>> dt >= DateTime().timeTime()\n False\n >>> DateTime().timeTime() >= dt\n True\n\n >>> dt.greaterThanEqualTo(dt)\n True\n >>> DateTime().greaterThanEqualTo(dt)\n True\n >>> dt.greaterThanEqualTo(DateTime().timeTime())\n False\n\n >>> dt < dt\n False\n >>> DateTime() < dt\n False\n >>> dt < DateTime().timeTime()\n True\n >>> DateTime().timeTime() < dt\n False\n\n >>> dt.lessThan(dt)\n False\n >>> DateTime().lessThan(dt)\n False\n >>> dt.lessThan(DateTime().timeTime())\n True\n\n >>> dt <= dt\n True\n >>> DateTime() <= dt\n False\n >>> dt <= DateTime().timeTime()\n True\n >>> DateTime().timeTime() <= dt\n False\n\n >>> dt.lessThanEqualTo(dt)\n True\n >>> DateTime().lessThanEqualTo(dt)\n False\n >>> dt.lessThanEqualTo(DateTime().timeTime())\n True\n\nNumeric Services Provided by DateTime\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nA DateTime may be added to a number and a number may be added to a\nDateTime:\n\n >>> dt + 5\n DateTime('1997/03/14 13:45:00 US/Eastern')\n >>> 5 + dt\n DateTime('1997/03/14 13:45:00 US/Eastern')\n\nTwo DateTimes cannot be added:\n\n >>> from DateTime.interfaces import DateTimeError\n >>> try:\n ... dt + dt\n ... print('fail')\n ... except DateTimeError:\n ... print('ok')\n ok\n\nEither a DateTime or a number may be subtracted from a DateTime,\nhowever, a DateTime may not be subtracted from a number:\n\n >>> DateTime('1997/03/10 13:45 US/Eastern') - dt\n 1.0\n >>> dt - 1\n DateTime('1997/03/08 13:45:00 US/Eastern')\n >>> 1 - dt\n Traceback (most recent call last):\n ...\n TypeError: unsupported operand type(s) for -: 'int' and 'DateTime'\n\nDateTimes can also be converted to integers (number of seconds since\nthe epoch) and floats:\n\n >>> int(dt)\n 857933100\n >>> float(dt)\n 857933100.0\n\n\nChangelog\n=========\n\n5.5 (2024-03-21)\n----------------\n\n- Change pickle format to export the microseconds as an int, to\n solve a problem with dates after 2038.\n (`#56 <https://github.com/zopefoundation/DateTime/issues/56>`_)\n\n\n5.4 (2023-12-15)\n----------------\n\n- Fix ``UnknownTimeZoneError`` when unpickling ``DateTime.DateTime().asdatetime()``.\n (`#58 <https://github.com/zopefoundation/DateTime/issues/58>`_)\n\n- Repair equality comparison between DateTime instances and other types.\n (`#60 <https://github.com/zopefoundation/DateTime/issues/60>`_)\n\n\n5.3 (2023-11-14)\n----------------\n\n- Add support for Python 3.12.\n\n- Add preliminary support for Python 3.13a2.\n\n\n5.2 (2023-07-19)\n----------------\n\n- Cast int to float in compare methods.\n- Fix compare methods between DateTime instances and None.\n (`#52 <https://github.com/zopefoundation/DateTime/issues/52>`_)\n\n\n5.1 (2023-03-14)\n----------------\n\n- Add missing ``python_requires`` to ``setup.py``.\n\n\n5.0 (2023-01-12)\n----------------\n\n- Drop support for Python 2.7, 3.5, 3.6.\n\n\n4.8 (2022-12-16)\n----------------\n\n- Fix insidious buildout configuration bug that prevented tests on Python 2.7\n and 3.5, and fix test code that was incompatible with Python 3.5.\n (`#44 <https://github.com/zopefoundation/DateTime/issues/44>`_)\n\n- Add support for Python 3.11.\n\n\n4.7 (2022-09-14)\n----------------\n\n- Fix rounding problem with `DateTime` addition beyond the year 2038\n (`#41 <https://github.com/zopefoundation/DateTime/issues/41>`_)\n\n\n4.6 (2022-09-10)\n----------------\n\n- Fix ``__format__`` method for DateTime objects\n (`#39 <https://github.com/zopefoundation/DateTime/issues/39>`_)\n\n\n4.5 (2022-07-04)\n----------------\n\n- Add ``__format__`` method for DateTime objects\n (`#35 <https://github.com/zopefoundation/DateTime/issues/35>`_)\n\n\n4.4 (2022-02-11)\n----------------\n\n- Fix WAT definition\n `#31 <https://github.com/zopefoundation/DateTime/issues/31>`_.\n\n- Add support for Python 3.8, 3.9, and 3.10.\n\n- Drop support for Python 3.4.\n\n4.3 (2018-10-05)\n----------------\n\n- Add support for Python 3.7.\n\n4.2 (2017-04-26)\n----------------\n\n- Add support for Python 3.6, drop support for Python 3.3.\n\n4.1.1 (2016-04-30)\n------------------\n\n- Support unpickling instances having a numeric timezone like `+0430`.\n\n4.1 (2016-04-03)\n----------------\n\n- Add support for Python 3.4 and 3.5.\n\n- Drop support for Python 2.6 and 3.2.\n\n4.0.1 (2013-10-15)\n------------------\n\n- Provide more backward compatible timezones.\n [vangheem]\n\n4.0 (2013-02-23)\n----------------\n\n- Added support for Python 3.2 and 3.3 in addition to 2.6 and 2.7.\n\n- Removed unused legacy pytz tests and the DateTimeZone module and renamed\n some test internals.\n\n3.0.3 (2013-01-22)\n------------------\n\n- Allow timezone argument to be a Unicode string while creating a DateTime\n object using two arguments.\n\n3.0.2 (2012-10-21)\n------------------\n\n- LP #1045233: Respect date format setting for parsing dates like `11-01-2001`.\n\n3.0.1 (2012-09-23)\n------------------\n\n- Add `_dt_reconstructor` function introduced in DateTime 2.12.7 to provide\n forward compatibility with pickles that might reference this function.\n\n3.0 (2011-12-09)\n----------------\n\n- No changes.\n\nBackwards compatibility of DateTime 3\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nDateTime 3 changes its pickle representation. DateTime instances pickled with\nformer versions of DateTime can be read, but older DateTime versions cannot read\nDateTime instances pickled with version 3.\n\nDateTime 3 changes DateTime to be a new-style class with slots instead of being\nan old-style class.\n\nDateTime 3 tries to preserve microsecond resolution throughout most of its API's\nwhile former versions were often only accurate to millisecond resolution. Due to\nthe representation of float values in Python versions before Python 2.7 you\nshouldn't compare string or float representations of DateTime instances if you\nwant high accuracy. The same is true for calculated values returned by methods\nlike `timeTime()`. You get the highest accuracy of comparing DateTime values by\ncalling its `micros()` methods. DateTime is not particular well suited to be\nused in comparing timestamps of file systems - use the time and datetime objects\nfrom the Python standard library instead.\n\n3.0b3 (2011-10-19)\n------------------\n\n- Allow comparison of DateTime objects against None.\n\n3.0b2 (2011-10-19)\n------------------\n\n- Reverted the single argument `None` special case handling for unpickling and\n continue to treat it as meaning `now`.\n\n3.0b1 (2011-05-07)\n------------------\n\n- Restored `strftimeFormatter` as a class.\n\n- Added tests for read-only class attributes and interface.\n\n3.0a2 (2011-05-07)\n------------------\n\n- Added back support for reading old DateTime pickles without a `_micros` value.\n\n- Avoid storing `_t` representing the time as a float in seconds since the\n epoch, as we already have `_micros` doing the same as a long. Memory use is\n down to about 300 bytes per DateTime instance.\n\n- Updated exception raising syntax to current style.\n\n- Avoid storing `_aday`, `_fday`, `_pday`, `_amon`, `_fmon`, `_pmon`, `_pmhour`\n and `_pm` in memory for every instance but look them up dynamically based on\n `_dayoffset`, `_month` and `_hour`. This saves another 150 bytes of memory\n per DateTime instance.\n\n- Moved various internal parsing related class variables to module constants.\n\n- No longer provide the `DateError`, `DateTimeError`, `SyntaxError` and\n `TimeError` exceptions as class attributes, import them from their canonical\n `DateTime.interfaces` location instead.\n\n- Removed deprecated `_isDST` and `_localzone` class variables.\n\n- Moved pytz cache from `DateTime._tzinfo` to a module global `_TZINFO`.\n\n- Make DateTime a new-style class and limit its available attributes via a\n slots definition. The pickle size increases to 110 bytes thanks to the\n `ccopy_reg\\n_reconstructor` stanza. But the memory size drops from 3kb to\n 500 bytes for each instance.\n\n3.0a1 (2011-05-06)\n------------------\n\n- Reordered some calculations in `_calcIndependentSecondEtc` to preserve more\n floating point precision.\n\n- Optimized the pickled data, by only storing a tuple of `_micros` and time\n zone information - this reduces the pickle size from an average of 300 bytes\n to just 60 bytes.\n\n- Optimized un-pickling, by avoiding the creation of an intermediate DateTime\n value representing the current time.\n\n- Removed in-place migration of old DateTime pickles without a `_micros` value.\n\n- Removed deprecated support for using `DateTime.__cmp__`.\n\n- Take time zone settings into account when comparing two date times for\n (non-) equality.\n\n- Fixed (possibly unused) _parse_iso8601 function.\n\n- Removed unused import of legacy DateTimeZone, strftime and re.\n Remove trailing whitespace.\n\n- Removed reference to missing version section from buildout.\n\n2.12.7 (2012-08-11)\n-------------------\n\n- Added forward compatibility with DateTime 3 pickle format. DateTime\n instances constructed under version 3 can be read and unpickled by this\n version. The pickled data is converted to the current versions format\n (old-style class / no slots). Once converted it will be stored again in the\n old format. This should allow for a transparent upgrade/downgrade path\n between DateTime 2 and 3.\n\n2.12.6 (2010-10-17)\n-------------------\n\n- Changed ``testDayOfWeek`` test to be independent of OS locale.\n\n2.12.5 (2010-07-29)\n-------------------\n\n- Launchpad #143269: Corrected the documentation for year value\n behavior when constructing a DateTime object with three numeric\n arguments.\n\n- Launchpad #142521: Removed confusing special case in\n DateTime.__str__ where DateTime instances for midnight\n (e.g. '2010-07-27 00:00:00 US/Eastern') values would\n render only their date and nothing else.\n\n2.12.4 (2010-07-12)\n-------------------\n\n- Fixed mapping of EDT (was -> 'GMT-0400', now 'GMT-4').\n\n2.12.3 (2010-07-09)\n-------------------\n\n- Added EDT timezone support. Addresses bug #599856.\n [vangheem]\n\n2.12.2 (2010-05-05)\n-------------------\n\n- Launchpad #572715: Relaxed pin on pytz, after applying a patch from\n Marius Gedminus which fixes the apparent API breakage.\n\n2.12.1 (2010-04-30)\n-------------------\n\n- Removed an undeclared testing dependency on zope.testing.doctest in favor of\n the standard libraries doctest module.\n\n- Added a maximum version requirement on pytz <= 2010b. Later versions produce\n test failures related to timezone changes.\n\n2.12.0 (2009-03-04)\n-------------------\n\n- Launchpad #290254: Forward-ported fix for '_micros'-less pickles from\n the Zope 2.11 branch version.\n\n2.11.2 (2009-02-02)\n-------------------\n\n- Include *all* pytz zone names, not just \"common\" ones.\n\n- Fix one fragile doctest, band-aid another.\n\n- Fix for launchpad #267545: DateTime(DateTime()) should preserve the\n correct hour.\n\n2.11.1 (2008-08-05)\n-------------------\n\n- DateTime conversion of datetime objects with non-pytz tzinfo. Timezones()\n returns a copy of the timezone list (allows tests to run).\n\n- Merged the slinkp-datetime-200007 branch: fix the DateTime(anotherDateTime)\n constructor to preserve timezones.\n\n2.11.0b1 (2008-01-06)\n---------------------\n\n- Split off from the Zope2 main source code tree.\n",
"bugtrack_url": null,
"license": "ZPL 2.1",
"summary": "This package provides a DateTime data type, as known from Zope. Unless you need to communicate with Zope APIs, you're probably better off using Python's built-in datetime module.",
"version": "5.5",
"project_urls": {
"Homepage": "https://github.com/zopefoundation/DateTime"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f3788e382b8cb4346119e2e04270b6eb4a01c5ee70b47a8a0244ecdb157204f7",
"md5": "b79b5ac908450e1b2bdc4dfff3eb1393",
"sha256": "0abf6c51cb4ba7cee775ca46ccc727f3afdde463be28dbbe8803631fefd4a120"
},
"downloads": -1,
"filename": "DateTime-5.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b79b5ac908450e1b2bdc4dfff3eb1393",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 52649,
"upload_time": "2024-03-21T07:26:47",
"upload_time_iso_8601": "2024-03-21T07:26:47.849806Z",
"url": "https://files.pythonhosted.org/packages/f3/78/8e382b8cb4346119e2e04270b6eb4a01c5ee70b47a8a0244ecdb157204f7/DateTime-5.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2f66e284b9978fede35185e5d18fb3ae855b8f573d8c90a56de5f6d03e8ef99e",
"md5": "fa5da1fb1d9acd87a137fc7a2b7f14c7",
"sha256": "21ec6331f87a7fcb57bd7c59e8a68bfffe6fcbf5acdbbc7b356d6a9a020191d3"
},
"downloads": -1,
"filename": "DateTime-5.5.tar.gz",
"has_sig": false,
"md5_digest": "fa5da1fb1d9acd87a137fc7a2b7f14c7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 63671,
"upload_time": "2024-03-21T07:26:50",
"upload_time_iso_8601": "2024-03-21T07:26:50.211583Z",
"url": "https://files.pythonhosted.org/packages/2f/66/e284b9978fede35185e5d18fb3ae855b8f573d8c90a56de5f6d03e8ef99e/DateTime-5.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-21 07:26:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zopefoundation",
"github_project": "DateTime",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "datetime"
}
