Skip to main content

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for apextras, version 0.9.1
Filename, size File type Python version Upload date Hashes
Filename, size apextras-0.9.1-py3-none-any.whl (4.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size apextras-0.9.1.tar.gz (2.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page