argparsenv 1.0.0__tar.gz

argparsenv-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 snaeil
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

argparsenv-1.0.0/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.1
+Name: argparsenv
+Version: 1.0.0
+Summary: Extends python's argparser with environment variables
+License: MIT
+Author: snaeil
+Author-email: schnegel@posteo.de
+Requires-Python: >=3.11,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: overrides (>=7.7.0,<8.0.0)
+Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
+Description-Content-Type: text/markdown
+
+# argparsenv
+
+This project extends python's argparse module to allow for environment variable overrides of command line arguments.
+
+The rule for environment variable overrides is as follows:
+
+1. If the argument is provided on the command line, the environment variable is ignored.
+2. If the argument is not provided on the command line, the environment variable is used if it is set.
+3. If the argument is not provided on the command line and the environment variable is not set, the default value is used.
+4. If the argument is environment variable is set both on the command line and in the environment, the command line value is used.
+
+## Installation
+
+Stable release version:
+
+```bash
+pip install argparsenv
+```
+
+Latest development version:
+
+```bash
+pip install git+https://github.com/snaeil/argparsenv
+```
+
+## Usage
+
+This module builds on top of python's standard library
+[argparse](https://docs.python.org/3/library/argparse.html).
+
+```python
+env_arg_parser = ArgumentParser()
+env_arg_parser.add_argument(
+    "--port",
+    dest="port",
+    env_var="MY_APP_DB_PORT",
+    default="3306",
+)
+```
+
+With this ArgumentParser instance, the port argument can be set in three ways:
+
+1. On the command line:
+
+```bash
+python my_app.py --port 3307
+```
+
+2. As an environment variable (this can also be done by using a `.env` file):
+
+```bash
+export MY_APP_DB_PORT=3307
+python my_app.py
+```
+
+3. Using the default value (here `3306`):
+
+```bash
+python my_app.py
+```
+
+## Contributing
+
+Contributions are welcome!
+For feature requests, bug reports or questions, please open an issue.
+For code contributions, please open a pull request.
+
+Please make sure to install `pre-commit` before making changes to the code (this enables
+checks for code formatting, linting, etc. before committing changes):
+
+```bash
+pip install pre-commit
+cd path/to/argparsenv
+pre-commit install
+```
+

argparsenv-1.0.0/README.md

@@ -0,0 +1,75 @@
+# argparsenv
+
+This project extends python's argparse module to allow for environment variable overrides of command line arguments.
+
+The rule for environment variable overrides is as follows:
+
+1. If the argument is provided on the command line, the environment variable is ignored.
+2. If the argument is not provided on the command line, the environment variable is used if it is set.
+3. If the argument is not provided on the command line and the environment variable is not set, the default value is used.
+4. If the argument is environment variable is set both on the command line and in the environment, the command line value is used.
+
+## Installation
+
+Stable release version:
+
+```bash
+pip install argparsenv
+```
+
+Latest development version:
+
+```bash
+pip install git+https://github.com/snaeil/argparsenv
+```
+
+## Usage
+
+This module builds on top of python's standard library
+[argparse](https://docs.python.org/3/library/argparse.html).
+
+```python
+env_arg_parser = ArgumentParser()
+env_arg_parser.add_argument(
+    "--port",
+    dest="port",
+    env_var="MY_APP_DB_PORT",
+    default="3306",
+)
+```
+
+With this ArgumentParser instance, the port argument can be set in three ways:
+
+1. On the command line:
+
+```bash
+python my_app.py --port 3307
+```
+
+2. As an environment variable (this can also be done by using a `.env` file):
+
+```bash
+export MY_APP_DB_PORT=3307
+python my_app.py
+```
+
+3. Using the default value (here `3306`):
+
+```bash
+python my_app.py
+```
+
+## Contributing
+
+Contributions are welcome!
+For feature requests, bug reports or questions, please open an issue.
+For code contributions, please open a pull request.
+
+Please make sure to install `pre-commit` before making changes to the code (this enables
+checks for code formatting, linting, etc. before committing changes):
+
+```bash
+pip install pre-commit
+cd path/to/argparsenv
+pre-commit install
+```

argparsenv-1.0.0/argparsenv/__init__.py

@@ -0,0 +1,3 @@
+"""Provides the ArgumentParser class for parsing environment variables and command line arguments."""
+
+from .argparsenv import ArgumentParser

argparsenv-1.0.0/argparsenv/argparsenv.py

@@ -0,0 +1,79 @@
+"""This module contains utilities for command line interfaces, icnluding argument parsing and configuration."""
+
+from __future__ import annotations
+import argparse
+from os import (
+    path as os_path,
+    getenv as os_getenv,
+    getcwd as os_getcwd,
+)
+from dotenv import load_dotenv
+from overrides import override
+
+
+class ArgumentParser(argparse.ArgumentParser):
+    """Enhances the standard argparse.ArgumentParser by adding the ability to read\
+            default values from environment variables."""
+
+    def __init__(self, *args, **kwargs):
+        """Initializes the parser and loads the environment variables from the .env file.
+        *args: inherited from argparse.ArgumentParser
+        **kwargs: inherited from argparse.ArgumentParser
+
+        Initializes the parser with the given arguments and loads the environment variables.
+        >>> parser = ArgumentParser(description="This is a parser")
+        """
+        super().__init__(*args, **kwargs)
+        load_dotenv(os_path.join(os_getcwd(), ".env"))
+
+    def get_value_from_environment(
+        self, env_key: None | str, fallback_value: None | str
+    ) -> None | str:
+        """Looks up the value of the given environment variable and returns it if it is\
+                set or the fallback value otherwise. If the environment variable is set\
+                both via the environment and the .env file, the value from\
+                the environment is used.
+
+        Args:
+            env_key: The name of the environment variable to look up.
+            fallback_value: The value to return if the environment variable is not set.
+
+        Returns:
+            A string containing the value of the environment variable or the fallback\
+                    value if the environment variable is not set. May be None.
+        """
+        if env_key:
+            env_key = env_key.strip()
+            if env_key := env_key.strip():
+                if (env_value := os_getenv(env_key.strip())) is not None:
+                    return env_value
+        return fallback_value
+
+    @override
+    def add_argument(self, *args, **kwargs):
+        """Adds an argument to the parser and (in additon to the inherited method)\
+                overrides the default value with the value of the environment variable\
+                if it is set.
+
+        Args:
+            *args: Inherited from argparse.ArgumentParser.add_argument.
+            **kwargs: Inherited from argparse.ArgumentParser.add_argument.\
+                    Additionally, the keyword argument `env_var` is added.\
+                    If `env_var` is set, the default value is tried to be read from\
+                    the environment variable with the given name.\
+
+        Returns:
+            The original return value of argparse.ArgumentParser.add_argument.
+
+        Example:
+        >>> p = ArgumentParser().add_argument("--port", dest="port", env_var="MY_APP_DB_PORT", default="3306", )
+        """
+
+        if "env_var" in kwargs:
+            env_var = kwargs["env_var"]
+            del kwargs["env_var"]
+            kwargs["default"] = self.get_value_from_environment(
+                env_var,
+                kwargs["default"] if "default" in kwargs else None,
+            )
+        return super().add_argument(*args, **kwargs)

argparsenv-1.0.0/pyproject.toml

@@ -0,0 +1,25 @@
+[tool.poetry]
+name = "argparsenv"
+version = "1.0.0"
+description = "Extends python's argparser with environment variables"
+authors = ["snaeil <schnegel@posteo.de>"]
+license = "MIT"
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.11"
+python-dotenv = "^1.0.1"
+overrides = "^7.7.0"
+
+[tool.poetry.group.dev.dependencies]
+black = "^24.4.2"
+pytest-cov = "^5.0.0"
+mypy = "^1.10.0"
+pdoc = "^14.4.0"
+bandit = "^1.7.8"
+pylint = "^3.1.0"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"