8.2. calendar — 一般的なカレンダーに関する関数群

このモジュールは Unix の cal プログラムのようなカレンダー出力を行い、それに加えてカレンダーに関する有益な関数群を提供します。標準ではこれらのカレンダーは（ヨーロッパの慣例に従って）月曜日を週の始まりとし、日曜日を最後の日としています。 setfirstweekday() を用いることで、日曜日(6)や他の曜日を週の始まりに設定することができます。日付を表す引数は整数値で与えます。関連する機能として、 datetime と time モジュールも参照してください。

このモジュールで提供する関数とクラスのほとんどは datetime に依存しており、過去も未来も現代のグレゴリオ暦を利用します。この方式は Dershowitz と Reingold の書籍「Calendrical Calculations」にある proleptic Gregorian 暦に一致しており、同書では全ての計算の基礎となる暦としています。 [1]

参考

最新バージョンの calendar module Python source code

class calendar.Calendar([firstweekday])

Calendar オブジェクトを作ります。 firstweekday は整数で週の始まりの曜日を指定するものです。 0 が月曜(デフォルト)、 6 なら日曜です。

Calendar オブジェクトは整形されるカレンダーのデータを準備するために使えるいくつかのメソッドを提供しています。しかし整形機能そのものは提供していません。それはサブクラスの仕事なのです。

バージョン 2.5 で追加.

Calendar インスタンスには以下のメソッドがあります。

calendar.iterweekdays(weekday)

曜日の数字を一週間分生成するイテレータを返します。イテレータから得られる最初の数字は firstweekday() が返す数字と同じになります。

calendar.itermonthdates(year, month)

year 年 month 月に対するイテレータを返します。このイテレータはその月の全ての日(datetime.date オブジェクトとして) およびその前後の日で週に欠けが無いようにするのに必要な日を返します。

calendar.itermonthdays2(year, month)

year 年 month 月に対する itermonthdates() と同じようなイテレータを返します。生成されるのは日付の数字と曜日を表す数字のタプルです。

calendar.itermonthdays(year, month)

year 年 month 月に対する itermonthdates() と同じようなイテレータを返します。生成されるのは日付の数字だけです。

calendar.monthdatescalendar(year, month)

year 年 month 月の週のリストを返します。週は全て七つの datetime.date オブジェクトからなるリストです。

calendar.monthdays2calendar(year, month)

year 年 month 月の週のリストを返します。週は全て七つの日付の数字と曜日を表す数字のタプルからなるリストです。

calendar.monthdayscalendar(year, month)

year 年 month 月の週のリストを返します。週は全て七つの日付の数字からなるリストです。

calendar.yeardatescalendar(year[, width])

指定された年のデータを整形に向く形で返します。返される値は月の並びのリストです。月の並びは最大で width ヶ月(デフォルトは3ヶ月)分です。各月は4ないし6週からなり、各週は1ないし7日からなります。各日は datetime.date オブジェクトです。

calendar.yeardays2calendar(year[, width])

指定された年のデータを整形に向く形で返します (yeardatescalendar() と同様です)。週のリストの中が日付の数字と曜日の数字のタプルになります。月の範囲外の部分の日付はゼロです。

calendar.yeardayscalendar(year[, width])

指定された年のデータを整形に向く形で返します (yeardatescalendar() と同様です)。週のリストの中が日付の数字になります。月の範囲外の日付はゼロです。

class calendar.TextCalendar([firstweekday])

このクラスはプレインテキストのカレンダーを生成するのに使えます。

バージョン 2.5 で追加.

TextCalendar インスタンスには以下のメソッドがあります。

formatmonth(theyear, themonth[, w[, l]])

ひと月分のカレンダーを複数行の文字列で返します。 w により日の列幅を変えることができ、それらはセンタリングされます。 l により各週の表示される行数を変えることができます。 setfirstweekday() メソッドでセットされた週の最初の曜日に依存します。

prmonth(theyear, themonth[, w[, l]])

formatmonth() で返されるひと月分のカレンダーを出力します。

formatyear(theyear[, w[, l[, c[, m]]]])

m 列からなる一年間のカレンダーを複数行の文字列で返します。任意の引数 w, l, c はそれぞれ、日付列の表示幅、各週の行数及び月と月の間のスペースの数を変更するためのものです。 setfirstweekday() メソッドでセットされた週の最初の曜日に依存します。カレンダーを出力できる最初の年はプラットフォームに依存します。

pryear(theyear[, w[, l[, c[, m]]]])

formatyear() で返される一年間のカレンダーを出力します。

class calendar.HTMLCalendar([firstweekday])

このクラスは HTML のカレンダーを生成するのに使えます。

バージョン 2.5 で追加.

HTMLCalendar インスタンスには以下のメソッドがあります。

formatmonth(theyear, themonth[, withyear])

ひと月分のカレンダーを HTML のテーブルとして返します。 withyear が真であればヘッダには年も含まれます。そうでなければ月の名前だけが使われます。

formatyear(theyear[, width])

