Skip to content
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.

Sign up for GitHub

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

Jump to bottom

bpo-46266: Improve day constants (MONDAY ... SUNDAY) in calendar #30412

Merged
merged 2 commits into from
Jan 5, 2022
Merged

bpo-46266: Improve day constants (MONDAY ... SUNDAY) in calendar #30412

merged 2 commits into from
Jan 5, 2022

Conversation

sobolevn
Copy link
Member

@sobolevn sobolevn commented Jan 5, 2022 •
edited by bedevere-bot
Loading

Things I've changed:

  1. Used MONDAY constant everywhere 0 was used as a default day. It is way more readable, you don't have to guess what 0 is in this context.
  2. I've added all day constants to __all__, this is the only thing I doubt. I don't know what policy is about __all__, so this can be reverted if I am not correct. But, initially I though that it is useful to have them when from calendar import * and this way they are automatically tested by test__all__
  3. Since they are now in __all__, I've updated the test case. Now we check that they are still present
  4. Docs are updated, now :const:MONDAY is clickable

https://bugs.python.org/issue46266

@rhettinger rhettinger closed this Jan 5, 2022
@rhettinger rhettinger reopened this Jan 5, 2022
@rhettinger rhettinger self-assigned this Jan 5, 2022
rhettinger
rhettinger requested changes Jan 5, 2022
View reviewed changes
Doc/library/calendar.rst Outdated
@@ -28,10 +28,10 @@ interpreted as prescribed by the ISO 8601 standard. Year 0 is 1 BC, year -1 is
2 BC, and so on.


.. class:: Calendar(firstweekday=0)
.. class:: Calendar(firstweekday=MONDAY)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please leave this as 0.

Doc/library/calendar.rst Outdated
@@ -275,13 +275,13 @@ interpreted as prescribed by the ISO 8601 standard. Year 0 is 1 BC, year -1 is
cssclass_year = "text-italic lead"


.. class:: LocaleTextCalendar(firstweekday=0, locale=None)
.. class:: LocaleTextCalendar(firstweekday=MONDAY, locale=None)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leave all the defaults as 0.

Doc/library/calendar.rst Outdated

This subclass of :class:`TextCalendar` can be passed a locale name in the
constructor and will return month and weekday names in the specified locale.


.. class:: LocaleHTMLCalendar(firstweekday=0, locale=None)
.. class:: LocaleHTMLCalendar(firstweekday=MONDAY, locale=None)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, this one.

Lib/calendar.py Outdated
@@ -151,7 +153,7 @@ class Calendar(object):
provides data to subclasses.
"""

def __init__(self, firstweekday=0):
def __init__(self, firstweekday=MONDAY):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leave all of these as 0 as well.

Lib/calendar.py Outdated
@@ -561,7 +563,7 @@ class LocaleTextCalendar(TextCalendar):
month and weekday names in the specified locale.
"""

def __init__(self, firstweekday=0, locale=None):
def __init__(self, firstweekday=MONDAY, locale=None):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here too.

Lib/calendar.py Outdated
@@ -581,7 +583,7 @@ class LocaleHTMLCalendar(HTMLCalendar):
This class can be passed a locale name in the constructor and will return
month and weekday names in the specified locale.
"""
def __init__(self, firstweekday=0, locale=None):
def __init__(self, firstweekday=MONDAY, locale=None):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here too.

@bedevere-bot
Copy link

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@sobolevn
Copy link
Member Author

sobolevn commented Jan 5, 2022

Thanks for the review!

I have made the requested changes; please review again

@bedevere-bot
Copy link

Thanks for making the requested changes!

@rhettinger: please review the changes made to this pull request.

@rhettinger rhettinger merged commit e5894ca into python:main Jan 5, 2022
@sobolevn
Copy link
Member Author

sobolevn commented Jan 5, 2022

Thank you, @rhettinger! 👍

@rhettinger rhettinger added the needs backport to 3.10 only security fixes label Jan 5, 2022
@miss-islington
Copy link
Contributor

Thanks @sobolevn for the PR, and @rhettinger for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-30424 is a backport of this pull request to the 3.10 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Jan 5, 2022
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 5, 2022
@sobolevn @miss-islington
bpo-46266: Add calendar day of week constants to __all__ (pythonGH-30412
1a1f783 
)

(cherry picked from commit e5894ca)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
vstinner pushed a commit that referenced this pull request Jan 23, 2022
@miss-islington @sobolevn
bpo-46266: Add calendar day of week constants to __all__ (GH-30412) (G…
f66ef3e 
…H-30424)

(cherry picked from commit e5894ca)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rhettinger rhettinger Awaiting requested review from rhettinger

Assignees

@rhettinger rhettinger

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@sobolevn @bedevere-bot @miss-islington @rhettinger @the-knights-who-say-ni