pytest-revealtype-injector 0.7.1__py3-none-any.whl → 0.9.0__py3-none-any.whl

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.7.1"
+__version__ = "0.9.0"

pytest_revealtype_injector/adapter/mypy_.py

@@ -5,11 +5,11 @@ import importlib
 import json
 import pathlib
 import re
+import sys
 from collections.abc import (
     Iterable,
 )
 from typing import (
-    ForwardRef,
     Literal,
     TypedDict,
     cast,
@@ -27,6 +27,11 @@ from ..models import (
     VarType,
 )
 
+if sys.version_info >= (3, 14):
+    from annotationlib import ForwardRef
+else:
+    from typing import ForwardRef
+
 _logger = get_logger()
 
 

pytest_revealtype_injector/adapter/pyrefly_.py

@@ -8,12 +8,11 @@ import shutil
 import subprocess
 import sys
 from collections.abc import Iterable
-from typing import ForwardRef, Literal, TypedDict, cast
-
-if sys.version_info >= (3, 11):
-    from typing import TypedDict
-else:
-    from typing_extensions import TypedDict
+from typing import (
+    Literal,
+    TypedDict,
+    cast,
+)
 
 import schema as s
 
@@ -26,6 +25,16 @@ from ..models import (
     VarType,
 )
 
+if sys.version_info >= (3, 11):
+    from typing import TypedDict
+else:
+    from typing_extensions import TypedDict
+
+if sys.version_info >= (3, 14):
+    from annotationlib import ForwardRef
+else:
+    from typing import ForwardRef
+
 _logger = get_logger()
 
 
@@ -53,15 +62,16 @@ class NameCollector(BareNameCollector):
         # resolves to a pytest function or method
         return ast.Name(id=node.attr, ctx=node.ctx)
 
+
 class PyreflyAdapter(TypeCheckerAdapter):
     id = "pyrefly"
     _executable = "pyrefly"
-    _type_mesg_re = re.compile(r'revealed type: (?P<type>.+)')
+    _type_mesg_re = re.compile(r"revealed type: (?P<type>.+)")
     _namecollector_class = NameCollector
     _schema = s.Schema({
         "line": int,
         "column": int,
-        "stop_line": int,   
+        "stop_line": int,
         "stop_column": int,
         "path": str,
         "code": int,
@@ -90,13 +100,22 @@ class PyreflyAdapter(TypeCheckerAdapter):
         # of exit status
         if proc.returncode > 0:
             raise TypeCheckerError(
-                "{} error with exit code {}: {}".format(self.id, proc.returncode, proc.stderr.decode()), None, None)
+                "{} error with exit code {}: {}".format(
+                    self.id, proc.returncode, proc.stderr.decode()
+                ),
+                None,
+                None,
+            )
 
         try:
             report = json.loads(proc.stdout)
         except Exception as e:
-            raise TypeCheckerError(f"Failed to parse pyrefly JSON output: {e}", None, None) from e
-
+            # pyrefly (circa 0.47.0) appends github text formatted annotation at the end of json output
+            decoder = json.JSONDecoder()
+            report, _ = decoder.raw_decode(proc.stdout.decode())
+            _logger.warning(
+                f"({self.id}) failed to parse json output, extracted partial json: {e}"
+            )
         assert isinstance(report, dict) and "errors" in report
         items = cast(list[_PyreflyDiagItem], report["errors"])
 

pytest_revealtype_injector/adapter/pyright_.py

@@ -10,16 +10,10 @@ from collections.abc import (
     Iterable,
 )
 from typing import (
-    ForwardRef,
     Literal,
     cast,
 )
 
-if sys.version_info >= (3, 11):
-    from typing import NotRequired, TypedDict
-else:
-    from typing_extensions import NotRequired, TypedDict
-
 import schema as s
 
 from ..log import get_logger
@@ -31,6 +25,16 @@ from ..models import (
     VarType,
 )
 
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict
+else:
+    from typing_extensions import NotRequired, TypedDict
+
+if sys.version_info >= (3, 14):
+    from annotationlib import ForwardRef
+else:
+    from typing import ForwardRef
+
 _logger = get_logger()
 
 

pytest_revealtype_injector/adapter/ty_.py

@@ -63,7 +63,7 @@ class NameCollector(BareNameCollector):
 class TyAdapter(TypeCheckerAdapter):
     id = "ty"
     _executable = "ty"
-    _type_mesg_re = re.compile(r'Revealed type: `(?P<type>.+?)`')
+    _type_mesg_re = re.compile(r"Revealed type: `(?P<type>.+?)`")
     _namecollector_class = BareNameCollector
     _schema = s.Schema({
         "check_name": str,
@@ -78,8 +78,8 @@ class TyAdapter(TypeCheckerAdapter):
             "path": str,
             "positions": {
                 "begin": {"line": int, "column": int},
-                "end"  : {"line": int, "column": int},
-            }
+                "end": {"line": int, "column": int},
+            },
         },
     })
 
