Comments (2)
Semantically None
is used to communicate the absence of a specified value in typer. So you can't as far as I can tell set it explicitly or enable functionality to allow it.
My proposal is that you either use a special value (for example -1
or 0
) to indicate the limit, or to create a special --disable-limit
flag, like so:
from typing import Optional
import typer
def main1(
limit: Optional[int] = typer.Option(11, help="A limit value of 0 disables the limit.")
):
if limit > 0:
print(limit)
else:
print("unlimited")
def main2(
limit: Optional[int] = 11,
disable_limit: bool = typer.Option(False, "--disable-limit")
):
if disable_limit:
limit = None
print(limit)
if __name__ == "__main__":
typer.run(main1)
from typer.
Update here: with custom parsers, you should be able to implement this as of typer 0.8.0!
from typing import Optional
import typer
def int_or_none(raw: str) -> Optional[int]:
return None if raw == 'None' else int(raw)
def main(
limit: Optional[int] = typer.Option(11, parser=int_or_none),
):
print(limit)
if __name__ == "__main__":
typer.run(main)
Usage:
$ /usr/bin/python3 main.py
11
$ /usr/bin/python3 main.py --limit None
None
$ /usr/bin/python3 main.py --limit 3
3
The name of the parser is even displayed in the help string:
$ /usr/bin/python3 main.py --help
Usage: main.py [OPTIONS]
Options:
--limit INT_OR_NONE [default: 11]
--help Show this message and exit.
You could modify the metavar
or help
field of your Option
for additional clarify.
from typer.
Related Issues (20)
- Documentation is misleading. new `typer.run` behavior HOT 2
- See if rich 13.x is compatible HOT 4
- Using `some_type | None` syntax for type annotations causes error in python 3.11 HOT 12
- unlimited argument for an option with comma spliter HOT 1
- TAB completion is giving local directory files where command is called. HOT 2
- Support for bytes in Options and Arguments HOT 2
- Is it possible to include a Prolog in `--help` HOT 2
- Get the typer output with html format to provide it to termynal HOT 5
- how to use typer on class method __init__ with self argument, got this error: Error: Missing argument 'SELF'. HOT 2
- Support for localization of messages HOT 1
- Auto-completion when application works in 2 modes (GUI, CLI) HOT 1
- DOC: Documentation of passing multiple values in "option" vs "argument" isn't sufficiently explicit HOT 1
- SIGINT from docker is ignored HOT 4
- 🚀 Roadmap HOT 2
- Source distribution of 0.11.0 is missing the `docs_src` folder HOT 1
- 🐛 Upgrading from `typer<0.12.0` to `typer==0.12.0` breaks the install by partially removing the package/module files HOT 4
- Rich markup in generated Markdown docs HOT 1
- Add CI configs to run tests on Windows and MacOS
- Rich markup in Zsh completion help lines
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from typer.