8.1. datetime — 基本的日期和时间类型

源代码: Lib/datetime.py


datetime 模块提供了可以通过多种方式操作日期和时间的类。在支持日期时间数学运算的同时,实现的关注点更着重于如何能够更有效地解析其属性用于格式化输出和数据操作。相关功能可以参阅 timecalendar 模块。

有两种日期和时间的对象:“简单型“和”感知型“。

感知型对象有着用足以支持一些应用层面算法和国家层面时间调整的信息,例如时区和夏令时,来让自己和其他的感知型对象区别开来。感知型对象是用来表达不对解释器开放的特定时间信息 1

简单型对象没包含足够多的信息来明确定位与之相关的 date/time 对象。 简单型对象所代表的是世界标准时间(UTC)、当地时间或者是其它时区的时间完全取决于程序,就像一个数字是代表的是米、英里或者质量完全取决于程序一样。 简单型对象以忽略了一些现实情况的为代价使得它容易理解和使用。

对于需要感知型对象的应用, datetime 对象和 time 对象有一个可选的时区信息属性 tzinfo ,这个属性可以设置给 tzinfo 类的子类实例。这些 tzinfo 对象捕获关于相对于世界标准时间(UTC)偏移、时区名字和夏令时是否有效等信息。需要注意的是,只有一个具体的 tzinfo 类,即由 datetime 模块提供的 timezone 类。 timezone 类可以代表相对于世界标准时间(UTC)固定偏移的简单时区,比如世界标准时间(UTC)自己或者北美东部时间或者东部夏令时。支持时区的详细程度取决于应用。世界各地的时间调整规则相比理性更加政治性,经常会变更。也没有一个基于世界标准时间(UTC)的标准套件适合用于所有应用。

The datetime module exports the following constants:

datetime.MINYEAR

date 或者 datetime 对象允许的最小年份。 常量 MINYEAR1

datetime.MAXYEAR

datedatetime 对象允许最大的年份。常量 MAXYEAR9999

也參考

模块 calendar

日历相关函数

模块 time

时间的访问和转换

8.1.1. 有效的类型

class datetime.date

一个理想化的简单型日期,它假设当今的公历在过去和未来永远有效。 属性: year, month, and day

class datetime.time

一个理想化的时间,它独立于任何特定的日期,假设每天一共有 24*60*60 秒(这里没有」闰秒」的概念)。 属性: hour, minute, second, microsecond, 和 tzinfo

class datetime.datetime

日期和时间的结合。属性:year, month, day, hour, minute, second, microsecond, and tzinfo.

class datetime.timedelta

表示两个 date 对象或者 time 对象,或者 datetime 对象之间的时间间隔,精确到微秒。

class datetime.tzinfo

一个描述时区信息的抽象基类。用于给 datetime 类和 time 类提供自定义的时间调整概念(例如,负责时区或者夏令时)。

class datetime.timezone

一个实现了 tzinfo 抽象基类的子类,用于表示相对于 世界标准时间(UTC)的偏移量。

3.2 版新加入.

这些类型的对象都是不可变的。

date 类型的对象都是简单型的。

An object of type time or datetime may be naive or aware. A datetime object d is aware if d.tzinfo is not None and d.tzinfo.utcoffset(d) does not return None. If d.tzinfo is None, or if d.tzinfo is not None but d.tzinfo.utcoffset(d) returns None, d is naive. A time object t is aware if t.tzinfo is not None and t.tzinfo.utcoffset(None) does not return None. Otherwise, t is naive.

简单型和感知型之间的差别不适用于 timedelta 对象。

子类关系

object
    timedelta
    tzinfo
        timezone
    time
    date
        datetime

8.1.2. timedelta 类对象

timedelta 对象表示两个 date 或者 time 的时间间隔。

class datetime.timedelta(days=0, seconds=0, microseconds=0, milliseconds=0, minutes=0, hours=0, weeks=0)

所有的参数都是可选的并且默认为 0。这些参数可以是整数或者浮点数,也可以是正数或者负数。

只有 days,*seconds* 和 microseconds 会存储在内部,即python内部以 days,*seconds* 和 microseconds 三个单位作为存储的基本单位。参数单位转换规则如下:

  • 1毫秒会转换成1000微秒。

  • 1分钟会转换成60秒。

  • 1小时会转换成3600秒。

  • 1星期会转换成7天。

days, seconds, microseconds 本身也是标准化的,以保证表达方式的唯一性,例:

  • 0 <= microseconds < 1000000

  • 0 <= seconds < 3600*24 (一天的秒数)

  • -999999999 <= days <= 999999999

在有任何浮点型参数或者微秒为小数的情况下,所有小数均会按照前面的换算规则叠加到下一级,并使用round-half-to-even的方法对微秒进行取舍。没有浮点型参数情况下,转换的过程就是精确的(没有信息丢失)。

如果标准化后的 days 数值超过了指定范围,将会抛出 OverflowError 异常。

需要注意的是,负数被标准化后的结果会让你大吃一惊。例如,

>>> from datetime import timedelta
>>> d = timedelta(microseconds=-1)
>>> (d.days, d.seconds, d.microseconds)
(-1, 86399, 999999)

类属性:

timedelta.min

The most negative timedelta object, timedelta(-999999999).

timedelta.max

The most positive timedelta object, timedelta(days=999999999, hours=23, minutes=59, seconds=59, microseconds=999999).

timedelta.resolution

两个不相等的 timedelta 类对象最小的间隔为 timedelta(microseconds=1)

需要注意的是,因为标准化的缘故,timedelta.max > -timedelta.min-timedelta.max 不可以表示一个 timedelta 类对象。

实例属性(只读):

属性

days

-999999999 至 999999999 ,含999999999

seconds

0 至 86399,包含86399

microseconds

0 至 999999,包含999999

支持的运算:

运算

结果:

t1 = t2 + t3

t2t3 的和。 运算后 t1-t2 == t3 and t1-t3 == t2 必为真值。(1)

t1 = t2 - t3

t2t3 的差。 运算后 t1 == t2 - t3 and t2 == t1 + t3 必为真值。 (1)(6)

t1 = t2 * i or t1 = i * t2

乘以一个整数。运算后假如 i != 0t1 // i == t2 必为真值。

In general, t1 * i == t1 * (i-1) + t1 is true. (1)

t1 = t2 * f or t1 = f * t2

乘以一个浮点数,结果会被舍入到 timedelta 最接近的整数倍。 精度使用四舍五偶入奇不入规则。

f = t2 / t3

Division (3) of t2 by t3. Returns a float object.

t1 = t2 / f or t1 = t2 / i

除以一个浮点数或整数。 结果会被舍入到 timedelta 最接近的整数倍。 精度使用四舍五偶入奇不入规则。

t1 = t2 // i or t1 = t2 // t3

取整除,余数部分(如果有的话)将被丢弃。在第二种情况下,返回一个整数。(3)

t1 = t2 % t3

余数为一个 timedelta 对象。(3)

q, r = divmod(t1, t2)

通过 : q = t1 // t2 (3) and r = t1 % t2 计算出商和余数。q是一个整数,r是一个 timedelta 对象。

+t1

返回一个相同数值的 timedelta 对象。

-t1

等价于 timedelta(-t1.days, -t1.seconds, -t1.microseconds), 和 t1* -1. (1)(4)

abs(t)

t.days >= 0``时等于 +\ *t*, ``t.days < 0 时 -t 。 (2)

str(t)

返回一个形如 [D day[s], ][H]H:MM:SS[.UUUUUU] 的字符串,当 t 为负数的时候, D 也为负数。 (5)

repr(t)

Returns a string in the form datetime.timedelta(D[, S[, U]]), where D is negative for negative t. (5)

註解:

  1. 精确但可能会溢出。

  2. 精确且不会溢出。

  3. 除以0将会抛出异常 ZeroDivisionError

  4. -timedelta.max 不是一个 timedelta 类对象。

  5. String representations of timedelta objects are normalized similarly to their internal representation. This leads to somewhat unusual results for negative timedeltas. For example:

    >>> timedelta(hours=-5)
    datetime.timedelta(-1, 68400)
    >>> print(_)
    -1 day, 19:00:00
    
  6. 表达式 t2 - t3 通常与 t2 + (-t3) 是等价的,除非 t3 等于 timedelta.max; 在这种情况下前者会返回结果,而后者则会溢出。

除了上面列举的操作以外 timedelta 对象还支持与 datedatetime 对象进行特定的相加和相减运算(见下文)。

3.2 版更變: 现在已支持 timedelta 对象与另一个 timedelta 对象相整除或相除,包括求余运算和 divmod() 函数。 现在也支持 timedelta 对象被 float 对象除或乘。

timedelta 对象与 timedelta 对象比较的支持是通过将表示较小时间差的 timedelta 对象视为较小值。 为了防止将混合类型比较回退为基于对象地址的默认比较,当 timedelta 对象与不同类型的对象比较时,将会引发 TypeError,除非比较运算符是 ==!=。 在后一种情况下将分别返回 FalseTrue

timedelta 对象是 hashable 类型的(可以作为字典关键字), 支持高效获取, 在布尔上下文中, timedelta 对象大多数情况下都被视为真,仅在不等于 timedelta(0) 时。

实例方法:

timedelta.total_seconds()

Return the total number of seconds contained in the duration. Equivalent to td / timedelta(seconds=1).

需要注意的是,时间间隔较大时,这个方法的结果中的微秒将会失真(大多数平台上大于270年视为一个较大的时间间隔)。

