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

pytest_revealtype_injector-0.2.1/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/LICENSE → pytest_revealtype_injector-0.2.1/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 → pytest_revealtype_injector-0.2.1}/PKG-INFO

@@ -1,15 +1,16 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: pytest-revealtype-injector
-Version: 0.1.1
+Version: 0.2.1
 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.

{pytest_revealtype_injector-0.1.1 → pytest_revealtype_injector-0.2.1}/README.md

@@ -1,3 +1,8 @@
+![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.

{pytest_revealtype_injector-0.1.1 → pytest_revealtype_injector-0.2.1}/pyproject.toml

@@ -1,7 +1,8 @@
 #:schema https://json.schemastore.org/pyproject.json
 
 [build-system]
-requires = ['hatchling']
+# replace with 'hatchling >= 1.27.0' when things are sorted out
+requires = ['hatchling @ git+https://github.com/pypa/hatch.git@72d57279ac8fa58b1981734b58d55cf607e84656#subdirectory=backend']
 build-backend = 'hatchling.build'
 
 [project]
@@ -12,12 +13,15 @@ test functions with static and runtime type checking result comparison,
 for confirming type annotation validity."""
 readme = 'README.md'
 requires-python = '>=3.10'
-license = {text = 'MIT'}
+license = 'MIT'
+license-files = ['COPYING*']
 dependencies = [
     'mypy >= 1.11.2',
     'pyright ~= 1.1',
     'pytest >= 7.0',
-    'typeguard ~= 4.3'
+    'typeguard ~= 4.3',
+    # schema with annotation support is still unreleased
+    'schema == 0.7.7',
 ]
 keywords = [
     'pytest',
@@ -45,7 +49,6 @@ classifiers = [
     'Programming Language :: Python :: 3.11',
     'Programming Language :: Python :: 3.12',
     'Programming Language :: Python :: 3.13',
-    'License :: OSI Approved :: MIT License',
     'Topic :: Software Development :: Testing',
     'Typing :: Typed',
 ]
@@ -75,11 +78,13 @@ packages = ["src/pytest_revealtype_injector"]
 typeCheckingMode = 'strict'
 enableTypeIgnoreComments = false
 deprecateTypingAliases = true
+reportMissingTypeStubs = false
 
 [tool.mypy]
 mypy_path = "$MYPY_CONFIG_FILE_DIR/src"
 packages = "pytest_revealtype_injector"
 strict = true
+ignore_missing_imports = true
 
 [tool.ruff]
 target-version = "py312"
@@ -117,12 +122,12 @@ addopts = [
     "--tb=short",
     "--import-mode=importlib",
 ]
-markers = [
-    "slow: marks tests as slow",
-]
 testpaths = [
     "tests",
 ]
+pythonpath = [
+    "src",
+]
 
 # We only use version determination logic from python-semantic-release,
 # and never does any permanent change with it
@@ -132,5 +137,6 @@ major_on_zero = false  # switch on for 1.0.0
 
 [tool.semantic_release.changelog]
 exclude_commit_patterns = [
-    'Merge pull request #\d+ from',
+    '^Merge pull request #\d+ from',
+    '^(build|ci|style)(\(.+?\))?: ',
 ]

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

{pytest_revealtype_injector-0.1.1 → pytest_revealtype_injector-0.2.1}/src/pytest_revealtype_injector/adapter/mypy_.py

@@ -17,6 +17,7 @@ from typing import (
 
 import mypy.api
 import pytest
+import schema as s
 
 from ..models import (
     FilePos,
@@ -124,6 +125,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 +162,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():
-            # TODO Mypy json schema validation
-            diag = cast(_MypyDiagObj, json.loads(line))
+            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":

{pytest_revealtype_injector-0.1.1 → pytest_revealtype_injector-0.2.1}/src/pytest_revealtype_injector/adapter/pyright_.py

@@ -11,9 +11,13 @@ from collections.abc import (
 from typing import (
     Any,
     ForwardRef,
+    Literal,
+    TypedDict,
+    cast,
 )
 
 import pytest
+import schema as s
 
 from ..models import (
     FilePos,
@@ -27,6 +31,21 @@ _logger = logging.getLogger(__name__)
 _logger.setLevel(logging.INFO)
 
 
+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):
     # Pyright inferred type results always contain bare names only,
     # so don't need to bother with visit_Attribute()
@@ -47,6 +66,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 +101,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-0.1.1 → pytest_revealtype_injector-0.2.1}/src/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.2.1/tests/conftest.py

@@ -0,0 +1 @@
+pytest_plugins = ["pytester"]

pytest_revealtype_injector-0.2.1/tests/test_basic.py

@@ -0,0 +1,31 @@
+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)