Added get_relative_delta and get_tzinfo in datetime API
#2310
Conversation
This file contains 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
ramonski
requested changes
May 16, 2023
src/senaite/core/api/dtime.py
Outdated
| def get_relative_delta(from_dtime, to_dtime=None): | ||
| """Returns the relative delta between two datetimes. If to_dtime is None, | ||
| compares current datetime with from_dtime | ||
| """ |
There was a problem hiding this comment.
Would you mind to provide the docstrings in API functions in the same way we did for the to_localized_time, e.g.:
def get_relative_delta(from_dtime, to_dtime=None):
"""Calculate the relative delta between two dates
If `to_dtime` is None, the current datetime is used.
:param from_dtime:
:type from_dtime: str/datetime/DateTime
:param to_dtime:
:type to_dtime: str/datetime/DateTime
:returns: relativedelta object, e.g. `relativedelta(hours=+3)`
:rtype: object
"""
src/senaite/core/api/dtime.py
Outdated
| from_dtime = to_dt(from_dtime) | ||
| to_dtime = to_dt(to_dtime) | ||
| if not all([from_dtime, to_dtime]): | ||
| return None |
There was a problem hiding this comment.
Better raise an Exception if the parameters can not be converted to valid dates.
src/senaite/core/api/dtime.py
Outdated
| try: | ||
| return pytz.timezone(get_timezone(dt)) | ||
| except pytz.UnknownTimeZoneError: | ||
| return default |
There was a problem hiding this comment.
Please make this an own API function (outside of this function)
xispa
changed the title
get_relative_delta and get_tzinfo in datetime API
ramonski
approved these changes
May 17, 2023
Is used by some plone.* packages, like |
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.
Description of the issue/feature this PR addresses
This Pull Request adds the function
get_relative_deltain dtime apiCurrent behavior before PR
There is no handy function to get the relative delta between two dates
Desired behavior after PR is merged
There is a handy function to get the relative delta between two dates
--
I confirm I have tested this PR thoroughly and coded it according to PEP8
and Plone's Python styleguide standards.