3.2 版新加入.

用法示例:

>>> from datetime import timedelta
>>> year = timedelta(days=365)
>>> another_year = timedelta(weeks=40, days=84, hours=23,
...                          minutes=50, seconds=600)  # adds up to 365 days
>>> year.total_seconds()
31536000.0
>>> year == another_year
True
>>> ten_years = 10 * year
>>> ten_years, ten_years.days // 365
(datetime.timedelta(3650), 10)
>>> nine_years = ten_years - year
>>> nine_years, nine_years.days // 365
(datetime.timedelta(3285), 9)
>>> three_years = nine_years // 3;
>>> three_years, three_years.days // 365
(datetime.timedelta(1095), 3)
>>> abs(three_years - ten_years) == 2 * three_years + year
True

8.1.3. date 对象

date 对象代表一个理想化历法中的日期(年、月和日),即当今的格列高利历向前后两个方向无限延伸。公元 1 年 1 月 1 日是第 1 日,公元 1 年 1 月 2 日是第 2 日, 依此类推。 这与 Dershowitz 与 Reingold 所著 Calendrical Calculations 中“预期格列高利”历法的定义一致,它是适用于该书中所有运算的基础历法。 请参阅该书了解在预期格列高利历序列与许多其他历法系统之间进行转换的算法。

class datetime.date(year, month, day)

All arguments are required. Arguments may be integers, in the following ranges:

  • MINYEAR <= year <= MAXYEAR

  • 1 <= month <= 12

  • 1 <= 日期 <= 给定年月对应的天数

如果参数不在这些范围内,则抛出 ValueError 异常。

其它构造器,所有的类方法:

classmethod date.today()

返回当地的当前日期。与``date.fromtimestamp(time.time())``等价。

classmethod date.fromtimestamp(timestamp)

返回对应于 POSIX 时间戳例如 time.time() 返回值的本地日期。 这可能引发 OverflowError,如果时间戳数值超出所在平台 C localtime() 函数的支持范围的话,并会在 localtime() 出错时引发 OSError。 通常该数值会被限制在 1970 年至 2038 年之间。 请注意在时间戳概念包含闰秒的非 POSIX 系统上,闰秒会被 fromtimestamp() 所忽略。

3.3 版更變: 引发 OverflowError 而不是 ValueError,如果时间戳数值超出所在平台 C localtime() 函数的支持范围的话,并会在 localtime() 出错时引发 OSError 而不是 ValueError

classmethod date.fromordinal(ordinal)

返回对应于预期格列高利历序号的日期,其中公元 1 年 1 月 1 日的序号为 1。 除非 1 <= 序号 <= date.max.toordinal() 否则会引发 ValueError。 对于任意日期 ddate.fromordinal(d.toordinal()) == d

类属性:

date.min

最小的日期 date(MINYEAR, 1, 1)

date.max

最大的日期 ,date(MAXYEAR, 12, 31)

date.resolution

两个日期对象的最小间隔,timedelta(days=1)

实例属性(只读):

date.year

MINYEARMAXYEAR 之间,包含边界。

date.month

1 至 12(含)

date.day

返回1到指定年月的天数间的数字。

支持的运算:

运算

结果:

date2 = date1 + timedelta

date2 等于从 date1 减去 timedelta.days 天。 (1)

date2 = date1 - timedelta

计算 date2 的值使得 date2 + timedelta == date1。 (2)

timedelta = date1 - date2

(3)

date1 < date2

如果 date1 的时间在 date2 之前则认为 date1 小于 date2 。 (4)

註解:

  1. 如果 timedelta.days > 0date2 在时间线上前进,如果 timedelta.days < 0 则后退。 操作完成后 date2 - date1 == timedelta.daystimedelta.secondstimedelta.microseconds 会被忽略。如果 date2.year 将小于 MINYEAR 或大于 MAXYEAR 则会引发 OverflowError。.

  2. timedelta.secondstimedelta.microseconds 会被忽略。

  3. 精确且不会溢出。 操作完成后 timedelta.seconds 和 timedelta.microseconds 均为0, 并且 date2 + timedelta == date1。

  4. 换句话说,当且仅当 date1.toordinal() < date2.toordinal()date1 < date2。 日期比较会引发 TypeError,如果比较目标不为 date 对象的话。 不过也可能会返回 NotImplemented,如果比较目标具有 timetuple() 属性的话。 这个钩子给予其他日期对象类型实现混合类型比较的机会。 否则,当 date 对象与不同类型的对象比较时将会引发 TypeError,除非 ==!= 比较。 后两种情况将分别返回 FalseTrue

日期可以作为字典的关键字。在布尔上下文中,所有的 date 对象都视为真。

实例方法:

date.replace(year=self.year, month=self.month, day=self.day)

返回一个具有同样值的日期,除非通过任何关键字参数给出了某些形参的新值。 例如,如果 d == date(2002, 12, 31),则 d.replace(day=26) == date(2002, 12, 26)

date.timetuple()

返回一个 time.struct_time,即与 time.localtime() 的返回类型相同。 hours, minutes 和 seconds 值为 0, 且 DST 标志值为 -1。 d.timetuple() 等价于 time.struct_time((d.year, d.month, d.day, 0, 0, 0, d.weekday(), yday, -1)),其中 yday = d.toordinal() - date(d.year, 1, 1).toordinal() + 1 是日期在当前年份中的序号,起始序号 1 表示 1 月 1 日。

date.toordinal()

返回日期的预期格列高利历序号,其中公元 1 年 1 月 1 日的序号为 1。 对于任意 date 对象 ddate.fromordinal(d.toordinal()) == d

date.weekday()

返回一个整数代表星期几,星期一为0,星期天为6。例如, date(2002, 12, 4).weekday() == 2,表示的是星期三。参阅 isoweekday()

date.isoweekday()

返回一个整数代表星期几,星期一为1,星期天为7。例如:date(2002, 12, 4).isoweekday() == 3,表示星期三。参见 weekday(), isocalendar()

date.isocalendar()

返回一个三元元组,(ISO year, ISO week number, ISO weekday) 。

ISO日历是一个被广泛使用的公历。可以从 https://www.staff.science.uu.nl/~gent0113/calendar/isocalendar.htm 上查看更完整的说明。

ISO 年由 52 或 53 个完整星期构成,每个星期开始于星期一结束于星期日。 一个 ISO 年的第一个星期就是(格列高利)历法的的一年中第一个包含星期四的星期。 这被称为 1 号星期,其中星期四所在的 ISO 年与其所在的格列高利年相同。

例如,2004 年的第一天是一个星期四,因此 ISO 2004 年的第一个星期开始于 2003 年 12 月 29 日星期一,结束于 2004 年 1 月 4 日星期日,因此 date(2003, 12, 29).isocalendar() == (2004, 1, 1) and date(2004, 1, 4).isocalendar() == (2004, 1, 7)

date.isoformat()

返回一个 ISO 8601 格式的字符串, 『YYYY-MM-DD』。例如 date(2002, 12, 4).isoformat() == '2002-12-04'

date.__str__()

对于日期对象 d, str(d) 等价于 d.isoformat()

date.ctime()

返回一个代表日期的字符串,例如 date(2002, 12, 4).ctime() == 'Wed Dec 4 00:00:00 2002'。 在原生 C ctime() 函数 (time.ctime() 会发起调用该函数,但 date.ctime() 则不会) 遵循 C 标准的平台上,d.ctime() 等价于 time.ctime(time.mktime(d.timetuple()))

date.strftime(format)

返回一个由显式格式字符串所指明的代表日期的字符串。 表示时、分或秒的格式代码值将为 0。 要获取格式指令的完整列表请参阅 strftime() 和 strptime() 的行为

date.__format__(format)

date.strftime() 相同。 此方法使得为 date 对象指定以 格式化字符串字面值 表示的格式化字符串以及使用 str.format() 进行格式化成为可能。 要获取格式指令的完整列表,请参阅 strftime() 和 strptime() 的行为

计算距离特定事件天数的例子:

>>> import time
>>> from datetime import date
>>> today = date.today()
>>> today
datetime.date(2007, 12, 5)
>>> today == date.fromtimestamp(time.time())
True
>>> my_birthday = date(today.year, 6, 24)
>>> if my_birthday < today:
...     my_birthday = my_birthday.replace(year=today.year + 1)
>>> my_birthday
datetime.date(2008, 6, 24)
>>> time_to_birthday = abs(my_birthday - today)
>>> time_to_birthday.days
202

使用 date 的例子:

>>> from datetime import date
>>> d = date.fromordinal(730920) # 730920th day after 1. 1. 0001
>>> d
datetime.date(2002, 3, 11)
>>> t = d.timetuple()
>>> for i in t:     
...     print(i)
2002                # year
3                   # month
11                  # day
0
0
0
0                   # weekday (0 = Monday)
70                  # 70th day in the year
-1
>>> ic = d.isocalendar()
>>> for i in ic:    
...     print(i)
2002                # ISO year
11                  # ISO week number
1                   # ISO day number ( 1 = Monday )
>>> d.isoformat()
'2002-03-11'
>>> d.strftime("%d/%m/%y")
'11/03/02'
>>> d.strftime("%A %d. %B %Y")
'Monday 11. March 2002'
>>> 'The {1} is {0:%d}, the {2} is {0:%B}.'.format(d, "day", "month")
'The day is 11, the month is March.'

8.1.4. datetime 对象