@@ -152,11 +152,12 @@ class TyAdapter(TypeCheckerAdapter):
             filename, lineno = (
                 pathlib.Path(diag["location"]["path"]).name,
                 diag["location"]["positions"]["begin"]["line"],
-            )            
+            )
             if (m := self._type_mesg_re.search(diag["description"])) is None:
                 continue
             pos = FilePos(filename, lineno)
             self.typechecker_result[pos] = VarType(None, ForwardRef(m["type"]))
 
+
 def generate_adapter() -> TypeCheckerAdapter:
-    return TyAdapter()
+    return TyAdapter()

pytest_revealtype_injector/hooks.py

@@ -20,20 +20,36 @@ def pytest_pyfunc_call(pyfuncitem: pytest.Function) -> Iterator[None]:
     assert pyfuncitem.module is not None
     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}
+    # Marker-based adapter filtering
+    notype_mark = pyfuncitem.get_closest_marker("notypechecker")
+    only_mark = pyfuncitem.get_closest_marker("onlytypechecker")
+
+    if notype_mark and only_mark:
+        pytest.fail(
+            "Cannot use both 'notypechecker' and 'onlytypechecker' markers on the same test."
+        )
+
+    if only_mark:
+        enabled_adapters = {a.id for a in adp_stash if a.id in only_mark.args}
+        for a in enabled_adapters:
+            _logger.info(
+                f"{a} adapter enabled by 'onlytypechecker' marker in {pyfuncitem.name} test"
+            )
+        adapters = {a for a in adp_stash if a.id in enabled_adapters}
+
+    elif notype_mark:
+        disabled_adapters = {a.id for a in adp_stash if a.id in notype_mark.args}
         for a in disabled_adapters:
             _logger.info(
                 f"{a} adapter disabled by 'notypechecker' marker in {pyfuncitem.name} test"
             )
         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.")
+        pytest.skip("No type checker is enabled for this test.")
 
     # Monkeypatch reveal_type() with our own function, to guarantee
     # each test func can receive different adapters
@@ -139,3 +155,10 @@ def pytest_configure(config: pytest.Config) -> None:
         "specified type checker(s). Following type checkers are supported: "
         + ", ".join(all_ids),
     )
+    # Marker to enable only specified adapters for a test
+    config.addinivalue_line(
+        "markers",
+        "onlytypechecker(name, ...): mark reveal_type() test to enable "
+        "only the specified type checker(s). Following type checkers are supported: "
+        + ", ".join(all_ids),
+    )

pytest_revealtype_injector/main.py

@@ -4,7 +4,6 @@ import pathlib
 import sys
 from typing import (
     Any,
-    ForwardRef,
     TypeVar,
 )
 
@@ -22,6 +21,12 @@ from .models import (
     VarType,
 )
 
+if sys.version_info >= (3, 14):
+    from annotationlib import ForwardRef
+else:
+    from typing import ForwardRef
+
+
 _T = TypeVar("_T")
 _logger = log.get_logger()
 

pytest_revealtype_injector/models.py

@@ -5,11 +5,11 @@ import ast
 import importlib
 import pathlib
 import re