一年分のカレンダーを HTML のテーブルとして返します。 width の値 (デフォルトでは 3 です) は何ヶ月分を一行に収めるかを指定します。

formatyearpage(theyear[, width[, css[, encoding]]])

一年分のカレンダーを一つの完全な HTML ページとして返します。 width の値(デフォルトでは 3 です) は何ヶ月分を一行に収めるかを指定します。 css は使われるカスケーディングスタイルシートの名前です。スタイルシートを使わないようにするために None を渡すこともできます。 encoding には出力に使うエンコーディングを指定します (デフォルトではシステムデフォルトのエンコーディングです)。

class calendar.LocaleTextCalendar([firstweekday[, locale]])

この TextCalendar のサブクラスではコンストラクタにロケール名を渡すことができ、メソッドの返り値で月や曜日が指定されたロケールのものになります。このロケールがエンコーディングを含む場合には、月や曜日の入った文字列はユニコードとして返されます。

バージョン 2.5 で追加.

class calendar.LocaleHTMLCalendar([firstweekday[, locale]])

この HTMLCalendar のサブクラスではコンストラクタにロケール名を渡すことができ、メソッドの返り値で月や曜日が指定されたロケールのものになります。このロケールがエンコーディングを含む場合には、月や曜日の入った文字列はユニコードとして返されます。

バージョン 2.5 で追加.

ノート

これら2つのクラスの formatweekday() と formatmonthname() メソッドは、一時的に現在の locale を指定された locale に変更します。現在の locale はプロセス全体に影響するので、これらはスレッドセーフではありません。

単純なテキストのカレンダーに関して、このモジュールには以下のような関数が提供されています。

calendar.setfirstweekday(weekday)

週の最初の曜日(0 は月曜日, 6 は日曜日)を設定します。定数 MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY 及び SUNDAY は便宜上提供されています。例えば、日曜日を週の開始日に設定するときは:

import calendar
calendar.setfirstweekday(calendar.SUNDAY)

バージョン 2.0 で追加.

calendar.firstweekday()

現在設定されている週の最初の曜日を返します。

バージョン 2.0 で追加.

calendar.isleap(year)

year が閏年なら True を、そうでなければ False を返します。

calendar.leapdays(y1, y2)

範囲(y1 ... y2)指定された期間の閏年の回数を返します。ここで y1 や y2 は年を表します。

バージョン 2.0 で変更: Python 1.5.2では、この関数は世紀をまたがった範囲では動作しません。

calendar.weekday(year, month, day)

year (1970–...), month (1–12), day (1–31) で与えられた日の曜日(0 は月曜日)を返します。

calendar.weekheader(n)

短縮された曜日名を含むヘッダを返します。 n は各曜日を何文字で表すかを指定します。

calendar.monthrange(year, month)

year と month で指定された月の一日の曜日と日数を返します。

calendar.monthcalendar(year, month)

月のカレンダーを行列で返します。各行が週を表し、月の範囲外の日は0になります。それぞれの週は setfirstweekday() で設定をしていない限り月曜日から始まります。

calendar.prmonth(theyear, themonth[, w[, l]])

month() 関数によって返される月のカレンダーを出力します。

calendar.month(theyear, themonth[, w[, l]])

TextCalendar の formatmonth() メソッドを利用して、ひと月分のカレンダーを複数行の文字列で返します。

バージョン 2.0 で追加.

calendar.prcal(year[, w[, l[c]]])

calendar() 関数で返される一年間のカレンダーを出力します。

calendar.calendar(year[, w[, l[c]]])

TextCalendar の formatyear() メソッドを利用して、 3列からなる一年間のカレンダーを複数行の文字列で返します。

バージョン 2.0 で追加.

calendar.timegm(tuple)

関連はありませんが便利な関数で、 time モジュールの gmtime() 関数の戻値のような時間のタプルを受け取り、 1970年を起点とし、POSIX規格のエンコードによるUnixのタイムスタンプに相当する値を返します。実際、 time.gmtime() と timegm() は反対の動作をします。

バージョン 2.0 で追加.

calendar モジュールの以下のデータ属性を利用することができます:

calendar.day_name

現在のロケールでの曜日を表す配列です。

calendar.day_abbr

現在のロケールでの短縮された曜日を表す配列です。

calendar.month_name

現在のロケールでの月の名を表す配列です。この配列は通常の約束事に従って、 1月を数字の 1 で表しますので、長さが 13 ある代わりに month_name[0] が空文字列になります。

calendar.month_abbr

現在のロケールでの短縮された月の名を表す配列です。この配列は通常の約束事に従って、1月を数字の 1 で表しますので、長さが 13 ある代わりに month_name[0] が空文字列になります。

参考

Module datetime

time モジュールと似た機能を持った日付と時間用のオブジェクト指向インタフェース。

Module time

低レベルの時間に関連した関数群。

注記

[1]	訳注: proleptic Gregorian 暦とはグレゴリオ暦制定(1582年)以前についてもグレゴリオ暦で言い表す暦の方式のことで ISO 8601 などでも採用されています