datetime 对象是一个包含了来自 date 对象和 time 对象所有信息的单一对象。 与 date 对象一样,datetime 假定当今的格列高利历向前后两个方向无限延伸;与 time 对象一样,datetime 假定每一天恰好有 3600*24 秒。

构造器 :

class datetime.datetime(year, month, day, hour=0, minute=0, second=0, microsecond=0, tzinfo=None, *, fold=0)

The year, month and day arguments are required. tzinfo may be None, or an instance of a tzinfo subclass. The remaining arguments may be integers, in the following ranges:

  • MINYEAR <= year <= MAXYEAR,

  • 1 <= month <= 12,

  • 1 <= day <= 指定年月的天数,

  • 0 <= hour < 24,

  • 0 <= minute < 60,

  • 0 <= second < 60,

  • 0 <= microsecond < 1000000,

  • fold in [0, 1].

如果参数不在这些范围内,则抛出 ValueError 异常。

3.6 版新加入: 增加了 fold 参数。

其它构造器,所有的类方法:

classmethod datetime.today()

返回当前的本地 datetime,tzinfo 值为 None。 这等价于 datetime.fromtimestamp(time.time())。 另请参阅 now(), fromtimestamp()

classmethod datetime.now(tz=None)

返回当前的本地 date 和 time。 如果可选参数 tzNone 或未指定,这就类似于 today(),但该方法会在可能的情况下提供比通过 time.time() 时间戳所获时间值更高的精度(例如,在提供了 C gettimeofday() 函数的平台上就可能做到)。

如果 tz 不为 None,它必须是 tzinfo 的子类的一个实例,并且当前日期和时间将转换为 tz 时区的日期和时间。 在这种情况下结果等价于 tz.fromutc(datetime.utcnow().replace(tzinfo=tz))。 另请参阅 today(), utcnow()

classmethod datetime.utcnow()

返回当前 UTC 日期和时间,其中 tzinfoNone。 这类似于 now(),但返回的当前 UTC 日期和时间是一个本机 datetime 对象。 自动感知的当前 UTC 日期时间可通过调用 datetime.now(timezone.utc) 来获得。 另请参阅 now()

classmethod datetime.fromtimestamp(timestamp, tz=None)

返回对应于 POSIX 时间戳例如 time.time() 的返回值的本地日期和时间。 如果可选参数 tzNone 或未指定,时间戳会被转换为所在平台的本地日期和时间,返回的 datetime 对象将为天真型。

如果 tz 不为 None,它必须是 tzinfo 子类的一个实例,并且时间戳将被转换到 tz 指定的时区。 在这种情况下结果等价于 tz.fromutc(datetime.utcfromtimestamp(timestamp).replace(tzinfo=tz))

fromtimestamp() 可能引发 OverflowError,如果时间戳数值超出所在平台 C localtime()gmtime() 函数的支持范围的话,并会在 localtime()gmtime() 出错时引发 OSError。 通常该数值会被限制在 1970 年至 2038 年之间。 请注意在时间戳概念包含闰秒的非 POSIX 系统上,闰秒会被 fromtimestamp() 所忽略,结果可能导致两个相差一秒的时间戳产生相同的 datetime 对象。 另请参阅 utcfromtimestamp()

3.3 版更變: 引发 OverflowError 而不是 ValueError,如果时间戳数值超出所在平台 C localtime()gmtime() 函数的支持范围的话。 并会在 localtime()gmtime() 出错时引发 OSError 而不是 ValueError

3.6 版更變: fromtimestamp() 可能返回 fold 值设为 1 的实例。

classmethod datetime.utcfromtimestamp(timestamp)

返回对应于 POSIX 时间戳的 UTC datetime,其中 tzinfoNone。 这可能引发 OverflowError,如果时间戳数值超出所在平台 C gmtime() 函数的支持范围的话,并会在 gmtime() 出错时引发 OSError。 通常该数值并会限制在 1970 年至 2038 年之间。

要得到一个感知型 datetime 对象,应调用 fromtimestamp():

datetime.fromtimestamp(timestamp, timezone.utc)

在 POSIX 兼容的平台上,它等价于以下表达式:

datetime(1970, 1, 1, tzinfo=timezone.utc) + timedelta(seconds=timestamp)

不同之处在于后一种形式总是支持完整年份范围:从 MINYEARMAXYEAR 的开区间。

3.3 版更變: 引发 OverflowError 而不是 ValueError,如果时间戳数值超出所在平台 C gmtime() 函数的支持范围的话。 并会在 gmtime() 出错时引发 OSError 而不是 ValueError

classmethod datetime.fromordinal(ordinal)

返回对应于预期格列高利历序号的 datetime,其中公元 1 年 1 月 1 日的序号为 1。 除非 1 <= ordinal <= datetime.max.toordinal() 否则会引发 ValueError。 结果的hour, minute, second 和 microsecond 值均为 0,并且 tzinfo 值为 None

classmethod datetime.combine(date, time, tzinfo=self.tzinfo)

返回一个新的 datetime 对象,对象的日期数值等于给定的 date 对象的数值,时间数值等于给定的 time 对象的数值。 如果提供 tzinfo 参数,其值会被用来设置结果的 tzinfo 属性,否则将会使用 time 参数的 tzinfo 属性。

对于任意 datetime 对象 dd == datetime.combine(d.date(), d.time(), d.tzinfo)。 如果 date 是一个 datetime 对象,它的时间数值和 tzinfo 属性会被忽略。

3.6 版更變: 增加了 tzinfo 参数。

classmethod datetime.strptime(date_string, format)

返回根据 format 解析与 date_string 相对应的 datetime,这等价于 datetime(*(time.strptime(date_string, format)[0:6])),如果 date_string 和 format 无法被 time.strptime() 解析或它返回一个不是时间元组的值,则将引发 ValueError。 要获取格式化指令的完整列表请参阅 strftime() 和 strptime() 的行为

类属性:

datetime.min

最早的可表示 datetimedatetime(MINYEAR, 1, 1, tzinfo=None)

datetime.max

最晚的可表示 datetimedatetime(MAXYEAR, 12, 31, 23, 59, 59, 999999, tzinfo=None)

datetime.resolution

两个不相等的 datetime 对象之间可能的最小间隔,timedelta(microseconds=1)

实例属性(只读):

datetime.year

MINYEARMAXYEAR 之间,包含边界。

datetime.month

1 至 12(含)

datetime.day

返回1到指定年月的天数间的数字。

datetime.hour

取值范围是 range(24)

datetime.minute

取值范围是 range(60)

datetime.second

取值范围是 range(60)

datetime.microsecond

取值范围是 range(1000000)

datetime.tzinfo

作为 tzinfo 参数被传给 datetime 构造器的对象,如果没有传入值则为 None

datetime.fold

取值范围是 [0, 1]。 用于在重复的时间段中消除边界时间歧义。 (当夏令时结束时回调时钟或由于政治原因导致当前时区的 UTC 时差减少就会出现重复的时间段。) 取值 0 (1) 表示两个时刻早于(晚于)所代表的同一边界时间。

3.6 版新加入.

支持的运算:

运算

结果:

datetime2 = datetime1 + timedelta

(1)

datetime2 = datetime1 - timedelta

(2)

timedelta = datetime1 - datetime2

(3)

datetime1 < datetime2

比较 datetimedatetime。 (4)

  1. datetime2 是从中去掉的一段 timedelta 的结果,如果 timedelta.days > 0 则是在时间线上前进,如果 timedelta.days < 0 则后退。 结果具有与输入的 datetime 相同的 tzinfo 属性,并且操作完成后 datetime2 - datetime1 == timedelta。 如果 datetime2.year 将小于 MINYEAR 或大于 MAXYEAR 则会引发 OverflowError。 请注意即使输入的是一个感知型对象,该方法也不会进行时区调整。

  2. 计算 datetime2 使得 datetime2 + timedelta == datetime1。 与相加操作一样,结果具有与输入的 datetime 相同的 tzinfo 属性,即使输入的是一个感知型对象,该方法也不会进行时区调整。

  3. 从一个 datetime 减去一个 datetime 仅对两个操作数均为简单型或均为感知型时有定义。 如果一个是感知型而另一个是简单型,则会引发 TypeError

    如果两个操作数都是简单型,或都是感知型且具有相同的 tzinfo 属性,tzinfo 属性会被忽略,结果是一个使得 datetime2 + t == datetime1timedelta 对象 t。 在此情况下不会进行时区调整。

    如果两个操作数都是感知型且具有不同的 tzinfo 属性,a-b 操作的行为就如同 ab 被首先转换为简单型 UTC 日期时间。 结果将是 (a.replace(tzinfo=None) - a.utcoffset()) - (b.replace(tzinfo=None) - b.utcoffset()) 除非具体实现绝对不溢出。

  4. datetime1 的时间在 datetime2 之前则认为 datetime1 小于 datetime2

    如果比较的一方是简单型而另一方是感知型,则如果尝试进行顺序比较将引发 TypeError。 对于相等比较,简单型实例将永远不等于感知型实例。

    如果两个比较方都是感知型,且具有相同的 tzinfo 属性,相同的 tzinfo 属性会被忽略并对基本日期时间值进行比较。 如果两个比较方都是感知型且具有不同的 tzinfo 属性,两个比较方将首先通过减去它们的 UTC 差值(使用 self.utcoffset() 获取)来进行调整。

    3.3 版更變: 简单型和感知型 datetime 实例之间的相等比较不会引发 TypeError

    備註

    为了防止比较操作回退为默认的对象地址比较方案,datetime 比较通常会引发 TypeError,如果比较目标不同样为 datetime 对象的话。 不过也可能会返回 NotImplemented 如果比较目标具有 timetuple() 属性的话。 这个钩子给予其他日期对象类型实现混合类型比较的机会。 否则,当 datetime 对象与不同类型的对象比较时将会引发 TypeError,除非 ==!= 比较。 后两种情况将分别返回 FalseTrue

