Method _validate_table_data

cmd2/argparse_completer.py:574–601

Verify the integrity of completion table data. :raises ValueError: if there is an error with the data.

(arg_state: _ArgumentState, completions: Completions)

    @staticmethod
    def _validate_table_data(arg_state: _ArgumentState, completions: Completions) -> None:
        """Verify the integrity of completion table data.

        :raises ValueError: if there is an error with the data.
        """
        table_columns = arg_state.action.get_table_columns()  # type: ignore[attr-defined]
        has_table_data = any(item.table_data for item in completions)

        if table_columns is None:
            if has_table_data:
                raise ValueError(
                    f"Argument '{arg_state.action.dest}' has CompletionItems with table_data, "
                    f"but no table_columns were defined in add_argument()."
                )
            return

        # If columns are defined, then every item must have data, and lengths must match
        for item in completions:
            if not item.table_data:
                raise ValueError(
                    f"Argument '{arg_state.action.dest}' has table_columns defined, "
                    f"but the CompletionItem for '{item.text}' is missing table_data."
                )
            if len(item.table_data) != len(table_columns):
                raise ValueError(
                    f"Argument '{arg_state.action.dest}': table_data length ({len(item.table_data)}) "
                    f"does not match table_columns length ({len(table_columns)}) for item '{item.text}'."
                )

    def _build_completion_table(self, arg_state: _ArgumentState, completions: Completions) -> Completions:
        """Build a rich.Table for completion results if applicable."""