formatter: add new JobsFormatter class, restructure view-job-records to use new class
#563
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: The formatter module in flux-accounting does not have a class for formatting the output of job records which would be useful because the flux-accounting Python bindings manually define the formatting of these job records within its bindings. Create a new class called JobsFormatter which takes a list of job records for formatting. Add a method called as_columns() which will create column-separated output of job records to be returned while supporting custom formatting (i.e allowing custom formatting of these columns).
Problem: The convert_to_str() function defines its own formatting for job records to be returned with the view-job-records command, but the formatter module in flux-accounting now has its own JobsFormatter class that does this (and also includes custom formatting). Edit the convert_to_str() function to create a JobsFormatter object, initialized with the list of job_records to be returned. Add a --fields optional argument to the view-job-records command to allow the user to specify which fields to include in their output if they so choose.
Problem: The output of the view-job-records command has been slightly adjusted as a result of including custom formatting in its output, but there are a couple of tests throughout the testsuite that are now out-of-date because they look for the old format. Adjust the tests that look for view-job-records output throughout the testsuite to account for the new formatting. Get rid of a expected file in the testsuite in favor of just creating that file within the test itself.
cmoussa1
added
improvement
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.
Problem
The
formattermodule in flux-accounting does not have a class for formatting the output of job records which would be useful because the flux-accounting Python bindings manually define the formatting of these job records within its bindings.This PR creates a new class called
JobsFormatterwhich takes a list of job records for formatting. It adds a method calledas_columns(), which will create column-separated output of job records to be returned while supporting custom formatting (i.e allowing custom formatting of these columns).view-job-recordsis restructured to use the newJobsFormatterclass instead of defining its own print function as well as modified to include a--fieldsoptional argument to the command to allow the user to specify which fields to include in their output if they so choose.Finally, a couple of the
view-job-recordstests are cleaned up to account for the use of the new formatter class.