moved out from main project

Author: dzerrenner

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "python.linting.flake8Enabled": true,
+    "python.linting.pylintEnabled": false,
+    "python.linting.enabled": true,
+    "python.pythonPath": "/home/dazer/.local/share/virtualenvs/python-argparse-extras-1dpB_DZQ/bin/python"
+}

Pipfile

@@ -0,0 +1,18 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+flake8 = "*"
+black = "*"
+setuptools = "*"
+wheel = "*"
+
+[packages]
+
+[requires]
+python_version = "3.6"
+
+[pipenv]
+allow_prereleases = true

Pipfile.lock

@@ -1,2 +1,33 @@
 # python-argparse-extras
-Some helpers for python's argparse
+
+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
+
+### `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.
+
+### `ThreeQuarterWidthHelpFormatter`
+
+A `WideHelpFormatter` subclass with its `percentage_of_line_length` set to three quarters of the terminal line length.
+
+### `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.
+
+## Usage
+
+Use these classes in the same way as any other `argparse.HelpFormatter` subclass while creating your argument parser:
+
+    parser = argparse.ArgumentParser(formatter_class=<HelpFormatter>)
+    parser.add_argument(...)
+    ...

README.md

@@ -0,0 +1,17 @@
+import argparse
+from .wide import WideHelpFormatter
+
+
+class ThreeQuarterWidthHelpFormatter(WideHelpFormatter):
+    percentage_of_line_length = 0.75
+
+
+class ThreeQuarterWidthDefaultsHelpFormatter(ThreeQuarterWidthHelpFormatter, argparse.ArgumentDefaultsHelpFormatter):
+    pass
+
+
+__all__ = (
+    WideHelpFormatter, 
+    ThreeQuarterWidthHelpFormatter, 
+    ThreeQuarterWidthDefaultsHelpFormatter
+)

apextras/__init__.py

@@ -0,0 +1,52 @@
+import argparse
+import shutil
+
+
+class WideHelpFormatter(argparse.HelpFormatter):
+    """
+    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.
+
+    Add more formatting features by adding more superclasses to your formatter:
+
+    >>> import argparse
+    >>> class ThreeQuarterWidthDefaultsHelpFormatter(WideDefaulsHelpFormatter, argparse.ArgumentDefaultsHelpFormatter):
+    ...     percentage_of_line_length = 0.75
+    >>> parser = argparse.ArgumentParser(formatter_class=ThreeQuarterWidthDefaultsHelpFormatter)
+    >>> arg = parser.add_argument(
+    ...     "-l", "-long_help",
+    ...     help="This is a really long help message but should be displayed in one line."
+    ... )
+    >>> parser.parse_args(["-h"])  # doctest: +IGNORE_EXCEPTION_DETAIL
+    Traceback (most recent call last):
+        ...
+    SystemExit: 0
+    usage: [-h] [-l L]
+
+    optional arguments:
+    -h, --help          show this help message and exit
+    -l L, -long_help L  This is a really long help message but should be displayed in one line. (default: None)
+
+    This is an example if the line length exceeds the maximum of 100%:
+    >>> import argparse
+    >>> class TooWideHelpFormatter(WideDefaulsHelpFormatter):
+    ...     percentage_of_line_length = 1.5
+    >>> parser = argparse.ArgumentParser(formatter_class=TooWideHelpFormatter)  # doctest: +IGNORE_EXCEPTION_DETAIL
+    Traceback (most recent call last):
+        ...
+    ValueError: ValueError: Line length percentage can't exceed 1.0 (full width; actual value: 1.5)
+    """
+
+    percentage_of_line_length = 1.0
+
+    def __init__(self, *args, **kwargs):
+        if self.percentage_of_line_length > 1.0:
+            raise ValueError(
+                f"Line length percentage can't exceed 1.0 (full width; actual value: {self.percentage_of_line_length})"
+            )
+        max_columns = int(shutil.get_terminal_size().columns * self.percentage_of_line_length)
+        super().__init__(max_help_position=min(60, int(max_columns / 3)), width=max_columns, *args, **kwargs)

apextras/formatter/__init__.py

@@ -0,0 +1,22 @@
+import setuptools
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name="apextras", 
+    version="0.9.0",
+    author="David Zerrenner",
+    author_email="dazer017@gmail.com",
+    description="Some helpers for python's argparse",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/pypyr-scheduler/python-argparse-extras",
+    packages=setuptools.find_packages(),
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires='>=3.6',
+)