Module « flask.cli »

Classe « FlaskGroup »

Informations générales

Héritage

builtins.object
    BaseCommand
        Command
            MultiCommand
                Group
                    AppGroup
                        FlaskGroup

Définition

class FlaskGroup(AppGroup):

Description _{[extrait de FlaskGroup.__doc__]}

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 based on the active
        environment

    .. 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=True, create_app=None, add_version_option=True, load_dotenv=True, set_debug_flag=True, **extra)

Liste des opérateurs

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

__eq__, __ge__, __gt__, __le__, __lt__, __ne__

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, parse_args, resolve_command, result_callback, resultcallback, 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

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

__call__, __repr__, make_context

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

__delattr__, __dir__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__