DOC/ENH: Holiday exclusion argument #61600
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sharkipelago
changed the title
mroeschke
reviewed
Jun 9, 2025
doc/source/whatsnew/v2.3.0.rst
Outdated
| @@ -27,6 +27,7 @@ Other enhancements | |||
| - :meth:`Series.str.decode` result now has :class:`StringDtype` when ``future.infer_string`` is True (:issue:`60709`) | |||
| - :meth:`~Series.to_hdf` and :meth:`~DataFrame.to_hdf` now round-trip with :class:`StringDtype` (:issue:`60663`) | |||
| - Improved ``repr`` of :class:`.NumpyExtensionArray` to account for NEP51 (:issue:`61085`) | |||
| - The :class:`Holiday` has gained the constructor argument and field ``exclude_dates`` to exclude specific datetimes from a custom holiday calendar (:issue:`54382`) | |||
There was a problem hiding this comment.
Can you move this to v3.0.0.rst?
mroeschke
reviewed
Jun 9, 2025
pandas/tseries/holiday.py
Outdated
| @@ -169,6 +172,7 @@ def __init__( | |||
| start_date=None, | |||
| end_date=None, | |||
| days_of_week: tuple | None = None, | |||
| exclude_dates: list[Any] | None = None, | |||
There was a problem hiding this comment.
Suggested change
| exclude_dates: list[Any] | None = None, | |
| exclude_dates: list[Timestamp] | None = None, |
Let's make the users do the Timestamp conversion before passing into this object
mroeschke
reviewed
Jun 9, 2025
pandas/tseries/holiday.py
Outdated
Comment on lines
267
to
271
| self.exclude_dates = ( | ||
| [Timestamp(ex) for ex in exclude_dates] | ||
| if exclude_dates is not None | ||
| else exclude_dates | ||
| ) |
There was a problem hiding this comment.
With the constructor argument being stricter, we can just validate the arguments are all Timestamp
mroeschke
reviewed
Jun 9, 2025
pandas/tseries/holiday.py
Outdated
Comment on lines
345
to
347
| holiday_dates = DatetimeIndex( | ||
| [hd for hd in holiday_dates if hd not in self.exclude_dates] | ||
| ) |
There was a problem hiding this comment.
- Conversion to
DatetimeIndexshould be done in__init__ - Probably better to use
.differenceor releated method instead
mroeschke
reviewed
Jun 10, 2025
pandas/tseries/holiday.py
Outdated
Comment on lines
7
to
9
| from typing import ( | ||
| TYPE_CHECKING, | ||
| ) |
There was a problem hiding this comment.
Suggested change
| from typing import ( | |
| TYPE_CHECKING, | |
| ) | |
| from typing import TYPE_CHECKING |
mroeschke
reviewed
Jun 10, 2025
pandas/tseries/holiday.py
Outdated
| @@ -169,6 +171,7 @@ def __init__( | |||
| start_date=None, | |||
| end_date=None, | |||
| days_of_week: tuple | None = None, | |||
| exclude_dates: list[Timestamp] | None = None, | |||
There was a problem hiding this comment.
Actually, can we type this as exclude_dates: DatetimeIndex | None = None,?
mroeschke
reviewed
Jun 10, 2025
pandas/tseries/holiday.py
Outdated
Comment on lines
266
to
268
| assert exclude_dates is None or all( | ||
| type(ex) == Timestamp for ex in exclude_dates | ||
| ) |
There was a problem hiding this comment.
Can you raise a ValueError if exclude_dates is not a DatetimeIndex or None?
sharkipelago
commented
Jun 10, 2025
| @@ -257,6 +260,9 @@ class from pandas.tseries.offsets, default None | |||
| self.observance = observance | |||
| assert days_of_week is None or type(days_of_week) == tuple | |||
There was a problem hiding this comment.
Should I also switch this to throw a ValueError on failing? Or would that be a separate PR?
There was a problem hiding this comment.
A separate PR would be better, thanks.
There was a problem hiding this comment.
For this, should I open a new issue? Or just make another PR?
mroeschke
reviewed
Jun 10, 2025
pandas/tseries/holiday.py
Outdated
| @@ -257,6 +260,9 @@ class from pandas.tseries.offsets, default None | |||
| self.observance = observance | |||
| assert days_of_week is None or type(days_of_week) == tuple | |||
| self.days_of_week = days_of_week | |||
| if exclude_dates is not None and type(exclude_dates) != DatetimeIndex: | |||
There was a problem hiding this comment.
Suggested change
| if exclude_dates is not None and type(exclude_dates) != DatetimeIndex: | |
| if not (exclude_dates is None or isinstance(exclude_dates, DatetimeIndex): |
mroeschke
reviewed
Jun 10, 2025
| @@ -257,6 +260,9 @@ class from pandas.tseries.offsets, default None | |||
| self.observance = observance | |||
| assert days_of_week is None or type(days_of_week) == tuple | |||
| self.days_of_week = days_of_week | |||
| if exclude_dates is not None and type(exclude_dates) != DatetimeIndex: | |||
| raise ValueError("exclude_dates must be None or of type DatetimeIndex.") | |||
There was a problem hiding this comment.
Could you add a test that checks this exception?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Holidaydocumentation is missing or hard to find for re-arranged national holidays. #54382 (Replace xxxx with the GitHub issue number)doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.