Jay Taylor's notes
back to listing indexgoogle/python-fire
[web search]
Original source (github.com)
Clipped on: 2018-08-17
Skip to content
functions, classes, modules, objects, dictionaries, lists, tuples, etc.
They all work!
Here's an example of calling Fire on a class.
import fire class Calculator(object): """A simple calculator class.""" def double(self, number): return 2 * number if __name__ == '__main__': fire.Fire(Calculator)
Then, from the command line, you can run:
python calculator.py double 10 # 20 python calculator.py double --number=15 # 30
To learn how Fire behaves on functions, objects, dicts, lists, etc, and to learn about Fire's other features, see the Using a Fire CLI page.
For additional examples, see The Python Fire Guide.
Why is it called Fire?
When you call Fire, it fires off (executes) your command.
Where can I learn more?
Please see The Python Fire Guide.
Reference
| Setup | Command | Notes |
|---|---|---|
| install | pip install fire |
| Creating a CLI | Command | Notes |
|---|---|---|
| import | import fire |
|
| Call | fire.Fire() |
Turns the current module into a Fire CLI. |
| Call | fire.Fire(component) |
Turns component into a Fire CLI. |
| Using a CLI | Command | Notes |
|---|---|---|
| Help | command -- --help |
|
| REPL | command -- --interactive |
Enters interactive mode. |
| Separator | command -- --separator=X |
This sets the separator to X. The default separator is -. |
| Completion | command -- --completion [shell] |
Generate a completion script for the CLI. |
| Trace | command -- --trace |
Gets a Fire trace for the command. |
| Verbose | command -- --verbose |
Note that flags are separated from the Fire command by an isolated -- arg.
Disclaimer
This is not an official Google product.
Press h to open a hovercard with more details.