datetime 对象可以用作字典的键。 在布尔运算时,所有 datetime 对象都被视为真值。

实例方法:

datetime.date()

返回具有同样 year, month 和 day 值的 date 对象。

datetime.time()

返回具有同样 hour, minute, second, microsecond 和 fold 值的 time 对象。 tzinfoNone。 另请参见方法 timetz()

3.6 版更變: fold 值会被复制给返回的 time 对象。

datetime.timetz()

返回具有同样 hour, minute, second, microsecond, fold 和 tzinfo 属性值的 time 对象。 另请参见方法 time()

3.6 版更變: fold 值会被复制给返回的 time 对象。

datetime.replace(year=self.year, month=self.month, day=self.day, hour=self.hour, minute=self.minute, second=self.second, microsecond=self.microsecond, tzinfo=self.tzinfo, * fold=0)

返回一个具有同样属性值的 datetime,除非通过任何关键字参数指定了某些属性值。 请注意可以通过指定 tzinfo=None 从一个感知型 datetime 创建一个简单型 datetime 而不必转换日期和时间值。

3.6 版新加入: 增加了 fold 参数。

datetime.astimezone(tz=None)

返回一个具有新的 tzinfo 属性 tzdatetime 对象,并会调整日期和时间数据使得结果对应的 UTC 时间与 self 相同,但为 tz 时区的本地时间。

tz 如果给出则必须是一个 tzinfo 子类的实例,并且其 utcoffset()dst() 方法不可返回 None。 如果 self 为简单型,它会被假定为基于系统时区表示的时间。

如果调用时不传入参数(或传入 tz=None) 则将假定目标时区为系统的本地时区。 转换后 datetime 实例的 .tzinfo 属性将被设为一个 timezone 实例,时区名称和时差值将从系统获取。

如果 self.tzinfotzself.astimezone(tz) 等于 self: 不会对日期或时间数据进行调整。 否则结果为 tz 时区的本地时间,代表的 UTC 时间与 self 相同:在 astz = dt.astimezone(tz) 之后,astz - astz.utcoffset() 将具有与 dt - dt.utcoffset() 相同的日期和时间数据。

如果你只想附加一个时区对象 tz 给一个 datetime 对象 dt 而不调整日期和时间数据,请使用 dt.replace(tzinfo=tz)。 如果你只想从一个感知型 datetime 对象 dt 移除时区对象则不转换日期和时间数据,请使用 dt.replace(tzinfo=None)

请注意默认的 tzinfo.fromutc() 方法在 tzinfo 的子类中可以被重载,从而影响 astimezone() 的返回结果。 如果忽略出错的情况,astimezone() 的行为就类似于:

def astimezone(self, tz):
    if self.tzinfo is tz:
        return self
    # Convert self to UTC, and attach the new time zone object.
    utc = (self - self.utcoffset()).replace(tzinfo=tz)
    # Convert from UTC to tz's local time.
    return tz.fromutc(utc)

3.3 版更變: tz 现在可以被省略。

3.6 版更變: astimezone() 方法可以由简单型实例调用,这将假定其表示本地时间。

datetime.utcoffset()

If tzinfo is None, returns None, else returns self.tzinfo.utcoffset(self), and raises an exception if the latter doesn’t return None, or a timedelta object representing a whole number of minutes with magnitude less than one day.

datetime.dst()

If tzinfo is None, returns None, else returns self.tzinfo.dst(self), and raises an exception if the latter doesn’t return None, or a timedelta object representing a whole number of minutes with magnitude less than one day.

datetime.tzname()

如果 tzinfoNone,则返回 None,否则返回 self.tzinfo.tzname(self),如果后者不返回 None 或者一个字符串对象则将引发异常。

datetime.timetuple()

返回一个 time.struct_time,即与 time.localtime() 的返回类型相同。 d.timetuple() 等价于 time.struct_time((d.year, d.month, d.day, d.hour, d.minute, d.second, d.weekday(), yday, dst)),其中 yday = d.toordinal() - date(d.year, 1, 1).toordinal() + 1 是日期在当前年份中的序号,起始序号 1 表示 1 月 1 日。 结果的 tm_isdst 旗标的设定会依据 dst() 方法:如果 tzinfoNonedst() 返回 None,则 tm_isdst 将设为 -1;否则如果 dst() 返回一个非零值,则 tm_isdst 将设为 1;否则 tm_isdst 将设为 0

datetime.utctimetuple()

如果 datetime 实例 d 为简单型,这类似于 d.timetuple(),不同之处为 tm_isdst 会强设为 0,无论 d.dst() 返回什么结果。 DST 对于 UTC 时间永远无效。

如果 d 为感知型,d 会通过减去 d.utcoffset() 被标准化为 UTC 时间,并返回标准化时间对应的 time.struct_timetm_isdst 会强设为 0。 请注意如果 d.year 为 MINYEARMAXYEAR 并且 UTC 调整超出一年的边界则可能引发 OverflowError

datetime.toordinal()

返回日期的预期格列高利历序号。 与 self.date().toordinal() 相同。

datetime.timestamp()

返回对应于 datetime 实例的 POSIX 时间戳。 返回值是与 time.time() 类似的 float

简单型 datetime 实例会假定为代表本地时间,并且此方法依赖于平台的 C mktime() 函数来执行转换。 由于在许多平台上 datetime 支持的值范围比 mktime() 更广,对于极其遥远的过去或末来时间此方法可能引发 OverflowError

对于感知型 datetime 实例,返回值的计算方式为:

(dt - datetime(1970, 1, 1, tzinfo=timezone.utc)).total_seconds()

3.3 版新加入.

3.6 版更變: timestamp() 方法使用 fold 属性来消除重复间隔中的时间歧义。

備註

没有一个方法能直接从简单型 datetime 实例获取 POSIX 时间戳来代表 UTC 时间。 如果你的应用使用此惯例方式并且你的系统时区不是设为 UTC,你可以通过提供 tzinfo=timezone.utc 来获取 POSIX 时间戳:

timestamp = dt.replace(tzinfo=timezone.utc).timestamp()

或者通过直接计算时间戳:

timestamp = (dt - datetime(1970, 1, 1)) / timedelta(seconds=1)
datetime.weekday()

返回一个整数代表星期几,星期一为 0,星期天为 6。 相当于 self.date().weekday()。 另请参阅 isoweekday()

datetime.isoweekday()

返回一个整数代表星期几,星期一为 1,星期天为 7。 相当于 self.date().isoweekday()。 另请参阅 weekday(), isocalendar()

datetime.isocalendar()

返回一个 3 元组 (ISO 年份, ISO 周序号, ISO 周日期)。 相当于 self.date().isocalendar()

datetime.isoformat(sep='T', timespec='auto')

Return a string representing the date and time in ISO 8601 format, YYYY-MM-DDTHH:MM:SS.mmmmmm or, if microsecond is 0, YYYY-MM-DDTHH:MM:SS

If utcoffset() does not return None, a 6-character string is appended, giving the UTC offset in (signed) hours and minutes: YYYY-MM-DDTHH:MM:SS.mmmmmm+HH:MM or, if microsecond is 0 YYYY-MM-DDTHH:MM:SS+HH:MM

可选参数 sep (默认为 'T') 为单个分隔字符,会被放在结果的日期和时间两部分之间。例如

>>> from datetime import tzinfo, timedelta, datetime
>>> class TZ(tzinfo):
...     def utcoffset(self, dt): return timedelta(minutes=-399)
...
>>> datetime(2002, 12, 25, tzinfo=TZ()).isoformat(' ')
'2002-12-25 00:00:00-06:39'

可选参数 timespec 要包含的额外时间组件值 (默认为 'auto')。它可以是以下值之一:

  • 'auto': 如果 microsecond 为 0 则与 'seconds' 相同,否则与 'microseconds' 相同。

  • 'hours': 以两个数码的 HH 格式包含 hour

  • 'minutes': 以 HH:MM 格式包含 hourminute

  • 'seconds': 以 HH:MM:SS 格式包含 hour, minutesecond

  • 'milliseconds': 包含完整时间,但将秒值的小数部分截断至微秒。 格式为 HH:MM:SS.sss。

  • 'microseconds': Include full time in HH:MM:SS.mmmmmm format.

備註

排除掉的时间部分将被截断,而不是被舍入。

对于无效的 timespec 参数将引发 ValueError

>>> from datetime import datetime
>>> datetime.now().isoformat(timespec='minutes')
'2002-12-25T00:00'
>>> dt = datetime(2015, 1, 1, 12, 30, 59, 0)
>>> dt.isoformat(timespec='microseconds')
'2015-01-01T12:30:59.000000'

3.6 版新加入: 增加了 timespec 参数。

datetime.__str__()

对于 datetime 实例 dstr(d) 等价于 d.isoformat(' ')

datetime.ctime()

返回一个代表日期和时间的字符串,例如 datetime(2002, 12, 4, 20, 30, 40).ctime() == 'Wed Dec  4 20:30:40 2002'。 在原生 C ctime() 函数 (time.ctime() 会发起调用该函数,但 datetime.ctime() 则不会) 遵循 C 标准的平台上,d.ctime() 等价于 time.ctime(time.mktime(d.timetuple()))

