pytest-revealtype-injector 0.2.1__tar.gz → 0.2.2__tar.gz

{pytest_revealtype_injector-0.2.1 → pytest_revealtype_injector-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-revealtype-injector
-Version: 0.2.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>
@@ -84,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.1 → pytest_revealtype_injector-0.2.2}/README.md

@@ -54,6 +54,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.1 → pytest_revealtype_injector-0.2.2}/pyproject.toml

@@ -1,8 +1,7 @@
 #:schema https://json.schemastore.org/pyproject.json
 
 [build-system]
-# replace with 'hatchling >= 1.27.0' when things are sorted out
-requires = ['hatchling @ git+https://github.com/pypa/hatch.git@72d57279ac8fa58b1981734b58d55cf607e84656#subdirectory=backend']
+requires = ['hatchling ~= 1.27']
 build-backend = 'hatchling.build'
 
 [project]

{pytest_revealtype_injector-0.2.1 → pytest_revealtype_injector-0.2.2}/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.2.1"
+__version__ = "0.2.2"

{pytest_revealtype_injector-0.2.1 → pytest_revealtype_injector-0.2.2}/src/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 (
@@ -19,6 +18,7 @@ import mypy.api
 import pytest
 import schema as s
 
+from ..log import get_logger
 from ..models import (
     FilePos,
     NameCollectorBase,
@@ -27,8 +27,7 @@ from ..models import (
     VarType,
 )
 
-_logger = logging.getLogger(__name__)
-_logger.setLevel(logging.INFO)
+_logger = get_logger()
 
 
 class _MypyDiagObj(TypedDict):
@@ -68,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
@@ -101,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}"')
@@ -162,6 +166,8 @@ 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():
+            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
@@ -210,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-0.2.1 → pytest_revealtype_injector-0.2.2}/src/pytest_revealtype_injector/adapter/pyright_.py

@@ -1,6 +1,5 @@
 import ast
 import json
-import logging
 import pathlib
 import re
 import shutil
@@ -19,6 +18,7 @@ from typing import (
 import pytest
 import schema as s
 
+from ..log import get_logger
 from ..models import (
     FilePos,
     NameCollectorBase,
@@ -27,8 +27,7 @@ from ..models import (
     VarType,
 )
 
-_logger = logging.getLogger(__name__)
-_logger.setLevel(logging.INFO)
+_logger = get_logger()
 
 
 class _PyrightDiagPosition(TypedDict):
@@ -55,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
 

{pytest_revealtype_injector-0.2.1 → pytest_revealtype_injector-0.2.2}/src/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-0.2.2/src/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-0.2.1 → pytest_revealtype_injector-0.2.2}/src/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-0.2.2/tests/test_basic.py

@@ -0,0 +1,91 @@
+import pytest
+
+
+def test_basic(pytester: pytest.Pytester) -> None:
+    pytester.makeconftest(
+        "pytest_plugins = ['pytest_revealtype_injector.plugin']"
+    )
+
+    pytester.makepyfile(  # pyright: ignore[reportUnknownMemberType]
+        """
+        import sys
+        import pytest
+        from typeguard import TypeCheckError
+
+        if sys.version_info >= (3, 11):
+            from typing import reveal_type
+        else:
+            from typing_extensions import reveal_type
+
+        def test_inferred():
+            x = 1
+            reveal_type(x)
+
+        def test_bad_inline_hint():
+            x: str = 1  # type: ignore  # pyright: ignore
+            with pytest.raises(TypeCheckError, match='is not an instance of str'):
+                reveal_type(x)
+        """
+    )
+    result = pytester.runpytest()
+    result.assert_outcomes(passed=2)
+
+
+def test_import_as(pytester: pytest.Pytester) -> None:
+    pytester.makeconftest(
+        "pytest_plugins = ['pytest_revealtype_injector.plugin']"
+    )
+
+    pytester.makepyfile(  # pyright: ignore[reportUnknownMemberType]
+        """
+        import sys
+        import pytest
+        from typeguard import TypeCheckError
+
+        if sys.version_info >= (3, 11):
+            from typing import reveal_type as rt
+        else:
+            from typing_extensions import reveal_type as rt
+
+        def test_inferred():
+            x = 1
+            rt(x)
+
+        def test_bad_inline_hint():
+            x: str = 1  # type: ignore  # pyright: ignore
+            with pytest.raises(TypeCheckError, match='is not an instance of str'):
+                rt(x)
+        """
+    )
+    result = pytester.runpytest()
+    result.assert_outcomes(passed=2)
+
+
+def test_import_module_as(pytester: pytest.Pytester) -> None:
+    pytester.makeconftest(
+        "pytest_plugins = ['pytest_revealtype_injector.plugin']"
+    )
+
+    pytester.makepyfile(  # pyright: ignore[reportUnknownMemberType]
+        """
+        import sys
+        import pytest
+        from typeguard import TypeCheckError
+
+        if sys.version_info >= (3, 11):
+            import typing as t
+        else:
+            import typing_extensions as t
+
+        def test_inferred():
+            x = 1
+            t.reveal_type(x)
+
+        def test_bad_inline_hint():
+            x: str = 1  # type: ignore  # pyright: ignore
+            with pytest.raises(TypeCheckError, match='is not an instance of str'):
+                t.reveal_type(x)
+        """
+    )
+    result = pytester.runpytest()
+    result.assert_outcomes(passed=2)

pytest_revealtype_injector-0.2.1/tests/test_basic.py

@@ -1,31 +0,0 @@
-import pytest
-
-
-def test_basic(pytester: pytest.Pytester):
-    pytester.makeconftest(
-        "pytest_plugins = ['pytest_revealtype_injector.plugin']"
-    )
-
-    pytester.makepyfile(  # pyright: ignore[reportUnknownMemberType]
-        """
-        import sys
-        import pytest
-        from typeguard import TypeCheckError
-
-        if sys.version_info >= (3, 11):
-            from typing import reveal_type
-        else:
-            from typing_extensions import reveal_type
-
-        def test_inferred():
-            x = 1
-            reveal_type(x)
-
-        def test_bad_inline_hint():
-            x: str = 1  # type: ignore  # pyright: ignore
-            with pytest.raises(TypeCheckError, match='is not an instance of str'):
-                reveal_type(x)
-        """
-    )
-    result = pytester.runpytest()
-    result.assert_outcomes(passed=2)