# SPDX-License-Identifier: MIT from __future__ import annotations import json import shutil import subprocess from pathlib import Path import pytest pytestmark = [ pytest.mark.skipif( shutil.which("pyright") is None, reason="Requires pyright." ), ] def parse_pyright_output(test_file: Path) -> set[tuple[str, str]]: pyright = subprocess.run( # noqa: PLW1510 ["pyright", "--outputjson", str(test_file)], capture_output=True ) pyright_result = json.loads(pyright.stdout) # We use tuples instead of proper classes to get nicer diffs from pytest. return { (d["severity"], d["message"]) for d in pyright_result["generalDiagnostics"] } def test_pyright_baseline(): """ The typing.dataclass_transform decorator allows pyright to determine attrs decorated class types. """ test_file = Path(__file__).parent / "dataclass_transform_example.py" diagnostics = parse_pyright_output(test_file) expected_diagnostics = { ( "information", 'Type of "Define.__init__" is "(self: Define, a: str, b: int) -> None"', ), ( "information", 'Type of "DefineConverter.__init__" is ' '"(self: DefineConverter, with_converter: str | Buffer | ' 'SupportsInt | SupportsIndex | SupportsTrunc) -> None"', ), ( "error", 'Cannot assign to attribute "a" for class ' '"Frozen"\n\xa0\xa0"Frozen" is frozen\n\xa0\xa0\xa0\xa0' 'Attribute "__set__" is unknown', ), ( "information", 'Type of "d.a" is "Literal[\'new\']"', ), ( "error", 'Cannot assign to attribute "a" for class ' '"FrozenDefine"\n\xa0\xa0"FrozenDefine" is frozen\n\xa0\xa0\xa0\xa0' 'Attribute "__set__" is unknown', ), ( "information", 'Type of "d2.a" is "Literal[\'new\']"', ), ( "information", 'Type of "af.__init__" is "(_a: int) -> None"', ), } assert expected_diagnostics == diagnostics def test_pyright_attrsinstance_compat(tmp_path): """ Test that `AttrsInstance` is compatible with Pyright. """ test_pyright_attrsinstance_compat_path = ( tmp_path / "test_pyright_attrsinstance_compat.py" ) test_pyright_attrsinstance_compat_path.write_text( """\ import attrs # We can assign any old object to `AttrsInstance`. foo: attrs.AttrsInstance = object() reveal_type(attrs.AttrsInstance) """ ) diagnostics = parse_pyright_output(test_pyright_attrsinstance_compat_path) expected_diagnostics = { ( "information", 'Type of "attrs.AttrsInstance" is "type[AttrsInstance]"', ) } assert diagnostics == expected_diagnostics