Skip to content

Note workaround for ignoring attributes #170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+87 −36
Open

Note workaround for ignoring attributes #170

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 87 additions & 36 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,16 @@ Running `python square.py --num 2` will print `The square of your number is 4.0.

Tap requires Python 3.10+

To install Tap from PyPI run:
To install Tap from PyPI run:

```
```shell
pip install typed-argument-parser
```

<details>
<summary>To install Tap from source, run the following commands:</summary>

```
```shell
git clone https://github.com/swansonk14/typed-argument-parser.git
cd typed-argument-parser
pip install -e .
Expand All @@ -61,51 +61,69 @@ pip install -e .
<details>
<summary>To develop this package, install development requirements (in a virtual environment):</summary>

```
```shell
python -m pip install -e ".[dev]"
```

Use [`flake8`](https://github.com/PyCQA/flake8) linting.

To run tests, run:

```
```shell
pytest
```

</details>

## Table of Contents

* [Installation](#installation)
* [Table of Contents](#table-of-contents)
* [Tap is Python-native](#tap-is-python-native)
* [Tap features](#tap-features)
+ [Arguments](#arguments)
+ [Tap help](#tap-help)
+ [Configuring arguments](#configuring-arguments)
- [Adding special argument behavior](#adding-special-argument-behavior)
- [Adding subparsers](#adding-subparsers)
+ [Types](#types)
+ [Argument processing](#argument-processing)
+ [Processing known args](#processing-known-args)
+ [Subclassing](#subclassing)
+ [Printing](#printing)
+ [Reproducibility](#reproducibility)
+ [Saving and loading arguments](#saving-and-loading-arguments)
+ [Loading from configuration files](#loading-from-configuration-files)
* [tapify](#tapify)
+ [Examples](#examples)
- [Function](#function)
- [Class](#class)
- [Dataclass](#dataclass)
+ [tapify help](#tapify-help)
+ [Command line vs explicit arguments](#command-line-vs-explicit-arguments)
+ [Known args](#known-args)
* [Convert to a `Tap` class](#convert-to-a-tap-class)
+ [`to_tap_class` examples](#to_tap_class-examples)
- [Simple](#simple)
- [Complex](#complex)
- [Typed Argument Parser (Tap)](#typed-argument-parser-tap)
- [Installation](#installation)
- [Table of Contents](#table-of-contents)
- [Tap is Python-native](#tap-is-python-native)
- [Tap features](#tap-features)
- [Arguments](#arguments)
- [Tap help](#tap-help)
- [Configuring arguments](#configuring-arguments)
- [Adding special argument behavior](#adding-special-argument-behavior)
- [Adding subparsers](#adding-subparsers)
- [Types](#types)
- [`str`, `int`, and `float`](#str-int-and-float)
- [`bool`](#bool)
- [`Optional`](#optional)
- [`List`](#list)
- [`Set`](#set)
- [`Tuple`](#tuple)
- [`Literal`](#literal)
- [`Union`](#union)
- [Complex Types](#complex-types)
- [Ignore Attribute (Workaround)](#ignore-attribute-workaround)
- [Argument processing](#argument-processing)
- [Processing known args](#processing-known-args)
- [Subclassing](#subclassing)
- [Printing](#printing)
- [Reproducibility](#reproducibility)
- [Reproducibility info](#reproducibility-info)
- [Conversion Tap to and from dictionaries](#conversion-tap-to-and-from-dictionaries)
- [Saving and loading arguments](#saving-and-loading-arguments)
- [Save](#save)
- [Load](#load)
- [Load from dict](#load-from-dict)
- [Loading from configuration files](#loading-from-configuration-files)
- [tapify](#tapify)
- [Examples](#examples)
- [Function](#function)
- [Class](#class)
- [Dataclass](#dataclass)
- [Pydantic](#pydantic)
- [tapify help](#tapify-help)
- [Command line vs explicit arguments](#command-line-vs-explicit-arguments)
- [Known args](#known-args)
- [Explicit boolean arguments](#explicit-boolean-arguments)
- [Convert to a `Tap` class](#convert-to-a-tap-class)
- [`to_tap_class` examples](#to_tap_class-examples)
- [Simple](#simple)
- [Complex](#complex)

## Tap is Python-native

Expand Down Expand Up @@ -361,6 +379,39 @@ args = Args().parse_args('--aged_person Tapper,27'.split())
print(f'{args.aged_person.name} is {args.aged_person.age}') # Tapper is 27
```

### Ignore Attribute (Workaround)

Sometimes you may want to define attributes that should not be parsed as command line arguments, but you still want to type them.
This is currently not supported, however there is a workaround as `tap` only looks for annotated or public attributes.
You can exclude attributes and still type them from argument parsing by using type comment annotations instead of regular type hints -
Check if your type-checker supports them. Note you should provide default values for ignored attributes (else you likely get a `NameError`)
and they **must** be private (prefixed with underscore). For example,

```python
from typing import ClassVar
from tap import Tap

class MyTap(Tap):
# Regular arguments (will be parsed)
package: str
stars: int = 5

# Ignored attributes (will not be parsed - must be private)
_internal_counter = 0 # type: int
_class_variable = "DEFAULT" # type: ClassVar[str]

args = MyTap().parse_args(["--help"])
```

```txt
usage: ipython --package PACKAGE [--stars STARS] [-h]

options:
--package PACKAGE (str, required)
--stars STARS (int, default=5)
-h, --help show this help message and exit
```


### Argument processing

Expand Down Expand Up @@ -863,7 +914,7 @@ Running `python person.py --name Jesse --age 1` prints `My name is Jesse.` follo

### Explicit boolean arguments

Tapify supports explicit specification of boolean arguments (see [bool](#bool) for more details). By default, `explicit_bool=False` and it can be set with `tapify(..., explicit_bool=True)`.
Tapify supports explicit specification of boolean arguments (see [bool](#bool) for more details). By default, `explicit_bool=False` and it can be set with `tapify(..., explicit_bool=True)`.

## Convert to a `Tap` class

Expand Down Expand Up @@ -903,7 +954,7 @@ if __name__ == "__main__":

Running `python main.py --package tap` will print `Project instance: package='tap' is_cool=True stars=5`.

### Complex
#### Complex

The general pattern is:

Expand Down