datetime.strftime(format)

返回一个由显式格式字符串所指明的代表日期和时间的字符串, 要获取格式指令的完整列表请参阅 strftime() 和 strptime() 的行为

datetime.__format__(format)

datetime.strftime() 相同。 此方法使得为 datetime 对象指定以 格式化字符串字面值 表示的格式化字符串以及使用 str.format() 进行格式化成为可能。 要获取格式指令的完整列表,请参阅 strftime() 和 strptime() 的行为

使用 datetime 对象的例子:

>>> from datetime import datetime, date, time
>>> # Using datetime.combine()
>>> d = date(2005, 7, 14)
>>> t = time(12, 30)
>>> datetime.combine(d, t)
datetime.datetime(2005, 7, 14, 12, 30)
>>> # Using datetime.now() or datetime.utcnow()
>>> datetime.now()   
datetime.datetime(2007, 12, 6, 16, 29, 43, 79043)   # GMT +1
>>> datetime.utcnow()   
datetime.datetime(2007, 12, 6, 15, 29, 43, 79060)
>>> # Using datetime.strptime()
>>> dt = datetime.strptime("21/11/06 16:30", "%d/%m/%y %H:%M")
>>> dt
datetime.datetime(2006, 11, 21, 16, 30)
>>> # Using datetime.timetuple() to get tuple of all attributes
>>> tt = dt.timetuple()
>>> for it in tt:   
...     print(it)
...
2006    # year
11      # month
21      # day
16      # hour
30      # minute
0       # second
1       # weekday (0 = Monday)
325     # number of days since 1st January
-1      # dst - method tzinfo.dst() returned None
>>> # Date in ISO format
>>> ic = dt.isocalendar()
>>> for it in ic:   
...     print(it)
...
2006    # ISO year
47      # ISO week
2       # ISO weekday
>>> # Formatting datetime
>>> dt.strftime("%A, %d. %B %Y %I:%M%p")
'Tuesday, 21. November 2006 04:30PM'
>>> 'The {1} is {0:%d}, the {2} is {0:%B}, the {3} is {0:%I:%M%p}.'.format(dt, "day", "month", "time")
'The day is 21, the month is November, the time is 04:30PM.'

使用 datetime 并附带 tzinfo:

>>> from datetime import timedelta, datetime, tzinfo
>>> class GMT1(tzinfo):
...     def utcoffset(self, dt):
...         return timedelta(hours=1) + self.dst(dt)
...     def dst(self, dt):
...         # DST starts last Sunday in March
...         d = datetime(dt.year, 4, 1)   # ends last Sunday in October
...         self.dston = d - timedelta(days=d.weekday() + 1)
...         d = datetime(dt.year, 11, 1)
...         self.dstoff = d - timedelta(days=d.weekday() + 1)
...         if self.dston <=  dt.replace(tzinfo=None) < self.dstoff:
...             return timedelta(hours=1)
...         else:
...             return timedelta(0)
...     def tzname(self,dt):
...          return "GMT +1"
...
>>> class GMT2(tzinfo):
...     def utcoffset(self, dt):
...         return timedelta(hours=2) + self.dst(dt)
...     def dst(self, dt):
...         d = datetime(dt.year, 4, 1)
...         self.dston = d - timedelta(days=d.weekday() + 1)
...         d = datetime(dt.year, 11, 1)
...         self.dstoff = d - timedelta(days=d.weekday() + 1)
...         if self.dston <=  dt.replace(tzinfo=None) < self.dstoff:
...             return timedelta(hours=1)
...         else:
...             return timedelta(0)
...     def tzname(self,dt):
...         return "GMT +2"
...
>>> gmt1 = GMT1()
>>> # Daylight Saving Time
>>> dt1 = datetime(2006, 11, 21, 16, 30, tzinfo=gmt1)
>>> dt1.dst()
datetime.timedelta(0)
>>> dt1.utcoffset()
datetime.timedelta(0, 3600)
>>> dt2 = datetime(2006, 6, 14, 13, 0, tzinfo=gmt1)
>>> dt2.dst()
datetime.timedelta(0, 3600)
>>> dt2.utcoffset()
datetime.timedelta(0, 7200)
>>> # Convert datetime to another time zone
>>> dt3 = dt2.astimezone(GMT2())
>>> dt3     
datetime.datetime(2006, 6, 14, 14, 0, tzinfo=<GMT2 object at 0x...>)
>>> dt2     
datetime.datetime(2006, 6, 14, 13, 0, tzinfo=<GMT1 object at 0x...>)
>>> dt2.utctimetuple() == dt3.utctimetuple()
True

8.1.5. time 对象

一个 time 对象代表某个日期内的(本地)时间,它独立于任何特定日期,并可通过 tzinfo 对象来调整。

class datetime.time(hour=0, minute=0, second=0, microsecond=0, tzinfo=None, *, fold=0)

All arguments are optional. tzinfo may be None, or an instance of a tzinfo subclass. The remaining arguments may be integers, in the following ranges:

  • 0 <= hour < 24,

  • 0 <= minute < 60,

  • 0 <= second < 60,

  • 0 <= microsecond < 1000000,

  • fold in [0, 1].

如果给出一个此范围以外的参数,则会引发 ValueError。 所有参数值默认为 0,除了 tzinfo 默认为 None

类属性:

time.min

早最的可表示 time, time(0, 0, 0, 0)

time.max

最晚的可表示 time, time(23, 59, 59, 999999)

time.resolution

两个不相等的 time 对象之间可能的最小间隔,timedelta(microseconds=1),但是请注意 time 对象并不支持算术运算。

实例属性(只读):

time.hour

取值范围是 range(24)

time.minute

取值范围是 range(60)

time.second

取值范围是 range(60)

time.microsecond

取值范围是 range(1000000)

time.tzinfo

作为 tzinfo 参数被传给 time 构造器的对象,如果没有传入值则为 None

time.fold

取值范围是 [0, 1]。 用于在重复的时间段中消除边界时间歧义。 (当夏令时结束时回调时钟或由于政治原因导致当前时区的 UTC 时差减少就会出现重复的时间段。) 取值 0 (1) 表示两个时刻早于(晚于)所代表的同一边界时间。

3.6 版新加入.

支持的运算:

  • 比较 time 和另一个 time,当 a 的时间在 b 之前时,则认为 a 小于 b。 如果比较的一方是简单型而另一方是感知型,则如果尝试进行顺序比较将引发 TypeError。 对于相等比较,简单型实例将永远不等于感知型实例。

    如果两个比较方都是感知型,且具有相同的 tzinfo 属性,相同的 tzinfo 属性会被忽略并对基本时间值进行比较。 如果两个比较方都是感知型且具有不同的 tzinfo 属性,两个比较方将首先通过减去它们的 UTC 差值(使用 self.utcoffset() 获取)来进行调整。 为了防止将混合类型比较回退为基于对象地址的默认比较,当 time 对象与不同类型的对象比较时,将会引发 TypeError,除非比较运算符是 ==!=。 在后一种情况下将分别返回 FalseTrue

    3.3 版更變: 简单型和感知型 time 实例之前的相等比较不会引发 TypeError

  • 哈希,以便用作字典的键

  • 高效的封存

在布尔运算时,time 对象总是被视为真值。

3.5 版更變: 在 Python 3.5 之前,如果一个 time 对象代表 UTC 午夜零时则会被视为假值。 此行为被认为容易引发困惑和错误,因此从 Python 3.5 起已被去除。 详情参见 bpo-13936

实例方法:

time.replace(hour=self.hour, minute=self.minute, second=self.second, microsecond=self.microsecond, tzinfo=self.tzinfo, * fold=0)

返回一个具有同样属性值的 time,除非通过任何关键字参数指定了某些属性值。 请注意可以通过指定 tzinfo=None 从一个感知型 time 创建一个简单型 time 而不必转换时间值。

3.6 版新加入: 增加了 fold 参数。

time.isoformat(timespec='auto')

Return a string representing the time in ISO 8601 format, HH:MM:SS.mmmmmm or, if microsecond is 0, HH:MM:SS If utcoffset() does not return None, a 6-character string is appended, giving the UTC offset in (signed) hours and minutes: HH:MM:SS.mmmmmm+HH:MM or, if self.microsecond is 0, HH:MM:SS+HH:MM

可选参数 timespec 要包含的额外时间组件值 (默认为 'auto')。它可以是以下值之一:

  • 'auto': 如果 microsecond 为 0 则与 'seconds' 相同,否则与 'microseconds' 相同。

  • 'hours': 以两个数码的 HH 格式包含 hour

  • 'minutes': 以 HH:MM 格式包含 hourminute

  • 'seconds': 以 HH:MM:SS 格式包含 hour, minutesecond

  • 'milliseconds': 包含完整时间,但将秒值的小数部分截断至微秒。 格式为 HH:MM:SS.sss。

  • 'microseconds': Include full time in HH:MM:SS.mmmmmm format.

備註

排除掉的时间部分将被截断,而不是被舍入。

对于无效的 timespec 参数将引发 ValueError

>>> from datetime import time
>>> time(hour=12, minute=34, second=56, microsecond=123456).isoformat(timespec='minutes')
'12:34'
>>> dt = time(hour=12, minute=34, second=56, microsecond=0)
>>> dt.isoformat(timespec='microseconds')
'12:34:56.000000'
>>> dt.isoformat(timespec='auto')
'12:34:56'

