Python Fire é uma biblioteca para gerar automaticamente interfaces de linha de comando (CLIs) a partir de absolutamente qualquer objeto Python.
Para instalar Python Fire com pip, execute: pip install fire
Para instalar o Python Fire com conda, execute: conda install fire -c conda-forge
Para instalar o Python Fire a partir do código-fonte, primeiro clone o repositório e depois execute: python setup.py install
Você pode chamar Fire
em qualquer objeto Python:
funções, classes, módulos, objetos, dicionários, listas, tuplas, etc. Todos funcionam!
Aqui está um exemplo de chamada de Fire em uma função.
import fire
def hello ( name = "World" ):
return "Hello %s!" % name
if __name__ == '__main__' :
fire . Fire ( hello )
Então, na linha de comando, você pode executar:
python hello.py # Hello World!
python hello.py --name=David # Hello David!
python hello.py --help # Shows usage information.
Aqui está um exemplo de como chamar Fire em uma classe.
import fire
class Calculator ( object ):
"""A simple calculator class."""
def double ( self , number ):
return 2 * number
if __name__ == '__main__' :
fire . Fire ( Calculator )
Então, na linha de comando, você pode executar:
python calculator.py double 10 # 20
python calculator.py double --number=15 # 30
Para saber como o Fire se comporta em funções, objetos, dictos, listas, etc, e para aprender sobre os outros recursos do Fire, consulte a página Usando uma CLI do Fire.
Para obter exemplos adicionais, consulte The Python Fire Guide.
Quando você chama Fire
, ele dispara (executa) seu comando.
Consulte o Guia do Python Fire.
Configurar | Comando | Notas |
---|---|---|
instalar | pip install fire |
Criando uma CLI | Comando | Notas |
---|---|---|
importar | import fire | |
Chamar | fire.Fire() | Transforma o módulo atual em um Fire CLI. |
Chamar | fire.Fire(component) | Transforma component em um Fire CLI. |
Usando uma CLI | Comando | Notas |
---|---|---|
Ajuda | command --help ou command -- --help | |
REPL | command -- --interactive | Entra no modo interativo. |
Separador | command -- --separator=X | Define o separador como X . O separador padrão é - . |
Conclusão | command -- --completion [shell] | Gera um script de conclusão para a CLI. |
Rastreamento | command -- --trace | Obtém um rastreamento Fire para o comando. |
Verboso | command -- --verbose |
Observe que esses sinalizadores são separados do comando Fire por um isolado --
.
Licenciado sob a licença Apache 2.0.
Este não é um produto oficial do Google.