Skip to content

Implement HolidayBase::get_closest_holiday functionality #2211

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
Merged
merged 10 commits into from
Feb 11, 2025
Merged

Implement HolidayBase::get_closest_holiday functionality #2211

merged 10 commits into from
Feb 11, 2025

Conversation

@Rosi2143
Copy link
Contributor

@Rosi2143 Rosi2143 commented Jan 4, 2025

Proposed change

a new function get_next_holiday is added to retrieve the date of the next known holiday.
Also the name of the holiday is returned.

It is possible to search forward and backward in time.

This should solve #1825

Documentation will be added once the basic changes are approved.

  • New country/market holidays support (thank you!)
  • Supported country/market holidays update (calendar discrepancy fix, localization)
  • Existing code/documentation/test/process quality improvement (best practice, cleanup, refactoring, optimization)
  • Dependency update (version deprecation/pin/upgrade)
  • Bugfix (non-breaking change which fixes an issue)
  • Breaking change (a code change causing existing functionality to break)
  • New feature (new holidays functionality in general)

Checklist

  • I've followed the [contributing guidelines][contributing-guidelines]
  • I've successfully run make check, all checks and tests are green

@github-actions github-actions bot added the test label Jan 4, 2025
@codecov
Copy link

codecov bot commented Jan 4, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (4d07367) to head (000d71e).
Report is 1 commits behind head on dev.

Additional details and impacted files 
@@            Coverage Diff            @@
##               dev     #2211   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          200       200           
  Lines        12215     12230   +15     
  Branches      1737      1741    +4     
=========================================
+ Hits         12215     12230   +15

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@KJhellico
Copy link
Collaborator

@Rosi2143, it's good start! But some checks are required. Try to run this:

from holidays.countries.ukraine import UA
ua = UA()
ua.get_next_holiday("1991-01-01", True)
ua.get_next_holiday("2022-03-08")

@Rosi2143
Copy link
Contributor Author

Rosi2143 commented Jan 4, 2025

@KJhellico: Thanks - I didn't know that there is a start/end-date for a calender. But I guess for some countries it makes sense.

Added the checks and the documentation with the latest version.

@Rosi2143 Rosi2143 force-pushed the add_get_next_holiday branch from 053f942 to 562bfa1 Compare January 4, 2025 20:19
@github-actions github-actions bot added the doc label Jan 4, 2025
@Rosi2143 Rosi2143 force-pushed the add_get_next_holiday branch from 562bfa1 to c91e03e Compare January 4, 2025 21:07
KJhellico
KJhellico reviewed Jan 7, 2025
View reviewed changes
Copy link
Collaborator

@KJhellico KJhellico left a comment

Choose a reason for hiding this comment

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

@Rosi2143, , well done! Please take a look at a few suggestions.

@Rosi2143 Rosi2143 force-pushed the add_get_next_holiday branch from b353dde to a5554fb Compare January 9, 2025 20:36
KJhellico
KJhellico reviewed Jan 10, 2025
View reviewed changes
Copy link
Collaborator

@KJhellico KJhellico left a comment

Choose a reason for hiding this comment

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

That's a great speed improvement! 👍

@Rosi2143 Rosi2143 force-pushed the add_get_next_holiday branch from a5554fb to c9cd832 Compare January 10, 2025 20:20
arkid15r
arkid15r reviewed Jan 10, 2025
View reviewed changes
@Rosi2143 Rosi2143 force-pushed the add_get_next_holiday branch from c9cd832 to adf4653 Compare January 10, 2025 21:41
@KJhellico
Copy link
Collaborator

Since the holidays in the holidays entity object are not always placed in chronological order, it's necessary to sort them before searching:

>>> from holidays.countries.united_states import US
>>> h = US(years=2024)
>>> h.get_next_holiday("2024-02-01")
(datetime.date(2024, 5, 27), 'Memorial Day')
>>> for d, name in h.items():
>>>     print(d, name)
2024-01-01 New Year's Day
2024-05-27 Memorial Day
2024-06-19 Juneteenth National Independence Day
2024-07-04 Independence Day
2024-09-02 Labor Day
2024-11-11 Veterans Day
2024-11-28 Thanksgiving
2024-12-25 Christmas Day
2024-01-15 Martin Luther King Jr. Day
2024-02-19 Washington's Birthday
2024-10-14 Columbus Day

@Rosi2143 Rosi2143 force-pushed the add_get_next_holiday branch from 8934029 to e56effc Compare January 12, 2025 11:44
@Rosi2143
Copy link
Contributor Author

Thanks for the hint that no sorting is applied to calendars.

That was one of the reasons I choose my initial implementation. I wanted to keep all the corner cases out of this function - at the cost of having a longer runtime.
My guess was that this function will not be called frequently, so a little more execution time would not hurt.