3.6 版新加入: 增加了 timespec 参数。

time.__str__()

对于时间对象 t, str(t) 等价于 t.isoformat()

time.strftime(format)

返回一个由显式格式字符串所指明的代表时间的字符串。 要获取格式指令的完整列表请参阅 strftime() 和 strptime() 的行为

time.__format__(format)

time.strftime() 相同。 此方法使得为 time 对象指定以 格式化字符串字面值 表示的格式化字符串以及使用 str.format() 进行格式化成为可能。 要获取格式指令的完整列表,请参阅 strftime() 和 strptime() 的行为

time.utcoffset()

If tzinfo is None, returns None, else returns self.tzinfo.utcoffset(None), and raises an exception if the latter doesn’t return None or a timedelta object representing a whole number of minutes with magnitude less than one day.

time.dst()

If tzinfo is None, returns None, else returns self.tzinfo.dst(None), and raises an exception if the latter doesn’t return None, or a timedelta object representing a whole number of minutes with magnitude less than one day.

time.tzname()

如果 tzinfoNone,则返回 None,否则返回 self.tzinfo.tzname(None),如果后者不返回 None 或者一个字符串对象则将引发异常。

示例:

>>> from datetime import time, tzinfo, timedelta
>>> class GMT1(tzinfo):
...     def utcoffset(self, dt):
...         return timedelta(hours=1)
...     def dst(self, dt):
...         return timedelta(0)
...     def tzname(self,dt):
...         return "Europe/Prague"
...
>>> t = time(12, 10, 30, tzinfo=GMT1())
>>> t                               
datetime.time(12, 10, 30, tzinfo=<GMT1 object at 0x...>)
>>> gmt = GMT1()
>>> t.isoformat()
'12:10:30+01:00'
>>> t.dst()
datetime.timedelta(0)
>>> t.tzname()
'Europe/Prague'
>>> t.strftime("%H:%M:%S %Z")
'12:10:30 Europe/Prague'
>>> 'The {} is {:%H:%M}.'.format("time", t)
'The time is 12:10.'

8.1.6. tzinfo 对象

class datetime.tzinfo

这是一个抽象基类,即这个类不可直接被实例化。 你必须从该类派生一个实体子类,并且(至少)提供你使用 datetime 需要的标准 tzinfo 方法的实现。 datetime 模块提供了 tzinfo 的一个简单实体子类,timezone,它能以与 UTC 的固定差值来表示不同的时区,例如 UTC 本身或北美的 EST 和 EDT。

tzinfo 的(某个实体子类)的实例可以被传给 datetimetime 对象的构造器。 这些对象会将它们的属性视为对应于本地时间,并且 tzinfo 对象支持展示本地时间与 UTC 的差值、时区名称以及 DST 差值的方法,都是与传给它们的日期或时间对象的相对值。

对于封存操作的特殊要求:一个 tzinfo 子类必须具有可不带参数调用的 __init__() 方法,否则它虽然可以被封存,但可能无法再次解封。 这是个技术性要求,在未来可能会被取消。

一个 tzinfo 的实体子类可能需要实现以下方法。 具体需要实现的方法取决于感知型 datetime 对象如何使用它。 如果有疑问,可以简单地全都实现。

tzinfo.utcoffset(dt)

Return offset of local time from UTC, in minutes east of UTC. If local time is west of UTC, this should be negative. Note that this is intended to be the total offset from UTC; for example, if a tzinfo object represents both time zone and DST adjustments, utcoffset() should return their sum. If the UTC offset isn’t known, return None. Else the value returned must be a timedelta object specifying a whole number of minutes in the range -1439 to 1439 inclusive (1440 = 24*60; the magnitude of the offset must be less than one day). Most implementations of utcoffset() will probably look like one of these two:

return CONSTANT                 # fixed-offset class
return CONSTANT + self.dst(dt)  # daylight-aware class

如果 utcoffset() 返回值不为 None,则 dst() 也不应返回 None

默认的 utcoffset() 实现会引发 NotImplementedError

tzinfo.dst(dt)

Return the daylight saving time (DST) adjustment, in minutes east of UTC, or None if DST information isn’t known. Return timedelta(0) if DST is not in effect. If DST is in effect, return the offset as a timedelta object (see utcoffset() for details). Note that DST offset, if applicable, has already been added to the UTC offset returned by utcoffset(), so there’s no need to consult dst() unless you’re interested in obtaining DST info separately. For example, datetime.timetuple() calls its tzinfo attribute’s dst() method to determine how the tm_isdst flag should be set, and tzinfo.fromutc() calls dst() to account for DST changes when crossing time zones.

一个可以同时处理标准时和夏令时的 tzinfo 子类的实例 tz 必须在此情形中保持一致:

tz.utcoffset(dt) - tz.dst(dt)

必须为具有同样的 tzinfo 子类实例 dt.tzinfo == tz 的每个 datetime 对象 dt 返回同样的结果,此表达式会产生时区的“标准时差”,它不应取决于具体日期或时间,只取决于地理位置。 datetime.astimezone() 的实现依赖此方法,但无法检测违反规则的情况;确保符合规则是程序员的责任。 如果一个 tzinfo 子类不能保证这一点,也许应该重载 tzinfo.fromutc() 的默认实现以便在任何情况下与 astimezone() 配合正常。

大多数 dst() 的实现可能会如以下两者之一:

def dst(self, dt):
    # a fixed-offset class:  doesn't account for DST
    return timedelta(0)

或者

def dst(self, dt):
    # Code to set dston and dstoff to the time zone's DST
    # transition times based on the input dt.year, and expressed
    # in standard local time.  Then

    if dston <= dt.replace(tzinfo=None) < dstoff:
        return timedelta(hours=1)
    else:
        return timedelta(0)

默认的 dst() 实现会引发 NotImplementedError

tzinfo.tzname(dt)

将对应于 datetime 对象 dt 的时区名称作为字符串返回。 datetime 模块没有定义任何字符串名称相关内容,也不要求名称有任何特定含义。 例如,」GMT」, 「UTC」, 「-500」, 「-5:00」, 「EDT」, 「US/Eastern」, 「America/New York」 都是有效的返回值。 如果字符串名称未知则返回 None。 请注意这是一个方法而不是一个固定的字符串,这主要是因为某些 tzinfo 子类可能需要根据所传入的特定 dt 值返回不同的名称,特别是当 tzinfo 类要负责处理夏令时的时候。

默认的 tzname() 实现会引发 NotImplementedError

这些方法会被 datetimetime 对象调用,用来对应它们的同名方法。 datetime 对象会将自身作为传入参数,而 time 对象会将 None 作为传入参数。 这样 tzinfo 子类的方法应当准备好接受 dt 参数值为 None 或是 datetime 类的实例。

当传入 None 时,应当由类的设计者来决定最佳回应方式。 例如,返回 None 适用于希望该类提示时间对象不参与 tzinfo 协议处理。 让 utcoffset(None) 返回标准 UTC 时差也许会更有用处,如果没有其他用于发现标准时差的约定。

当传入一个 datetime 对象来回应 datetime 方法时,dt.tzinfoself 是同一对象。 tzinfo 方法可以依赖这一点,除非用户代码直接调用了 tzinfo 方法。 此行为的目的是使得 tzinfo 方法将 dt 解读为本地时间,而不需要担心其他时区的相关对象。

还有一个额外的 tzinfo 方法,某个子类可能会希望重载它:

tzinfo.fromutc(dt)

此方法会由默认的 datetime.astimezone() 实现来调用。 当被调用时,dt.tzinfoself,并且 dt 的日期和时间数据会被视为代表 UTC 时间。 fromutc() 的目标是调整日期和时间数据,返回一个等价的 datetime 来表示 self 的本地时间。

大多数 tzinfo 子类应该能够毫无问题地继承默认的 fromutc() 实现。 它的健壮性足以处理固定差值的时区以及同时负责标准时和夏令时的时区,对于后者甚至还能处理 DST 转换时间在各个年份有变化的情况。 一个默认 fromutc() 实现可能无法在所有情况下正确处理的例子是(与 UTC 的)标准差值取决于所经过的特定日期和时间,这种情况可能由于政治原因而出现。 默认的 astimezone()fromutc() 实现可能无法生成你希望的结果,如果这个结果恰好是跨越了标准差值发生改变的时刻当中的某个小时值的话。

忽略针对错误情况的代码,默认 fromutc() 实现的行为方式如下:

def fromutc(self, dt):
    # raise ValueError error if dt.tzinfo is not self
    dtoff = dt.utcoffset()
    dtdst = dt.dst()
    # raise ValueError if dtoff is None or dtdst is None
    delta = dtoff - dtdst  # this is self's standard offset
    if delta:
        dt += delta   # convert to standard local time
        dtdst = dt.dst()
        # raise ValueError if dtdst is None
    if dtdst:
        return dt + dtdst
    else:
        return dt

Example tzinfo classes:

from datetime import tzinfo, timedelta, datetime, timezone

ZERO = timedelta(0)
HOUR = timedelta(hours=1)
SECOND = timedelta(seconds=1)

# A class capturing the platform's idea of local time.
# (May result in wrong values on historical times in
#  timezones where UTC offset and/or the DST rules had
#  changed in the past.)
import time as _time

STDOFFSET = timedelta(seconds = -_time.timezone)
if _time.daylight:
    DSTOFFSET = timedelta(seconds = -_time.altzone)
