feat: Added result commands #30
Conversation
☂️ Python Coverage
Overall Coverage
New FilesNo new covered files... Modified FilesNo covered modified files...
|
AncientPatata
force-pushed
the
ad/add_results_commands
branch
5 times, most recently
from
0311513 to
42e76b0
Compare
AncientPatata
force-pushed
the
ad/add_results_commands
branch
from
42e76b0 to
a550aed
Compare
|
|
||
|
|
||
| @results.command(name="list") | ||
| @click.argument("session-id", required=True, type=str) |
There was a problem hiding this comment.
Remove this argument. The user is free to list results as needed. The filters are here for that!
This change must also be applied on task list command.
| "-f", | ||
| "--filter", | ||
| "filter_with", | ||
| type=FilterParam("Partition"), |
There was a problem hiding this comment.
Small typo that should be “Result”.
src/armonik_cli/commands/results.py
Outdated
| metavar="FILTER EXPR", | ||
| ) | ||
| @click.option( | ||
| "--sort-by", type=FieldParam("Task"), required=False, help="Attribute of task to sort with." |
| results_list = [] | ||
| while True: | ||
| total, results = results_client.list_results( | ||
| result_filter=(Result.session_id == session_id) & filter_with |
There was a problem hiding this comment.
here just put the filter and ignore the session_id!
| "-r", | ||
| "--result", | ||
| "results", | ||
| type=ResultParam(), |
There was a problem hiding this comment.
Use a more explicit name like ResultNameDataParam.
| raise click.FileError( | ||
| str(result_data_filepath), | ||
| f"File {str(result_data_filepath)} not found for result {res[0]}", | ||
| ) |
There was a problem hiding this comment.
This should be done in the ResultParam.
| @click.option( | ||
| "-r", | ||
| "--result", | ||
| "results", |
| ) | ||
|
|
||
| # Enforce that at least one mutual option is provided | ||
| if self.require_one and not (mutex or self.name in opts): |
There was a problem hiding this comment.
if self.require_one and not mutex and self.name not in opts
| # Enforce that at least one mutual option is provided | ||
| if self.require_one and not (mutex or self.name in opts): | ||
| raise click.UsageError( | ||
| f"At least one of the following options must be provided: {', '.join(self.mutual | {self.name})}." |
| @@ -188,3 +189,67 @@ def convert( | |||
| ) | |||
| cls = getattr(common, self.base_struct) | |||
| return getattr(cls, value) | |||
|
|
|||
|
|
|||
| class ResultParam(click.ParamType): | |||
There was a problem hiding this comment.
Rework the implementation using namedtuples. The conversion should return a list of namedtuples with values for name and data.
Motivation
The current version of the CLI doesn't have result-specific commands.
Description
Added commands for :
Along with a parameter type for parsing result inputs.
Testing
Unit testing for different failing scenarios, serialization and commandline argument parsing.
Impact
Not applicable.
Additional Information
None.
Checklist