# nestargs
*nestargs* is a Python library that treats command line arguments as a hierarchical structure. The functionality for interpreting command line arguments is the same as argparse.
[](https://pypi.org/project/nestargs/)
[](https://pypi.org/project/nestargs/)
[](https://github.com/speg03/nestargs/actions/workflows/python-tests.yml)
[](https://codecov.io/gh/speg03/nestargs)
[](https://results.pre-commit.ci/latest/github/speg03/nestargs/main)
## Installation
```
pip install nestargs
```
## Basic usage
When defining command line arguments, use "." as the delimiter. to represent a variable hierarchy. The following code example defines an `n` and `price` variable in the `apple` hierarchy and another separate `n` and `price` variable in the `banana` hierarchy.
```python
import nestargs
parser = nestargs.NestedArgumentParser()
parser.add_argument("--apple.n", type=int)
parser.add_argument("--apple.price", type=float)
parser.add_argument("--banana.n", type=int)
parser.add_argument("--banana.price", type=float)
args = parser.parse_args(
["--apple.n=2", "--apple.price=1.5", "--banana.n=3", "--banana.price=3.5"]
)
# => _NestedNamespace(apple=_NestedNamespace(n=2, price=1.5), banana=_NestedNamespace(n=3, price=3.5))
```
Variables obtained by parsing command line arguments can be referenced by hierarchy.
```python
args.apple
# => _NestedNamespace(n=2, price=1.5)
```
Of course, you can also refer directly to variables lower down in the hierarchy.
```python
args.apple.price
# => 1.5
```
When referring to each level of hierarchy, you can use `vars` to create a dictionary format.
```python
vars(args.apple)
# => {'n': 2, 'price': 1.5}
```
## Use a different delimiter for namespace
The default namespace delimiter is "." but can be any other character. In that case, specify the delimiter in the `NestedArgumentParser` constructor argument.
```python
import nestargs
parser = nestargs.NestedArgumentParser(delimiter="/")
parser.add_argument("--apple/n", type=int)
args = parser.parse_args(["--apple/n=1"])
# => _NestedNamespace(apple=_NestedNamespace(n=1))
```
However, references to variables must be separated by "." delimiter when referring to variables.
```python
args.apple.n
# => 1
```
Raw data
{
"_id": null,
"home_page": "",
"name": "nestargs",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "argparse,arguments,cli,command,interface,line,parser",
"author": "",
"author_email": "Takahiro Yano <speg03@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/45/cd/9252cd4f0ee6ec41842d63fd02b05adddecb2c2d03b79ed4eeb42609cee9/nestargs-1.1.0.tar.gz",
"platform": null,
"description": "# nestargs\n\n*nestargs* is a Python library that treats command line arguments as a hierarchical structure. The functionality for interpreting command line arguments is the same as argparse.\n\n[](https://pypi.org/project/nestargs/)\n[](https://pypi.org/project/nestargs/)\n[](https://github.com/speg03/nestargs/actions/workflows/python-tests.yml)\n[](https://codecov.io/gh/speg03/nestargs)\n[](https://results.pre-commit.ci/latest/github/speg03/nestargs/main)\n\n## Installation\n\n```\npip install nestargs\n```\n\n## Basic usage\n\nWhen defining command line arguments, use \".\" as the delimiter. to represent a variable hierarchy. The following code example defines an `n` and `price` variable in the `apple` hierarchy and another separate `n` and `price` variable in the `banana` hierarchy.\n\n```python\nimport nestargs\n\nparser = nestargs.NestedArgumentParser()\n\nparser.add_argument(\"--apple.n\", type=int)\nparser.add_argument(\"--apple.price\", type=float)\n\nparser.add_argument(\"--banana.n\", type=int)\nparser.add_argument(\"--banana.price\", type=float)\n\nargs = parser.parse_args(\n [\"--apple.n=2\", \"--apple.price=1.5\", \"--banana.n=3\", \"--banana.price=3.5\"]\n)\n# => _NestedNamespace(apple=_NestedNamespace(n=2, price=1.5), banana=_NestedNamespace(n=3, price=3.5))\n```\n\nVariables obtained by parsing command line arguments can be referenced by hierarchy.\n\n```python\nargs.apple\n# => _NestedNamespace(n=2, price=1.5)\n```\n\nOf course, you can also refer directly to variables lower down in the hierarchy.\n\n```python\nargs.apple.price\n# => 1.5\n```\n\nWhen referring to each level of hierarchy, you can use `vars` to create a dictionary format.\n\n```python\nvars(args.apple)\n# => {'n': 2, 'price': 1.5}\n```\n\n## Use a different delimiter for namespace\n\nThe default namespace delimiter is \".\" but can be any other character. In that case, specify the delimiter in the `NestedArgumentParser` constructor argument.\n\n```python\nimport nestargs\n\nparser = nestargs.NestedArgumentParser(delimiter=\"/\")\nparser.add_argument(\"--apple/n\", type=int)\n\nargs = parser.parse_args([\"--apple/n=1\"])\n# => _NestedNamespace(apple=_NestedNamespace(n=1))\n```\n\nHowever, references to variables must be separated by \".\" delimiter when referring to variables.\n\n```python\nargs.apple.n\n# => 1\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "Nested arguments parser",
"version": "1.1.0",
"project_urls": {
"Repository": "https://github.com/speg03/nestargs"
},
"split_keywords": [
"argparse",
"arguments",
"cli",
"command",
"interface",
"line",
"parser"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "12cb59926db20b93833d0de3b0420e152ce92aa8b600b3b2f58b60f0e92e9af2",
"md5": "ad4945a4f66d25036b09f1b9613981ca",
"sha256": "7861120093aea429b7a400a7b683f423210651a4fe5c67eb18a766d9d84a9317"
},
"downloads": -1,
"filename": "nestargs-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ad4945a4f66d25036b09f1b9613981ca",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 4190,
"upload_time": "2023-11-17T16:28:35",
"upload_time_iso_8601": "2023-11-17T16:28:35.734401Z",
"url": "https://files.pythonhosted.org/packages/12/cb/59926db20b93833d0de3b0420e152ce92aa8b600b3b2f58b60f0e92e9af2/nestargs-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "45cd9252cd4f0ee6ec41842d63fd02b05adddecb2c2d03b79ed4eeb42609cee9",
"md5": "31b63bab1e4cab96ce3a394a4b09418e",
"sha256": "fa04ece9d36c7156566fb6d97f00bf108c5ea1b045d8b5ef26c43a5b48333720"
},
"downloads": -1,
"filename": "nestargs-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "31b63bab1e4cab96ce3a394a4b09418e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6063,
"upload_time": "2023-11-17T16:28:36",
"upload_time_iso_8601": "2023-11-17T16:28:36.933231Z",
"url": "https://files.pythonhosted.org/packages/45/cd/9252cd4f0ee6ec41842d63fd02b05adddecb2c2d03b79ed4eeb42609cee9/nestargs-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-17 16:28:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "speg03",
"github_project": "nestargs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nestargs"
}
JSON