else:
    DSTOFFSET = STDOFFSET

DSTDIFF = DSTOFFSET - STDOFFSET

class LocalTimezone(tzinfo):

    def fromutc(self, dt):
        assert dt.tzinfo is self
        stamp = (dt - datetime(1970, 1, 1, tzinfo=self)) // SECOND
        args = _time.localtime(stamp)[:6]
        dst_diff = DSTDIFF // SECOND
        # Detect fold
        fold = (args == _time.localtime(stamp - dst_diff))
        return datetime(*args, microsecond=dt.microsecond,
                        tzinfo=self, fold=fold)

    def utcoffset(self, dt):
        if self._isdst(dt):
            return DSTOFFSET
        else:
            return STDOFFSET

    def dst(self, dt):
        if self._isdst(dt):
            return DSTDIFF
        else:
            return ZERO

    def tzname(self, dt):
        return _time.tzname[self._isdst(dt)]

    def _isdst(self, dt):
        tt = (dt.year, dt.month, dt.day,
              dt.hour, dt.minute, dt.second,
              dt.weekday(), 0, 0)
        stamp = _time.mktime(tt)
        tt = _time.localtime(stamp)
        return tt.tm_isdst > 0

Local = LocalTimezone()


# A complete implementation of current DST rules for major US time zones.

def first_sunday_on_or_after(dt):
    days_to_go = 6 - dt.weekday()
    if days_to_go:
        dt += timedelta(days_to_go)
    return dt


# US DST Rules
#
# This is a simplified (i.e., wrong for a few cases) set of rules for US
# DST start and end times. For a complete and up-to-date set of DST rules
# and timezone definitions, visit the Olson Database (or try pytz):
# http://www.twinsun.com/tz/tz-link.htm
# http://sourceforge.net/projects/pytz/ (might not be up-to-date)
#
# In the US, since 2007, DST starts at 2am (standard time) on the second
# Sunday in March, which is the first Sunday on or after Mar 8.
DSTSTART_2007 = datetime(1, 3, 8, 2)
# and ends at 2am (DST time) on the first Sunday of Nov.
DSTEND_2007 = datetime(1, 11, 1, 2)
# From 1987 to 2006, DST used to start at 2am (standard time) on the first
# Sunday in April and to end at 2am (DST time) on the last
# Sunday of October, which is the first Sunday on or after Oct 25.
DSTSTART_1987_2006 = datetime(1, 4, 1, 2)
DSTEND_1987_2006 = datetime(1, 10, 25, 2)
# From 1967 to 1986, DST used to start at 2am (standard time) on the last
# Sunday in April (the one on or after April 24) and to end at 2am (DST time)
# on the last Sunday of October, which is the first Sunday
# on or after Oct 25.
DSTSTART_1967_1986 = datetime(1, 4, 24, 2)
DSTEND_1967_1986 = DSTEND_1987_2006

def us_dst_range(year):
    # Find start and end times for US DST. For years before 1967, return
    # start = end for no DST.
    if 2006 < year:
        dststart, dstend = DSTSTART_2007, DSTEND_2007
    elif 1986 < year < 2007:
        dststart, dstend = DSTSTART_1987_2006, DSTEND_1987_2006
    elif 1966 < year < 1987:
        dststart, dstend = DSTSTART_1967_1986, DSTEND_1967_1986
    else:
        return (datetime(year, 1, 1), ) * 2

    start = first_sunday_on_or_after(dststart.replace(year=year))
    end = first_sunday_on_or_after(dstend.replace(year=year))
    return start, end


class USTimeZone(tzinfo):

    def __init__(self, hours, reprname, stdname, dstname):
        self.stdoffset = timedelta(hours=hours)
        self.reprname = reprname
        self.stdname = stdname
        self.dstname = dstname

    def __repr__(self):
        return self.reprname

    def tzname(self, dt):
        if self.dst(dt):
            return self.dstname
        else:
            return self.stdname

    def utcoffset(self, dt):
        return self.stdoffset + self.dst(dt)

    def dst(self, dt):
        if dt is None or dt.tzinfo is None:
            # An exception may be sensible here, in one or both cases.
            # It depends on how you want to treat them.  The default
            # fromutc() implementation (called by the default astimezone()
            # implementation) passes a datetime with dt.tzinfo is self.
            return ZERO
        assert dt.tzinfo is self
        start, end = us_dst_range(dt.year)
        # Can't compare naive to aware objects, so strip the timezone from
        # dt first.
        dt = dt.replace(tzinfo=None)
        if start + HOUR <= dt < end - HOUR:
            # DST is in effect.
            return HOUR
        if end - HOUR <= dt < end:
            # Fold (an ambiguous hour): use dt.fold to disambiguate.
            return ZERO if dt.fold else HOUR
        if start <= dt < start + HOUR:
            # Gap (a non-existent hour): reverse the fold rule.
            return HOUR if dt.fold else ZERO
        # DST is off.
        return ZERO

    def fromutc(self, dt):
        assert dt.tzinfo is self
        start, end = us_dst_range(dt.year)
        start = start.replace(tzinfo=self)
        end = end.replace(tzinfo=self)
        std_time = dt + self.stdoffset
        dst_time = std_time + HOUR
        if end <= dst_time < end + HOUR:
            # Repeated hour
            return std_time.replace(fold=1)
        if std_time < start or dst_time >= end:
            # Standard time
            return std_time
        if start <= std_time < end - HOUR:
            # Daylight saving time
            return dst_time


Eastern  = USTimeZone(-5, "Eastern",  "EST", "EDT")
Central  = USTimeZone(-6, "Central",  "CST", "CDT")
Mountain = USTimeZone(-7, "Mountain", "MST", "MDT")
Pacific  = USTimeZone(-8, "Pacific",  "PST", "PDT")

请注意同时负责标准时和夏令时的 tzinfo 子类在每年两次的 DST 转换点上会出现不可避免的微妙问题。 具体而言,考虑美国东部时区 (UTC -0500),它的 EDT 从三月的第二个星期天 1:59 (EST) 之后一分钟开始,并在十一月的第一个星期天 1:59 (EDT) 之后一分钟结束:

  UTC   3:MM  4:MM  5:MM  6:MM  7:MM  8:MM
  EST  22:MM 23:MM  0:MM  1:MM  2:MM  3:MM
  EDT  23:MM  0:MM  1:MM  2:MM  3:MM  4:MM

start  22:MM 23:MM  0:MM  1:MM  3:MM  4:MM

  end  23:MM  0:MM  1:MM  1:MM  2:MM  3:MM

当 DST 开始时(见 「start」 行),本地时钟从 1:59 跳到 3:00。 形式为 2:MM 的时间值在那一天是没有意义的,因此在 DST 开始的那一天 astimezone(Eastern) 不会输出包含 hour == 2 的结果。 例如,在 2016 年春季时钟向前调整时,我们得到

>>> u0 = datetime(2016, 3, 13, 5, tzinfo=timezone.utc)
>>> for i in range(4):
...     u = u0 + i*HOUR
...     t = u.astimezone(Eastern)
...     print(u.time(), 'UTC =', t.time(), t.tzname())
...
05:00:00 UTC = 00:00:00 EST
06:00:00 UTC = 01:00:00 EST
07:00:00 UTC = 03:00:00 EDT
08:00:00 UTC = 04:00:00 EDT

当 DST 结束时(见 「end」 行),会有更糟糕的潜在问题:本地时间值中有一个小时是不可能没有歧义的:夏令时的最后一小时。 即以美国东部时间表示当天夏令时结束时的形式为 5:MM UTC 的时间。 本地时间从 1:59 (夏令时) 再次跳回到 1:00 (标准时)。 形式为 1:MM 的本地时间就是有歧义的。 此时 astimezone() 是通过将两个相邻的 UTC 小时映射到两个相同的本地小时来模仿本地时钟的行为。 在这个美国东部时间的示例中,形式为 5:MM 和 6:MM 的 UTC 时间在转换为美国东部时间时都将被映射到 1:MM,但前一个时间会将 fold 属性设为 0 而后一个时间会将其设为 1。 例如,在 2016 年秋季时钟往回调整时,我们得到

>>> u0 = datetime(2016, 11, 6, 4, tzinfo=timezone.utc)
>>> for i in range(4):
...     u = u0 + i*HOUR
...     t = u.astimezone(Eastern)
...     print(u.time(), 'UTC =', t.time(), t.tzname(), t.fold)
...
04:00:00 UTC = 00:00:00 EDT 0
05:00:00 UTC = 01:00:00 EDT 0
06:00:00 UTC = 01:00:00 EST 1
07:00:00 UTC = 02:00:00 EST 0

请注意不同的 datetime 实例仅通过 fold 属性值来加以区分,它们在比较时会被视为相等。

不允许时间显示存在歧义的应用需要显式地检查 fold 属性的值,或者避免使用混合式的 tzinfo 子类;当使用 timezone 或者任何其他固定差值的 tzinfo 子类例如仅表示 EST(固定差值 -5 小时)或仅表示 EDT(固定差值 -4 小时)的类时是不会有歧义的。

也參考

dateutil.tz

该标准库具有 timezone 类用来将相对于 UTC 和 timezone.utc 的任意固定差值处理为 UTC 时区实例。

dateutil.tz 库将 IANA 时区数据库 (又名 Olson 数据库) 引入 Python 并推荐使用。

IANA 时区数据库

