pytest-revealtype-injector 0.1.1__py3-none-any.whl → 0.2.2__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.1.1"
+__version__ = "0.2.2"

pytest_revealtype_injector/adapter/mypy_.py

@@ -1,7 +1,6 @@
 import ast
 import importlib
 import json
-import logging
 import pathlib
 import re
 from collections.abc import (
@@ -17,7 +16,9 @@ from typing import (
 
 import mypy.api
 import pytest
+import schema as s
 
+from ..log import get_logger
 from ..models import (
     FilePos,
     NameCollectorBase,
@@ -26,8 +27,7 @@ from ..models import (
     VarType,
 )
 
-_logger = logging.getLogger(__name__)
-_logger.setLevel(logging.INFO)
+_logger = get_logger()
 
 
 class _MypyDiagObj(TypedDict):
@@ -67,7 +67,9 @@ class _NameCollector(NameCollectorBase):
         _ = self.visit(node.value)
 
         if resolved := getattr(self.collected[prefix], name, False):
-            self.collected[ast.unparse(node)] = resolved
+            code = ast.unparse(node)
+            self.collected[code] = resolved
+            _logger.debug(f"Mypy NameCollector resolved '{code}' as {resolved}")
             return node
 
         # For class defined in local scope, mypy just prepends test
@@ -100,10 +102,13 @@ class _NameCollector(NameCollectorBase):
             pass
         else:
             self.collected[name] = mod
+            _logger.debug(f"Mypy NameCollector resolved '{name}' as {mod}")
             return node
 
         if hasattr(self.collected["typing"], name):
-            self.collected[name] = getattr(self.collected["typing"], name)
+            obj = getattr(self.collected["typing"], name)
+            self.collected[name] = obj
+            _logger.debug(f"Mypy NameCollector resolved '{name}' as {obj}")
             return node
 
         raise NameError(f'Cannot resolve "{name}"')
@@ -124,6 +129,19 @@ class _MypyAdapter(TypeCheckerAdapter):
     id = "mypy"
     typechecker_result = {}
     _type_mesg_re = re.compile(r'^Revealed type is "(?P<type>.+?)"$')
+    _schema = s.Schema({
+        "file": str,
+        "line": int,
+        "column": int,
+        "message": str,
+        "hint": s.Or(str, s.Schema(None)),
+        "code": str,
+        "severity": s.Or(
+            s.Schema("note"),
+            s.Schema("warning"),
+            s.Schema("error"),
+        ),
+    })
 
     @classmethod
     def run_typechecker_on(cls, paths: Iterable[pathlib.Path]) -> None:
@@ -148,8 +166,10 @@ class _MypyAdapter(TypeCheckerAdapter):
         # So-called mypy json output is merely a line-by-line
         # transformation of plain text output into json object
         for line in stdout.splitlines():
-            # TODO Mypy json schema validation
-            diag = cast(_MypyDiagObj, json.loads(line))
+            if len(line) <= 2 or line[0] != "{":
+                continue
+            obj = json.loads(line)
+            diag = cast(_MypyDiagObj, cls._schema.validate(obj))
             filename = pathlib.Path(diag["file"]).name
             pos = FilePos(filename, diag["line"])
             if diag["severity"] != "note":
@@ -196,7 +216,6 @@ class _MypyAdapter(TypeCheckerAdapter):
 
     @classmethod
     def set_config_file(cls, config: pytest.Config) -> None:
-        # Mypy doesn't have a default config file
         if (path_str := config.option.revealtype_mypy_config) is None:
             _logger.info("Using default mypy configuration")
             return

pytest_revealtype_injector/adapter/pyright_.py

@@ -1,6 +1,5 @@
 import ast
 import json
-import logging
 import pathlib
 import re
 import shutil
@@ -11,10 +10,15 @@ from collections.abc import (
 from typing import (
     Any,
     ForwardRef,
+    Literal,
+    TypedDict,
+    cast,
 )
 
 import pytest
+import schema as s
 
+from ..log import get_logger
 from ..models import (
     FilePos,
     NameCollectorBase,
@@ -23,8 +27,22 @@ from ..models import (
     VarType,
 )
 
-_logger = logging.getLogger(__name__)
-_logger.setLevel(logging.INFO)
+_logger = get_logger()
+
+
+class _PyrightDiagPosition(TypedDict):
+    line: int
+    character: int
+
+class _PyrightDiagRange(TypedDict):
+    start: _PyrightDiagPosition
+    end: _PyrightDiagPosition
+
+class _PyrightDiagItem(TypedDict):
+    file: str
+    severity: Literal["information", "warning", "error"]
+    message: str
+    range: _PyrightDiagRange
 
 
 class _NameCollector(NameCollectorBase):
@@ -36,9 +54,12 @@ class _NameCollector(NameCollectorBase):
             eval(name, self._globalns, self._localns | self.collected)
         except NameError:
             for m in ("typing", "typing_extensions"):
-                if hasattr(self.collected[m], name):
-                    self.collected[name] = getattr(self.collected[m], name)
-                    return node
+                if not hasattr(self.collected[m], name):
+                    continue
+                obj = getattr(self.collected[m], name)
+                self.collected[name] = obj
+                _logger.debug(f"Pyright NameCollector resolved '{name}' as {obj}")
+                return node
             raise
         return node
 
@@ -47,6 +68,21 @@ class _PyrightAdapter(TypeCheckerAdapter):
     id = "pyright"
     typechecker_result = {}
     _type_mesg_re = re.compile('^Type of "(?P<var>.+?)" is "(?P<type>.+?)"$')
+    # We only care about diagnostic messages that contain type information.
+    # Metadata not specified here.
+    _schema = s.Schema({
+        "file": str,
+        "severity": s.Or(
+            s.Schema("information"),
+            s.Schema("warning"),
+            s.Schema("error"),
+        ),
+        "message": str,
+        "range": {
+            "start": {"line": int, "character": int},
+            "end": {"line": int, "character": int},
+        },
+    })
 
     @classmethod
     def run_typechecker_on(cls, paths: Iterable[pathlib.Path]) -> None:
@@ -67,22 +103,17 @@ class _PyrightAdapter(TypeCheckerAdapter):
         if len(proc.stderr):
             raise TypeCheckerError(proc.stderr.decode(), None, None)
 
-        # TODO Pyright json schema validation
         report = json.loads(proc.stdout)
-        if proc.returncode:
-            for diag in report["generalDiagnostics"]:
-                if diag["severity"] != "error":
-                    continue
-                # Pyright report lineno is 0-based,
-                # OTOH python frame lineno is 1-based
-                lineno = diag["range"]["start"]["line"] + 1
-                filename = pathlib.Path(diag["file"]).name
-                raise TypeCheckerError(diag["message"], filename, lineno)
-        for diag in report["generalDiagnostics"]:
-            if diag["severity"] != "information":
+        for item in report["generalDiagnostics"]:
+            diag = cast(_PyrightDiagItem, cls._schema.validate(item))
+            if diag["severity"] != ("error" if proc.returncode else "information"):
                 continue
+            # Pyright report lineno is 0-based, while
+            # python frame lineno is 1-based
             lineno = diag["range"]["start"]["line"] + 1
             filename = pathlib.Path(diag["file"]).name
+            if proc.returncode:
+                raise TypeCheckerError(diag["message"], filename, lineno)
             if (m := cls._type_mesg_re.match(diag["message"])) is None:
                 continue
             pos = FilePos(filename, lineno)

pytest_revealtype_injector/hooks.py

@@ -1,15 +1,13 @@
 from __future__ import annotations
 
 import inspect
-import logging
 
 import pytest
 
-from . import adapter
+from . import adapter, log
 from .main import revealtype_injector
 
-_logger = logging.getLogger(__name__)
-_logger.setLevel(logging.INFO)
+_logger = log.get_logger()
 
 
 def pytest_pyfunc_call(pyfuncitem: pytest.Function) -> None:
@@ -65,6 +63,7 @@ def pytest_addoption(parser: pytest.Parser) -> None:
 
 
 def pytest_configure(config: pytest.Config) -> None:
+    _logger.setLevel(config.get_verbosity(config.VERBOSITY_TEST_CASES))
     # Forget config stash, it can't store collection of unserialized objects
     for adp in adapter.discovery():
         if config.option.revealtype_disable_adapter == adp.id:

pytest_revealtype_injector/log.py

@@ -0,0 +1,19 @@
+import logging
+
+LOGGER_NAME = "revealtype-injector"
+
+_logger = logging.getLogger(LOGGER_NAME)
+
+# Mapping of pytest.Config.VERBOSITY_TEST_CASES to logging levels
+_verbosity_map = {
+    0: logging.WARNING,
+    1: logging.INFO,
+    2: logging.DEBUG,
+}
+
+def get_logger() -> logging.Logger:
+    return _logger
+
+
+def set_verbosity(verbosity: int) -> None:
+    _logger.setLevel(_verbosity_map.get(verbosity, logging.DEBUG))

pytest_revealtype_injector/main.py

@@ -1,6 +1,5 @@
 import ast
 import inspect
-import logging
 import pathlib
 import sys
 from typing import (
@@ -15,7 +14,7 @@ from typeguard import (
     check_type_internal,
 )
 
-from . import adapter
+from . import adapter, log
 from .models import (
     FilePos,
     TypeCheckerError,
@@ -24,8 +23,7 @@ from .models import (
 
 _T = TypeVar("_T")
 
-_logger = logging.getLogger(__name__)
-_logger.setLevel(logging.WARN)
+_logger = log.get_logger()
 
 
 class RevealTypeExtractor(ast.NodeVisitor):
@@ -42,8 +40,15 @@ class RevealTypeExtractor(ast.NodeVisitor):
 
 
 def _get_var_name(frame: inspect.Traceback) -> str | None:
+    filename = pathlib.Path(frame.filename)
+    if not filename.exists():
+        _logger.warning(
+            f"Stack frame points to file '{filename}' "
+            "which doesn't exist on local system."
+        )
     ctxt, idx = frame.code_context, frame.index
-    assert ctxt is not None and idx is not None
+    assert ctxt is not None
+    assert idx is not None
     code = ctxt[idx].strip()
 
     walker = RevealTypeExtractor()
@@ -51,7 +56,9 @@ def _get_var_name(frame: inspect.Traceback) -> str | None:
     # as much restriction on test code as 'eval' mode does.
     walker.visit(ast.parse(code, mode="eval"))
     assert walker.target is not None
-    return ast.get_source_segment(code, walker.target)
+    result = ast.get_source_segment(code, walker.target)
+    _logger.debug(f"Extraction OK: {code=}, {result=}")
+    return result
 
 
 def revealtype_injector(var: _T) -> _T:
@@ -134,7 +141,8 @@ def revealtype_injector(var: _T) -> _T:
         try:
             check_type_internal(var, ref, memo)
         except TypeCheckError as e:
-            e.args = (f"({adp.id}) " + e.args[0],) + e.args[1:]
+            # Only args[0] contains message
+            e.args = (e.args[0] + f" (from {adp.id})",) + e.args[1:]
             raise
 
     return var

pytest_revealtype_injector/models.py

@@ -15,6 +15,7 @@ from typing import (
 )
 
 import pytest
+from schema import Schema
 
 
 class FilePos(NamedTuple):
@@ -91,6 +92,7 @@ class TypeCheckerAdapter:
     # {('file.py', 10): ('var_name', 'list[str]'), ...}
     typechecker_result: ClassVar[dict[FilePos, VarType]]
     _type_mesg_re: ClassVar[re.Pattern[str]]
+    _schema: ClassVar[Schema]
 
     @classmethod
     @abc.abstractmethod

{pytest_revealtype_injector-0.1.1.dist-info → pytest_revealtype_injector-0.2.2.dist-info}/METADATA

@@ -1,15 +1,16 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: pytest-revealtype-injector
-Version: 0.1.1
+Version: 0.2.2
 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>
-License: MIT
+License-Expression: MIT
+License-File: COPYING
+License-File: COPYING.mit
 Keywords: annotation,dynamic-typing,pytest,reveal_type,static-typing,stub,stubs,type-checking,types,typing
 Classifier: Development Status :: 4 - Beta
 Classifier: Framework :: Pytest
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
@@ -23,9 +24,15 @@ Requires-Python: >=3.10
 Requires-Dist: mypy>=1.11.2
 Requires-Dist: pyright~=1.1
 Requires-Dist: pytest>=7.0
+Requires-Dist: schema==0.7.7
 Requires-Dist: typeguard~=4.3
 Description-Content-Type: text/markdown
 
+![PyPI - Version](https://img.shields.io/pypi/v/pytest-revealtype-injector)
+![GitHub Release Date](https://img.shields.io/github/release-date/abelcheung/pytest-revealtype-injector)
+![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fgithub.com%2Fabelcheung%2Fpytest-revealtype-injector%2Fraw%2Frefs%2Fheads%2Fmain%2Fpyproject.toml)
+![PyPI - Wheel](https://img.shields.io/pypi/wheel/pytest-revealtype-injector)
+
 `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.
@@ -77,6 +84,31 @@ def test_something():
 
 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).
 
+## Logging
+
+This plugin uses standard [`logging`](https://docs.python.org/3/library/logging.html) internally. `pytest -v` can be used to reveal `INFO` and `DEBUG` logs. Given following example:
+
+```python
+def test_superfluous(self) -> None:
+    x: list[str] = ['a', 'b', 'c', 1]  # type: ignore  # pyright: ignore
+    reveal_type(x)
+```
+
+Something like this will be shown as test result:
+
+```
+...
+    raise TypeCheckError(f"is not an instance of {qualified_name(origin_type)}")
+E   typeguard.TypeCheckError: item 3 is not an instance of str (from pyright)
+------------------------------------------------------------- Captured log call -------------------------------------------------------------
+INFO     revealtype-injector:hooks.py:26 Replaced reveal_type() from global import with <function revealtype_injector at 0x00000238DB923D00>
+DEBUG    revealtype-injector:main.py:60 Extraction OK: code='reveal_type(x)', result='x'
+========================================================== short test summary info ==========================================================
+FAILED tests/runtime/test_attrib.py::TestAttrib::test_superfluous - typeguard.TypeCheckError: item 3 is not an instance of str (from pyright)
+============================================================= 1 failed in 3.38s =============================================================
+```
+
+
 ## History
 
 This pytest plugin starts its life as part of testsuite related utilities within [`types-lxml`](https://github.com/abelcheung/types-lxml). As `lxml` is a `cython` project and probably never incorporate inline python annotation in future, there is need to compare runtime result to static type checker output for discrepancy. As time goes by, it starts to make sense to manage as an independent project.

pytest_revealtype_injector-0.2.2.dist-info/RECORD

@@ -0,0 +1,16 @@
+pytest_revealtype_injector/__init__.py,sha256=3zGbYqpjy1u4__CnFV56_VB1fSpZ1LPbOgsI35Vfpz8,211
+pytest_revealtype_injector/hooks.py,sha256=cj1iXJJrVtqylXvvdLfjZ61HGBt5wsGBUe-iAgu9WiU,2434
+pytest_revealtype_injector/log.py,sha256=U9IvsoZzhFQcdFmVtuSmt2OTYxxFuIP5o321dyE4hiA,417
+pytest_revealtype_injector/main.py,sha256=ftTxEY13fNCY7Z3_oPvh38OtHQzqmxYAYnyzzgit29w,4786
+pytest_revealtype_injector/models.py,sha256=XsxUQGdv1U4CFi1bB1VeEojPpiwCZp7uxRIWuTGhIaM,3214
+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=wQg3Ply0Xrfe9US_lzgqRgKFE89ZBvDFti6_77X_NKk,339
+pytest_revealtype_injector/adapter/mypy_.py,sha256=q-stxOY2bffTAm2SoHiCAb7VA_f9jXc4UxlyimXV-RY,8840
+pytest_revealtype_injector/adapter/pyright_.py,sha256=fn8lE0G3ZeRANH6xKpizDOEXyH8a9yHHYdLCgMSsiFg,4857
+pytest_revealtype_injector-0.2.2.dist-info/METADATA,sha256=JXyzhgJp_UwveDqAvKDIWeFkJcdFv5lEEUrKS4I8A2o,5520
+pytest_revealtype_injector-0.2.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pytest_revealtype_injector-0.2.2.dist-info/entry_points.txt,sha256=UfOm7y3WQnOoGV1mgTMb42MI6iBRPIl88FJiAOnt6SY,74
+pytest_revealtype_injector-0.2.2.dist-info/licenses/COPYING,sha256=LSYUX8PcSMvHCkhM5oi07eOrSLV89qdEJ-FVZmbcpNE,355
+pytest_revealtype_injector-0.2.2.dist-info/licenses/COPYING.mit,sha256=IzYEFDIOECyuupg_B3O9FvgjnU9i4JtambpbleoYHdQ,1060
+pytest_revealtype_injector-0.2.2.dist-info/RECORD,,

{pytest_revealtype_injector-0.1.1.dist-info → pytest_revealtype_injector-0.2.2.dist-info}/WHEEL

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

pytest_revealtype_injector-0.2.2.dist-info/licenses/COPYING

@@ -0,0 +1,6 @@
+pytest-revealtype-injector is released under MIT license (see COPYING.mit).
+
+Original source code comes from part of types-lxml project, which is
+release under Apache-2.0 license. But as the sole author of all source
+code inside this repository, it is at my own discretion to follow pytest
+license because this project is taking shape as a pytest plugin.

pytest_revealtype_injector-0.1.1.dist-info/licenses/LICENSE → pytest_revealtype_injector-0.2.2.dist-info/licenses/COPYING.mit

@@ -1,4 +1,4 @@
-Copyright (c) 2023-2025 Abel Cheung
+Copyright (c) 2023-2024 Abel Cheung
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -17,13 +17,3 @@ 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.
-
-
----------------------
-
-pytest-revealtype-injector is released under MIT license (see above).
-
-Original source code comes from part of types-lxml project, which is released
-under Apache-2.0 license. But as the sole author of all relevant source code, it
-is at my own discretion to follow pytest license because this project is taking
-form of a pytest plugin.

pytest_revealtype_injector-0.1.1.dist-info/RECORD

@@ -1,14 +0,0 @@
-pytest_revealtype_injector/__init__.py,sha256=-sBG0VW8hqWI1JUSqzgJ6M0nptG5OWWQw9dzjnVpRQ8,211
-pytest_revealtype_injector/hooks.py,sha256=5V2r19I47xQtCDd8ZAzXlqt3nYaBZ4CaMAyGP6w_Y0k,2414
-pytest_revealtype_injector/main.py,sha256=dBlXcGc2NBcEHp0YX75Bp4Q7KY-t1oxlmPQS6o08U24,4490
-pytest_revealtype_injector/models.py,sha256=hWo9Oz2ausmht-QpfMTTiCtdE3980IA2KEuch7mo_jk,3158
-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=wQg3Ply0Xrfe9US_lzgqRgKFE89ZBvDFti6_77X_NKk,339
-pytest_revealtype_injector/adapter/mypy_.py,sha256=qXZKppEwPYtCcRVBAvg8cLx2heI673w8cT9VftHNU_c,8237
-pytest_revealtype_injector/adapter/pyright_.py,sha256=SEibrnMa0AAa1M3S4BmwEQ7ZgwQEUttsFOi-GWCrisA,4105
-pytest_revealtype_injector-0.1.1.dist-info/METADATA,sha256=ZNYRvvNfc1Hm5LAPyUvPcJWmqHqdFQxlQwviUovZJAE,3649
-pytest_revealtype_injector-0.1.1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-pytest_revealtype_injector-0.1.1.dist-info/entry_points.txt,sha256=UfOm7y3WQnOoGV1mgTMb42MI6iBRPIl88FJiAOnt6SY,74
-pytest_revealtype_injector-0.1.1.dist-info/licenses/LICENSE,sha256=nLEPjqH24l4RByIq0dHIFhblIpcxpDrRX7sT3lBNoeM,1420
-pytest_revealtype_injector-0.1.1.dist-info/RECORD,,