psw/borgmatic
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add more doccomments, drop a check

Browse source
This commit is contained in:
Isaac 2023-05-06 10:46:27 -07:00
parent 469e0ccace
commit 372622fbb1
No known key found for this signature in database
GPG key ID: E69FB5A841448A48
1 changed files with 11 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
borgmatic/commands/completion.py
View file

@ -87,7 +87,13 @@ def has_choice_options(action: Action):
return action.choices is not None return action.choices is not None
def has_required_param_options(action: Action): def has_unknown_required_param_options(action: Action):
'''
A catch-all for options that take a required parameter, but we don't know what the parameter is.
This should be used last. These are actions that take something like a glob, a list of numbers, or a string.
There is no way to know what the valid options are, but we need to prevent another argument from being shown,
and let the user know that they need to provide a parameter.
'''
return ( return (
action.required is True action.required is True
or action.nargs or action.nargs
@ -95,7 +101,6 @@ def has_required_param_options(action: Action):
'+', '+',
'*', '*',
) )
or '--archive' in action.option_strings
or action.metavar in ('PATTERN', 'KEYS', 'N') or action.metavar in ('PATTERN', 'KEYS', 'N')
or (action.type is not None and action.default is None) or (action.type is not None and action.default is None)
) )
@ -103,7 +108,9 @@ def has_required_param_options(action: Action):
def has_exact_options(action: Action): def has_exact_options(action: Action):
return ( return (
has_file_options(action) or has_choice_options(action) or has_required_param_options(action) has_file_options(action)
or has_choice_options(action)
or has_unknown_required_param_options(action)
) )
@ -126,7 +133,7 @@ def exact_options_completion(action: Action):
if has_choice_options(action): if has_choice_options(action):
return f'''\ncomplete -c borgmatic -f -a '{' '.join(map(str, action.choices))}' -n "__borgmatic_last_arg {args}"''' return f'''\ncomplete -c borgmatic -f -a '{' '.join(map(str, action.choices))}' -n "__borgmatic_last_arg {args}"'''
if has_required_param_options(action): if has_unknown_required_param_options(action):
return f'''\ncomplete -c borgmatic -x -n "__borgmatic_last_arg {args}"''' return f'''\ncomplete -c borgmatic -x -n "__borgmatic_last_arg {args}"'''
raise RuntimeError( raise RuntimeError(