每週一個 Python 模塊 | calendar

時間 2019-11-16

原文原文鏈接

calendar模塊定義了Calendar類，它封裝了值的計算，好比計算給定月份或年份中周的日期。此外，TextCalendar和 HTMLCalendar類能夠生成預格式化的輸出。python

格式化示例

prmonth()方法是很簡單，能夠生成一個月的格式化文本輸出。git

import calendar

c = calendar.TextCalendar(calendar.SUNDAY)
c.prmonth(2017, 7)

# 輸出
# July 2017
# Su Mo Tu We Th Fr Sa
# 1
# 2 3 4 5 6 7 8
# 9 10 11 12 13 14 15
# 16 17 18 19 20 21 22
# 23 24 25 26 27 28 29
# 30 31
複製代碼

根據TextCalendar美國慣例，該示例配置爲在週日開始周。默認是使用星期一開始一週的歐洲慣例。github

可使用HTMLCalendar和formatmonth()生成相似 HTML 的表格。呈現的輸出看起來與純文本大體相同，可是用 HTML 標記包裝。每一個表格單元格都有一個與星期幾相對應的類屬性，所以 HTML 能夠經過 CSS 設置樣式。函數

要以不一樣於其中一個可用默認值的格式生成輸出，請使用calendar計算日期並將值組織爲周和月範圍，而後迭代結果。Calendar模塊的 weekheader()，monthcalendar()和 yeardays2calendar()方法對此特別有用。ui

調用yeardays2calendar()會生成一系列「月份行」列表。每一個列表包括月份做爲另外一個周列表。這幾周是由日期編號（1-31）和工做日編號（0-6）組成的元組列表。超出月份的天數爲 0。spa

import calendar
import pprint

cal = calendar.Calendar(calendar.SUNDAY)

cal_data = cal.yeardays2calendar(2017, 3)
print('len(cal_data) :', len(cal_data))

top_months = cal_data[0]
print('len(top_months) :', len(top_months))

first_month = top_months[0]
print('len(first_month) :', len(first_month))

print('first_month:')
pprint.pprint(first_month, width=65)

# 輸出
# len(cal_data) : 4
# len(top_months) : 3
# len(first_month) : 5
# first_month:
# [[(1, 6), (2, 0), (3, 1), (4, 2), (5, 3), (6, 4), (7, 5)],
# [(8, 6), (9, 0), (10, 1), (11, 2), (12, 3), (13, 4), (14, 5)],
# [(15, 6), (16, 0), (17, 1), (18, 2), (19, 3), (20, 4), (21, 5)],
# [(22, 6), (23, 0), (24, 1), (25, 2), (26, 3), (27, 4), (28, 5)],
# [(29, 6), (30, 0), (31, 1), (0, 2), (0, 3), (0, 4), (0, 5)]]
複製代碼

至關於使用formatyear()。code

import calendar

cal = calendar.TextCalendar(calendar.SUNDAY)
print(cal.formatyear(2017, 2, 1, 1, 3))

# 輸出
# 2017
# 
# January February March
# Su Mo Tu We Th Fr Sa Su Mo Tu We Th Fr Sa Su Mo Tu We Th Fr Sa
# 1 2 3 4 5 6 7 1 2 3 4 1 2 3 4
# 8 9 10 11 12 13 14 5 6 7 8 9 10 11 5 6 7 8 9 10 11
# 15 16 17 18 19 20 21 12 13 14 15 16 17 18 12 13 14 15 16 17 18
# 22 23 24 25 26 27 28 19 20 21 22 23 24 25 19 20 21 22 23 24 25
# 29 30 31 26 27 28 26 27 28 29 30 31
# 
# April May June
# Su Mo Tu We Th Fr Sa Su Mo Tu We Th Fr Sa Su Mo Tu We Th Fr Sa
# 1 1 2 3 4 5 6 1 2 3
# 2 3 4 5 6 7 8 7 8 9 10 11 12 13 4 5 6 7 8 9 10
# 9 10 11 12 13 14 15 14 15 16 17 18 19 20 11 12 13 14 15 16 17
# 16 17 18 19 20 21 22 21 22 23 24 25 26 27 18 19 20 21 22 23 24
# 23 24 25 26 27 28 29 28 29 30 31 25 26 27 28 29 30
# 30
# 
# July August September
# Su Mo Tu We Th Fr Sa Su Mo Tu We Th Fr Sa Su Mo Tu We Th Fr Sa
# 1 1 2 3 4 5 1 2
# 2 3 4 5 6 7 8 6 7 8 9 10 11 12 3 4 5 6 7 8 9
# 9 10 11 12 13 14 15 13 14 15 16 17 18 19 10 11 12 13 14 15 16
# 16 17 18 19 20 21 22 20 21 22 23 24 25 26 17 18 19 20 21 22 23
# 23 24 25 26 27 28 29 27 28 29 30 31 24 25 26 27 28 29 30
# 30 31
# 
# October November December
# Su Mo Tu We Th Fr Sa Su Mo Tu We Th Fr Sa Su Mo Tu We Th Fr Sa
# 1 2 3 4 5 6 7 1 2 3 4 1 2
# 8 9 10 11 12 13 14 5 6 7 8 9 10 11 3 4 5 6 7 8 9
# 15 16 17 18 19 20 21 12 13 14 15 16 17 18 10 11 12 13 14 15 16
# 22 23 24 25 26 27 28 19 20 21 22 23 24 25 17 18 19 20 21 22 23
# 29 30 31 26 27 28 29 30 24 25 26 27 28 29 30
# 31
複製代碼

