Enable more linting rules (#801)

Author: droserasprout

pdm.lock

@@ -86,7 +86,6 @@ dipdup = "dipdup.cli:cli"
 dev = [
     "black",
     "docker",
-    "isort",
     "mypy",
     "pprofile",
     "pytest",
@@ -104,12 +103,11 @@ dev = [
 ]
 
 [tool.pdm.scripts]
-_isort = "isort src tests scripts"
 _black = "black src tests scripts"
 _ruff = "ruff check --fix src tests scripts"
 _mypy = "mypy src tests scripts"
 all = { composite = ["fmt", "lint", "test"] }
-fmt = { composite = ["_isort", "_black"] }
+fmt = { composite = ["_black"] }
 lint = { composite = ["_ruff", "_mypy"] }
 test = "pytest --cov-report=term-missing --cov=dipdup --cov-report=xml -n auto -s -v tests"
 update = { shell = """
@@ -129,25 +127,27 @@ docs_build = "python scripts/docs.py --source docs --destination {args:../interf
 docs_serve = "python scripts/docs.py --source docs --destination {args:../interface}/content/docs --watch --serve"
 docs_watch = "python scripts/docs.py --source docs --destination {args:../interface}/content/docs --watch"
 docs_references = "python scripts/dump_references.py"
+fixme = "grep -r -e 'FIXME: ' -e 'TODO: ' -e 'type: ignore' -n src/dipdup --color"
 
 [tool.pdm.build.targets.wheel]
 packages = ["src/dipdup"]
 
-[tool.isort]
-line_length = 120
-force_single_line = true
-
 [tool.black]
 line-length = 120
 target-version = ["py311"]
 skip-string-normalization = true
 
 [tool.ruff]
 line-length = 120
-ignore = ["E402", "E501", "B905"]
+ignore = [
+    "E402",  # module level import not at top of file
+    "E501",  # line too long
+    "TCH001", # breaks our runtime Pydantic magic
+]
 target-version = "py311"
-extend-select = ["B", "C4", "PTH", "Q"]                                   # todo: G, RET, RUF, S, TCH
+extend-select = ["B", "C4", "FA", "G", "I", "PTH", "Q", "RET", "RUF", "TCH", "UP"]
 flake8-quotes = { inline-quotes = "single", multiline-quotes = "double" }
+isort = { force-single-line = true, known-first-party = ["dipdup"] }
 
 [tool.mypy]
 python_version = "3.11"

pyproject.toml

@@ -2,15 +2,15 @@
 import logging
 import re
 import time
+from collections.abc import Callable
+from collections.abc import Iterator
 from contextlib import ExitStack
 from contextlib import contextmanager
 from contextlib import suppress
 from pathlib import Path
 from shutil import rmtree
 from subprocess import Popen
 from typing import Any
-from typing import Callable
-from typing import Iterator
 
 import click
 from watchdog.events import EVENT_TYPE_CREATED
@@ -68,15 +68,15 @@ def on_modified(self, event: FileSystemEvent) -> None:
             dst_file.unlink(True)
             return
 
-        elif event.event_type not in (EVENT_TYPE_CREATED, EVENT_TYPE_MODIFIED, EVENT_TYPE_MOVED):
+        if event.event_type not in (EVENT_TYPE_CREATED, EVENT_TYPE_MODIFIED, EVENT_TYPE_MOVED):
             return
 
         src_file = self._source / src_file
         dst_file = (self._destination / src_file.relative_to(self._source)).resolve()
         # NOTE: Make sure the destination directory exists
         dst_file.parent.mkdir(parents=True, exist_ok=True)
 
-        _logger.info(f'`{src_file}` has been modified; copying')
+        _logger.info('`%s` has been modified; copying', src_file)
 
         try:
             if src_file.suffix in TEXT:
@@ -97,7 +97,7 @@ def callback(data: str) -> str:
         def replacer(match: re.Match[str]) -> str:
             # FIXME: Slices are not handled yet
             included_file = source / match.group(1).split(':')[0]
-            _logger.info(f'including `{included_file.name}`')
+            _logger.info('including `%s`', included_file.name)
             return included_file.read_text()
 
         return re.sub(INCLUDE_REGEX, replacer, data)

scripts/docs.py

@@ -3,6 +3,8 @@
 import atexit
 import logging
 import sys
+from collections.abc import Awaitable
+from collections.abc import Callable
 from contextlib import AsyncExitStack
 from contextlib import suppress
 from copy import copy
@@ -11,8 +13,6 @@
 from pathlib import Path
 from typing import TYPE_CHECKING
 from typing import Any
-from typing import Awaitable
-from typing import Callable
 from typing import TypeVar
 from typing import cast
 
@@ -28,14 +28,18 @@
 from dipdup.report import save_report
 from dipdup.sys import set_up_process
 
+if TYPE_CHECKING:
+    from dipdup.config import DipDupConfig
+
+
 _click_wrap_text = click.formatting.wrap_text
 
 
 def _wrap_text(text: str, *a: Any, **kw: Any) -> str:
     # NOTE: WELCOME_ASCII and EPILOG
-    if text.startswith(('    ')):
+    if text.startswith('    '):
         return text
-    if text.startswith(('\0\n')):
+    if text.startswith('\0\n'):
         return text[2:]
     return _click_wrap_text(text, *a, **kw)
 
@@ -60,8 +64,6 @@ def _wrap_text(text: str, *a: Any, **kw: Any) -> str:
     'wipe',
 }
 
-if TYPE_CHECKING:
-    from dipdup.config import DipDupConfig
 
 _logger = logging.getLogger(__name__)
 
@@ -218,7 +220,7 @@ async def cli(ctx: click.Context, config: list[str], env_file: list[str]) -> Non
 
     # NOTE: Fire and forget, do not block instant commands
     if not any((_config.advanced.skip_version_check, env.TEST, env.CI)):
-        asyncio.ensure_future(_check_version())
+        _ = asyncio.ensure_future(_check_version())
 
     try:
         # NOTE: Avoid early import errors if project package is incomplete.
@@ -242,7 +244,6 @@ async def run(ctx: click.Context) -> None:
 
     Execution can be gracefully interrupted with `Ctrl+C` or `SIGINT` signal.
     """
-    from dipdup.config import DipDupConfig
     from dipdup.dipdup import DipDup
 
     config: DipDupConfig = ctx.obj.config
@@ -388,7 +389,6 @@ async def schema(ctx: click.Context) -> None:
 async def schema_approve(ctx: click.Context) -> None:
     """Continue to use existing schema after reindexing was triggered."""
 
-    from dipdup.config import DipDupConfig
     from dipdup.database import tortoise_wrapper
     from dipdup.models import Index
     from dipdup.models import Schema

src/dipdup/cli.py

@@ -2,12 +2,12 @@
 import subprocess
 from abc import ABC
 from abc import abstractmethod
+from collections.abc import Awaitable
+from collections.abc import Callable
 from pathlib import Path
 from shutil import rmtree
 from shutil import which
 from typing import Any
-from typing import Awaitable
-from typing import Callable
 
 from pydantic import BaseModel
 

src/dipdup/codegen/__init__.py

@@ -174,15 +174,14 @@ async def _fetch_abi(self, index_config: SubsquidEventsIndexConfig) -> None:
             abi_path.write_bytes(json_dumps(abi_json))
 
     def get_typeclass_name(self, schema_path: Path) -> str:
-        module_name = schema_path.stem
+        return schema_path.stem
         # FIXME: Do we need prefixes or postfixes there?
         # if schema_path.parent.name == 'evm_events':
         #     class_name = f'{module_name}_event'
         # elif schema_path.parent.name == 'evm_functions':
         #     class_name = f'{module_name}_function'
         # else:
         #     class_name = module_name
-        return module_name
 
     async def _generate_type(self, schema_path: Path, force: bool) -> None:
         if 'evm_events' not in schema_path.parts:

src/dipdup/codegen/evm_subsquid.py

@@ -66,20 +66,19 @@ def preprocess_storage_jsonschema(schema: dict[str, Any]) -> dict[str, Any]:
                 prop: preprocess_storage_jsonschema(sub_schema) for prop, sub_schema in schema['properties'].items()
             },
         }
-    elif 'items' in schema:
+    if 'items' in schema:
         return {
             **schema,
             'items': preprocess_storage_jsonschema(schema['items']),
         }
-    elif 'additionalProperties' in schema:
+    if 'additionalProperties' in schema:
         return {
             **schema,
             'additionalProperties': preprocess_storage_jsonschema(schema['additionalProperties']),
         }
-    elif schema.get('$comment') == 'big_map':
+    if schema.get('$comment') == 'big_map':
         return cast(dict[str, Any], schema['oneOf'][1])
-    else:
-        return schema
+    return schema
 
 
 class TzktCodeGenerator(CodeGenerator):
@@ -156,7 +155,7 @@ async def generate_handlers(self) -> None:
             if isinstance(index_config, IndexTemplateConfig):
                 continue
             # NOTE: Always single handler
-            if isinstance(index_config, (TzktOperationsUnfilteredIndexConfig, TzktHeadIndexConfig)):
+            if isinstance(index_config, TzktOperationsUnfilteredIndexConfig | TzktHeadIndexConfig):
                 await self._generate_callback(index_config.handler_config, 'handlers')
                 continue
 
@@ -232,7 +231,7 @@ async def _fetch_operation_pattern_schema(
             return
 
         # NOTE: A very special case; unresolved `operation` template to spawn from factory indexes.
-        elif isinstance(contract_config, str) and contract_config in self._config.contracts:
+        if isinstance(contract_config, str) and contract_config in self._config.contracts:
             contract_config = self._config.get_tezos_contract(contract_config)
 
         elif isinstance(contract_config, str):

src/dipdup/codegen/tezos_tzkt.py

@@ -24,11 +24,10 @@
 from collections import Counter
 from contextlib import suppress
 from dataclasses import field
-from pathlib import Path
 from pydoc import locate
+from typing import TYPE_CHECKING
 from typing import Any
 from typing import Generic
-from typing import Iterator
 from typing import Literal
 from typing import TypeVar
 from typing import cast
@@ -49,10 +48,15 @@
 from dipdup.models import ReindexingReason
 from dipdup.models import SkipHistory
 from dipdup.performance import MetricsLevel
-from dipdup.subscriptions import Subscription
 from dipdup.utils import pascal_to_snake
 from dipdup.yaml import DipDupYAMLConfig
 
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+    from pathlib import Path
+
+    from dipdup.subscriptions import Subscription
+
 DEFAULT_POSTGRES_SCHEMA = 'public'
 DEFAULT_POSTGRES_DATABASE = 'postgres'
 DEFAULT_POSTGRES_USER = 'postgres'
@@ -196,7 +200,7 @@ def create(
         cls,
         default: HttpConfig,
         user: HttpConfig | None,
-    ) -> 'ResolvedHttpConfig':
+    ) -> ResolvedHttpConfig:
         config = cls()
         # NOTE: Apply datasource defaults first
         for merge_config in (default, user):
@@ -445,7 +449,7 @@ def __post_init_post_parse__(self) -> None:
         schedules_enabled = sum(int(bool(x)) for x in (self.crontab, self.interval, self.daemon))
         if schedules_enabled > 1:
             raise ConfigurationError('Only one of `crontab`, `interval` of `daemon` can be specified')
-        elif not schedules_enabled:
+        if not schedules_enabled:
             raise ConfigurationError('One of `crontab`, `interval` or `daemon` must be specified')
 
         NameMixin.__post_init_post_parse__(self)

src/dipdup/config/__init__.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from dataclasses import field
-from typing import Iterator
+from typing import TYPE_CHECKING
 from typing import Literal
 
 from pydantic.dataclasses import dataclass
@@ -13,10 +13,14 @@
 from dipdup.config.evm_subsquid import SubsquidDatasourceConfig
 from dipdup.models.evm_node import EvmNodeLogsSubscription
 from dipdup.models.evm_node import EvmNodeNewHeadsSubscription
-from dipdup.subscriptions import Subscription
 from dipdup.utils import pascal_to_snake
 from dipdup.utils import snake_to_pascal
 
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+
+    from dipdup.subscriptions import Subscription
+
 
 @dataclass
 class SubsquidEventsHandlerConfig(HandlerConfig):

src/dipdup/config/evm_subsquid_events.py

@@ -1,8 +1,8 @@
 from __future__ import annotations
 
 from dataclasses import field
+from typing import TYPE_CHECKING
 from typing import Any
-from typing import Iterator
 from typing import Literal
 
 from pydantic.dataclasses import dataclass
@@ -12,7 +12,11 @@
 from dipdup.config import IndexConfig
 from dipdup.config.evm import EvmContractConfig
 from dipdup.config.evm_subsquid import SubsquidDatasourceConfig
-from dipdup.subscriptions import Subscription
+
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+
+    from dipdup.subscriptions import Subscription
 
 
 @dataclass