Method get_help_string

scenedetect/_cli/config.py:809–831

Get a string to specify for the help text indicating the current command option value, if set, or the default. Arguments: command: A command name or, "global" for global options. option: Command-line option to set within `command`. show_default: A

(self, command: str, option: str, show_default: bool | None = None)

        return value

    def get_help_string(self, command: str, option: str, show_default: bool | None = None) -> str:
        """Get a string to specify for the help text indicating the current command option value,
        if set, or the default.

        Arguments:
            command: A command name or, "global" for global options.
            option: Command-line option to set within `command`.
            show_default: Always show default value. Default is False for flag/bool values,
                True otherwise.
        """
        assert command in CONFIG_MAP and option in CONFIG_MAP[command]
        is_flag = isinstance(CONFIG_MAP[command][option], bool)
        if command in self._config and option in self._config[command]:
            if is_flag:
                value_str = "on" if self._config[command][option] else "off"
            else:
                value_str = str(self._config[command][option])
            return f" [setting: {value_str}]"
        if show_default is False or (
            show_default is None and is_flag and CONFIG_MAP[command][option] is False
        ):
            return ""
        return f" [default: {CONFIG_MAP[command][option]!s}]"