Skip to content

Remove tab hint suppression from do_set #897

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kmvanbrunt merged 2 commits into from
Feb 21, 2020
Merged

Remove tab hint suppression from do_set #897

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e96ee6
Since CompletionError handling has been moved from ArgparseCompleter …
kmvanbrunt Feb 21, 2020
ce87cb4
Removed hyphen from tab-completion
kmvanbrunt Feb 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 7 additions & 10 deletions cmd2/cmd2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ def __init__(self, completekey: str = 'tab', stdin=None, stdout=None, *,
self.default_sort_key = Cmd.ALPHABETICAL_SORT_KEY

############################################################################################################
# The following variables are used by tab-completion functions. They are reset each time complete() is run
# The following variables are used by tab completion functions. They are reset each time complete() is run
# in _reset_completion_defaults() and it is up to completer functions to set them before returning results.
############################################################################################################

Expand All @@ -351,14 +351,14 @@ def __init__(self, completekey: str = 'tab', stdin=None, stdout=None, *,
# will be added if there is an unmatched opening quote
self.allow_closing_quote = True

# An optional header that prints above the tab-completion suggestions
# An optional header that prints above the tab completion suggestions
self.completion_header = ''

# Used by complete() for readline tab completion
self.completion_matches = []

# Use this list if you are completing strings that contain a common delimiter and you only want to
# display the final portion of the matches as the tab-completion suggestions. The full matches
# display the final portion of the matches as the tab completion suggestions. The full matches
# still must be returned from your completer function. For an example, look at path_complete()
# which uses this to show only the basename of paths as the suggestions. delimiter_complete() also
# populates this list.
Expand Down Expand Up @@ -939,7 +939,7 @@ def complete_users() -> List[str]:
# Build display_matches and add a slash to directories
for index, cur_match in enumerate(matches):

# Display only the basename of this path in the tab-completion suggestions
# Display only the basename of this path in the tab completion suggestions
self.display_matches.append(os.path.basename(cur_match))

# Add a separator after directories if the next character isn't already a separator
Expand Down Expand Up @@ -1430,7 +1430,7 @@ def _complete_argparse_command(self, text: str, line: str, begidx: int, endidx:
completer = ArgparseCompleter(argparser, self)
tokens, raw_tokens = self.tokens_for_completion(line, begidx, endidx)

# To have tab-completion parsing match command line parsing behavior,
# To have tab completion parsing match command line parsing behavior,
# use preserve_quotes to determine if we parse the quoted or unquoted tokens.
tokens_to_parse = raw_tokens if preserve_quotes else tokens
return completer.complete_command(tokens_to_parse, text, line, begidx, endidx)
Expand Down Expand Up @@ -2830,7 +2830,7 @@ def complete_set_value(self, text: str, line: str, begidx: int, endidx: int,
settable_parser = DEFAULT_ARGUMENT_PARSER(parents=[Cmd.set_parser_parent])

# Settables with choices list the values of those choices instead of the arg name
# in help text and this shows in tab-completion hints. Set metavar to avoid this.
# in help text and this shows in tab completion hints. Set metavar to avoid this.
arg_name = 'value'
settable_parser.add_argument(arg_name, metavar=arg_name, help=settable.description,
choices=settable.choices,
Expand Down Expand Up @@ -2859,11 +2859,8 @@ def complete_set_value(self, text: str, line: str, begidx: int, endidx: int,

# Create the parser for the set command
set_parser = DEFAULT_ARGUMENT_PARSER(parents=[set_parser_parent])

# Suppress tab-completion hints for this field. The completer method is going to create an
# ArgparseCompleter based on the actual parameter being completed and we only want that hint printing.
set_parser.add_argument('value', nargs=argparse.OPTIONAL, help='new value for settable',
completer_method=complete_set_value, suppress_tab_hint=True)
completer_method=complete_set_value)

# Preserve quotes so users can pass in quoted empty strings and flags (e.g. -h) as the value
@with_argparser(set_parser, preserve_quotes=True)
Expand Down
4 changes: 2 additions & 2 deletions cmd2/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,8 @@ def __init__(self, name: str, val_type: Callable, description: str, *,
:param choices: iterable of accepted values
:param choices_function: function that provides choices for this argument
:param choices_method: cmd2-app method that provides choices for this argument (See note below)
:param completer_function: tab-completion function that provides choices for this argument
:param completer_method: cmd2-app tab-completion method that provides choices
:param completer_function: tab completion function that provides choices for this argument
:param completer_method: cmd2-app tab completion method that provides choices
for this argument (See note below)

Note:
Expand Down