DOC: Update start/end parameter for BusinessHour and CustomBusinessHour #49774
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
2 tasks
mroeschke
reviewed
Nov 18, 2022
| @@ -1613,9 +1613,9 @@ cdef class BusinessHour(BusinessMixin): | |||
| Normalize start/end dates to midnight before generating date range. | |||
| weekmask : str, Default 'Mon Tue Wed Thu Fri' | |||
| Weekmask of valid business days, passed to ``numpy.busdaycalendar``. | |||
| start : str, default "09:00" | |||
| start : str, time, or list of str/time, default "09:00" | |||
There was a problem hiding this comment.
Could you add to the Examples section showing this?
gandhis1
force-pushed
the
time
branch
3 times, most recently
from
22c69cf to
4c0ffb9
Compare
gandhis1
commented
Dec 4, 2022
pandas/_libs/tslibs/offsets.pyx
Outdated
| >>> ts + pd.offsets.CustomBusinessHour(end=dt_time(19, 0)) | ||
| Timestamp('2022-08-05 17:00:00') | ||
| >>> ts + pd.offsets.CustomBusinessHour(start=[dt_time(9, 0), "20:00"], | ||
| ... end=["17:00", dt_time(22, 0)]) |
There was a problem hiding this comment.
The docstrings examples apparently get compiled. This is failing. I tried time, but the error seemed to indicate it uses the same imports as the module itself - so I updated to using dt_time, which still didn't work. Based on the following import:
from cpython.datetime cimport (
PyDate_Check,
PyDateTime_Check,
PyDelta_Check,
date,
datetime,
import_datetime,
time as dt_time,
timedelta,
)
I would have expected dt_time to work. What's the right syntax here?
mroeschke
reviewed
Dec 5, 2022
pandas/_libs/tslibs/offsets.pyx
Outdated
| End time of your custom business hour in 24h format. | ||
|
|
||
| Examples | ||
| -------- | ||
| >>> ts = pd.Timestamp(2022, 8, 5, 16) | ||
| >>> ts + pd.offsets.BusinessHour() | ||
| Timestamp('2022-08-08 09:00:00') | ||
| >>> ts + pd.offsets.BusinessHour(start="11:00") | ||
| Timestamp('2022-08-08 11:00:00') | ||
| >>> ts + pd.offsets.BusinessHour(end=dt_time(19, 0)) |
There was a problem hiding this comment.
You'll need to import dt_time before the first usage.
>>> from datetime import time as dt_time
…usinessHour to mention allowed input types of time and list of str/time
…Hour This covers usage of datetime.time start/end values as well as multiple start and end values
mroeschke
approved these changes
Dec 6, 2022
|
Thanks @gandhis1 |
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.
These are all valid usages. Examples from pandas-stubs here:
https://github.com/pandas-dev/pandas-stubs/blob/main/tests/test_timefuncs.py#L601-L639