Cramnurbel

Cette page est en lecture seule. Vous pouvez afficher le texte source, mais ne pourrez pas le modifier. Contactez votre administrateur si vous pensez qu'il s'agit d'une erreur.

====== Commandes personnalisées ======

Doc: [[https://flask.palletsprojects.com/en/2.2.x/cli/#custom-commands]]

Commande définie au niveau de l'application :

<code python>
import click
from flask import Flask

app = Flask(__name__)

@app.cli.command("create-user")
@click.argument("name")
def create_user(name):
    ...

</code>

Commande définie au niveau d'un Blueprint :

<code python>
import click
from flask import Blueprint

articles = Blueprint("articles", __name__)

...

@articles.cli.command("import")
@click.argument("filepath")
def import_from_file(filepath):
    ...

</code>

Selon qu'elle est définie au niveau de l'application ou d'un Blueprint,
la commande s'appelle de la façon suivante :

<code bash>
$ flask <commande> <arguments...>
$ flask <blueprint> <commande> <arguments...>
</code>

Exemple d'appel des commandes définies ci-dessus :

<code bash>
$ flask create-user albert
$ flask articles import /home/albert/fichier.txt
</code>

===== Liste des commandes personnalisées =====

Taper ''flask'' en ligne de commande affiche les commandes disponibles,
aussi bien celles de Flask que les commandes custom :

<code bash>
$ flask

...

Commands:
  db        Perform database migrations.
  articles                  <<< blueprint "articles" défini ci-dessus
  routes    Show the routes for the app.
  run       Run a development server.
  shell     Run a shell in the app context.
</code>

Taper ''flask articles'' affiche les différentes commandes disponibles
dans le blueprint "articles" :

<code bash>
$ flask articles

...

Commands:
  import  <description optionnelle>
</code>

Pour mettre une description il suffit de l'écrire en documentation de
la fonction correspondante. Exemple :

<code python>
@articles.cli.command("import")
@click.argument("filepath")
def import_from_file(filepath):
    """ Importe les articles depuis un fichier """
    ...
</code>

Cramnurbel

Outils pour utilisateurs

Outils du site

Outils de la page