Method _complete_flags

cmd2/argparse_completer.py:529–571

Completion routine for a parsers unused flags.

(self, text: str, line: str, begidx: int, endidx: int, used_flags: set[str])

        return Completions()

    def _complete_flags(self, text: str, line: str, begidx: int, endidx: int, used_flags: set[str]) -> Completions:
        """Completion routine for a parsers unused flags."""
        # Build a list of flags that can be completed
        match_against: list[str] = []

        for flag in self._flags:
            # Make sure this flag hasn't already been used
            if flag not in used_flags:
                # Make sure this flag isn't considered hidden
                action = self._flag_to_action[flag]
                if action.help != argparse.SUPPRESS:
                    match_against.append(flag)

        # Build a dictionary linking actions with their matched flag names
        matched_actions: dict[argparse.Action, list[str]] = {}

        # Keep flags sorted in the order provided by argparse so our completion
        # suggestions display the same as argparse help text.
        matched_flags = self._cmd2_app.basic_complete(text, line, begidx, endidx, match_against, sort=False)

        for flag in matched_flags.to_strings():
            action = self._flag_to_action[flag]
            matched_actions.setdefault(action, []).append(flag)

        # For completion suggestions, group matched flags by action
        items: list[CompletionItem] = []
        for action, option_strings in matched_actions.items():
            flag_text = ", ".join(option_strings)

            # Mark optional flags with brackets
            if not action.required:
                flag_text = "[" + flag_text + "]"

            # Use the first option string as the completion result for this action
            items.append(
                CompletionItem(
                    option_strings[0],
                    display=flag_text,
                    display_meta=action.help or "",
                )
            )

        return Completions(items)

    @staticmethod
    def _validate_table_data(arg_state: _ArgumentState, completions: Completions) -> None: