Skip to main content

A `formatter_class` for `argparse` that deals with ANSI colour escapes. Specifically, this formatter does not count escape characters as displayed characters when wrapping `argparse`'s help text into the terminal.

Project description

argparse-color-formatter

A formatter_class for argparse that deals with ANSI colour escapes. Specifically, this formatter does not count escape characters as displayed characters when wrapping argparse's help text into the terminal.

That script's help text is so cool...

PYPI

Tests Coverage

Tests Coverage

Tests Coverage

Tests Coverage

Tests Coverage

Tests Coverage

Flake8

Install

$ pip install argparse-color-formatter

Usage

Pass in argparse_color_formatter.ColorHelpFormatter to a new argument parser as formatter_class

import argparse
from argparse_color_formatter import ColorHelpFormatter

parser = argparse.ArgumentParser(
    formatter_class=ColorHelpFormatter
)

Development

Setup

pipenv install --dev
pre-commit install
pre-commit install --hook-type commit-msg

Build

pipenv run build

Test

pipenv run test

After & Before

ANSI colour escapes using this library's new ColorHelpFormatter: after screenshot

ANSI colour escapes using the default HelpFormatter: before screenshot

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

argparse_color_formatter-2.0.0.post1-py2.py3-none-any.whl (8.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file argparse_color_formatter-2.0.0.post1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for argparse_color_formatter-2.0.0.post1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c7b0f94d8fe04deb3935f82eb58ba0f5b4c5254dbd8d4bca35cb9b39819e0374
MD5 41d7e7a6b3513abad968a53200648739
BLAKE2b-256 87fc1212fade6e562b903de597bc2f3e705cb4907c2f65cc5465c22ce7223c21

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page