Skip to content

[3.10] bpo-46266: Add calendar day of week constants to __all__ (GH-30412) #30424

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 23, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion Doc/library/calendar.rst
Original file line number Diff line number Diff line change
@@ -31,7 +31,7 @@ interpreted as prescribed by the ISO 8601 standard. Year 0 is 1 BC, year -1 is
.. class:: Calendar(firstweekday=0)

Creates a :class:`Calendar` object. *firstweekday* is an integer specifying the
first day of the week. ``0`` is Monday (the default), ``6`` is Sunday.
first day of the week. :const:`MONDAY` is ``0`` (the default), :const:`SUNDAY` is ``6``.

A :class:`Calendar` object provides several methods that can be used for
preparing the calendar data for formatting. This class doesn't do any formatting
@@ -409,6 +409,15 @@ The :mod:`calendar` module exports the following data attributes:
locale. This follows normal convention of January being month number 1, so it
has a length of 13 and ``month_abbr[0]`` is the empty string.

.. data:: MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
SATURDAY
SUNDAY

Aliases for day numbers, where ``MONDAY`` is ``0`` and ``SUNDAY`` is ``6``.

.. seealso::

4 changes: 3 additions & 1 deletion Lib/calendar.py
Original file line number Diff line number Diff line change
@@ -15,7 +15,9 @@
"monthcalendar", "prmonth", "month", "prcal", "calendar",
"timegm", "month_name", "month_abbr", "day_name", "day_abbr",
"Calendar", "TextCalendar", "HTMLCalendar", "LocaleTextCalendar",
"LocaleHTMLCalendar", "weekheader"]
"LocaleHTMLCalendar", "weekheader",
"MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY",
"SATURDAY", "SUNDAY"]

# Exception raised for bad input (with string parameter for details)
error = ValueError
3 changes: 1 addition & 2 deletions Lib/test/test_calendar.py
Original file line number Diff line number Diff line change
@@ -935,8 +935,7 @@ def test_html_output_year_css(self):
class MiscTestCase(unittest.TestCase):
def test__all__(self):
not_exported = {
'mdays', 'January', 'February', 'EPOCH', 'MONDAY', 'TUESDAY',
'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY',
'mdays', 'January', 'February', 'EPOCH',
'different_locale', 'c', 'prweek', 'week', 'format',
'formatstring', 'main', 'monthlen', 'prevmonth', 'nextmonth'}
support.check__all__(self, calendar, not_exported=not_exported)
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Improve day constants in :mod:`calendar`.

Now all constants (`MONDAY` ... `SUNDAY`) are documented, tested, and added
to ``__all__``.