Метод command

Метод command применяется к экземпляру класса AppGroup и регистрирует функцию как команду интерфейса командной строки Flask. Первым параметром передаётся имя команды, вторым - декорируемая функция. После регистрации команда становится доступна через flask в терминале.

Синтаксис

@group.command(name)

Пример

Давайте создадим приложение Flask и зарегистрируем простую команду hello в группе app.cli:

from flask import Flask

app = Flask(__name__)

@app.cli.command('hello')
def hello_command():
	print('hello')

Запустим команду в терминале:

<+terminal+> flask hello <-terminal+>

Результат выполнения команды:

"hello"

Пример

Давайте зарегистрируем команду с аргументом, который принимает значение из терминала:

from flask import Flask
import click

app = Flask(__name__)

@app.cli.command('greet')
@click.argument('name')
def greet_command(name):
	print(f'hello, {name}')

Запустим команду с аргументом 'user':

<+terminal+> flask greet user <-terminal+>

Результат выполнения команды:

"hello, user"

Смотрите также

метод group,
который создаёт вложенную группу команд
класс AppGroup,
который представляет группу команд приложения
декоратор command,
который регистрирует команду в приложении
метод with_appcontext,
который выполняет команду в контексте приложения