# `importlib-metadata-argparse-version`
[![PyPI][pypi-version-badge-link]][pypi-link]
[![Python versions][pypi-pyversions-badge-link]][pypi-link]
[![License][license-image]][license-link]
[![Tests][tests-image]][tests-link]
[![Coverage status][coverage-image]][coverage-link]
Python's [`argparse`] module action to define CLI version with a delayed
call to [`importlib.metadata.version`] only when `--version` argument
is passed.
## Rationale
When you use `importlib.metadata` for adding the version to a CLI utility,
you need to import `importlib.metadata` and call
`importlib.metadata.version("<your-package>")` at initialization time.
If you only want to execute other parts of the CLI
(eg. like passing the option `--help`), `importlib.metadata` will be
imported too even when is not needed at all.
The problem is easily fixed by this module.
## Usage
```python
import argparse
from importlib_metadata_argparse_version import ImportlibMetadataVersionAction
parser = argparse.ArgumentParser()
parser.add_argument(
"-v", "--version",
action=ImportlibMetadataVersionAction,
version_from="your-package-name",
)
```
This is a rough equivalent to something like:
```python
import argparse
import importlib.metadata
parser = argparse.ArgumentParser()
parser.add_argument(
"-v", "--version",
action="version",
version=importlib_metadata.version("your-package-name"),
)
```
...but with the difference that `importlib.metadata` will only be
imported when you call `--version`, so it is more efficient.
When using `ImportlibMetadataVersionAction` the `version` kwarg
accepts `%(version)s` as a placeholder like `%(prog)s`. So you
can write something like this to display the program name before the
version:
```python
parser.add_argument(
"-v", "--version",
action=ImportlibMetadataVersionAction,
version_from="your-package-name",
version="%(prog)s %(version)s",
)
# or
parser.version = "%(prog)s %(version)s"
parser.add_argument(
"-v", "--version",
action=ImportlibMetadataVersionAction,
version_from="your-package-name",
)
```
And the `version` kwarg becomes optional, being `"%(version)s"`
the default value.
## For convenience
If you forget to define the kwarg `version_from`
in the argument, a `ValueError` will be raised at initialization time.
Python's [`argparse`] built-in `"version"` action raises an
`AttributeError` **only when you call your program with `--version`**,
which is unsafe because could lead you to pass the error unnoticed
until you test it when you forget to define the `version` kwarg.
[`argparse`]: https://docs.python.org/3/library/argparse.html
[`importlib.metadata.version`]: https://docs.python.org/3/library/importlib.metadata.html?highlight=importlib%20metadata#distribution-versions
[pypi-link]: https://pypi.org/project/importlib-metadata-argparse-version
[pypi-version-badge-link]: https://img.shields.io/pypi/v/importlib-metadata-argparse-version?logo=pypi&logoColor=white
[pypi-pyversions-badge-link]: https://img.shields.io/pypi/pyversions/importlib-metadata-argparse-version?logo=python&logoColor=white
[license-image]: https://img.shields.io/pypi/l/importlib-metadata-argparse-version?color=light-green&logo=freebsd&logoColor=white
[license-link]: https://github.com/mondeja/importlib-metadata-argparse-version/blob/master/LICENSE
[tests-image]: https://img.shields.io/github/actions/workflow/status/mondeja/importlib-metadata-argparse-version/ci.yml?logo=github&label=tests&branch=master
[tests-link]: https://github.com/mondeja/importlib-metadata-argparse-version/actions?query=workflow%3ACI
[coverage-image]: https://img.shields.io/codecov/c/github/mondeja/importlib-metadata-argparse-version?logo=codecov&logoColor=white
[coverage-link]: https://app.codecov.io/gh/mondeja/importlib-metadata-argparse-version
Raw data
{
"_id": null,
"home_page": "",
"name": "importlib-metadata-argparse-version",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "argparse,cli,importlib,metadata,performance,version",
"author": "",
"author_email": "\u00c1lvaro Mond\u00e9jar Rubio <mondejar1994@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/11/73/28f9f6860557652243d28f08c16d5ffeaa952cc1224dbaa4510a1154766d/importlib_metadata_argparse_version-2.0.0.tar.gz",
"platform": null,
"description": "# `importlib-metadata-argparse-version`\n\n[![PyPI][pypi-version-badge-link]][pypi-link]\n[![Python versions][pypi-pyversions-badge-link]][pypi-link]\n[![License][license-image]][license-link]\n[![Tests][tests-image]][tests-link]\n[![Coverage status][coverage-image]][coverage-link]\n\nPython's [`argparse`] module action to define CLI version with a delayed\ncall to [`importlib.metadata.version`] only when `--version` argument\nis passed.\n\n## Rationale\n\nWhen you use `importlib.metadata` for adding the version to a CLI utility,\nyou need to import `importlib.metadata` and call\n`importlib.metadata.version(\"<your-package>\")` at initialization time.\nIf you only want to execute other parts of the CLI\n(eg. like passing the option `--help`), `importlib.metadata` will be\nimported too even when is not needed at all.\n\nThe problem is easily fixed by this module.\n\n## Usage\n\n```python\nimport argparse\n\nfrom importlib_metadata_argparse_version import ImportlibMetadataVersionAction\n\nparser = argparse.ArgumentParser()\nparser.add_argument(\n \"-v\", \"--version\",\n action=ImportlibMetadataVersionAction,\n version_from=\"your-package-name\",\n)\n```\n\nThis is a rough equivalent to something like:\n\n```python\nimport argparse\nimport importlib.metadata\n\nparser = argparse.ArgumentParser()\nparser.add_argument(\n \"-v\", \"--version\",\n action=\"version\",\n version=importlib_metadata.version(\"your-package-name\"),\n)\n```\n\n...but with the difference that `importlib.metadata` will only be\nimported when you call `--version`, so it is more efficient.\n\nWhen using `ImportlibMetadataVersionAction` the `version` kwarg\naccepts `%(version)s` as a placeholder like `%(prog)s`. So you\ncan write something like this to display the program name before the\nversion:\n\n```python\nparser.add_argument(\n \"-v\", \"--version\",\n action=ImportlibMetadataVersionAction,\n version_from=\"your-package-name\",\n version=\"%(prog)s %(version)s\",\n)\n\n# or\n\nparser.version = \"%(prog)s %(version)s\"\nparser.add_argument(\n \"-v\", \"--version\",\n action=ImportlibMetadataVersionAction,\n version_from=\"your-package-name\",\n)\n```\n\nAnd the `version` kwarg becomes optional, being `\"%(version)s\"`\nthe default value.\n\n## For convenience\n\nIf you forget to define the kwarg `version_from`\nin the argument, a `ValueError` will be raised at initialization time.\nPython's [`argparse`] built-in `\"version\"` action raises an\n`AttributeError` **only when you call your program with `--version`**,\nwhich is unsafe because could lead you to pass the error unnoticed\nuntil you test it when you forget to define the `version` kwarg.\n\n[`argparse`]: https://docs.python.org/3/library/argparse.html\n[`importlib.metadata.version`]: https://docs.python.org/3/library/importlib.metadata.html?highlight=importlib%20metadata#distribution-versions\n[pypi-link]: https://pypi.org/project/importlib-metadata-argparse-version\n[pypi-version-badge-link]: https://img.shields.io/pypi/v/importlib-metadata-argparse-version?logo=pypi&logoColor=white\n[pypi-pyversions-badge-link]: https://img.shields.io/pypi/pyversions/importlib-metadata-argparse-version?logo=python&logoColor=white\n[license-image]: https://img.shields.io/pypi/l/importlib-metadata-argparse-version?color=light-green&logo=freebsd&logoColor=white\n[license-link]: https://github.com/mondeja/importlib-metadata-argparse-version/blob/master/LICENSE\n[tests-image]: https://img.shields.io/github/actions/workflow/status/mondeja/importlib-metadata-argparse-version/ci.yml?logo=github&label=tests&branch=master\n[tests-link]: https://github.com/mondeja/importlib-metadata-argparse-version/actions?query=workflow%3ACI\n[coverage-image]: https://img.shields.io/codecov/c/github/mondeja/importlib-metadata-argparse-version?logo=codecov&logoColor=white\n[coverage-link]: https://app.codecov.io/gh/mondeja/importlib-metadata-argparse-version\n",
"bugtrack_url": null,
"license": "",
"summary": "Argparse action to define CLI version with a delayed call to importlib.metadata",
"version": "2.0.0",
"project_urls": {
"Bug tracker": "https://github.com/mondeja/importlib-metadata-argparse-version/issues",
"Changelog": "https://github.com/mondeja/importlib-metadata-argparse-version/releases",
"Documentation": "https://mondeja.github.io/importlib-metadata-argparse-version",
"Source": "https://github.com/mondeja/importlib-metadata-argparse-version"
},
"split_keywords": [
"argparse",
"cli",
"importlib",
"metadata",
"performance",
"version"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "49473dc0d705612771d6337432de8bfcac7de8b8bc261c2f52e80436a86a8b58",
"md5": "a80d79d6982cf6d1b5161f5d0f2d4450",
"sha256": "f7d26c79f7d515602f3477f41b14bf47ad3d41297dc40b27076f61a73e2ad653"
},
"downloads": -1,
"filename": "importlib_metadata_argparse_version-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a80d79d6982cf6d1b5161f5d0f2d4450",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 4616,
"upload_time": "2024-03-06T00:36:16",
"upload_time_iso_8601": "2024-03-06T00:36:16.480440Z",
"url": "https://files.pythonhosted.org/packages/49/47/3dc0d705612771d6337432de8bfcac7de8b8bc261c2f52e80436a86a8b58/importlib_metadata_argparse_version-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "117328f9f6860557652243d28f08c16d5ffeaa952cc1224dbaa4510a1154766d",
"md5": "384271ba2e04dae7c10a4f0f9180456a",
"sha256": "51c97ab7c6be1d8c6ca186ba4ef2f6dbd962f8708db92bf8e5ca744081c1d9a8"
},
"downloads": -1,
"filename": "importlib_metadata_argparse_version-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "384271ba2e04dae7c10a4f0f9180456a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4844,
"upload_time": "2024-03-06T00:36:17",
"upload_time_iso_8601": "2024-03-06T00:36:17.420072Z",
"url": "https://files.pythonhosted.org/packages/11/73/28f9f6860557652243d28f08c16d5ffeaa952cc1224dbaa4510a1154766d/importlib_metadata_argparse_version-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-06 00:36:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mondeja",
"github_project": "importlib-metadata-argparse-version",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "importlib-metadata-argparse-version"
}
JSON
