Add utilities to deal with time and duration #103
Merged
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
Signed-off-by: Michel Hidalgo <[email protected]>
mhidalgo-bdai
requested review from
jbarry-bdai and
amessing-bdai
as code owners
khughes-bdai
approved these changes
Jun 10, 2024
Signed-off-by: Michel Hidalgo <[email protected]>
robodreamer
reviewed
Jun 10, 2024
| def as_proper_duration(duration: Union[int, float, timedelta, Duration]) -> Duration: | ||
| """Return `duration` as a proper Duration object. | ||
|
|
||
| Note that for scalar durations the convention is that floating point durations |
There was a problem hiding this comment.
Do we want to add a proper docstring with input specification including units?
There was a problem hiding this comment.
Hmm, I'm not exactly sure what you mean by input specification.
There was a problem hiding this comment.
I meant, something like the following:
Suggested change
| Note that for scalar durations the convention is that floating point durations | |
| """ | |
| Convert various duration inputs into a standardized Duration object. | |
| Parameters: | |
| duration (Union[int, float, timedelta, Duration]): The duration to be converted. | |
| - If an int is provided, it is assumed to be the duration in seconds. | |
| - If a float is provided, it is assumed to be the duration in seconds. | |
| - If a timedelta is provided, it is converted to the appropriate Duration object. | |
| - If a Duration object is provided, it is returned as is. | |
| Returns: | |
| Duration: A standardized Duration object representing the input duration. | |
| Raises: | |
| ValueError: If the input duration is not of a supported type. | |
| Example: | |
| >>> as_proper_duration(3600) | |
| <Duration: 3600 seconds> | |
| >>> as_proper_duration(2.5) | |
| <Duration: 2.5 seconds> | |
| >>> as_proper_duration(timedelta(hours=1)) | |
| <Duration: 3600 seconds> | |
| >>> as_proper_duration(Duration(3600)) | |
| <Duration: 3600 seconds> | |
| """ |
There was a problem hiding this comment.
Ha! The first example is wrong. Katie's right. The current behavior is going to be confusing. I'll standardize to SI units and include this docstring.
There was a problem hiding this comment.
See c3262c8. I purposely opted out from duplicating type annotations in docstrings.
robodreamer
approved these changes
Jun 10, 2024
Signed-off-by: Michel Hidalgo <[email protected]>
|
It looks like #96 wasn't enough. The log forwarding test keeps flaking -.- |
amessing-bdai
approved these changes
Jun 12, 2024
robodreamer
approved these changes
Jun 12, 2024
|
Success! |
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.
Precisely what the title says. Use of Time and Duration representations in Python,
rclpy,rosbag2, and our own codebase is not particularly homogeneous. This patch introduces minimal conventions to simplify API implementation.