pytest-inject-config 1.0.0__py3-none-any.whl

pytest_inject_config/__init__.py

@@ -0,0 +1,3 @@
+from pytest_inject_config.const import CLASS_ATTRIBUTE, FLAG
+
+__all__ = ["CLASS_ATTRIBUTE", "FLAG"]

pytest_inject_config/const.py

@@ -0,0 +1,8 @@
+from typing import Any
+
+import pytest
+
+FLAG = "--config-path"
+CLASS_ATTRIBUTE = "config"
+INJECTOR_PLUGIN_NAME = "inject-config-injector"
+CONFIG_DATA_KEY = pytest.StashKey[Any]()

pytest_inject_config/injector.py

@@ -0,0 +1,20 @@
+"""Registered by ``plugin.pytest_configure`` only when ``--config-path`` is set; never loaded on its own."""
+
+import copy
+
+import pytest
+
+from pytest_inject_config.const import CLASS_ATTRIBUTE, CONFIG_DATA_KEY
+
+
+# Why a separate module, and not a fixture in plugin.py that returns early when the flag isn't set:
+# plugin.py is always registered (it is the entry point), so a fixture there would be attached to every test class
+# in every run and would execute even without --config-path. This module is registered only when the flag is set,
+# so without it pytest never sees the fixture and nothing runs.
+# It is a module-level function rather than a method on a plugin object because class-scoped fixtures defined as
+# instance methods are deprecated (PytestRemovedIn10Warning).
+@pytest.fixture(scope="class", autouse=True)
+def inject_config_into_class(request: pytest.FixtureRequest) -> None:
+    if request.cls is not None:
+        # A copy per class, so a test that mutates its config can't leak into other classes.
+        setattr(request.cls, CLASS_ATTRIBUTE, copy.deepcopy(request.config.stash[CONFIG_DATA_KEY]))

pytest_inject_config/plugin.py

@@ -0,0 +1,100 @@
+"""Load a config file given by ``--config-path`` and inject its content into every test class as ``self.config``.
+
+The format is chosen by the file extension (``.json``, ``.yaml``, ``.yml``); any other extension is rejected, so
+adding a format later never changes how an existing file is read. Every loader has the same shape: it takes the
+path, loads it with its own library, and returns a mapping. File-level errors (missing, not UTF-8, unreadable)
+are handled once, in ``load_config``.
+
+Without the flag the injector module is never registered, so no fixture runs. The file is read once, at startup;
+a missing, unreadable or invalid file stops the run with a usage error before any test is collected.
+"""
+
+import json
+from collections.abc import Callable
+from pathlib import Path
+from typing import Any
+
+import pytest
+import yaml
+
+from pytest_inject_config import injector
+from pytest_inject_config.const import CLASS_ATTRIBUTE, CONFIG_DATA_KEY, FLAG, INJECTOR_PLUGIN_NAME
+
+ConfigLoader = Callable[[Path], dict[str, Any]]
+
+
+def ensure_mapping(data: Any, path: Path) -> dict[str, Any]:
+    if data is None:
+        raise pytest.UsageError(f"{FLAG}: {path} is empty or null")
+    if not isinstance(data, dict):
+        raise pytest.UsageError(f"{FLAG}: top level of {path} must be a mapping, got {type(data).__name__}")
+    return data
+
+
+def load_json_config(path: Path) -> dict[str, Any]:
+    with path.open(encoding="utf-8") as config_file:
+        try:
+            data = json.load(config_file)
+        except json.JSONDecodeError as e:
+            raise pytest.UsageError(f"{FLAG}: invalid JSON in {path}: {e}") from e
+    return ensure_mapping(data=data, path=path)
+
+
+def load_yaml_config(path: Path) -> dict[str, Any]:
+    with path.open(encoding="utf-8") as config_file:
+        # safe_load only: full YAML loading can construct arbitrary Python objects (code execution) from the file.
+        try:
+            data = yaml.safe_load(config_file)
+        except yaml.YAMLError as e:
+            raise pytest.UsageError(f"{FLAG}: invalid YAML in {path}: {e}") from e
+    return ensure_mapping(data=data, path=path)
+
+
+# Keyed by lowercase file extension. To support a new format, write a load_<format>_config and add it here.
+CONFIG_LOADERS: dict[str, ConfigLoader] = {
+    ".json": load_json_config,
+    ".yaml": load_yaml_config,
+    ".yml": load_yaml_config,
+}
+
+
+def pytest_addoption(parser: pytest.Parser) -> None:
+    parser.addoption(
+        FLAG,
+        action="store",
+        type=Path,
+        default=None,
+        metavar="PATH",
+        help=f"Load a config file ({', '.join(CONFIG_LOADERS)}) and expose its content to test classes "
+        f"as `self.{CLASS_ATTRIBUTE}`.",
+    )
+
+
+def pytest_configure(config: pytest.Config) -> None:
+    if (config_path := config.getoption(FLAG)) is None:
+        return
+
+    config.stash[CONFIG_DATA_KEY] = load_config(path=config_path)
+    config.pluginmanager.register(injector, INJECTOR_PLUGIN_NAME)
+
+
+def get_config_loader(path: Path) -> ConfigLoader:
+    suffix = path.suffix.lower()
+    if (loader := CONFIG_LOADERS.get(suffix)) is None:
+        supported = ", ".join(CONFIG_LOADERS)
+        raise pytest.UsageError(
+            f"{FLAG}: unsupported format {suffix or '(no extension)'!r} in {path}, supported: {supported}"
+        )
+    return loader
+
+
+def load_config(path: Path) -> dict[str, Any]:
+    loader = get_config_loader(path=path)
+    try:
+        return loader(path)
+    except FileNotFoundError as e:
+        raise pytest.UsageError(f"{FLAG}: file not found: {path}") from e
+    except UnicodeDecodeError as e:
+        raise pytest.UsageError(f"{FLAG}: {path} is not UTF-8 text: {e}") from e
+    except OSError as e:
+        raise pytest.UsageError(f"{FLAG}: cannot read {path}: {e}") from e

