Classe « FlaskGroup »

Informations générales

Héritage

builtins.object
    BaseCommand
        Command
            MultiCommand
                Group
                    AppGroup
                        FlaskGroup

Définition

class FlaskGroup(AppGroup):

help(FlaskGroup)

Special subclass of the :class:`AppGroup` group that supports
loading more commands from the configured Flask app.  Normally a
developer does not have to interface with this class but there are
some very advanced use cases for which it makes sense to create an
instance of this. see :ref:`custom-scripts`.

:param add_default_commands: if this is True then the default run and
    shell commands will be added.
:param add_version_option: adds the ``--version`` option.
:param create_app: an optional callback that is passed the script info and
    returns the loaded app.
:param load_dotenv: Load the nearest :file:`.env` and :file:`.flaskenv`
    files to set environment variables. Will also change the working
    directory to the directory containing the first file found.
:param set_debug_flag: Set the app's debug flag.

.. versionchanged:: 3.1
    ``-e path`` takes precedence over default ``.env`` and ``.flaskenv`` files.

.. versionchanged:: 2.2
    Added the ``-A/--app``, ``--debug/--no-debug``, ``-e/--env-file`` options.

.. versionchanged:: 2.2
    An app context is pushed when running ``app.cli`` commands, so
    ``@with_appcontext`` is no longer required for those commands.

.. versionchanged:: 1.0
    If installed, python-dotenv will be used to load environment variables
    from :file:`.env` and :file:`.flaskenv` files.

Constructeur(s)

Signature du constructeur	Description
__init__(self, add_default_commands: 'bool' = True, create_app: 't.Callable[..., Flask] \| None' = None, add_version_option: 'bool' = True, load_dotenv: 'bool' = True, set_debug_flag: 'bool' = True, **extra: 't.Any') -> 'None'

Liste des attributs statiques

Nom de l'attribut	Valeur
allow_extra_args	True
allow_interspersed_args	False
command_class	None
group_class	None
ignore_unknown_options	False

Liste des opérateurs

Opérateurs hérités de la classe object

__eq__, __ge__, __gt__, __le__, __lt__, __ne__

Liste des méthodes

Toutes les méthodes Méthodes d'instance Méthodes statiques

Signature de la méthode	Description
get_command(self, ctx: 'click.Context', name: 'str') -> 'click.Command \| None'
list_commands(self, ctx: 'click.Context') -> 'list[str]'
make_context(self, info_name: 'str \| None', args: 'list[str]', parent: 'click.Context \| None' = None, **extra: 't.Any') -> 'click.Context'
parse_args(self, ctx: 'click.Context', args: 'list[str]') -> 'list[str]'

Méthodes héritées de la classe AppGroup

__init_subclass__, __subclasshook__, command, group

Méthodes héritées de la classe Group

__init_subclass__, __subclasshook__, add_command, command, group

Méthodes héritées de la classe MultiCommand

collect_usage_pieces, format_commands, format_options, invoke, resolve_command, result_callback, shell_complete, to_info_dict

Méthodes héritées de la classe Command

format_epilog, format_help, format_help_text, format_usage, get_help, get_help_option, get_help_option_names, get_params, get_short_help_str, get_usage, make_parser