pytest-revealtype-injector 0.5.0__tar.gz → 0.6.0__tar.gz

{pytest_revealtype_injector-0.5.0 → pytest_revealtype_injector-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-revealtype-injector
-Version: 0.5.0
+Version: 0.6.0
 Summary: Pytest plugin for replacing reveal_type() calls inside test functions with static and runtime type checking result comparison, for confirming type annotation validity.
 Project-URL: homepage, https://github.com/abelcheung/pytest-revealtype-injector
 Author-email: Abel Cheung <abelcheung@gmail.com>
@@ -18,12 +18,10 @@ 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 :: 3.14
 Classifier: Topic :: Software Development :: Testing
 Classifier: Typing :: Typed
 Requires-Python: >=3.10
-Requires-Dist: basedpyright>=1.0
-Requires-Dist: mypy>=1.11.2
-Requires-Dist: pyright>=1.1
 Requires-Dist: pytest<9,>=7.0
 Requires-Dist: schema==0.7.7
 Requires-Dist: typeguard>=4.3
@@ -37,7 +35,7 @@ Description-Content-Type: text/markdown
 
 `pytest-revealtype-injector` is a `pytest` plugin for replacing [`reveal_type()`](https://docs.python.org/3/library/typing.html#typing.reveal_type) calls inside test functions as something more sophisticated. It does the following tasks in parallel:
 
-- Launch external static type checkers (`pyright` and `mypy`) and store `reveal_type` results.
+- Launch external static type checkers (`basesdpyright`, `pyright` and `mypy`) and store `reveal_type` results.
 - Use [`typeguard`](https://github.com/agronholm/typeguard) to verify the aforementioned static type checker result _really_ matches runtime code result.
 
 ## Usage
@@ -54,7 +52,17 @@ For using `reveal_type()` inside tests, there is no boiler plate code involved.
 from typing import reveal_type
 ```
 
-Just importing `typing` module is fine too (or import `typing_extensions` for Python 3.10, because `reveal_type()` is only available officially since 3.11):
+If you care about compatibility with older pythons, use:
+
+```python
+import sys
+if sys.version >= (3, 11):
+    from typing import reveal_type
+else:
+    from typing_extensions import reveal_type
+```
+
+Just importing `typing` (or `typing_extensions`) module is fine too:
 
 ```python
 import typing
@@ -64,7 +72,7 @@ def test_something():
     typing.reveal_type(x)  # typeguard fails here
 ```
 
-Since this plugin scans for `reveal_type()` for replacement under carpet, even `import ... as ...` syntax works too:
+Since this plugin scans for `reveal_type()` for replacement under carpet, even `import ... as ...` syntax works:
 
 ```python
 import typing as typ  # or...
@@ -73,7 +81,7 @@ from typing import reveal_type as rt
 
 ### Limitations
 
-But there are 2 caveats.
+But there are 3 caveats.
 
 1. This plugin only searches for global import in test files, so local import inside test function doesn't work. That means following code doesn't utilize this plugin at all:
 
@@ -84,7 +92,41 @@ def test_something():
     reveal_type(x)  # calls vanilla reveal_type()
 ```
 
-2. `reveal_type()` calls have to stay in a single line, without anything else. This limitation comes from using [`eval` mode in AST parsing](https://docs.python.org/3/library/ast.html#ast.Expression).
+2. `reveal_type()` calls have to stay within a single line, although you can use `reveal_type` result in assertion or other purpose:
+
+```python
+x = "1"
+assert reveal_type(str(int(x))) == x
+```
+
+3. This plugin does not enlist any type checker as dependency, because any of them can be optionally disabled with pytest marker (see below) or command line option. It is up to application or library authors to include suitable type checker(s) as dependency themselves.
+
+## Disable type checker with marker
+
+Using [pytest marker](https://docs.pytest.org/en/stable/example/markers.html), it is possible to disable usage of certain type checker for specific test. All 3 types of markers (function, class and module level) are supported.
+
+Function level:
+```python
+@pytest.mark.notypechecker("mypy")
+def test_something(self) -> None:
+    x = 1
+    reveal_type(x)
+```
+
+Class level:
+```python
+@pytest.mark.notypechecker("pyright")
+class TestSomething:
+    def test_foo(self) -> None:
+    ...
+```
+
+Module level:
+```python
+pytestmark = pytest.mark.notypechecker("basedpyright", "pyright")
+```
+
+Note that disabling all type checkers is disallowed, and such tests would be treated as `pytest.fail`. Disable the `reveal_type()` call instead.
 
 ## Logging
 

{pytest_revealtype_injector-0.5.0 → pytest_revealtype_injector-0.6.0}/README.md

@@ -5,7 +5,7 @@
 
 `pytest-revealtype-injector` is a `pytest` plugin for replacing [`reveal_type()`](https://docs.python.org/3/library/typing.html#typing.reveal_type) calls inside test functions as something more sophisticated. It does the following tasks in parallel:
 
-- Launch external static type checkers (`pyright` and `mypy`) and store `reveal_type` results.
+- Launch external static type checkers (`basesdpyright`, `pyright` and `mypy`) and store `reveal_type` results.
 - Use [`typeguard`](https://github.com/agronholm/typeguard) to verify the aforementioned static type checker result _really_ matches runtime code result.
 
 ## Usage
@@ -22,7 +22,17 @@ For using `reveal_type()` inside tests, there is no boiler plate code involved.
 from typing import reveal_type
 ```
 
-Just importing `typing` module is fine too (or import `typing_extensions` for Python 3.10, because `reveal_type()` is only available officially since 3.11):
+If you care about compatibility with older pythons, use:
+
+```python
+import sys
+if sys.version >= (3, 11):
+    from typing import reveal_type
+else:
+    from typing_extensions import reveal_type
+```
+
+Just importing `typing` (or `typing_extensions`) module is fine too:
 
 ```python
 import typing
@@ -32,7 +42,7 @@ def test_something():
     typing.reveal_type(x)  # typeguard fails here
 ```
 
-Since this plugin scans for `reveal_type()` for replacement under carpet, even `import ... as ...` syntax works too:
+Since this plugin scans for `reveal_type()` for replacement under carpet, even `import ... as ...` syntax works:
 
 ```python
 import typing as typ  # or...
@@ -41,7 +51,7 @@ from typing import reveal_type as rt
 
 ### Limitations
 
-But there are 2 caveats.
+But there are 3 caveats.
 
 1. This plugin only searches for global import in test files, so local import inside test function doesn't work. That means following code doesn't utilize this plugin at all:
 
@@ -52,7 +62,41 @@ def test_something():
     reveal_type(x)  # calls vanilla reveal_type()
 ```
 
-2. `reveal_type()` calls have to stay in a single line, without anything else. This limitation comes from using [`eval` mode in AST parsing](https://docs.python.org/3/library/ast.html#ast.Expression).
+2. `reveal_type()` calls have to stay within a single line, although you can use `reveal_type` result in assertion or other purpose:
+
+```python
+x = "1"
+assert reveal_type(str(int(x))) == x
+```
+
+3. This plugin does not enlist any type checker as dependency, because any of them can be optionally disabled with pytest marker (see below) or command line option. It is up to application or library authors to include suitable type checker(s) as dependency themselves.
+
+## Disable type checker with marker
+
+Using [pytest marker](https://docs.pytest.org/en/stable/example/markers.html), it is possible to disable usage of certain type checker for specific test. All 3 types of markers (function, class and module level) are supported.
+
+Function level:
+```python
+@pytest.mark.notypechecker("mypy")
+def test_something(self) -> None:
+    x = 1
+    reveal_type(x)
+```
+
+Class level:
+```python
+@pytest.mark.notypechecker("pyright")
+class TestSomething:
+    def test_foo(self) -> None:
+    ...
+```
+
+Module level:
+```python
+pytestmark = pytest.mark.notypechecker("basedpyright", "pyright")
+```
+
+Note that disabling all type checkers is disallowed, and such tests would be treated as `pytest.fail`. Disable the `reveal_type()` call instead.
 
 ## Logging
 

{pytest_revealtype_injector-0.5.0 → pytest_revealtype_injector-0.6.0}/pyproject.toml

@@ -16,9 +16,6 @@ license = 'MIT'
 license-files = ['COPYING*']
 dependencies = [
     'typing_extensions >= 4.0; python_version < "3.11"',
-    'mypy >= 1.11.2',
-    'pyright >= 1.1',
-    'basedpyright >= 1.0',
     'pytest >=7.0,<9',
     'typeguard >= 4.3',
     # schema with annotation support is still unreleased
@@ -50,6 +47,7 @@ classifiers = [
     'Programming Language :: Python :: 3.11',
     'Programming Language :: Python :: 3.12',
     'Programming Language :: Python :: 3.13',
+    'Programming Language :: Python :: 3.14',
     'Topic :: Software Development :: Testing',
     'Typing :: Typed',
 ]

{pytest_revealtype_injector-0.5.0 → pytest_revealtype_injector-0.6.0}/src/pytest_revealtype_injector/__init__.py

@@ -1,3 +1,3 @@
 """Pytest plugin for replacing reveal_type() calls inside test functions with static and runtime type checking result comparison, for confirming type annotation validity."""  # noqa: E501
 
-__version__ = "0.5.0"
+__version__ = "0.6.0"

{pytest_revealtype_injector-0.5.0 → pytest_revealtype_injector-0.6.0}/src/pytest_revealtype_injector/adapter/pyright_.py

@@ -53,6 +53,7 @@ class _PyrightDiagItem(TypedDict):
     range: _PyrightDiagRange
     rule: NotRequired[str]
 
+
 class NameCollector(NameCollectorBase):
     type_checker = "pyright"
     # Pre-register common used bare names from typing

{pytest_revealtype_injector-0.5.0 → pytest_revealtype_injector-0.6.0}/src/pytest_revealtype_injector/hooks.py

@@ -16,8 +16,22 @@ adapter_stash_key: pytest.StashKey[set[TypeCheckerAdapter]]
 
 def pytest_pyfunc_call(pyfuncitem: pytest.Function) -> None:
     assert pyfuncitem.module is not None
-    adapters = pyfuncitem.config.stash[adapter_stash_key].copy()
+    adp_stash = pyfuncitem.config.stash[adapter_stash_key]
 
+    # Disable type checker based on marker
+    mark = pyfuncitem.get_closest_marker("notypechecker")
+    if mark:
+        disabled_adapters = {a.id for a in adp_stash if a.id in mark.args}
+        for a in disabled_adapters:
+            _logger.info(f"{a} adapter disabled by 'notypechecker' marker")
+        adapters = {a for a in adp_stash if a.id not in disabled_adapters}
+    else:
+        adapters = {a for a in adp_stash}
+
+    if not adapters:
+        pytest.fail("All type checkers have been disabled.")
+
+    # Replace reveal_type() with our own function
     for name in dir(pyfuncitem.module):
         if name.startswith("__") or name.startswith("@py"):
             continue
@@ -54,6 +68,8 @@ def pytest_pyfunc_call(pyfuncitem: pytest.Function) -> None:
 
 def pytest_collection_finish(session: pytest.Session) -> None:
     files = {i.path for i in session.items}
+    if not files:
+        return
     for adp in session.config.stash[adapter_stash_key]:
         try:
             adp.run_typechecker_on(files)
@@ -86,13 +102,16 @@ def pytest_addoption(parser: pytest.Parser) -> None:
 
 
 def pytest_configure(config: pytest.Config) -> None:
+    # Globally disable adapters using command line options
     global adapter_stash_key
     adapter_stash_key = pytest.StashKey[set[TypeCheckerAdapter]]()
     config.stash[adapter_stash_key] = set()
     verbosity = config.get_verbosity(config.VERBOSITY_TEST_CASES)
     log.set_verbosity(verbosity)
     to_be_disabled = cast(list[str], config.getoption("revealtype_disable_adapter"))
+    all_ids: list[str] = []
     for klass in adapter.get_adapter_classes():
+        all_ids.append(klass.id)
         if klass.id in to_be_disabled:
             _logger.info(f"({klass.id}) adapter disabled with command line option")
             continue
@@ -100,3 +119,11 @@ def pytest_configure(config: pytest.Config) -> None:
         adp.set_config_file(config)
         adp.log_verbosity = verbosity
         config.stash[adapter_stash_key].add(adp)
+
+    # Marker to disable adapters on demand
+    config.addinivalue_line(
+        "markers",
+        "notypechecker(name, ...): mark reveal_type() test to disable "
+        "specified type checker(s). Following type checkers are supported: "
+        + ", ".join(all_ids),
+    )

{pytest_revealtype_injector-0.5.0 → pytest_revealtype_injector-0.6.0}/src/pytest_revealtype_injector/models.py

@@ -15,7 +15,7 @@ from typing import (
 )
 
 import pytest
-from _pytest.config import Notset
+from _pytest.config import Notset  # pyright: ignore[reportPrivateImportUsage]
 from schema import Schema
 
 from .log import get_logger

pytest_revealtype_injector-0.6.0/tests/test_marker.py

@@ -0,0 +1,109 @@
+from __future__ import annotations
+
+import pytest
+
+
+class TestFuncAndGlobalMarker:
+    PYPROJECT_TOML = """
+    [tool.pyright]
+    reportUnreachable = false
+    defineConstant = {"MYPY" = false}
+
+    [tool.mypy]
+    always_true = ["MYPY"]
+    """
+    TEST_CONTENT = """
+    import sys
+    import pytest
+    from typing import cast
+    if sys.version_info >= (3, 11):
+        from typing import reveal_type
+    else:
+        from typing_extensions import reveal_type
+
+    # pytestmark = pytest.mark.notypechecker('mypy')
+
+    # @pytest.mark.notypechecker('mypy')
+    def test_foo() -> None:
+        MYPY = False
+        if MYPY:
+            x = cast(str, 1)  # type: ignore[assignment]
+        else:
+            x = 1
+        reveal_type(x)
+    """
+
+    def test_vanilla(self, pytester: pytest.Pytester) -> None:
+        pytester.makeconftest("pytest_plugins = ['pytest_revealtype_injector.plugin']")
+        pytester.makepyprojecttoml(self.PYPROJECT_TOML)
+        pytester.makepyfile(  # pyright: ignore[reportUnknownMemberType]
+            self.TEST_CONTENT
+        )
+        result = pytester.runpytest("--tb=short", "-vv")
+        result.assert_outcomes(passed=0, failed=1)
+
+    def test_function_marker(self, pytester: pytest.Pytester) -> None:
+        pytester.makeconftest("pytest_plugins = ['pytest_revealtype_injector.plugin']")
+        pytester.makepyprojecttoml(self.PYPROJECT_TOML)
+        pytester.makepyfile(  # pyright: ignore[reportUnknownMemberType]
+            self.TEST_CONTENT.replace("# @pytest.mark", "@pytest.mark")
+        )
+        result = pytester.runpytest("--tb=short", "-vv")
+        result.assert_outcomes(passed=1, failed=0)
+
+    def test_global_marker(self, pytester: pytest.Pytester) -> None:
+        pytester.makeconftest("pytest_plugins = ['pytest_revealtype_injector.plugin']")
+        pytester.makepyprojecttoml(self.PYPROJECT_TOML)
+        pytester.makepyfile(  # pyright: ignore[reportUnknownMemberType]
+            self.TEST_CONTENT.replace("# pytestmark", "pytestmark")
+        )
+        result = pytester.runpytest("--tb=short", "-vv")
+        result.assert_outcomes(passed=1, failed=0)
+
+
+class TestClassMarker:
+    PYPROJECT_TOML = """
+    [tool.pyright]
+    reportUnreachable = false
+    defineConstant = {"MYPY" = false}
+
+    [tool.mypy]
+    always_true = ["MYPY"]
+    """
+    TEST_CONTENT = """
+    import sys
+    import pytest
+    from typing import cast
+    if sys.version_info >= (3, 11):
+        from typing import reveal_type
+    else:
+        from typing_extensions import reveal_type
+
+    # @pytest.mark.notypechecker('pyright', 'basedpyright')
+    class TestFoo:
+        def test_foo(self) -> None:
+            MYPY = False
+            if MYPY:
+                x = 1
+            else:
+                x = cast(str, 1)  # pyright: ignore[reportInvalidCast]
+            reveal_type(x)
+    """
+
+    def test_vanilla(self, pytester: pytest.Pytester) -> None:
+        pytester.makeconftest("pytest_plugins = ['pytest_revealtype_injector.plugin']")
+        pytester.makepyprojecttoml(self.PYPROJECT_TOML)
+        pytester.makepyfile(  # pyright: ignore[reportUnknownMemberType]
+            self.TEST_CONTENT
+        )
+        result = pytester.runpytest("--tb=short", "-vv")
+        result.assert_outcomes(passed=0, failed=1)
+
+    def test_marker_applied(self, pytester: pytest.Pytester) -> None:
+        pytester.makeconftest("pytest_plugins = ['pytest_revealtype_injector.plugin']")
+        pytester.makepyprojecttoml(self.PYPROJECT_TOML)
+        pytester.makepyfile(  # pyright: ignore[reportUnknownMemberType]
+            self.TEST_CONTENT.replace("# @pytest.mark", "@pytest.mark")
+        )
+        result = pytester.runpytest("--tb=short", "-vv")
+        result.assert_outcomes(passed=1, failed=0)