该时区数据库 (通常称为 tz, tzdata 或 zoneinfo) 包含大量代码和数据用来表示全球许多有代表性的地点的本地时间的历史信息。 它会定期进行更新以反映各政治实体对时区边界、UTC 差值和夏令时规则的更改。

8.1.7. timezone 对象

timezone 类是 tzinfo 的一个子类,它的每个实例代表一个由与 UTC 的固定差值所定义的时区。 请注意该类的对象不可被用于代表某些特殊地点的时区信息,例如在一年的不同日期使用不同差值,或是在历史上对民用时间进行过调整的地点。

class datetime.timezone(offset, name=None)

The offset argument must be specified as a timedelta object representing the difference between the local time and UTC. It must be strictly between -timedelta(hours=24) and timedelta(hours=24) and represent a whole number of minutes, otherwise ValueError is raised.

name 参数是可选的。 如果指定则必须为一个字符串,它将被用作 datetime.tzname() 方法的返回值。

3.2 版新加入.

timezone.utcoffset(dt)

返回在构造 timezone 实例时指定的固定值。 dt 参数会被忽略。 返回值是一个 timedelta 实例,其值等于本地时间与 UTC 之间的差值。

timezone.tzname(dt)

返回在构造 timezone 实例时指定的固定值。 如果没有为构造器提供 name,则 tzname(dt) 所返回的名称将根据 offset 值按以下规则生成。 如果 offsettimedelta(0),则名称为 「UTC」,否则为字符串 『UTC±HH:MM』,其中 ± 为 offset 值的正负,HH 和 MM 分别为表示 offset.hoursoffset.minutes 的两个数码。

3.6 版更變: offset=timedelta(0) 生成的名称现在改为简单的 『UTC』 而不再是 『UTC+00:00』。

timezone.dst(dt)

总是返回 None

timezone.fromutc(dt)

返回 dt + offsetdt 参数必须为一个感知型 datetime 实例,其中 tzinfo 值设为 self

类属性:

timezone.utc

UTC 时区,timezone(timedelta(0))

8.1.8. strftime()strptime() 的行为

date, datetimetime 对象都支持 strftime(format) 方法,可用来创建一个由指定格式字符串所控制的表示时间的字符串。 总体而言,d.strftime(fmt) 类似于 time 模块的 time.strftime(fmt, d.timetuple()) 但是并非所有对象都支持 timetuple() 方法。

相反地,datetime.strptime() 类方法可根据一个表示时间的字符串和对应的格式字符串创建来一个 datetime 对象。 datetime.strptime(date_string, format) 等价于 datetime(*(time.strptime(date_string, format)[0:6])),差别在于当 format 包含小于秒的部分或者时区差值信息的时候,这些信息被 datetime.strptime 所支持但会被 time.strptime 所丢弃。

对于 time 对象,年、月、日的格式代码不应被使用,因为 time 对象没有这些值。 如果它们被使用,年份将被替换为 1900 而月和日将被替换为 1

对于 date 对象,时、分、秒和微秒的格式代码不应被使用,因为 date 对象没有这些值。 如果它们被使用,它们都将被替换为 0

对完整格式代码集的支持在不同平台上有所差异,因为 Python 要调用所在平台 C 库的 strftime() 函数,而不同平台的差异是很常见的。 要查看你所用平台所支持的完整格式代码集,请参阅 strftime(3) 文档。

以下列表显示了 C 标准(1989 版)所要求的全部格式代码,它们在带有标准 C 实现的所有平台上均可用。 请注意 1999 版 C 标准又添加了额外的格式代码。

指令

含义

示例

註解

%a

当地工作日的缩写。

Sun, Mon, …, Sat (美国);
So, Mo, …, Sa (德国)

(1)

%A

当地工作日的全名。

Sunday, Monday, …, Saturday (美国);
Sonntag, Montag, …, Samstag (德国)

(1)

%w

以十进制数显示的工作日,其中0表示星期日,6表示星期六。

0, 1, …, 6

%d

补零后,以十进制数显示的月份中的一天。

01, 02, …, 31

%b

当地月份的缩写。

Jan, Feb, …, Dec (美国);
Jan, Feb, …, Dez (德国)

(1)

%B

当地月份的全名。

January, February, …, December (美国);
Januar, Februar, …, Dezember (德国)

(1)

%m

补零后,以十进制数显示的月份。

01, 02, …, 12

%y

补零后,以十进制数表示的,不带世纪的年份。

00, 01, …, 99

%Y

十进制数表示的带世纪的年份。

0001, 0002, …, 2013, 2014, …, 9998, 9999

(2)

%H

以补零后的十进制数表示的小时(24 小时制)。

00, 01, …, 23

%I

以补零后的十进制数表示的小时(12 小时制)。

01, 02, …, 12

%p

本地化的 AM 或 PM 。

AM, PM (美国);
am, pm (德国)

(1), (3)

%M

补零后,以十进制数显示的分钟。

00, 01, …, 59

%S

补零后,以十进制数显示的秒。

00, 01, …, 59

(4)

%f

以十进制数表示的微秒,在左侧补零。

000000, 000001, …, 999999

(5)

%z

UTC offset in the form +HHMM or -HHMM (empty string if the object is naive).

(empty), +0000, -0400, +1030

(6)

%Z

时区名称(如果对象为简单型则为空字符串)。

(空), UTC, EST, CST

%j

以补零后的十进制数表示的一年中的日序号。

001, 002, …, 366

%U

以补零后的十进制数表示的一年中的周序号(星期日作为每周的第一天)。 在新的一年中第一个星期日之前的所有日子都被视为是在第 0 周。

00, 01, …, 53

(7)

%W

以十进制数表示的一年中的周序号(星期一作为每周的第一天)。 在新的一年中第一个第期一之前的所有日子都被视为是在第 0 周。

00, 01, …, 53

(7)

%c

本地化的适当日期和时间表示。

Tue Aug 16 21:30:00 1988 (美国);
Di 16 Aug 21:30:00 1988 (德国)

(1)

%x

本地化的适当日期表示。

08/16/88 (None);
08/16/1988 (en_US);
16.08.1988 (de_DE)

(1)

%X

本地化的适当时间表示。

21:30:00 (en_US);
21:30:00 (de_DE)

(1)

%%

字面的 '%' 字符。

%

有一些并非 C89 标准所要求的额外指令是为使用方便而加入的。 这些形参都与 ISO 8601 日期值相对应。 它们可能不是在所有平台上都可通过 strftime() 方法使用。 ISO 8601 年份和 ISO 8601 星期指令并不能与上面的年份和星期序号指令相互替代。 调用 strptime() 时传入不完整或有歧义的 ISO 8601 指令将引发 ValueError

指令

含义

示例

註解

%G

带有世纪的 ISO 8601 年份,表示包含大部分 ISO 星期 (%V) 的年份。

0001, 0002, …, 2013, 2014, …, 9998, 9999

(8)

%u

以十进制数显示的 ISO 8601 星期中的日序号,其中 1 表示星期一。

1, 2, …, 7

%V

以十进制数显示的 ISO 8601 星期,以星期一作为每周的第一天。 第 01 周为包含 1 月 4 日的星期。

01, 02, …, 53

(8)

3.6 版新加入: 增加了 %G, %u%V

註解:

  1. 由于此格式依赖于当前区域设置,因此对具体输出值应当保持谨慎预期。 字段顺序会发生改变(例如 「month/day/year」 与 「day/month/year」),并且输出可能包含使用区域设置所指定的默认编码格式的 Unicode 字符(例如如果当前区域为 ja_JP,则默认编码格式可能为 eucJP, SJISutf-8 中的一个;使用 locale.getlocale() 可确定当前区域设置的编码格式)。

  2. strptime() 方法能够解析整个 [1, 9999] 范围内的年份,但 < 1000 的年份必须加零填充为 4 位数字宽度。

    3.2 版更變: 在之前的版本中,strftime() 方法只限于 >= 1900 的年份。

    3.3 版更變: 在版本3.2中,strftime() 方法只限于 years >= 1000。

  3. 当与 strptime() 方法一起使用时,如果使用 %I 指令来解析小时,%p 指令只影响输出小时字段。

  4. time 模块不同的是, datetime 模块不支持闰秒。

  5. 当与 strptime() 方法一起使用时,%f 指令可接受一至六个数码及左边的零填充。 %f 是对 C 标准中格式字符集的扩展(但单独在 datetime 对象中实现,因此它总是可用)。

  6. 对于简单型对象,%z and %Z 格式代码会被替换为空字符串。

    对于一个觉悟型对象而言:

    %z

    utcoffset() is transformed into a 5-character string of the form +HHMM or -HHMM, where HH is a 2-digit string giving the number of UTC offset hours, and MM is a 2-digit string giving the number of UTC offset minutes. For example, if utcoffset() returns timedelta(hours=-3, minutes=-30), %z is replaced with the string '-0330'.

    %Z

    如果 tzname() 返回 None%Z 会被替换为一个空字符串。 在其他情况下 %Z 会被替换为返回值,这必须为一个字符串。

    3.2 版更變: 当提供 %z 指令给 strptime() 方法时,将产生一个感知型 datetime 对象。 结果的 tzinfo 将被设为一个 timezone 实例。

  7. 当与 strptime() 方法一起使用时,%U%W 仅用于指定星期几和日历年份 (%Y) 的计算。

  8. 类似于 %U%W%V 仅用于在 strptime() 格式字符串中指定星期几和 ISO 年份 (%G) 的计算。 还要注意 %G%Y 是不可交换的。

註解

1

就是说如果我们忽略相对论效应的话。