pytest-eo 0.5.1__py3-none-any.whl

pytest_eo/trial.py

@@ -0,0 +1,37 @@
+"""The test functions pytest would run."""
+
+import ast
+from dataclasses import dataclass
+from typing import final
+
+from typing_extensions import override
+
+
+@final
+@dataclass(frozen=True, slots=True)
+class Trial(ast.NodeVisitor):  # noqa: ENC100 - a visitor holds no state, ast dispatches on the node
+    """A function whose name makes pytest run it; nothing for other nodes."""
+
+    @override
+    def generic_visit(
+        self,
+        node: ast.AST,
+    ) -> tuple[ast.FunctionDef | ast.AsyncFunctionDef, ...]:
+        """Find no test in a node that isnt a function."""
+        return ()
+
+    @override
+    def visit_FunctionDef(
+        self,
+        node: ast.FunctionDef,
+    ) -> tuple[ast.FunctionDef | ast.AsyncFunctionDef, ...]:
+        """Find the function when its name starts with ``test``."""
+        return (node,) if node.name.startswith("test") else ()
+
+    @override
+    def visit_AsyncFunctionDef(
+        self,
+        node: ast.AsyncFunctionDef,
+    ) -> tuple[ast.FunctionDef | ast.AsyncFunctionDef, ...]:
+        """Find the coroutine when its name starts with ``test``."""
+        return (node,) if node.name.startswith("test") else ()

pytest_eo/verified.py

@@ -0,0 +1,28 @@
+"""A command that fails loudly unless it exits as expected."""
+
+from dataclasses import dataclass
+from typing import final
+
+from typing_extensions import override
+
+from pytest_eo.command import Command
+from pytest_eo.printout import Printout
+
+
+@final
+@dataclass(frozen=True, slots=True)
+class Verified(Command):
+    """A tool run that refuses any exit status its reader does not expect."""
+
+    _origin: Command
+    _tool: str
+    _allowed: tuple[int, ...]
+
+    @override
+    def run(self) -> Printout:
+        """Run the command and fail on a status outside of the allowed ones."""
+        output = self._origin.run()
+        if not output.exited(self._allowed):
+            reason = f"{self._tool} exited unexpectedly"
+            raise output.failure(reason)
+        return output

pytest_eo/violation.py

@@ -0,0 +1,24 @@
+"""A single style violation reported by one of the aggregated tools."""
+
+from dataclasses import dataclass
+from typing import final
+
+from typing_extensions import override
+
+from pytest_eo.place import Place
+
+
+@final
+@dataclass(frozen=True, slots=True)
+class Violation:
+    """What is wrong, where, and which tool says so."""
+
+    _tool: str
+    _code: str
+    _place: Place
+    _message: str
+
+    @override
+    def __str__(self) -> str:
+        """Render as ``path:line:col: [tool:code] message``."""
+        return f"{self._place}: [{self._tool}:{self._code}] {self._message}"

pytest_eo/wide_suppressions.py

@@ -0,0 +1,45 @@
+"""The suppressions that reach beyond their own line."""
+
+import re
+from collections.abc import Iterable, Iterator
+from dataclasses import dataclass
+from typing import final
+
+from typing_extensions import override
+
+from pytest_eo.remark import Remark
+from pytest_eo.violation import Violation
+
+_SPREAD = r"ruff:\s*(?:noqa|file-ignore|disable)\b|flake8:\s*noqa\b|mypy:"
+_WIDE = re.compile(rf"#\s*(?P<kind>{_SPREAD})")
+_BARE = re.compile(r"#\s*(?P<kind>type:\s*ignore\b(?!\[))")
+
+
+@final
+@dataclass(frozen=True, slots=True)
+class WideSuppressions(Iterable[Violation]):
+    """File-wide and range forms of ruff, flake8 and mypy in one comment.
+
+    Above the first code a bare ``# type: ignore`` silences the whole file,
+    so there it counts as one of them.
+    """
+
+    _tool: str
+    _comment: Remark
+
+    @override
+    def __iter__(self) -> Iterator[Violation]:
+        """Report every form of the comment that suppresses beyond its line."""
+        return (
+            Violation(
+                self._tool,
+                "SUP003",
+                place,
+                f"`# {match['kind']}` suppresses beyond its own line: "
+                "suppress on that one line instead, with a reason",
+            )
+            for place, match in (
+                *self._comment.matches(_WIDE),
+                *self._comment.heading(_BARE),
+            )
+        )

