cape.argread: Command-Line Argument Processor

argread: Parse command-line arguments and options

Parse command-line inputs based on one of two methods. The first method counts both “-” and “–” as prefixes for keyword names; this is common among many advanced programs. For example, the two following examples would be treated as equivalent (assuming it is called by some script `myScript.py.

Versions:

  • 2021-11-18 @ddalle: Version 0.1; started

cape.argread.readflags(argv=None)

Parse args where -cj becomes c=True, j=True

Call:
>>> a, kw = readflags(argv=None)
Inputs:
argv: {None} | list[str]

List of args other than sys.argv

Outputs:
a: list[str]

List of positional args

kw: dict[str | bool]

Keyword arguments

Versions:

  • 2021-12-01 @ddalle: Version 1.0

cape.argread.readflagstar(argv=None)

Parse args where -cf a becomes c=True, f="a"

Call:
>>> a, kw = readflags(argv=None)
Inputs:
argv: {None} | list[str]

List of args other than sys.argv

Outputs:
a: list[str]

List of positional args

kw: dict[str | bool]

Keyword arguments

Versions:

  • 2021-12-01 @ddalle: Version 1.0

cape.argread.readkeys(argv=None)

Parse args where -cj becomes cj=True

Call:
>>> a, kw = readkeys(argv=None)
Inputs:
argv: {None} | list[str]

List of args other than sys.argv

Outputs:
a: list[str]

List of positional args

kw: dict[str | bool]

Keyword arguments

Versions:

  • 2021-12-01 @ddalle: Version 1.0