python: improve handling of !d conversion specifier in output formats
#5169
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
Problem: It is inconvenient that UtilDatetime objects (obtained via the `!d` conversion specifier) are treated differently than the normal datetime conversion (`!D`) when the timestamp is zero. In the first case, the datetime is rendered to the epoch date in whatever format is specified by the user, while in the second case the result is an empty string. Since a zero timestamp is considered "unset", the empty string is much more preferable here. Since the prime use case for UtilDatetime is in output format rendering for utilities, have this class return an empty string by default for zero timestamps, presuming these are unset. Fix one test in t2800-jobs-cmd.t that assumed a 00:00 result.
Problem: The `!d` conversion specifier converts timestamps to UtilDatetime objects which support a `::` separator in order to allow a format after the datetime format specification. However, since the format is applied within the UtilDatetime format() method, the `h` suffix is not supported to replace empty fields with a hyphen. Check for a `h` suffix in the UtilDatetime.format() method and replace an empty string with `-`. Ignore UtilDatetime objects where `h` is normally handled so that the suffix can later be processed in UtilDatetime.format()
Problem: The `!d` conversion specifier returns an empty string if
no format is provided, which could cause confusion in casual usage.
For example `{expiration!d}` returns an empty string even if there
is an expiration timestamp for a job.
If no format is provided, default to an ISO 8601 format "%FT%T".
Problem: The documentation of `!d` handling in flux-jobs(1) is out of date. Update the documentation to include that `!d` formats to an empty string when unset (is 0.), and that `h` is supported.
Problem: There are no unit tests for the UtilDatetime class, which makes verification of the behavior of this class difficult. Add a small set of unit tests to t/python/t0024-util.py to ensure basic proper behavior of the various formatting options for UtilDatetime objects.
chu11
approved these changes
May 11, 2023
t/t2800-jobs-cmd.t
Outdated
Comment on lines
940
to
948
| cat expiration.in | \ | ||
| flux jobs --from-stdin -o "{expiration!d:%b%d %R::>20.20h}" \ | ||
| >exp-fmth.out && | ||
| test_debug "cat exp-fmt.out" && | ||
| grep " EXPIRATION" exp-fmt.out && | ||
| grep " $(date --date=@${exp} +%b%d\ %R)" exp-fmt.out | ||
| grep " $(date --date=@${exp} +%b%d\ %R)" exp-fmt.out && | ||
| test_debug "cat exp-fmt.out" && | ||
| grep " EXPIRATION" exp-fmth.out && | ||
| grep " $(date --date=@${exp} +%b%d\ %R)" exp-fmth.out |
There was a problem hiding this comment.
i think we need to add one test for !d without any format being specified {expiration!d}, perhaps in the test above test_expect_success 'flux-jobs --format={expiration!d:%FT%T},{t_remaining!H} works' '
There was a problem hiding this comment.
Ok, added a separate test for that and force pushed the result.
Problem: t2800-jobs-cmd.t does not test a couple use cases of the `!d` format specifier. Ensure `!d` works as expected when the `h` suffix is utilized, and that `!d` works when used without a format.
grondo
force-pushed
the
utildatetime-hyphen
branch
from
5283771
to
c73aa4f
Compare
Codecov Report
@@ Coverage Diff @@
## master #5169 +/- ##
==========================================
- Coverage 83.15% 83.12% -0.03%
==========================================
Files 453 453
Lines 77850 77856 +6
==========================================
- Hits 64733 64720 -13
- Misses 13117 13136 +19
|
|
Since this is approved I'll set MWP. |
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.
This PR fixes a few annoyances when using the
!dconversion specifier in output formats as discussed over in #5055!dconverted timestamp now renders as an empty string for a timestamp of0.0hsuffix can now be used with!dto replace the empty timestamp with a hyphen-!dused without a format returns an empty string, this PR adds a default format so that a ISO 8601 string is returned instead.I've also added a set of unit tests for the affected
UtilDatetimeclass to ensure the above is working.