May 5, 2021 · Apr 27, 2021 · Apr 27, 2021 · Apr 28, 2021 · Apr 29, 2021 · Apr 29, 2021
diff --git a/tests/dataclass_transform_example.py b/tests/dataclass_transform_example.py
 from typing import Optional

 import attr


 @attr.define()
 class Define:
    a: str
    b: int


 reveal_type(Define.__init__)


 @attr.define()
 class DefineConverter:
    # mypy plugin adapts the "int" method signature, pyright does not
    with_converter: int = attr.field(converter=int)


 reveal_type(DefineConverter.__init__)


 # mypy plugin supports attr.frozen, pyright does not
 @attr.frozen()
 class Frozen:
    a: str


 d = Frozen("a")
 d.a = "new"

 reveal_type(d.a)

 # but pyright supports attr.define(frozen)
 @attr.define(frozen=True)
 class FrozenDefine:
    a: str


 d2 = FrozenDefine("a")
 d2.a = "new"

 reveal_type(d2.a)
diff --git a/tests/test_pyright.py b/tests/test_pyright.py
 import json
 import pathlib
 import shutil
 import subprocess
 import sys

 import pytest

 import attr


 if sys.version_info < (3, 6):
    _found_pyright = False
 else:
    _found_pyright = shutil.which("pyright")


 @attr.define(frozen=True)
 class PyrightDiagnostic:
    severity: str
    message: str


 @pytest.mark.skipif(not _found_pyright, reason="Requires pyright.")
 def test_pyright_baseline():
    test_file = (
        pathlib.Path(__file__).parent / "dataclass_transform_example.py"
    )

    pyright = subprocess.run(
        ["pyright", "--outputjson", str(test_file)], capture_output=True
    )
    pyright_result = json.loads(pyright.stdout)

    diagnostics = set(
        PyrightDiagnostic(d["severity"], d["message"])
        for d in pyright_result["generalDiagnostics"]
    )

    expected_diagnostics = {
        PyrightDiagnostic(
            severity="information",
            message='Type of "Define.__init__" is "(self: Define, a: str, b: int) -> None"',
        ),
        PyrightDiagnostic(
            severity="information",
            message='Type of "DefineConverter.__init__" is "(self: DefineConverter, with_converter: int) -> None"',
        ),
        PyrightDiagnostic(
            severity="information",
            message='Type of "d.a" is "Literal[\'new\']"',
        ),
        PyrightDiagnostic(
            severity="error",
            message='Cannot assign member "a" for type "FrozenDefine"\n\xa0\xa0"FrozenDefine" is frozen',
        ),
        PyrightDiagnostic(
            severity="information",
            message='Type of "d2.a" is "Literal[\'new\']"',
        ),
    }

    assert diagnostics == expected_diagnostics
diff --git a/tox.ini b/tox.ini
 commands =
    mypy src/attr/__init__.pyi src/attr/_version_info.pyi src/attr/converters.pyi src/attr/exceptions.pyi src/attr/filters.pyi src/attr/setters.pyi src/attr/validators.pyi
    mypy tests/typing_example.py


 [testenv:pyright]
 # Install and configure node and pyright
 # This *could* be folded into a custom install_command
 # Use nodeenv to configure node in the running tox virtual environment
 # Seeing errors using "nodeenv -p"
 # Use npm install -g to install "globally" into the virtual environment
 basepython = python3.8
 deps = nodeenv
 commands =
    nodeenv --prebuilt --node=lts --force {envdir}
    npm install -g --no-package-lock --no-save pyright@1.1.135
    pytest tests/test_pyright.py -vv
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,44 @@
		from typing import Optional

		import attr


		@attr.define()
		class Define:
		a: str
		b: int


		reveal_type(Define.__init__)


		@attr.define()
		class DefineConverter:
		# mypy plugin adapts the "int" method signature, pyright does not
		with_converter: int = attr.field(converter=int)


		reveal_type(DefineConverter.__init__)


		# mypy plugin supports attr.frozen, pyright does not
		@attr.frozen()
		class Frozen:
		a: str


		d = Frozen("a")
		d.a = "new"

		reveal_type(d.a)

		# but pyright supports attr.define(frozen)
		@attr.define(frozen=True)
		class FrozenDefine:
		a: str


		d2 = FrozenDefine("a")
		d2.a = "new"

		reveal_type(d2.a)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,63 @@
		import json
		import pathlib
		import shutil
		import subprocess
		import sys

		import pytest

		import attr


		if sys.version_info < (3, 6):
		_found_pyright = False
		else:
		_found_pyright = shutil.which("pyright")


		@attr.define(frozen=True)
		class PyrightDiagnostic:
		severity: str
		message: str


		@pytest.mark.skipif(not _found_pyright, reason="Requires pyright.")
		def test_pyright_baseline():
		test_file = (
		pathlib.Path(__file__).parent / "dataclass_transform_example.py"
		)

		pyright = subprocess.run(
		["pyright", "--outputjson", str(test_file)], capture_output=True
		)
		pyright_result = json.loads(pyright.stdout)

		diagnostics = set(
		PyrightDiagnostic(d["severity"], d["message"])
		for d in pyright_result["generalDiagnostics"]
		)

		expected_diagnostics = {
		PyrightDiagnostic(
		severity="information",
		message='Type of "Define.__init__" is "(self: Define, a: str, b: int) -> None"',
		),
		PyrightDiagnostic(
		severity="information",
		message='Type of "DefineConverter.__init__" is "(self: DefineConverter, with_converter: int) -> None"',
		),
		PyrightDiagnostic(
		severity="information",
		message='Type of "d.a" is "Literal[\'new\']"',
		),
		PyrightDiagnostic(
		severity="error",
		message='Cannot assign member "a" for type "FrozenDefine"\n\xa0\xa0"FrozenDefine" is frozen',
		),
		PyrightDiagnostic(
		severity="information",
		message='Type of "d2.a" is "Literal[\'new\']"',
		),
		}

		assert diagnostics == expected_diagnostics
Original file line number	Diff line number	Diff line change
Expand Up		@@ -121,3 +121,17 @@ deps = mypy>=0.800
		commands =
		mypy src/attr/__init__.pyi src/attr/_version_info.pyi src/attr/converters.pyi src/attr/exceptions.pyi src/attr/filters.pyi src/attr/setters.pyi src/attr/validators.pyi
		mypy tests/typing_example.py


		[testenv:pyright]
		# Install and configure node and pyright
		# This could be folded into a custom install_command
		# Use nodeenv to configure node in the running tox virtual environment
		# Seeing errors using "nodeenv -p"
		# Use npm install -g to install "globally" into the virtual environment
		basepython = python3.8
		deps = nodeenv
		commands =
		nodeenv --prebuilt --node=lts --force {envdir}
		npm install -g --no-package-lock --no-save pyright@1.1.135
		pytest tests/test_pyright.py -vv