From 60326886de1d8fd3150fd46aa71ac766d709c8ae Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Fri, 29 Nov 2024 08:48:28 +0100 Subject: [PATCH] chore: Use specific rule codes when ignoring type issues --- pyproject.toml | 12 +++++------- scripts/check_async_docstrings.py | 2 +- scripts/fix_async_docstrings.py | 2 +- .../clients/resource_clients/actor_collection.py | 8 ++++---- .../resource_clients/actor_version_collection.py | 8 ++++---- .../clients/resource_clients/key_value_store.py | 6 +++--- .../clients/resource_clients/schedule_collection.py | 4 ++-- .../clients/resource_clients/webhook_collection.py | 4 ++-- 8 files changed, 22 insertions(+), 24 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 01a8b622..5df5626e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -38,9 +38,6 @@ keywords = [ "Issue Tracker" = "https://github.com/apify/apify-client-python/issues" "Repository" = "https://github.com/apify/apify-client-python" -# We use inclusive ordered comparison clauses for external packages intentionally in order to enhance SDK's -# compatibility with external packages. This decision was discussed in detail in the following PR: -# https://github.com/apify/apify-sdk-python/pull/154. [tool.poetry.dependencies] python = "^3.9" apify-shared = ">=1.1.2" @@ -82,7 +79,6 @@ ignore = [ "G004", # Logging statement uses f-string "ISC001", # This rule may cause conflicts when used with the formatter "FIX", # flake8-fixme - "PGH003", # Use specific rule codes when ignoring type issues "PLR0911", # Too many return statements "PLR0913", # Too many arguments in function definition "PLR0915", # Too many statements @@ -161,6 +157,11 @@ warn_unreachable = true warn_unused_ignores = true exclude = [] +[tool.basedpyright] +pythonVersion = "3.9" +typeCheckingMode = "standard" +include = ["scripts", "src", "tests"] + [tool.coverage.report] exclude_lines = [ "pragma: no cover", @@ -168,8 +169,5 @@ exclude_lines = [ "assert_never()", ] -[tool.basedpyright] -typeCheckingMode = "standard" - [tool.ipdb] context = 7 diff --git a/scripts/check_async_docstrings.py b/scripts/check_async_docstrings.py index fa8bc16b..1be2c90e 100755 --- a/scripts/check_async_docstrings.py +++ b/scripts/check_async_docstrings.py @@ -6,7 +6,7 @@ import sys from pathlib import Path -from redbaron import RedBaron # type: ignore +from redbaron import RedBaron # type: ignore[import-untyped] from utils import sync_to_async_docstring found_issues = False diff --git a/scripts/fix_async_docstrings.py b/scripts/fix_async_docstrings.py index 1b7aad4c..c3f7fc18 100755 --- a/scripts/fix_async_docstrings.py +++ b/scripts/fix_async_docstrings.py @@ -3,7 +3,7 @@ import re from pathlib import Path -from redbaron import RedBaron # type: ignore +from redbaron import RedBaron # type: ignore[import-untyped] from utils import sync_to_async_docstring # Get the directory of the source files diff --git a/src/apify_client/clients/resource_clients/actor_collection.py b/src/apify_client/clients/resource_clients/actor_collection.py index 14de9cab..f3660989 100644 --- a/src/apify_client/clients/resource_clients/actor_collection.py +++ b/src/apify_client/clients/resource_clients/actor_collection.py @@ -51,12 +51,12 @@ def create( description: str | None = None, seo_title: str | None = None, seo_description: str | None = None, - versions: list[dict] | None = None, # type: ignore + versions: list[dict] | None = None, # type: ignore[valid-type] restart_on_error: bool | None = None, is_public: bool | None = None, is_deprecated: bool | None = None, is_anonymously_runnable: bool | None = None, - categories: list[str] | None = None, # type: ignore + categories: list[str] | None = None, # type: ignore[valid-type] default_run_build: str | None = None, default_run_max_items: int | None = None, default_run_memory_mbytes: int | None = None, @@ -173,12 +173,12 @@ async def create( description: str | None = None, seo_title: str | None = None, seo_description: str | None = None, - versions: list[dict] | None = None, # type: ignore + versions: list[dict] | None = None, # type: ignore[valid-type] restart_on_error: bool | None = None, is_public: bool | None = None, is_deprecated: bool | None = None, is_anonymously_runnable: bool | None = None, - categories: list[str] | None = None, # type: ignore + categories: list[str] | None = None, # type: ignore[valid-type] default_run_build: str | None = None, default_run_max_items: int | None = None, default_run_memory_mbytes: int | None = None, diff --git a/src/apify_client/clients/resource_clients/actor_version_collection.py b/src/apify_client/clients/resource_clients/actor_version_collection.py index 1f82983c..52f353af 100644 --- a/src/apify_client/clients/resource_clients/actor_version_collection.py +++ b/src/apify_client/clients/resource_clients/actor_version_collection.py @@ -36,10 +36,10 @@ def create( *, version_number: str, build_tag: str | None = None, - env_vars: list[dict] | None = None, # type: ignore + env_vars: list[dict] | None = None, # type: ignore[valid-type] apply_env_vars_to_build: bool | None = None, source_type: ActorSourceType, - source_files: list[dict] | None = None, # type: ignore + source_files: list[dict] | None = None, # type: ignore[valid-type] git_repo_url: str | None = None, tarball_url: str | None = None, github_gist_url: str | None = None, @@ -107,10 +107,10 @@ async def create( *, version_number: str, build_tag: str | None = None, - env_vars: list[dict] | None = None, # type: ignore + env_vars: list[dict] | None = None, # type: ignore[valid-type] apply_env_vars_to_build: bool | None = None, source_type: ActorSourceType, - source_files: list[dict] | None = None, # type: ignore + source_files: list[dict] | None = None, # type: ignore[valid-type] git_repo_url: str | None = None, tarball_url: str | None = None, github_gist_url: str | None = None, diff --git a/src/apify_client/clients/resource_clients/key_value_store.py b/src/apify_client/clients/resource_clients/key_value_store.py index 97375cca..4b85b8eb 100644 --- a/src/apify_client/clients/resource_clients/key_value_store.py +++ b/src/apify_client/clients/resource_clients/key_value_store.py @@ -110,7 +110,7 @@ def get_record(self: KeyValueStoreClient, key: str, *, as_bytes: bool = False, a DeprecationWarning, stacklevel=2, ) - return self.stream_record(key) # type: ignore + return self.stream_record(key) # type: ignore[return-value] response = self.http_client.call( url=self._url(f'records/{key}'), @@ -120,7 +120,7 @@ def get_record(self: KeyValueStoreClient, key: str, *, as_bytes: bool = False, a return { 'key': key, - 'value': response._maybe_parsed_body, # type: ignore # noqa: SLF001 + 'value': response._maybe_parsed_body, # type: ignore[attr-defined] # noqa: SLF001 'content_type': response.headers['content-type'], } @@ -323,7 +323,7 @@ async def get_record(self: KeyValueStoreClientAsync, key: str) -> dict | None: return { 'key': key, - 'value': response._maybe_parsed_body, # type: ignore # noqa: SLF001 + 'value': response._maybe_parsed_body, # type: ignore[attr-defined] # noqa: SLF001 'content_type': response.headers['content-type'], } diff --git a/src/apify_client/clients/resource_clients/schedule_collection.py b/src/apify_client/clients/resource_clients/schedule_collection.py index b82ae9ed..c894dc9b 100644 --- a/src/apify_client/clients/resource_clients/schedule_collection.py +++ b/src/apify_client/clients/resource_clients/schedule_collection.py @@ -48,7 +48,7 @@ def create( is_enabled: bool, is_exclusive: bool, name: str | None = None, - actions: list[dict] | None = None, # type: ignore + actions: list[dict] | None = None, # type: ignore[valid-type] description: str | None = None, timezone: str | None = None, title: str | None = None, @@ -125,7 +125,7 @@ async def create( is_enabled: bool, is_exclusive: bool, name: str | None = None, - actions: list[dict] | None = None, # type: ignore + actions: list[dict] | None = None, # type: ignore[valid-type] description: str | None = None, timezone: str | None = None, title: str | None = None, diff --git a/src/apify_client/clients/resource_clients/webhook_collection.py b/src/apify_client/clients/resource_clients/webhook_collection.py index e5851dca..47d5c9f1 100644 --- a/src/apify_client/clients/resource_clients/webhook_collection.py +++ b/src/apify_client/clients/resource_clients/webhook_collection.py @@ -45,7 +45,7 @@ def list( def create( self: WebhookCollectionClient, *, - event_types: list[WebhookEventType], # type: ignore + event_types: list[WebhookEventType], # type: ignore[valid-type] request_url: str, payload_template: str | None = None, headers_template: str | None = None, @@ -132,7 +132,7 @@ async def list( async def create( self: WebhookCollectionClientAsync, *, - event_types: list[WebhookEventType], # type: ignore + event_types: list[WebhookEventType], # type: ignore[valid-type] request_url: str, payload_template: str | None = None, headers_template: str | None = None,