Interface de Linha de Comando do Flask

Introdução

Neste laboratório, você aprenderá como usar a Interface de Linha de Comando (CLI - Command Line Interface) do Flask para gerenciar sua aplicação Flask. A CLI do Flask oferece um conjunto de comandos que podem ajudá-lo a executar o servidor de desenvolvimento, criar comandos personalizados e muito mais.

Nota: Você precisa criar o arquivo de código você mesmo e executá-lo no ambiente. Você pode visualizar o status do serviço Flask na Web 5000.

Instalar Flask

Antes de começar, certifique-se de ter o Flask instalado no seu ambiente Python. Você pode instalar o Flask usando o pip:

pip install flask

Criar uma Aplicação Flask

Crie um novo arquivo Python chamado app.py e adicione o seguinte código para criar uma aplicação Flask básica:

from flask import Flask

app = Flask(__name__)

@app.route('/')
def hello():
    return 'Hello, Flask!'

if __name__ == '__main__':
    app.run()

Salve o arquivo e execute-o usando o seguinte comando no seu terminal:

python app.py

Executar o Servidor de Desenvolvimento

Em vez de executar manualmente a aplicação Flask usando python app.py, você pode usar a CLI (Command Line Interface) do Flask para iniciar o servidor de desenvolvimento. Pare a aplicação atualmente em execução (se houver) e execute o seguinte comando:

flask run

Você deve ver o servidor de desenvolvimento Flask iniciar e exibir a URL onde sua aplicação está rodando (geralmente http://127.0.0.1:5000/). Abra essa URL no seu navegador e você deverá ver a mensagem "Hello, Flask!".

Criar um Comando Personalizado

A CLI (Command Line Interface) do Flask permite que você crie comandos personalizados que podem ser executados a partir da linha de comando. Vamos criar um comando personalizado chamado greet que recebe um nome como argumento e imprime uma mensagem de saudação.

Crie um novo arquivo Python chamado commands.py e adicione o seguinte código:

import click

@click.command()
@click.argument('name')
def greet(name):
    click.echo(f'Hello, {name}!')

if __name__ == '__main__':
    greet()

Salve o arquivo e execute-o usando o seguinte comando:

python commands.py John

Você deverá ver a mensagem "Hello, John!" impressa no terminal.

Registrar Comandos com a Aplicação Flask

Para tornar seus comandos personalizados disponíveis através da CLI (Command Line Interface) do Flask, você precisa registrá-los com sua aplicação Flask. Abra o arquivo app.py e modifique-o da seguinte forma:

from flask import Flask
from commands import greet

app = Flask(__name__)
app.cli.add_command(greet)

@app.route('/')
def hello():
    return 'Hello, Flask!'

if __name__ == '__main__':
    app.run()

Salve o arquivo e reinicie o servidor de desenvolvimento Flask usando o comando flask run. Agora você pode executar seu comando personalizado greet a partir da linha de comando:

flask greet John

Você deverá ver a mensagem "Hello, John!" impressa no terminal.

Resumo

Neste laboratório, você aprendeu como usar a Interface de Linha de Comando (CLI - Command Line Interface) do Flask para gerenciar sua aplicação Flask. Você aprendeu como executar o servidor de desenvolvimento, criar comandos personalizados e registrar comandos com sua aplicação Flask. A CLI do Flask fornece uma maneira conveniente de interagir com sua aplicação Flask a partir da linha de comando, tornando mais fácil gerenciar e testar sua aplicação.