Write type-safe and elegant CLIs with a clear separation of concerns.
Project description
typed-argparse
💡 write type-safe and elegant CLIs with a clear separation of concerns.
Features
- Argument parsing based on type annotation (including runtime validation).
- Support for many common types.
- Clear separation of concern between argument parsing and business logic.
- Support for super-low-latency shell auto-completions.
- Great for writing sub-command CLIs.
- Very lightweight.
- No dependencies.
- Fully typed itself, no extra type stubs required.
- Offers both a high-level and a low-level API.
The high-level API generally requires less code to write, is fully based on type annotations, and is the preferred way for writing new CLIs.
The low-level API is mainly a low-effort migration path for incorporating type-safety into existing CLIs based on
argparse
.
Install
$ pip install typed-argparse
The only requirement is a modern Python (3.6+).
Basic Usage
import typed_argparse as tap
# 1. Argument definition
class Args(tap.TypedArgs):
my_arg: str = tap.arg(help="some help")
number_a: int = tap.arg(default=42, help="some help")
number_b: Optional[int] = tap.arg(help="some help")
verbose: bool = tap.arg(help="some help")
names: List[str] = tap.arg(help="some help")
# 2. Business logic
def runner(args: Args):
print(f"Running my app with args:\n{args}")
# 3. Bind argument definition + business logic & run
def main() -> None:
tap.Parser(Args).bind(runner).run()
Documentation
See full documentation.
Changes
See change log.
License
This project is licensed under the terms of the MIT license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
typed-argparse-0.2.8.tar.gz
(18.3 kB
view hashes)
Built Distribution
Close
Hashes for typed_argparse-0.2.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 36609589555b810096df4f22d73ac348e50fff73f6d0d7a6c187b6adbfeedf10 |
|
MD5 | 1e69e3579491d707a2769197dc6a3f67 |
|
BLAKE2b-256 | 9405f605483c424ace452eb75e3ebc4cc377fa17057601b42c468c796e8f939a |