poodle 1.0.0__tar.gz

poodle-1.0.0/LICENSE

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

poodle-1.0.0/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.1
+Name: poodle
+Version: 1.0.0
+Summary: Mutation Testing Tool
+Author-email: WiredNerd <pbuschmail-poodle@yahoo.com>
+Maintainer-email: WiredNerd <pbuschmail-poodle@yahoo.com>
+License: MIT License
+        
+        Copyright (c) 2023 WiredNerd
+        
+        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.
+        
+Project-URL: Documentation, https://poodle.readthedocs.io/
+Project-URL: Homepage, https://github.com/WiredNerd/poodle
+Project-URL: Issue Tracker, https://github.com/WiredNerd/poodle/issues
+Keywords: test,coverage,quality,mutation,pytest,pit,pitest,pittest,mutmut,mutatest
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8
+Requires-Dist: wcmatch>=8.5
+Requires-Dist: tomli>=2; python_version < "3.11"
+
+[![Homepage](https://img.shields.io/badge/Homepage-github-white)](https://github.com/WiredNerd/poodle)
+[![python>=3.9](https://img.shields.io/badge/python->=3.8-orange)](https://pypi.org/project/poodle)
+[![PyPI - Version](https://img.shields.io/pypi/v/poodle)](https://pypi.org/project/poodle)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/poodle)](https://pypi.org/project/poodle)
+[![PyPI - License](https://img.shields.io/pypi/l/poodle)](https://github.com/WiredNerd/poodle/blob/main/LICENSE)
+
+
+[![Code Coverage](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2FWiredNerd%2Fpoodle%2Fmain%2Fcode-coverage.json&query=%24.totals.percent_covered_display&suffix=%25&label=Code%20Coverage&color=teal)](https://pytest-cov.readthedocs.io)
+[![Documentation Status](https://readthedocs.org/projects/poodle/badge/?version=latest)](https://poodle.readthedocs.io/)
+<!-- [![Mutation Coverage](https://img.shields.io/badge/dynamic/xml?url=https%3A%2F%2Fraw.githubusercontent.com%2FWiredNerd%2Fpoodle%2Fmain%2Fmutation-testing-report.xml&query=round((%2F%2Ftestsuites%5B1%5D%2F%40tests%20-%20%2F%2Ftestsuites%5B1%5D%2F%40disabled%20-%20%2F%2Ftestsuites%5B1%5D%2F%40failures%20-%20%2F%2Ftestsuites%5B1%5D%2F%40errors)div(%2F%2Ftestsuites%5B1%5D%2F%40tests%20-%20%2F%2Ftestsuites%5B1%5D%2F%40disabled)*100)&suffix=%25&label=Mutation%20Coverage&color=orange)](https://mutmut.readthedocs.io/) --> 
+
+[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
+[![Code Style: black](https://img.shields.io/badge/Code_Style-Black-black)](https://black.readthedocs.io)
+[![Linter: ruff](https://img.shields.io/badge/Linter-ruff-purple)](https://beta.ruff.rs/docs/)
+<!-- [![Snyk Security](https://img.shields.io/badge/Snyk%20Security-monitored-FF66FF)](https://snyk.io/) -->
+
+# Poodle
+
+Poodle is an tool for Mutation Testing your Python projects.
+
+Mutation Testing proves the quality of your test suite by introducing bugs in your application, then verifying if your test cases can find the bug.
+
+## Features
+
+The goal of Poodle is to be highly efficient, configurable, and extendable.
+
+* Multi-Threaded execution
+* Highly Configurable (toml and py)
+* Plug in custom code
+
+## Quick Start
+
+Installation:
+
+```
+pip install poodle --upgrade
+```
+
+```
+Usage: poodle [OPTIONS] [SOURCES]...
+
+  Poodle Mutation Test Tool.
+
+Options:
+  -c PATH         Configuration File.
+  -q              Quiet mode: q, qq, or qq
+  -v              Verbose mode: v, vv, or vvv
+  -w INTEGER      Maximum number of parallel workers.
+  --exclude TEXT  Add a regex exclude file filter. Multiple allowed.
+  --only TEXT     Glob pattern for files to mutate. Multiple allowed.
+  --help          Show this message and exit.
+```
+
+## Documentation:
+
+- https://poodle.readthedocs.io/
+
+## Contribute
+
+- Issue Tracker: https://github.com/WiredNerd/poodle/issues
+- Source Code: https://github.com/WiredNerd/poodle
+
+## Support
+
+If you are having issues, please let us know.
+
+I can be contacted at: pbuschmail-poodle@yahoo.com
+
+Or by opening an issue: https://github.com/WiredNerd/poodle/issues
+
+## License
+
+The project is licensed under the MIT license.

poodle-1.0.0/README.md

@@ -0,0 +1,73 @@
+[![Homepage](https://img.shields.io/badge/Homepage-github-white)](https://github.com/WiredNerd/poodle)
+[![python>=3.9](https://img.shields.io/badge/python->=3.8-orange)](https://pypi.org/project/poodle)
+[![PyPI - Version](https://img.shields.io/pypi/v/poodle)](https://pypi.org/project/poodle)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/poodle)](https://pypi.org/project/poodle)
+[![PyPI - License](https://img.shields.io/pypi/l/poodle)](https://github.com/WiredNerd/poodle/blob/main/LICENSE)
+
+
+[![Code Coverage](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2FWiredNerd%2Fpoodle%2Fmain%2Fcode-coverage.json&query=%24.totals.percent_covered_display&suffix=%25&label=Code%20Coverage&color=teal)](https://pytest-cov.readthedocs.io)
+[![Documentation Status](https://readthedocs.org/projects/poodle/badge/?version=latest)](https://poodle.readthedocs.io/)
+<!-- [![Mutation Coverage](https://img.shields.io/badge/dynamic/xml?url=https%3A%2F%2Fraw.githubusercontent.com%2FWiredNerd%2Fpoodle%2Fmain%2Fmutation-testing-report.xml&query=round((%2F%2Ftestsuites%5B1%5D%2F%40tests%20-%20%2F%2Ftestsuites%5B1%5D%2F%40disabled%20-%20%2F%2Ftestsuites%5B1%5D%2F%40failures%20-%20%2F%2Ftestsuites%5B1%5D%2F%40errors)div(%2F%2Ftestsuites%5B1%5D%2F%40tests%20-%20%2F%2Ftestsuites%5B1%5D%2F%40disabled)*100)&suffix=%25&label=Mutation%20Coverage&color=orange)](https://mutmut.readthedocs.io/) --> 
+
+[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
+[![Code Style: black](https://img.shields.io/badge/Code_Style-Black-black)](https://black.readthedocs.io)
+[![Linter: ruff](https://img.shields.io/badge/Linter-ruff-purple)](https://beta.ruff.rs/docs/)
+<!-- [![Snyk Security](https://img.shields.io/badge/Snyk%20Security-monitored-FF66FF)](https://snyk.io/) -->
+
+# Poodle
+
+Poodle is an tool for Mutation Testing your Python projects.
+
+Mutation Testing proves the quality of your test suite by introducing bugs in your application, then verifying if your test cases can find the bug.
+
+## Features
+
+The goal of Poodle is to be highly efficient, configurable, and extendable.
+
+* Multi-Threaded execution
+* Highly Configurable (toml and py)
+* Plug in custom code
+
+## Quick Start
+
+Installation:
+
+```
+pip install poodle --upgrade
+```
+
+```
+Usage: poodle [OPTIONS] [SOURCES]...
+
+  Poodle Mutation Test Tool.
+
+Options:
+  -c PATH         Configuration File.
+  -q              Quiet mode: q, qq, or qq
+  -v              Verbose mode: v, vv, or vvv
+  -w INTEGER      Maximum number of parallel workers.
+  --exclude TEXT  Add a regex exclude file filter. Multiple allowed.
+  --only TEXT     Glob pattern for files to mutate. Multiple allowed.
+  --help          Show this message and exit.
+```
+
+## Documentation:
+
+- https://poodle.readthedocs.io/
+
+## Contribute
+
+- Issue Tracker: https://github.com/WiredNerd/poodle/issues
+- Source Code: https://github.com/WiredNerd/poodle
+
+## Support
+
+If you are having issues, please let us know.
+
+I can be contacted at: pbuschmail-poodle@yahoo.com
+
+Or by opening an issue: https://github.com/WiredNerd/poodle/issues
+
+## License
+
+The project is licensed under the MIT license.

poodle-1.0.0/pyproject.toml

@@ -0,0 +1,160 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "poodle"
+description = "Mutation Testing Tool"
+version = "1.0.0"
+license = { file = "LICENSE" }
+keywords = [
+    "test",
+    "coverage",
+    "quality",
+    "mutation",
+    "pytest",
+    "pit",
+    "pitest",
+    "pittest",
+    "mutmut",
+    "mutatest",
+]
+authors = [{ name = "WiredNerd", email = "pbuschmail-poodle@yahoo.com" }]
+maintainers = [{ name = "WiredNerd", email = "pbuschmail-poodle@yahoo.com" }]
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = ["click>=8", "wcmatch>=8.5", "tomli>=2; python_version<'3.11'"]
+
+[project.urls]
+"Documentation" = "https://poodle.readthedocs.io/"
+"Homepage" = "https://github.com/WiredNerd/poodle"
+"Issue Tracker" = "https://github.com/WiredNerd/poodle/issues"
+
+[project.scripts]
+poodle = "poodle.cli:main"
+
+[tool.setuptools]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+testpaths = ["tests"]
+addopts = "-vv --cov-reset --cov-report=html:reports/coverage --cov-report=term --cov-report=json:code-coverage.json"
+sort_mode = "random"
+sort_bucket = "session"
+filterwarnings = [
+    "ignore:.*cannot collect test class .TestingSummary",
+    "ignore:.*cannot collect test class .TestingResults",
+]
+
+[tool.poodle]
+file_filters = ["test_*.py", "*_test.py", 'cli.py', 'run.py', '__init__.py']
+
+[tool.poodle.runner_opts]
+
+[tool.coverage.run]
+branch = true
+
+[tool.coverage.report]
+skip_empty = true
+exclude_also = ["import .*", "from .* import .*", "if TYPE_CHECKING:"]
+
+[tool.black]
+line-length = 120
+target-version = ['py39', 'py310', 'py311']
+color = true
+
+[tool.isort]
+profile = 'black'
+line_length = 120
+py_version = 39
+
+[tool.mypy]
+files = "poodle"
+mypy_path = "src,tests"
+
+[tool.ruff]
+target-version = "py39"
+show-source = true
+select = ["ALL"]
+ignore = [
+    "COM812",  # missing-trailing-comma
+    "D203",    # 1 blank line required before class docstring
+    "D213",    # multi-line-summary-second-line
+    "EM101",   # Exception must not use a string literal, assign to variable first
+    "FBT001",  # Boolean-typed positional argument in function definition
+    "FBT002",  # Boolean default positional argument in function definition
+    "FIX002",  # Found a TODO
+    "TD002",   # Missing author in TODO
+    "TD003",   # Missing issue link on the line following this TODO
+    "TRY003",  # Avoid specifying long messages outside the exception class
+    "ANN101",  # Missing type annotation for self in method
+    "ANN102",  # Missing type annotation for cls in method
+    "ANN002",  # Missing type annotation for *args
+    "ANN003",  # Missing type annotation for **kwargs
+    "ISC001",  # single-line-implicit-string-concatenation
+    "PLR2004", # Magic value used in comparison
+    "PLR0911", # Too many return statements
+]
+line-length = 120
+exclude = [
+    ".eggs",
+    ".git",
+    ".mypy_cache",
+    ".pants.d",
+    ".ruff_cache",
+    ".venv",
+    "__pypackages__",
+    "_build",
+    "build",
+    "dist",
+    "venv",
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["poodle"]
+
+[tool.ruff.per-file-ignores]
+"src/*/__init__.py" = [
+    "F401", # imported but unused
+]
+"src/poodle/mutators/*" = [
+    "N802", # Function name should be lowercase
+]
+"src/poodle/cli.py" = [
+    "PLR0913", # Too many arguments in function definition
+]
+"src/poodle/data_types/interfaces.py" = [
+    "ARG001", # Unused function argument
+]
+"tests/*" = [
+    "D100",    # Missing docstring in public module
+    "D101",    # Missing docstring in public class
+    "D102",    # Missing docstring in public method
+    "D103",    # Missing docstring in public function
+    "D104",    # Missing docstring in public package
+    "D106",    # Missing docstring in public nested class
+    "S101",    # Use of `assert` detected
+    "ANN001",  # Missing type annotation for function argument
+    "ANN201",  # Missing return type annotation for public function
+    "ANN202",  # Missing return type annotation for private function
+    "ANN205",  # Missing return type annotation for staticmethod
+    "ANN206",  # Missing return type annotation for classmethod
+    "FBT003",  # Boolean positional value in function call
+    "ERA001",  # Found commented-out code
+    "PLR0913", # Too many arguments in function definition
+    "PLR2004", # Magic value used in comparison
+    "SLF001",  # Private member accessed
+]
+"tests/mutators/*" = [
+    "N802", # Function name should be lowercase
+]
+"tests/test_core.py" = [
+    "ARG002", # Unused method argument
+]
+
+[tool.ruff.format]

poodle-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

poodle-1.0.0/src/poodle/__init__.py

@@ -0,0 +1,29 @@
+"""Poodle Mutation Test Tool."""
+
+from __future__ import annotations
+
+import importlib
+import sys
+from contextlib import suppress
+from pathlib import Path
+from typing import Any
+
+
+class PoodleInputError(ValueError):
+    """An input value from Command Line, poodle_config.py, or a config file was invalid."""
+
+
+class PoodleTrialRunError(Exception):
+    """An unexpected error occurred when running a mutation trial or clean run."""
+
+
+try:
+    import tomllib  # type: ignore [import-not-found]
+except ModuleNotFoundError:  # < py3.11
+    import tomli as tomllib  # type: ignore [no-redef]
+
+
+poodle_config: Any = None
+with suppress(ImportError):
+    sys.path.append(str(Path.cwd()))
+    poodle_config = importlib.import_module("poodle_config")

poodle-1.0.0/src/poodle/cli.py

@@ -0,0 +1,58 @@
+"""Command Line Interface."""
+
+from __future__ import annotations
+
+import sys
+from pathlib import Path
+
+import click
+
+from . import PoodleInputError, core
+from .config import build_config
+
+CONTEXT_SETTINGS = {
+    "max_content_width": 120,
+}
+
+
+@click.command(context_settings=CONTEXT_SETTINGS)
+@click.argument("sources", type=click.Path(exists=True, path_type=Path), nargs=-1)
+@click.option("-c", "config_file", help="Configuration File.", type=click.Path(exists=True, path_type=Path))
+@click.option("-q", "quiet", help="Quiet mode: q, qq, or qq", count=True)
+@click.option("-v", "verbose", help="Verbose mode: v, vv, or vvv", count=True)
+@click.option("-w", "workers", help="Maximum number of parallel workers.", type=int)
+@click.option("--exclude", help="Add a regex exclude file filter. Multiple allowed.", multiple=True)
+@click.option("--only", help="Glob pattern for files to mutate. Multiple allowed.", multiple=True)
+def main(
+    sources: tuple[Path],
+    config_file: Path | None,
+    quiet: int,
+    verbose: int,
+    workers: int | None,
+    exclude: tuple[str],
+    only: tuple[str],
+) -> None:
+    """Poodle Mutation Test Tool."""
+    try:
+        config = build_config(sources, config_file, quiet, verbose, workers, exclude, only)
+    except PoodleInputError as err:
+        click.echo(err.args)
+        sys.exit(4)
+
+    try:
+        core.main(config)
+    except KeyboardInterrupt:
+        click.echo("Aborted due to Keyboard Interrupt!")
+        sys.exit(2)
+
+
+# pytest return codes
+# Exit code 0: All tests were collected and passed successfully
+# Exit code 1: Tests were collected and run but some of the tests failed
+# Exit code 2: Test execution was interrupted by the user
+# Exit code 3: Internal error happened while executing tests
+# Exit code 4: pytest command line usage error
+# Exit code 5: No tests were collected
+
+if __name__ == "__main__":
+    main()