+import sys
 from collections.abc import Iterable
 from typing import (
     Any,
     ClassVar,
-    ForwardRef,
     NamedTuple,
     TypeVar,
     cast,
@@ -21,6 +21,11 @@ from schema import Schema
 
 from .log import get_logger
 
+if sys.version_info >= (3, 14):
+    from annotationlib import ForwardRef
+else:
+    from typing import ForwardRef
+
 
 class FilePos(NamedTuple):
     file: str

{pytest_revealtype_injector-0.7.1.dist-info → pytest_revealtype_injector-0.9.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-revealtype-injector
-Version: 0.7.1
+Version: 0.9.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>
@@ -34,12 +34,17 @@ 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 (`basesdpyright`, `pyright` and `mypy`) and store `reveal_type` results.
+- Launch external static type checkers 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
 
-In short: install this plugin, create test functions which calls `reveal_type()` with variable or function return result, done.
+TL;DR:
+
+1. Install this plugin
+2. Install type checkers: `basedpyright`, `mypy`, `pyrefly`, `pyright`, `ty`
+    - Disable any unwanted with `--revealtype-disable-adapter=<ADAPTER>` pytest CLI option
+3. Create `pytest` functions which call `reveal_type()` with variable or function return result
 
 ### The longer story
 
@@ -78,9 +83,11 @@ import typing as typ  # or...
 from typing import reveal_type as rt
 ```
 
+To supply config file specific for certain type checker, use `--revealtype-<ADAPTER>-config=<FILE>` pytest CLI option. For example, `--revealtype-pyrefly-config=tests/pyrefly.toml` instructs pyrefly to use `pyrefly.toml` under `tests` folder to override project root config.
+
 ### Limitations
 
-But there are 3 caveats.
+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:
 
@@ -125,7 +132,15 @@ Module level:
 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.
+Conversely, it is possible to only turn on usage of specific type checkers with `onlytypechecker` marker and exclude all others:
+
+```python
+@pytest.mark.onlytypechecker("mypy")
+def test_for_mypy() -> None:
+    ......
+```
+
+Note that disabling all type checkers is disallowed, and such tests would be treated as failure. Disable the `reveal_type()` call instead.
 
 ## Logging
 

pytest_revealtype_injector-0.9.0.dist-info/RECORD

@@ -0,0 +1,18 @@
+pytest_revealtype_injector/__init__.py,sha256=xHdhFMEZ-16-efdImbsnZ6DlyFmSEs_AIKuo54vGvCI,211
+pytest_revealtype_injector/hooks.py,sha256=byWwZNiujxcKJra8cFfEfc51MRJmXIsECoAGMR8d9oA,5921
+pytest_revealtype_injector/log.py,sha256=Ptd3yp1H1GlUum6BAwHc9cdyeGmaY8XYf0jp6qJmG4M,418
+pytest_revealtype_injector/main.py,sha256=vXRtZ3ITY2FcUMzA4MFTXeOR33-qn0uTP1XNgaHP7ro,5771
+pytest_revealtype_injector/models.py,sha256=_Dpi4Y8rkThh8zIAf2RAzdF7sv0ldUnKdYMcp9IhPFA,6245
+pytest_revealtype_injector/plugin.py,sha256=fkI6yF0dFVba0jEikIrsRp1NUQd2ohWLq4x2lSvFyH0,211
+pytest_revealtype_injector/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pytest_revealtype_injector/adapter/__init__.py,sha256=8RvzccYXKBjj3718Io8_lqiL35O5mfHprKobwO8ioPI,762
+pytest_revealtype_injector/adapter/basedpyright_.py,sha256=8LX7GmJmg4OZ3LKO5WoQ7Ocub6Lxi3HTStIorMApzUA,466
+pytest_revealtype_injector/adapter/mypy_.py,sha256=NJAY5UGxVLoCznp1XRzaYG1eybI6URCbfvqzhO7GHpA,9427
+pytest_revealtype_injector/adapter/pyrefly_.py,sha256=c-n1R_5rseAI6xrdXrfZ8-_0vqlYhY0j7WORjJEnUdo,4607
+pytest_revealtype_injector/adapter/pyright_.py,sha256=Zz8RDlmpeUySH0xNnfn5K4PzrTxERtAuerdCqvRJwmU,4197
+pytest_revealtype_injector/adapter/ty_.py,sha256=wErCzMqFHNbKSUzfc_Wc3U_8lYNgYSxsa4YgFZDEBGI,4647
+pytest_revealtype_injector-0.9.0.dist-info/METADATA,sha256=EyYLEM2SWB5Og8EebKzRW7LuikseiPYbk0CcGWXeQxI,7574
+pytest_revealtype_injector-0.9.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+pytest_revealtype_injector-0.9.0.dist-info/entry_points.txt,sha256=UfOm7y3WQnOoGV1mgTMb42MI6iBRPIl88FJiAOnt6SY,74
+pytest_revealtype_injector-0.9.0.dist-info/licenses/COPYING.mit,sha256=IzYEFDIOECyuupg_B3O9FvgjnU9i4JtambpbleoYHdQ,1060
+pytest_revealtype_injector-0.9.0.dist-info/RECORD,,

pytest_revealtype_injector-0.7.1.dist-info/RECORD

@@ -1,18 +0,0 @@
-pytest_revealtype_injector/__init__.py,sha256=harACT0UENE1yOuofWYJrvZsXKjjQKWacY_O3Ha0Qbk,211
-pytest_revealtype_injector/hooks.py,sha256=ls6CK8BfZ0kr5YIRzTJ2e4NCGhDHYLf46JN_cqLassU,5036
-pytest_revealtype_injector/log.py,sha256=Ptd3yp1H1GlUum6BAwHc9cdyeGmaY8XYf0jp6qJmG4M,418
-pytest_revealtype_injector/main.py,sha256=k8B0plBAXolo994sfzQfpjGhytb6Vz3YRKa192s0x_s,5672
-pytest_revealtype_injector/models.py,sha256=cujU9GT5_khsFYqyeBxBhA5cmZKYoA1YmmheNSUO2R4,6136
-pytest_revealtype_injector/plugin.py,sha256=fkI6yF0dFVba0jEikIrsRp1NUQd2ohWLq4x2lSvFyH0,211
-pytest_revealtype_injector/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pytest_revealtype_injector/adapter/__init__.py,sha256=8RvzccYXKBjj3718Io8_lqiL35O5mfHprKobwO8ioPI,762
-pytest_revealtype_injector/adapter/basedpyright_.py,sha256=8LX7GmJmg4OZ3LKO5WoQ7Ocub6Lxi3HTStIorMApzUA,466
-pytest_revealtype_injector/adapter/mypy_.py,sha256=5J2SlbT78dS4KmMRted5RzYv5G7KGCbTH1JgJ_FkXHQ,9318
-pytest_revealtype_injector/adapter/pyrefly_.py,sha256=nJOUVl8SBuoOZbEj1vOuzRRsDG0kURSSKADBdd5sdV0,4165
-pytest_revealtype_injector/adapter/pyright_.py,sha256=7yYruxrom11m-g-qZTwhmmo3zTchRrNxB7YGv9bHMEA,4099
-pytest_revealtype_injector/adapter/ty_.py,sha256=fRkIj-xi0KzeJtP_RfmWIrNFFDDDH66mzV7OzuhXnUg,4658
-pytest_revealtype_injector-0.7.1.dist-info/METADATA,sha256=l15j6RO5_gF7W7GQST5U4EUTX32RsHLtJB25vWggzPE,6959
-pytest_revealtype_injector-0.7.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-pytest_revealtype_injector-0.7.1.dist-info/entry_points.txt,sha256=UfOm7y3WQnOoGV1mgTMb42MI6iBRPIl88FJiAOnt6SY,74
-pytest_revealtype_injector-0.7.1.dist-info/licenses/COPYING.mit,sha256=IzYEFDIOECyuupg_B3O9FvgjnU9i4JtambpbleoYHdQ,1060
-pytest_revealtype_injector-0.7.1.dist-info/RECORD,,