pytest_eo-0.5.1.dist-info/METADATA

@@ -0,0 +1,177 @@
+Metadata-Version: 2.5
+Name: pytest-eo
+Version: 0.5.1
+Summary: pytest --eo: strict style gate over ruff, mypy --strict and pyeo
+Author: RaulIQ
+License-Expression: MIT
+License-File: LICENSE.txt
+Requires-Python: >=3.11
+Requires-Dist: eo-styleguide==0.2.0
+Requires-Dist: flake8-override==0.1.1
+Requires-Dist: flake8==7.4.1
+Requires-Dist: mypy==2.4.0
+Requires-Dist: pyhamcrest>=2.1
+Requires-Dist: pytest>=8
+Requires-Dist: ruff==0.17.1
+Requires-Dist: typing-extensions>=4.4
+Provides-Extra: dev
+Requires-Dist: coverage>=7.10; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# pytest-eo
+
+[![codecov](https://codecov.io/gh/RaulIQ/pytest-eo/graph/badge.svg)](https://codecov.io/gh/RaulIQ/pytest-eo)
+
+`pytest --eo` is a strict quality gate in the spirit of
+[Qulice](https://github.com/yegor256/qulice), built from ready-made tools.
+The plugin runs the tools, reads their reports, and shows each tool as a
+separate test; its own rules cover only tests and suppressions.
+
+| Test              | Tool                                           |
+|-------------------|------------------------------------------------|
+| `eo::ruff`        | `ruff check`, all rules (`select = ["ALL"]`)   |
+| `eo::ruff-format` | `ruff format --check`                          |
+| `eo::mypy`        | `mypy --strict`                                |
+| `eo::flake8`      | `flake8` with [pyeo](https://pypi.org/project/eo-styleguide/) (Elegant Objects rules) |
+| `eo::suppressions`| `# noqa` and `# ruff: ignore` comments         |
+
+The Elegant Objects rules enabled so far, most of them from
+[pyeo](https://github.com/blablatdinov/pyeo) and the rest from its sibling
+packages:
+
+| Code     | Rule                                         | Package |
+|----------|----------------------------------------------|---------|
+| `FIN100` | every class is `@final`                      | pyeo    |
+| `PEO101` | `__init__` contains only assignments         | pyeo    |
+| `PEO102` | `@classmethod` contains only a `cls()` call  | pyeo    |
+| `PEO200` | every class is frozen (immutable)            | pyeo    |
+| `PEO300` | no class names ending in "-er"               | pyeo    |
+| `PEO301` | no public attributes                         | pyeo    |
+| `PEO400` | no static methods                            | pyeo    |
+| `PEO500` | no `@property`, a getter in disguise         | pyeo    |
+| `PEO601` | no methods starting with `get`               | pyeo    |
+| `PEO602` | no getter methods                            | pyeo    |
+| `PEO700` | no introspection, casting, or reflection     | pyeo    |
+| `NPM100` | no private functions or methods              | [flake8-no-private-methods](https://github.com/blablatdinov/flake8-no-private-methods) |
+| `OVR100` | every public method is an `@override` of an interface method | [flake8-override](https://github.com/blablatdinov/flake8-override) |
+| `FOC100` | one public class per module                  | [flake8-one-class](https://github.com/blablatdinov/flake8-one-class) |
+
+mypy runs with `explicit-override` and `warn_unreachable` on top of
+`--strict`: an `@override` must override a real method, every overriding
+method must say so, and code that can never run is an error.
+Python 3.11 has no `typing.override`; import it from `typing_extensions`.
+
+The package also brings a flake8 plugin of its own, with rules in the spirit
+of "Angry Tests" for the files pytest collects (`test_*.py`, `*_test.py`):
+
+| Code     | Rule                                                     |
+|----------|----------------------------------------------------------|
+| `TST100` | a test ends with its only assertion, or with `pytest.raises` |
+| `TST200` | a test module keeps no constants, except `pytest_plugins` |
+| `TST300` | an assertion carries a negative message, such as `"x doesnt y"` |
+
+More rules of its own cover every file, tests or not:
+
+| Code     | Rule                                                     |
+|----------|----------------------------------------------------------|
+| `ENC100` | a class encapsulates one to four attributes; a `Protocol` is exempt |
+| `BOD100` | a function body holds no blank lines, except around a nested `def` or `class` |
+| `BOD200` | a function body holds no comments, except suppressions |
+
+As in Qulice, which rejects plain JUnit assertions, a test asserts through a
+Hamcrest matcher, never through a plain `assert`; ruff's `S101` stays on in
+tests too. PyHamcrest comes with the package:
+
+```python
+from hamcrest import assert_that, equal_to
+
+
+def test_checks_the_whole_directory_by_default(tmp_path: Path) -> None:
+    assert_that(
+        Project(EoTable(tmp_path / "pyproject.toml"), tmp_path).paths(),
+        equal_to((".",)),
+        "Project doesnt check the whole directory by default",
+    )
+```
+
+A rule may be suppressed on one line only, with a reason:
+`# noqa: PEO200 - pytest.Item is mutable by design`, or
+`# ruff: ignore[unused-import] - re-exported for plugins`.
+`eo::suppressions` enforces it:
+
+| Code     | Rule                                                     |
+|----------|----------------------------------------------------------|
+| `SUP001` | a suppression gives a reason after ` - `                 |
+| `SUP002` | a suppression never names `TID251` (`banned-api`), the ban on mocks |
+| `SUP003` | nothing suppresses past one line: no `# ruff: noqa`, `file-ignore` or `disable`, no `# flake8: noqa`, no `# mypy:` comment, no `# type: ignore` above the code |
+
+ruff already rejects a bare `# noqa` (`PGH004`), a bare `# type: ignore`
+(`PGH003`) and an unused `# noqa` for its own codes (`RUF100`).
+
+The configuration is bundled with the package (`src/pytest_eo/config/`)
+and cannot be overridden by a project. A project may only say what to
+check and what to skip:
+
+```toml
+[tool.eo]
+paths = ["src", "tests"]    # default: src and tests, if they exist
+exclude = ["generated/"]
+```
+
+## Usage
+
+```sh
+pip install 'pytest-eo==0.5.1'
+pytest --eo
+```
+
+Without `--eo` the plugin does nothing. Pin an exact version: every version
+of the rules is a version of the package, so pip installs new rules only
+when the version in the requirement changes.
+
+## Claude Code hooks
+
+This repository runs the gate on every Claude Code session that works in it:
+after Claude edits a `.py`, `.toml`, `.ini` or `.cfg` file, and again before
+it finishes. When the gate is red, the findings go back to Claude and it has
+to fix them. If the gate is still red after one retry, Claude may stop, and
+you see a warning instead.
+
+To get the same in another project:
+
+1. Install pytest-eo into the project's `.venv`.
+2. Copy `.claude/hooks/eo-gate.sh` into the same place in that project and
+   make it executable.
+3. Copy the `hooks` block of `.claude/settings.json` into that project's
+   `.claude/settings.json`, merging it with what is already there.
+4. Commit both files, so everyone who opens the project with Claude Code gets
+   the gate, and run `/hooks` once in an open session to load them.
+
+## Development
+
+```sh
+python3 -m venv .venv
+.venv/bin/pip install -e '.[dev]'
+make check
+```
+
+`make check` runs the tests and `pytest --eo` on the plugin itself; Rultor
+merges on it. `make coverage` measures lines and branches, counting the
+pytest subprocesses of the end-to-end tests too, and writes `coverage.xml`,
+which GitHub Actions sends to Codecov on every push and pull request.
+
+`pyproject.toml` on `main` always says `version = "0.0.0"`; a real version
+exists only in a tag. To release, comment in any issue, with the version in
+backticks, since Rultor reads nothing else:
+
+```text
+@rultor release, tag is `0.3.0`
+```
+
+Rultor writes the version into `pyproject.toml`, runs
+`make check`, commits the result on a side branch and pushes only the tag.
+GitHub Actions builds that tag and uploads it to PyPI through Trusted
+Publishing, so no token is stored anywhere.
+Every change to the rules or the bundled configuration ships in a release:
+raise the minor number for a new or stricter rule and the patch number for a
+fix.

pytest_eo-0.5.1.dist-info/RECORD

@@ -0,0 +1,67 @@
+pytest_eo/__init__.py,sha256=3rmPJGpub_1Gi1GNn-2SRWudJqrWUik011WgAs6sNd4,73
+pytest_eo/angry_tests.py,sha256=v13cAE_Wux3w4-iKiD4c4-kWypgsWO9dyeo2-QYMRjE,1544
+pytest_eo/assertion.py,sha256=Iot15iPLIYa9HXB03EKFomjmcZ4CxgjzVTALz7sc-5M,908
+pytest_eo/assigned.py,sha256=lO7ZaLEQ29GXXtkSSwnNOjPQHsH881vJRUXc6fZwcHk,1070
+pytest_eo/blank_lines.py,sha256=p9YWpvxpkrlQ2WHgU-48utBsCFF9Jf1vfSVVVV5VJ3U,1300
+pytest_eo/bodies.py,sha256=9cWFgtMkjX_MxrmbdWss1qTcMLHxAJNuf9cfP5KFx2Q,1215
+pytest_eo/bundled.py,sha256=uo_-nFVL-hhV-Ok3-dmEJpOAD770mIz6sSTw253-y3o,528
+pytest_eo/callee.py,sha256=pQ7MrdQFRfo4unelaRYVy12xsJ1zlf-xEH9Cf4EInFM,682
+pytest_eo/capacity.py,sha256=s1rXY3NmRRAzGkN-JiUlAwZuaVppTZZkPkq-sp_U5c8,1459
+pytest_eo/check.py,sha256=Y4Y6fzIeP93P9QajG-XRHcKKxebFxEuFVbAy9IfOzGE,420
+pytest_eo/command.py,sha256=vxiLthNF6l0a0hFhbKVIzZs_UWEdbYBBZKx9mm6az2s,313
+pytest_eo/comment.py,sha256=JGX1_CJbJCFmBqewTb45nmsM5UOWQDEGmpmC1pOgcGM,1110
+pytest_eo/comments.py,sha256=RVbecuThDG_CEmRMpSpagQs1Pgkm_odcJd7izqXEBck,1293
+pytest_eo/edges.py,sha256=ut4IjmmfwtYVodSi2PaEjd6Z46NiP2rRzcn16Aethj8,775
+pytest_eo/encapsulation.py,sha256=jtRam6UpQ8mo2dR3McpUPlPDwS6T7upw1DpT1d1aVng,984
+pytest_eo/ending.py,sha256=anvKCy0leLYtkbe-8Dho8MI1j1SqD5kgvdzJ3NfRwII,910
+pytest_eo/eo_item.py,sha256=AIqmLvyi0tvW8wID4-RbrJIb4Hf2JYZXRjUTfdBbIwE,1368
+pytest_eo/eo_table.py,sha256=91IlQVyVqwWa_RkF-vOXepdgFSAECuFNflIa3Gwr6cs,1028
+pytest_eo/excludes.py,sha256=9hVp_LHrnaF1Kte87WqQpn9CpG3Hj06kr6i0_8M6P2o,715
+pytest_eo/extension.py,sha256=fixHQ6qmAMoON2jVYoJiy_A7T2t8xo7QKdkD6T9AKjg,359
+pytest_eo/fields.py,sha256=jWsu_IVQ-SXjdDuVtyPlUJZEyzUuLs5KYoGZY1iXaxg,1387
+pytest_eo/files.py,sha256=Oaun13ttiKk76sA7xTuPKGjvC2MonXgujhVJfUX4OSw,297
+pytest_eo/final_assertion.py,sha256=Qqp_hHSnq5LHUUJAQiAgsCJgNAz9xM1PM6M0uiMvS90,1393
+pytest_eo/flake_check.py,sha256=ABX_2GpYiPuwp895mltXNkKBmJq1UrqKA6liBiknXaE,1468
+pytest_eo/heading.py,sha256=luAGlGj0fIS44TCWaoLKXMY4A6-CporthWRZAuBhMiM,914
+pytest_eo/inline_comments.py,sha256=uvYzQdkUxioWFKwOCtgakhXhWCRweteeTMB8U4RED8k,1218
+pytest_eo/layout.py,sha256=l22k1o4WKVP8siY7Cyx-oJ4MsvnNOna6j61tntZ8iKo,390
+pytest_eo/margin.py,sha256=8yRlJf0grWr-BwUXjhKSAylyXeUeUcqb9p9OjeDRbhg,1364
+pytest_eo/message.py,sha256=v_Q6HE-E1wpMf8ctgdcTzh5gp6j7G7KJxgeaVxvL8gk,1833
+pytest_eo/module_constants.py,sha256=8nWaVyC34QAry9uZHMzlcsaMD9EpRmRcW2x5e6p5nXY,876
+pytest_eo/mypy_check.py,sha256=w3nHQ-aZhh63OEfwzpux4s7A_hwDaiTa7dndt0L3nOs,1234
+pytest_eo/narrow_suppressions.py,sha256=SgKNNJN3TPuJ60lfPmO9WWQY5VlZWDhS1CE6ppkU1Eg,2174
+pytest_eo/negative_messages.py,sha256=0kt213fA0EYXJf3yz5ZpMuBYCC-7J0iguva7gZWi8ZI,1092
+pytest_eo/output.py,sha256=31qAit03k7GKZhuSGu7-nG_DNEihHdwA3GO5-2cfR2M,1095
+pytest_eo/owned.py,sha256=Y0WazRWj3Yqki2kQh_eK5F6Sza97QhFEOxL71uxT6CM,1016
+pytest_eo/place.py,sha256=B0G-d0_qroVJ2VGtUe8OJ72lIHQa8k9U6zaK4RognKw,476
+pytest_eo/plugin.py,sha256=EVnyOfAu-NaTqEYt2jDZKwOd67Kyumg8C5uUiK0QFxw,1160
+pytest_eo/printout.py,sha256=rG3T4kZmFnyJ8NvRqVwQhxJm08dSto-0SNh6ALTBuYM,577
+pytest_eo/profile.py,sha256=IFOi6lYL0bDOLqNbpRmqk4LN0OvvURYkGseyO1WWItE,320
+pytest_eo/project.py,sha256=lbjBFFKo0m8E70pHY9HU_10wleJoAGvNPJK23DwnEVg,955
+pytest_eo/project_files.py,sha256=td42X4YOJs9UlhfwuuBBvOMobaiL6YlmVWiqFRf1zjg,1062
+pytest_eo/python_module.py,sha256=_WllphQs5kXrc00JJnEMFFCgfibHwLtB0CVCMsLoLOw,1130
+pytest_eo/raising.py,sha256=GmYtDzpCOQ5_KFc3DF4c3LnJddWRQUUB13Lz-lRWn-4,830
+pytest_eo/remark.py,sha256=iIYyooDxx3cQqunBPaa2FUz3dhee04rjRgUHGMXWBfo,662
+pytest_eo/ruff_check.py,sha256=C0OuzPxSRbj35WtYU0lWLF_d_AMU53WDpL4X3YYKMzQ,1466
+pytest_eo/ruff_format_check.py,sha256=sMNsRByys0uOoVZZbqFx-FmpcBQLSJyhFT-b88Ynfcw,1340
+pytest_eo/rule.py,sha256=0orHF-iiQN67i8uhTKxgexzSYO6VxaGqZzShQO7fSNE,371
+pytest_eo/shared.py,sha256=iMsGEjtR_S8t6ZM_mLbbEefQMirecoEaWElpnngyuO8,1182
+pytest_eo/span.py,sha256=5bqUarD2Kt5LN3pUjIedz-fk2JEvTgggEinVJnSRUUs,938
+pytest_eo/strict.py,sha256=u7eEN1RnRqRriO2Ww-AyWCnxWxkag5PwD0IPapDqy4I,3489
+pytest_eo/style_violations_error.py,sha256=Fz771ldN3Lpe-h3-kHMGdcfwmOFcX6ft16rnR9RoKJA,459
+pytest_eo/suppression_check.py,sha256=l1k-xPDX_HftKKDJu3IU1jdnpkqZ0DmHKc7GQw0qolU,1389
+pytest_eo/table.py,sha256=80-QnqaqBex_vWL_YvQXGQOL7voBfdJzkJPCFCyQZkg,304
+pytest_eo/text.py,sha256=67ZYl_CvJ6KkbPHuNoC64D56c77zY6_zAorpRSvPFgk,887
+pytest_eo/tool_failed_error.py,sha256=zKC7XtmckGG-kKgiZ4JCLkQEcjIRI4ChimTbD3l00BY,468
+pytest_eo/trial.py,sha256=Z3BSMwYsg1wsRmxX0hZgnf_33NlZAYjlT4vDMwa6Rsc,1160
+pytest_eo/verified.py,sha256=ViAUWHbenW_BTgEORFVcCwLBQBnwQkMIksB44QwDkB4,784
+pytest_eo/violation.py,sha256=JPgNLcHulIqCOT3hMu2c-GGr-UTk5vj-xR8exUk8Lh0,578
+pytest_eo/wide_suppressions.py,sha256=5qyiW8ioQmv2BTXf4dlrYP2I3uvyA7v2rLr_2KCozms,1367
+pytest_eo/config/flake8.ini,sha256=7AEG-U6qzQW2xl7FXHnmXgTDu0q9TIlgiP8SFEPz6Kg,1293
+pytest_eo/config/mypy.ini,sha256=dyih1DDGQx2NnTyVkdk2zEL9uf8LnlYA2hH9uIt-QtE,98
+pytest_eo/config/ruff.toml,sha256=aF6-MM1bUVd7PE_3mm53pj0U2XJXhbY0taxeYlU_BKU,1549
+pytest_eo-0.5.1.dist-info/METADATA,sha256=n_6gtwD0dB5nA1EVL-GdM9lOlm-AVKG-rWuWat_JGXE,7969
+pytest_eo-0.5.1.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+pytest_eo-0.5.1.dist-info/entry_points.txt,sha256=kz2JTYjRLRHI0I5pddKFDjgNY2odA956kHiq-HqqD0Y,166
+pytest_eo-0.5.1.dist-info/licenses/LICENSE.txt,sha256=6v7Og1usuuSqeiAL4u3DlOFfkGza0C98bFZFHKFWCO4,1063
+pytest_eo-0.5.1.dist-info/RECORD,,

pytest_eo-0.5.1.dist-info/WHEEL

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

pytest_eo-0.5.1.dist-info/entry_points.txt

@@ -0,0 +1,7 @@
+[flake8.extension]
+BOD = pytest_eo.bodies:Bodies
+ENC = pytest_eo.encapsulation:Encapsulation
+TST = pytest_eo.angry_tests:AngryTests
+
+[pytest11]
+eo = pytest_eo.plugin

pytest_eo-0.5.1.dist-info/licenses/LICENSE.txt

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