https://github.com/python/cpython/commit/3be7498d2450519d5d8f63a35ef298db3b3d935b
commit: 3be7498d2450519d5d8f63a35ef298db3b3d935b
branch: main
author: Nadeshiko Manju <m...@manjusaka.me>
committer: ethanfurman <et...@stoneleaf.us>
date: 2024-11-15T11:03:06-08:00
summary:
gh-126476: Raise IllegalMonthError for calendar.formatmonth() when the input
month is not correct (GH-126484)
Co-authored-by: Ethan Furman <et...@stoneleaf.us>
files:
A Misc/NEWS.d/next/Library/2024-11-06-18-30-50.gh-issue-126476.F1wh3c.rst
M Lib/calendar.py
M Lib/test/test_calendar.py
diff --git a/Lib/calendar.py b/Lib/calendar.py
index 069dd5174112ae..8c1c646da46a98 100644
--- a/Lib/calendar.py
+++ b/Lib/calendar.py
@@ -27,7 +27,9 @@
error = ValueError
# Exceptions raised for bad input
-class IllegalMonthError(ValueError):
+# This is trick for backward compatibility. Since 3.13, we will raise
IllegalMonthError instead of
+# IndexError for bad month number(out of 1-12). But we can't remove IndexError
for backward compatibility.
+class IllegalMonthError(ValueError, IndexError):
def __init__(self, month):
self.month = month
def __str__(self):
@@ -158,11 +160,14 @@ def weekday(year, month, day):
return Day(datetime.date(year, month, day).weekday())
+def _validate_month(month):
+ if not 1 <= month <= 12:
+ raise IllegalMonthError(month)
+
def monthrange(year, month):
"""Return weekday of first day of month (0-6 ~ Mon-Sun)
and number of days (28-31) for year, month."""
- if not 1 <= month <= 12:
- raise IllegalMonthError(month)
+ _validate_month(month)
day1 = weekday(year, month, 1)
ndays = mdays[month] + (month == FEBRUARY and isleap(year))
return day1, ndays
@@ -370,6 +375,8 @@ def formatmonthname(self, theyear, themonth, width,
withyear=True):
"""
Return a formatted month name.
"""
+ _validate_month(themonth)
+
s = month_name[themonth]
if withyear:
s = "%s %r" % (s, theyear)
@@ -500,6 +507,7 @@ def formatmonthname(self, theyear, themonth, withyear=True):
"""
Return a month name as a table row.
"""
+ _validate_month(themonth)
if withyear:
s = '%s %s' % (month_name[themonth], theyear)
else:
@@ -786,6 +794,8 @@ def main(args=None):
if options.month is None:
optdict["c"] = options.spacing
optdict["m"] = options.months
+ if options.month is not None:
+ _validate_month(options.month)
if options.year is None:
result = cal.formatyear(datetime.date.today().year, **optdict)
elif options.month is None:
diff --git a/Lib/test/test_calendar.py b/Lib/test/test_calendar.py
index f119d89c0ec39a..073df310bb49eb 100644
--- a/Lib/test/test_calendar.py
+++ b/Lib/test/test_calendar.py
@@ -457,6 +457,11 @@ def test_formatmonth(self):
calendar.TextCalendar().formatmonth(0, 2),
result_0_02_text
)
+ def test_formatmonth_with_invalid_month(self):
+ with self.assertRaises(calendar.IllegalMonthError):
+ calendar.TextCalendar().formatmonth(2017, 13)
+ with self.assertRaises(calendar.IllegalMonthError):
+ calendar.TextCalendar().formatmonth(2017, -1)
def test_formatmonthname_with_year(self):
self.assertEqual(
@@ -1121,7 +1126,7 @@ def test__all__(self):
not_exported = {
'mdays', 'January', 'February', 'EPOCH',
'different_locale', 'c', 'prweek', 'week', 'format',
- 'formatstring', 'main', 'monthlen', 'prevmonth', 'nextmonth'}
+ 'formatstring', 'main', 'monthlen', 'prevmonth', 'nextmonth', ""}
support.check__all__(self, calendar, not_exported=not_exported)
@@ -1149,6 +1154,13 @@ def test_formatmonth(self):
self.assertIn('class="text-center month"',
self.cal.formatmonth(2017, 5))
+ def test_formatmonth_with_invalid_month(self):
+ with self.assertRaises(calendar.IllegalMonthError):
+ self.cal.formatmonth(2017, 13)
+ with self.assertRaises(calendar.IllegalMonthError):
+ self.cal.formatmonth(2017, -1)
+
+
def test_formatweek(self):
weeks = self.cal.monthdays2calendar(2017, 5)
self.assertIn('class="wed text-nowrap"', self.cal.formatweek(weeks[0]))
diff --git
a/Misc/NEWS.d/next/Library/2024-11-06-18-30-50.gh-issue-126476.F1wh3c.rst
b/Misc/NEWS.d/next/Library/2024-11-06-18-30-50.gh-issue-126476.F1wh3c.rst
new file mode 100644
index 00000000000000..f558c29e8b087f
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2024-11-06-18-30-50.gh-issue-126476.F1wh3c.rst
@@ -0,0 +1,2 @@
+Raise :class:`calendar.IllegalMonthError` (now a subclass of
:class:`IndexError`) for :func:`calendar.month`
+when the input month is not correct.
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: arch...@mail-archive.com