day_name，day_abbr，month_name，和 month_abbr模塊主要用於生產定製格式化輸出（即，包括在 HTML 輸出連接）。它們會針對當前區域自動化配置。orm

區域設置

若是想生成非默認區域的格式化日曆，可使用LocaleTextCalendar或 LocaleHTMLCalendar。htm

import calendar

c = calendar.LocaleTextCalendar(locale='en_US')
c.prmonth(2017, 7)

print()

c = calendar.LocaleTextCalendar(locale='fr_FR')
c.prmonth(2017, 7)

# 輸出
# July 2017
# Mo Tu We Th Fr Sa Su
# 1 2
# 3 4 5 6 7 8 9
# 10 11 12 13 14 15 16
# 17 18 19 20 21 22 23
# 24 25 26 27 28 29 30
# 31
#
# juillet 2017
# Lu Ma Me Je Ve Sa Di
# 1 2
# 3 4 5 6 7 8 9
# 10 11 12 13 14 15 16
# 17 18 19 20 21 22 23
# 24 25 26 27 28 29 30
# 31
複製代碼

一週的第一天不是語言環境設置的一部分，並且這個值就是該類的一個參數，就像TextCalendar同樣。

計算日期

雖然日曆模塊主要側重於以各類格式打印完整日曆，但它還提供了以其餘方式處理日期的有用功能，例如計算重複事件的日期。

例如，Python 亞特蘭大用戶組在每月的第二個星期四開會。要計算一年的會議日期，請使用monthcalendar()。

import calendar
import pprint

pprint.pprint(calendar.monthcalendar(2017, 7))

# 輸出
# [[0, 0, 0, 0, 0, 1, 2],
# [3, 4, 5, 6, 7, 8, 9],
# [10, 11, 12, 13, 14, 15, 16],
# [17, 18, 19, 20, 21, 22, 23],
# [24, 25, 26, 27, 28, 29, 30],
# [31, 0, 0, 0, 0, 0, 0]]
複製代碼

0 值是與給定月份重疊的一週中的時間，是另外一個月的一部分。

一週的第一天默認爲星期一。能夠經過調用setfirstweekday()來更改，但因爲日曆模塊包含用於索引返回的日期範圍的常量 monthcalendar()，所以在這種狀況下跳過該步驟更方便。

要計算一年的小組會議日期，假設它們老是在每月的第二個星期四，查看 monthcalendar()輸出來查找星期四。本月的第一週和最後一週填充 0 值做爲前一個月或後一個月天數的佔位符。例如，若是一個月在星期五開始，則星期四位置第一週的值將爲 0。

import calendar
import sys

year = int(sys.argv[1])

# Show every month
for month in range(1, 13):

    # Compute the dates for each week that overlaps the month
    c = calendar.monthcalendar(year, month)
    first_week = c[0]
    second_week = c[1]
    third_week = c[2]

    # If there is a Thursday in the first week,
    # the second Thursday is # in the second week.
    # Otherwise, the second Thursday must be in
    # the third week.
    if first_week[calendar.THURSDAY]:
        meeting_date = second_week[calendar.THURSDAY]
    else:
        meeting_date = third_week[calendar.THURSDAY]

    print('{:>3}: {:>2}'.format(calendar.month_abbr[month], meeting_date))

# 輸出 
# Jan: 12
# Feb: 9
# Mar: 9
# Apr: 13
# May: 11
# Jun: 8
# Jul: 13
# Aug: 10
# Sep: 14
# Oct: 12
# Nov: 9
# Dec: 14
複製代碼

其餘可能有用的函數列表

序號	函數及描述
1	calendar.calendar(year,w=2,l=1,c=6) 返回一個多行字符串格式的year年年曆，3個月一行，間隔距離爲c。每日寬度間隔爲w字符。每行長度爲21* W+18+2* C。l是每星期行數。
2	calendar.firstweekday( ) 返回當前每週起始日期的設置。默認狀況下，首次載入calendar模塊時返回0，即星期一。
3	calendar.isleap(year) 是閏年返回True，不然爲false。
4	calendar.leapdays(y1,y2) 返回在Y1，Y2兩年之間的閏年總數。
5	calendar.month(year,month,w=2,l=1) 返回一個多行字符串格式的year年month月日曆，兩行標題，一週一行。每日寬度間隔爲w字符。每行的長度爲7* w+6。l是每星期的行數。
6	calendar.monthcalendar(year,month) 返回一個整數的單層嵌套列表。每一個子列表裝載表明一個星期的整數。Year年month月外的日期都設爲0;範圍內的日子都由該月第幾日表示，從1開始。
7	calendar.monthrange(year,month) 返回兩個整數。第一個是該月的星期幾的日期碼，第二個是該月的日期碼。日從0（星期一）到6（星期日）;月從1到12。
8	calendar.prcal(year,w=2,l=1,c=6) 至關於 print calendar.calendar(year,w,l,c).
9	calendar.prmonth(year,month,w=2,l=1) 至關於 print calendar.calendar（year，w，l，c）。
10	calendar.setfirstweekday(weekday) 設置每週的起始日期碼。0（星期一）到6（星期日）。
11	calendar.timegm(tupletime) 和time.gmtime相反：接受一個時間元組形式，返回該時刻的時間輟（1970紀元後通過的浮點秒數）。
12	calendar.weekday(year,month,day) 返回給定日期的日期碼。0（星期一）到6（星期日）。月份爲 1（一月）到 12（12月）。