pytest_inject_config-1.0.0.dist-info/METADATA

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: pytest-inject-config
+Version: 1.0.0
+Summary: A pytest plugin that loads a JSON or YAML file given by --config-path and injects it into test classes as self.config.
+Author: Avi Zaguri
+License: MIT
+Project-URL: Homepage, https://github.com/aviz92/pytest-inject-config
+Project-URL: Repository, https://github.com/aviz92/pytest-inject-config
+Project-URL: Issues, https://github.com/aviz92/pytest-inject-config/issues
+Keywords: pytest,plugin,testing,config,configuration,json,yaml
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Testing
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pytest>=9.2.0
+Requires-Dist: pyyaml>=6.0.3
+Dynamic: license-file
+
+![PyPI version](https://img.shields.io/pypi/v/pytest-inject-config)
+![Python](https://img.shields.io/badge/python->=3.12-blue)
+![Development Status](https://img.shields.io/badge/status-stable-green)
+![Maintenance](https://img.shields.io/maintenance/yes/2026)
+![PyPI](https://img.shields.io/pypi/dm/pytest-inject-config)
+![License](https://img.shields.io/pypi/l/pytest-inject-config)
+
+---
+
+# 💡 pytest-inject-config
+A pytest plugin that loads a config file given by `--config-path` and injects it into every test class as `self.config`.
+The format is chosen by the file extension: JSON (`.json`) and YAML (`.yaml`, `.yml`).
+Run the same test suite against different environments by switching a single flag.
+
+---
+
+## 📦 Installation
+```bash
+uv add pytest-inject-config
+```
+
+---
+
+## 🚀 Features
+  - ✅ **One flag, any environment** — point `--config-path` at a different JSON file per environment
+  - ✅ **Isolated per class** — each test class gets its own copy, so a test that mutates its config can't affect others
+  - ✅ **Fails fast** — a missing file, an unsupported extension, or invalid content stops the run at startup with a clear usage error
+  - ✅ **JSON and YAML** — chosen by extension; only known extensions are accepted, so adding formats later never changes how an existing file is read
+  - ✅ **Safe YAML** — YAML is loaded with `safe_load`, so a config file can never construct Python objects or run code
+  - ✅ **Read once** — the file is loaded at startup, not once per class
+  - ✅ **Zero footprint without the flag** — nothing is registered and no fixture runs
+
+---
+
+## 🛠️ How to Use
+1. Create a config file per environment, in JSON:
+   ```json
+   {
+       "host": "10.0.0.1",
+       "port": 8080
+   }
+   ```
+   or in YAML:
+   ```yaml
+   host: 10.0.0.1
+   port: 8080
+   ```
+2. Read it from your test classes through `self.config`:
+   ```python
+   class TestDevice:
+       def test_connect(self):
+           assert connect(self.config["host"], self.config["port"])
+   ```
+3. Run with the file for the environment you want:
+   ```bash
+   pytest --config-path=config/staging.json
+   ```
+
+---
+
+## ⚙️ Behavior
+| Situation | Result |
+|---|---|
+| Test inside a class | `self.config` holds the file's content as a `dict` |
+| Top level is not a mapping (a list, a number, a string) | `UsageError` at startup |
+| Module-level test function | Unaffected |
+| Relative path | Resolved from the directory pytest is run in |
+| Extension | Decides the format, case-insensitive. Supported: `.json`, `.yaml`, `.yml` |
+| Unsupported or missing extension | `UsageError` at startup (exit code 4), even if the content would parse |
+| Empty file, or a top-level `null` | `UsageError` at startup |
+| YAML with several documents (`---`) or Python tags (`!!python/...`) | `UsageError` at startup |
+| Missing file, directory, non-UTF-8 or invalid content | `UsageError` at startup (exit code 4), no tests run |
+| No `--config-path` | Nothing is injected; no fixture runs |
+
+---
+
+## ▶️ Usage Examples
+### Select the environment in CI
+```bash
+pytest --config-path="config/${TARGET_ENV}.yaml"
+```
+
+### Set a default in `pytest.ini`
+```ini
+[pytest]
+addopts =
+    --config-path=config/local.json
+```
+
+---
+
+## 🔁 Migrating from pytest-plugins
+This plugin was previously `add_config_parameters` in `pytest-plugins`, where it never worked.
+Both register the `--config-path` option, so don't install them together until you're on a `pytest-plugins`
+release without it.
+
+---
+
+## 🤝 Contributing
+1. Fork the repository
+2. Create a feature branch: `git checkout -b feature/my-addition`
+3. Make your changes
+4. Commit your changes: `git commit -m 'Add my addition'`
+5. Push to the branch: `git push origin feature/my-addition`
+6. Open a Pull Request
+
+Additions that promote clean, productive, and maintainable development are always welcome.
+
+---
+
+## 📄 License
+MIT License — see [LICENSE](LICENSE) for details.
+
+---
+
+## 🙏 Thanks
+Thanks for exploring this repository! <br>
+Happy coding!
+
+[![GitHub](https://img.shields.io/badge/GitHub-aviz92-181717?logo=github)](https://github.com/aviz92)
+&nbsp; [![PyPI](https://img.shields.io/badge/PyPI-aviz-3775A9?logo=pypi)](https://pypi.org/user/aviz/)
+&nbsp; [![Blog](https://img.shields.io/badge/Blog-aviz92.github.io-0066CC?logo=googlechrome)](https://aviz92.github.io/)
+&nbsp; [![LinkedIn](https://img.shields.io/badge/LinkedIn-avi--zaguri-0A66C2?logo=linkedin)](https://www.linkedin.com/in/avi-zaguri-41869b11b)

pytest_inject_config-1.0.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+pytest_inject_config/__init__.py,sha256=79WiTRBDlyXNyoouH3BZwAzNLQf6tAqj2XTs_2Nu-pU,100
+pytest_inject_config/const.py,sha256=lc52YiKnSeVvsdsuwbQOKvSPblsZDbeVBgD8Ee5xhtw,178
+pytest_inject_config/injector.py,sha256=6CzCPBgQS9zaXmG8VlJQM7_RVfF10Y8pBPwcfzhB6bM,1120
+pytest_inject_config/plugin.py,sha256=QmKsA9xynmpKpOjvRFyJUMvpwYRrs95xJWfdqRCnpS0,3769
+pytest_inject_config-1.0.0.dist-info/licenses/LICENSE,sha256=cSikHY6SZFsPZSBizCDAJ0-Bjjzxt-JtX6TVbKxwimo,1067
+pytest_inject_config-1.0.0.dist-info/METADATA,sha256=eNgmZEfXsN7DMIurF_7Pk8nWwgT-8nODhdOQ1uCb53Y,5442
+pytest_inject_config-1.0.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+pytest_inject_config-1.0.0.dist-info/entry_points.txt,sha256=d7iH0wQ7qW_BcWos3Qw9niVnU7AV_1Cuqptw82QfORs,55
+pytest_inject_config-1.0.0.dist-info/top_level.txt,sha256=rW8ry3J2a0OVn2d2k19aLwRJ7cW0NjGAh-ysvStc6RY,21
+pytest_inject_config-1.0.0.dist-info/RECORD,,

pytest_inject_config-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pytest_inject_config-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pytest11]
+inject_config = pytest_inject_config.plugin

pytest_inject_config-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Avi Zaguri
+
+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.

pytest_inject_config-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pytest_inject_config