Атрибут cli_group
Атрибут cli_group применяется к объекту
Blueprint и определяет имя группы, под которой
команды CLI данного blueprint будут отображаться
в интерфейсе flask. По умолчанию атрибут
равен None, и команды регистрируются
в корневой группе. Если задать строку, команды
blueprint группируются под указанным именем.
Если задать False, команды не регистрируются.
Синтаксис
Blueprint(name, import_name, cli_group=None)
Пример
Давайте создадим blueprint с атрибутом
cli_group и зарегистрируем команду CLI:
from flask import Flask, Blueprint
app = Flask(__name__)
bp = Blueprint('bp', __name__, cli_group='mygroup')
@bp.cli.command('hello')
def hello():
print('hello from cli')
app.register_blueprint(bp)
Теперь команда доступна в терминале:
flask mygroup hello
Результат выполнения команды:
"hello from cli"
Пример
Давайте установим cli_group в значение
False, чтобы команды blueprint не регистрировались:
from flask import Flask, Blueprint
app = Flask(__name__)
bp = Blueprint('bp', __name__, cli_group=False)
@bp.cli.command('hello')
def hello():
print('hello from cli')
app.register_blueprint(bp)
При попытке вызвать команду терминал выдаст ошибку:
flask hello
Результат выполнения команды:
"Error: No such command 'hello'."
Смотрите также
-
класс
Blueprint,
который создаёт blueprint приложения -
метод
register,
который регистрирует blueprint в приложении -
атрибут
name,
который задаёт имя blueprint -
атрибут
url_prefix,
который задаёт префикс URL для blueprint