But fixed this now as well.

KJhellico
KJhellico reviewed Jan 12, 2025
View reviewed changes
KJhellico
KJhellico reviewed Jan 13, 2025
View reviewed changes
arkid15r
arkid15r reviewed Jan 15, 2025
View reviewed changes
Copy link
Collaborator

@arkid15r arkid15r left a comment

Choose a reason for hiding this comment

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

Thanks for working on this @Rosi2143
Please consider these comments:

@Rosi2143 Rosi2143 force-pushed the add_get_next_holiday branch from 677ac23 to 6fda9a8 Compare January 16, 2025 16:55
@Rosi2143 Rosi2143 force-pushed the add_get_next_holiday branch from ec129fb to ecb340a Compare January 28, 2025 17:35
KJhellico
KJhellico reviewed Jan 28, 2025
View reviewed changes
Copy link
Collaborator

@KJhellico KJhellico left a comment

Choose a reason for hiding this comment

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

This version LGTM. For Ukraine, we can override this method individually when the time comes.

PPsyrius
PPsyrius previously approved these changes Jan 29, 2025
View reviewed changes
Copy link
Collaborator

@PPsyrius PPsyrius left a comment

Choose a reason for hiding this comment

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

LGTM

@Rosi2143 Rosi2143 force-pushed the add_get_next_holiday branch from 191ec86 to bc9f92e Compare January 31, 2025 14:48
@Rosi2143
Copy link
Contributor Author

Rosi2143 commented Feb 3, 2025

Hi @KJhellico and @arkid15r ,

will you merge this? I have no write access to your branch.

Thanks

@arkid15r
Copy link
Collaborator

arkid15r commented Feb 5, 2025

Hi @KJhellico and @arkid15r ,

will you merge this? I have no write access to your branch.

Thanks

I'll review it this week. Sorry for the delay.

@Rosi2143
add function to get the next holiday
74e45a9 
a new function get_next_holiday is added to retrieve the date
of the next known holiday.
Also the name of the holiday is returned.

It is possible to search forward and backward in time.

This should solve vacanza#1825

Signed-off-by: Schrotti <[email protected]>
@Rosi2143
Change name of function to "get_closest_holiday"
04cb7cb 
add test to check that years without holiday are handled correctly

Signed-off-by: Schrotti <[email protected]>
@Rosi2143
remove added function get_entries_sorted again
7b9b2b4 
Signed-off-by: Schrotti <[email protected]>
@Rosi2143
Fix maintainability warnings
bc39a89 
Signed-off-by: Schrotti <[email protected]>
@Rosi2143 Rosi2143 force-pushed the add_get_next_holiday branch from 8921633 to bc39a89 Compare February 7, 2025 21:41
arkid15r
arkid15r reviewed Feb 10, 2025
View reviewed changes
Copy link
Collaborator

@arkid15r arkid15r left a comment

Choose a reason for hiding this comment

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

Hi @Rosi2143
I've updated the implementation. Please let me know if you have any suggestions/comments.

KJhellico
KJhellico reviewed Feb 10, 2025
View reviewed changes
Copy link
Collaborator

@KJhellico KJhellico left a comment

Choose a reason for hiding this comment

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

LGTM.

@arkid15r arkid15r changed the title add function to get the next holiday Implement HolidayBase::get_closest_holiday functionality Feb 10, 2025
PPsyrius
PPsyrius previously approved these changes Feb 11, 2025
View reviewed changes
Copy link
Collaborator

@PPsyrius PPsyrius left a comment

Choose a reason for hiding this comment

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

LGTM

@sonarqubecloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@arkid15r arkid15r enabled auto-merge February 11, 2025 04:42
@arkid15r arkid15r added this pull request to the merge queue Feb 11, 2025
Merged via the queue into vacanza:dev with commit d55c5b4 Feb 11, 2025
32 checks passed
@Rosi2143 Rosi2143 deleted the add_get_next_holiday branch February 11, 2025 19:39
@Rosi2143
Copy link
Contributor Author

Thanks 😃

@arkid15r
Copy link
Collaborator

Thanks 😃

Sorry I forgot to thank you yesterday after merging this.

@Rosi2143 thanks for your continuous contributions to the code base and for implementing this new functionality for all holidays users 🎉

@KJhellico KJhellico mentioned this pull request Feb 17, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@arkid15r arkid15r arkid15r left review comments

@KJhellico KJhellico KJhellico approved these changes

@PPsyrius PPsyrius PPsyrius approved these changes

Assignees

No one assigned

Labels

doc test

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@Rosi2143 @KJhellico @arkid15r @PPsyrius