Декоратор command
Декоратор command применяется к функции и превращает её в команду CLI приложения Flask. Такие команды запускаются через flask и доступны в контексте приложения. Первым параметром передаётся имя команды, которое будет использоваться в терминале.
Если имя не указано, Flask использует имя декорируемой функции, заменяя подчёркивания на дефисы. Дополнительными параметрами можно передать справку help, а также параметры через click, например argument и option.
Синтаксис
@app.cli.command(name, [help])
Пример
Давайте зарегистрируем простую команду hello, которая выводит приветствие:
from flask import Flask
app = Flask(__name__)
@app.cli.command('hello')
def hello():
print('hello')
Результат выполнения команды в терминале:
flask hello
hello
Пример
Давайте зарегистрируем команду user, которая принимает аргумент name и выводит его:
from flask import Flask
import click
app = Flask(__name__)
@app.cli.command('user')
@click.argument('name')
def user(name):
print(name)
Результат выполнения команды с аргументом abcde:
flask user abcde
abcde
Смотрите также
-
команду
flask run,
которая запускает сервер разработки -
команду
flask shell,
которая открывает интерактивную оболочку -
декоратор
group,
который объединяет команды в группы -
декоратор
with_appcontext,
который выполняет команду в контексте приложения
