Python Fire est une bibliothèque permettant de générer automatiquement des interfaces de ligne de commande (CLI) à partir d'absolument n'importe quel objet Python.
Pour installer Python Fire avec pip, exécutez : pip install fire
Pour installer Python Fire avec conda, exécutez : conda install fire -c conda-forge
Pour installer Python Fire à partir des sources, clonez d'abord le référentiel, puis exécutez : python setup.py install
Vous pouvez appeler Fire
sur n'importe quel objet Python :
fonctions, classes, modules, objets, dictionnaires, listes, tuples, etc. Ils fonctionnent tous !
Voici un exemple d'appel de Fire sur une fonction.
import fire
def hello ( name = "World" ):
return "Hello %s!" % name
if __name__ == '__main__' :
fire . Fire ( hello )
Ensuite, depuis la ligne de commande, vous pouvez exécuter :
python hello.py # Hello World!
python hello.py --name=David # Hello David!
python hello.py --help # Shows usage information.
Voici un exemple d'appel de Fire sur une classe.
import fire
class Calculator ( object ):
"""A simple calculator class."""
def double ( self , number ):
return 2 * number
if __name__ == '__main__' :
fire . Fire ( Calculator )
Ensuite, depuis la ligne de commande, vous pouvez exécuter :
python calculator.py double 10 # 20
python calculator.py double --number=15 # 30
Pour savoir comment Fire se comporte sur les fonctions, les objets, les dictionnaires, les listes, etc., et pour en savoir plus sur les autres fonctionnalités de Fire, consultez la page Utilisation d'une CLI Fire.
Pour des exemples supplémentaires, consultez le Guide Python Fire.
Lorsque vous appelez Fire
, il déclenche (exécute) votre commande.
Veuillez consulter le guide Python Fire.
Installation | Commande | Remarques |
---|---|---|
installer | pip install fire |
Création d'une CLI | Commande | Remarques |
---|---|---|
importer | import fire | |
Appel | fire.Fire() | Transforme le module actuel en Fire CLI. |
Appel | fire.Fire(component) | Transforme component en Fire CLI. |
Utiliser une CLI | Commande | Remarques |
---|---|---|
Aide | command --help ou command -- --help | |
REPL | command -- --interactive | Passe en mode interactif. |
Séparateur | command -- --separator=X | Définit le séparateur sur X . Le séparateur par défaut est - . |
Achèvement | command -- --completion [shell] | Génère un script d'achèvement pour la CLI. |
Tracer | command -- --trace | Obtient une trace Fire pour la commande. |
Verbeux | command -- --verbose |
Notez que ces drapeaux sont séparés de la commande Fire par un --
.
Sous licence Apache 2.0.
Ce n'est pas un produit Google officiel.