jnoortheen / arger

Create argparser automatically from py3.6+ annotations :snake:.

Hi there 👋, I am Noortheen

• 💼 I am a freelancer, developing web and desktop apps.
• ⚡ I contribute back to the open source community as much as possible, especially the things I use regularly.
• 📫 Contact:
  • 🏢 LinkedIn

arger's Issues

Possible support for Literals

Hi, thanks for this very nice library. It looks very good.

I have a suggestion. Would it be possible to support Literals: https://docs.python.org/3/library/typing.html#typing.Literal

Right now, we can use Enum to denote choices, which is good. But we can also use the new Literal typing to denote choices, which can be very convenient.

Handling docstrings when using Argument class

Say, I want to create a countable argument like this

Verbosity = Argument(type=int, action='count', default=0)

@Arger.init(prog='parse')
def arger(verbosity: int = Verbosity, config_path: Path = DEFAULT_CONFIG_PATH):
    """My Parser.

    Args:
        verbosity: Counted argument, use -v for info and -vv for debug.
        config_path: Path to config file.
    """

The help string for verboisty shows this

  -v VERBOSITY, --verbosity VERBOSITY
                        Counted argument, use -v for info and -vv for debug. (default: <Argument: (), {'default': 0, 'type': <class 'int'>, 'action':
                        'count'}>)

Can we modify the default value part of the help string to show as 0 instead of
(default: <Argument: (), {'default': 0, 'type': <class 'int'>, 'action': 'count'}>)

Optional type annotation handled incorrectly

Try to run the example in
https://github.com/jnoortheen/arger/blob/1bb8b4ec7d6f4787d3fcb40f4423a0d2013ab518/docs/examples/3-arger-as-function/src.py

python src.py -o 'log.txt' list

This shows error:

pytest: error: argument -o/--log-file: invalid typing.Union value: 'log.txt'