pytest-max-warnings 0.1.0__py3-none-any.whl

pytest_max_warnings/plugin.py

@@ -0,0 +1,44 @@
+from __future__ import annotations
+
+import pytest
+
+
+_STASH_KEY = pytest.StashKey["bool"]()
+
+
+def pytest_addoption(parser: pytest.Parser) -> None:
+    group = parser.getgroup("pytest-max-warnings")
+    group.addoption(
+        "--max-warnings",
+        action="store",
+        type=int,
+        default=None,
+        help="Max number of warnings before failing",
+    )
+
+
+@pytest.hookimpl(trylast=True)
+def pytest_sessionfinish(session: pytest.Session, exitstatus: int) -> None:
+    max_warnings = session.config.option.max_warnings
+    terminal_reporter = session.config.pluginmanager.get_plugin("terminalreporter")
+    assert terminal_reporter is not None
+
+    warnings_summary = terminal_reporter.stats.get("warnings", [])
+
+    if max_warnings is not None and len(warnings_summary) > max_warnings:
+        session.exitstatus = 100
+        session.config.stash[_STASH_KEY] = True
+
+
+def pytest_terminal_summary(terminalreporter, exitstatus, config):
+    max_warnings = config.option.max_warnings
+    warnings_summary = terminalreporter.stats.get("warnings", [])
+
+    exceeded_max_warnings = config.stash.get(_STASH_KEY, False)
+    if not exceeded_max_warnings:
+        return
+
+    terminalreporter.write_sep("=", "pytest-max-warnings")
+    terminalreporter.write_line(
+        f"ERROR: Exceeded the maximum allowed warnings: {len(warnings_summary)} > {max_warnings}"
+    )

pytest_max_warnings-0.1.0.dist-info/METADATA

@@ -0,0 +1,61 @@
+Metadata-Version: 2.3
+Name: pytest-max-warnings
+Version: 0.1.0
+Summary: A Pytest plugin to exit non-zero exit code when the configured maximum warnings has been exceeded.
+Project-URL: Repository, https://github.com/miketheman/pytest-max-warnings
+Author-email: Mike Fiedler <miketheman@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Software Development :: Testing
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: pytest>=8.3.3
+Description-Content-Type: text/markdown
+
+# pytest-max-warnings
+
+A Pytest plugin to exit non-zero exit code
+when the configured maximum warnings has been exceeded.
+
+## Installation
+
+You can install "pytest-max-warnings" via [pip](https://pypi.org/project/pytest-max-warnings/):
+
+```bash
+pip install pytest-max-warnings
+```
+
+or any other package manager you prefer.
+
+## Usage
+
+You can set the maximum number of warnings allowed by using the `--max-warnings` option:
+
+```bash
+pytest --max-warnings 10
+```
+
+If the number of warnings exceeds the maximum, the test run will exit with a non-zero exit code.
+
+## License
+
+Distributed under the terms of the MIT license, "pytest-max-warnings" is free and open source software.
+See [LICENSE](./LICENSE) for more details.
+
+## Authors
+
+- [@miketheman](https://github.com/miketheman)

pytest_max_warnings-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+pytest_max_warnings/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pytest_max_warnings/plugin.py,sha256=-LCb3dFIq2LhWKwFaNmTMkClNAbEVZQcnPzprDj8lIU,1372
+pytest_max_warnings/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pytest_max_warnings-0.1.0.dist-info/METADATA,sha256=EP_cpD8DoCHYy3lp2JhqxwvFRElN0_cfmXcL0RqqrSQ,2006
+pytest_max_warnings-0.1.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+pytest_max_warnings-0.1.0.dist-info/entry_points.txt,sha256=-ZlTO0RLZcgX5iK8FGes4DyXald181viYGQv9CiHCO4,53
+pytest_max_warnings-0.1.0.dist-info/licenses/LICENSE,sha256=IaClHZaNw46higl3oPW9eTaoLvD5ftrcWEue3hASOW0,1068
+pytest_max_warnings-0.1.0.dist-info/RECORD,,

pytest_max_warnings-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.25.0
+Root-Is-Purelib: true
+Tag: py3-none-any

pytest_max_warnings-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pytest11]
+max-warnings = pytest_max_warnings.plugin

pytest_max_warnings-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Mike Fiedler
+
+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.