Some helpers for python's argparse
Project description
python-argparse-extras
Some helpers for python's argparse.
Currently, this package provides 3 HelpFormatter classes that you can extend and / or use with
python's argparse
module:
Contents
formatter.WideHelpFormatter
HelpFormatter which tries to use a given amount of the terminal width.
The maximum line length is determines by the class attribute percentage_of_line_length
.
This defaults to the full width (1.0). Override this class and set your own percentage.
This uses shutil.get_terminal_size()
to determine the line length.
formatter.ThreeQuarterWidthHelpFormatter
A WideHelpFormatter
subclass with its percentage_of_line_length
set to three quarters of the terminal line length.
formatter.ThreeQuarterWidthDefaultsHelpFormatter
A ThreeQuarterWidthHelpFormatter
subclass which also derives from argparse.ArgumentDefaultsHelpFormatter
. This means that in addition to using 3/4 of the terminal line length, it also prints the argument defaults in the help text.
Installation & Usage
Install the package with your favourite python package manager:
pip install apextras
or directly into your pipenv:
pipenv install apextras
After that, you can use these classes in the same way as any other argparse.HelpFormatter
subclass while creating your argument parser:
from apextras.formatter import WideHelpFormatter
parser = argparse.ArgumentParser(formatter_class=WideHelpFormatter)
parser.add_argument(...)
...
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
Built Distribution
File details
Details for the file apextras-0.9.1.tar.gz
.
File metadata
- Download URL: apextras-0.9.1.tar.gz
- Upload date:
- Size: 2.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.0 requests-toolbelt/0.9.1 tqdm/4.39.0 CPython/3.6.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0dd79bfd010ddd696c4b34050757a0dda4d56227276075573fd75442351e17b2 |
|
MD5 | f750b0d6522e7efde584ee44ce4ec0b5 |
|
BLAKE2b-256 | e0223a8d20045a36f77dc134ad0217ff96377461b7ded0cef30d6258a3b11af4 |
File details
Details for the file apextras-0.9.1-py3-none-any.whl
.
File metadata
- Download URL: apextras-0.9.1-py3-none-any.whl
- Upload date:
- Size: 4.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.0 requests-toolbelt/0.9.1 tqdm/4.39.0 CPython/3.6.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 661817ef3eddba2ea8dc26c1f369cb6aba31e42576cb02c8858a3be7ae17b6c6 |
|
MD5 | 4896b8cdc4bbda29ce06fa69a1b63e7b |
|
BLAKE2b-256 | 560804ff733adc508d493f325bc7071276d1c778358f8b1884e6517b0060febd |