Merge pull request #3216 from VWS-Python/codex/teach-ruff-beartype

Remove supported runtime-import suppressions

Author: adamtheturtle

newsfragments/3216.change.rst

@@ -0,0 +1 @@
+Remove supported inline type-checking comments by teaching Ruff about runtime-evaluated ``beartype`` annotations and postponing test annotations.

pyproject.toml

@@ -161,6 +161,7 @@ lint.flake8-tidy-imports.banned-api."operator.attrgetter".msg = "operator.attrge
 lint.flake8-tidy-imports.banned-api."typing.cast".msg = """\
     typing.cast is banned: use explicit type narrowing or a typed variable instead.\
     """
+lint.flake8-type-checking.runtime-evaluated-decorators = [ "beartype.beartype" ]
 lint.pydocstyle.convention = "google"
 lint.preview = true
 

src/vws/_async_vws_request.py

@@ -5,8 +5,8 @@
 from beartype import BeartypeConf, beartype
 from vws_auth_tools import authorization_header, rfc_1123_date
 
-from vws.response import Response  # noqa: TC001
-from vws.transports import AsyncTransport  # noqa: TC001
+from vws.response import Response
+from vws.transports import AsyncTransport
 
 
 @beartype(conf=BeartypeConf(is_pep484_tower=True))

src/vws/_model_targets.py

@@ -2,7 +2,7 @@
 
 import base64
 import json
-from collections.abc import Sequence  # noqa: TC003
+from collections.abc import Sequence
 from http import HTTPStatus
 from typing import Any
 
@@ -18,13 +18,13 @@
     UnknownModelTargetDatasetError,
 )
 from vws.exceptions.vws_exceptions import TooManyRequestsError
-from vws.model_target_datasets import (  # noqa: TC001
+from vws.model_target_datasets import (
     ModelTargetDatasetType,
     ModelTargetModel,
     ModelTargetView,
 )
 from vws.reports import ModelTargetDatasetStatusReport
-from vws.response import Response  # noqa: TC001
+from vws.response import Response
 
 OAUTH2_TOKEN_PATH = "/oauth2/token"  # noqa: S105
 OAUTH2_TOKEN_BODY = b"grant_type=client_credentials"

src/vws/_reco_counts.py

@@ -1,6 +1,6 @@
 """Internal helpers for the database reco counts report endpoints."""
 
-import calendar  # noqa: TC003
+import calendar
 import json
 from http import HTTPStatus
 
@@ -12,7 +12,7 @@
     RecoCountsReportNotReadyError,
 )
 from vws.reports import RecoCountsReport
-from vws.response import Response  # noqa: TC001
+from vws.response import Response
 
 
 @beartype(conf=BeartypeConf(is_pep484_tower=True))

src/vws/_vws_request.py

@@ -5,8 +5,8 @@
 from beartype import BeartypeConf, beartype
 from vws_auth_tools import authorization_header, rfc_1123_date
 
-from vws.response import Response  # noqa: TC001
-from vws.transports import Transport  # noqa: TC001
+from vws.response import Response
+from vws.transports import Transport
 
 
 @beartype(conf=BeartypeConf(is_pep484_tower=True))

src/vws/exceptions/model_target_exceptions.py

@@ -10,7 +10,7 @@
 from beartype import beartype
 
 from vws.reports import ModelTargetGenerationDetail
-from vws.response import Response  # noqa: TC001
+from vws.response import Response
 
 
 @beartype

src/vws/model_target_datasets.py

@@ -4,7 +4,7 @@
 https://developer.vuforia.com/library/vuforia-engine/web-api/model-target-web-api/.
 """
 
-from collections.abc import Sequence  # noqa: TC003
+from collections.abc import Sequence
 from dataclasses import dataclass
 from enum import StrEnum, unique
 

src/vws/reports.py

@@ -3,7 +3,7 @@
 import csv
 import datetime
 import io
-from collections.abc import Sequence  # noqa: TC003
+from collections.abc import Sequence
 from dataclasses import dataclass
 from enum import Enum, unique
 from typing import Any, Self

tests/conftest.py

@@ -1,10 +1,9 @@
 """Configuration, plugins and fixtures for `pytest`."""
 
+from __future__ import annotations
+
 import datetime
-import io  # noqa: TC003
-from collections.abc import AsyncGenerator, Generator  # noqa: TC003
-from pathlib import Path  # noqa: TC003
-from typing import BinaryIO, Literal
+from typing import TYPE_CHECKING, BinaryIO, Literal
 
 import pytest
 import pytest_asyncio
@@ -29,6 +28,11 @@
     ModelTargetView,
 )
 
+if TYPE_CHECKING:
+    import io
+    from collections.abc import AsyncGenerator, Generator
+    from pathlib import Path
+
 # The mock accepts one hard-coded pair of Model Target Web API OAuth2
 # credentials, which it does not expose.
 _MODEL_TARGET_CLIENT_ID = "client-id"