Migrate linting and formatting to Ruff (#236)

* Migrate linting and formatting to Ruff

* Prefer future annotations in Ruff checks

Author: dhruvmanila

.github/workflows/main.yml

@@ -23,7 +23,7 @@ jobs:
         run: uv sync --locked
       - name: Run tests
         run: uv run --locked pytest
-      - name: Run pre-commit
+      - name: Run pre-commit checks
         run: uv run --locked pre-commit run --verbose --all-files --show-diff-on-failure
       # FIXME: mypy is failing due to missing types-* packages
       # - name: Run mypy

.pre-commit-config.yaml

@@ -14,12 +14,8 @@ repos:
         additional_dependencies:
           - tomli
 
-  - repo: https://github.com/psf/black
-    rev: 23.7.0
-    hooks:
-      - id: black
-
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.0.285
+    rev: v0.16.6
     hooks:
-      - id: ruff
+      - id: ruff-check
+      - id: ruff-format

README.md

@@ -3,7 +3,7 @@
 # algorithms-keeper
 [![CI](https://github.com/TheAlgorithms/algorithms-keeper/actions/workflows/main.yml/badge.svg)](https://github.com/TheAlgorithms/algorithms-keeper/actions/workflows/main.yml)
 [![codecov](https://codecov.io/gh/TheAlgorithms/algorithms-keeper/branch/master/graph/badge.svg?token=QYAZ665UJL)](https://codecov.io/gh/TheAlgorithms/algorithms-keeper)
-[![code style: black](https://img.shields.io/static/v1?label=code%20style&message=black&color=black)](https://github.com/psf/black)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://docs.astral.sh/ruff/)
 [![Checked with mypy](https://img.shields.io/static/v1?label=mypy&message=checked&color=2a6db2&labelColor=505050)](http://mypy-lang.org/)
 
 </div>
@@ -57,8 +57,11 @@ the project and run tests from the repository root:
 ```shell
 uv sync
 uv run pytest
+uv run pre-commit run --all-files
 ```
 
+Ruff handles Python linting and formatting through the pre-commit hooks.
+
 ## Logging
 Logging is done using the standard library logging module. All the API calls made by the bot are being logged at INFO level and `aiohttp.log.access_logger` is logging the POST requests made by GitHub for delivering the payload. Other minor events relevant to the repository is also being logged along with using the using [Sentry](https://sentry.io/). The logs can be viewed best using the following command ([_requires Heroku CLI_](https://devcenter.heroku.com/articles/heroku-cli#download-and-install)):
 ```shell

algorithms_keeper/__main__.py

@@ -1,10 +1,11 @@
+from __future__ import annotations
+
 import asyncio
 import logging
 import os
-import sys
-from datetime import datetime, timezone
+from datetime import UTC, datetime
 from pathlib import Path
-from typing import Any, MutableMapping
+from typing import TYPE_CHECKING, Any
 
 from aiohttp import ClientSession, web
 from cachetools import LRUCache
@@ -15,10 +16,12 @@
 from algorithms_keeper.api import GitHubAPI
 from algorithms_keeper.event import main_router
 
+if TYPE_CHECKING:
+    from collections.abc import MutableMapping
+
 # TODO(dhruvmanila): Remove this block when it's the default.
 # https://github.com/Instagram/LibCST/issues/285#issuecomment-1011427731
-if sys.version_info >= (3, 10):
-    os.environ["LIBCST_PARSER_TYPE"] = "native"
+os.environ["LIBCST_PARSER_TYPE"] = "native"
 
 cache: MutableMapping[Any, Any] = LRUCache(maxsize=500)
 
@@ -90,7 +93,7 @@ async def main(request: web.Request) -> web.Response:
             logger.info(
                 "ratelimit=%s, time_remaining=%s",
                 f"{gh.rate_limit.remaining}/{gh.rate_limit.limit}",
-                gh.rate_limit.reset_datetime - datetime.now(timezone.utc),
+                gh.rate_limit.reset_datetime - datetime.now(UTC),
             )
         return web.Response(status=200)
     except Exception as err:
@@ -103,4 +106,4 @@ async def main(request: web.Request) -> web.Response:
     app.add_routes(routes)
     # Heroku dynamically assigns the app a port, so we can't set the port to a fixed
     # number. Heroku adds the port to the env, so we need to pull it from there.
-    web.run_app(app, port=int(os.environ.get("PORT", 5000)))
+    web.run_app(app, port=int(os.environ.get("PORT", "5000")))

algorithms_keeper/api.py

@@ -1,13 +1,19 @@
+from __future__ import annotations
+
 import logging
 import os
-from typing import Any, Mapping, MutableMapping
+from typing import TYPE_CHECKING, Any
 
-from aiohttp import ClientResponse
 from cachetools import TTLCache
 from gidgethub import apps
 from gidgethub.abc import UTF_8_CHARSET
 from gidgethub.aiohttp import GitHubAPI as BaseGitHubAPI
 
+if TYPE_CHECKING:
+    from collections.abc import Mapping, MutableMapping
+
+    from aiohttp import ClientResponse
+
 # Timed token_cache for installation access token (1 minute less than an hour)
 token_cache: MutableMapping[int, str] = TTLCache(maxsize=10, ttl=1 * 59 * 60)
 

algorithms_keeper/event/check_run.py

@@ -1,13 +1,18 @@
+from __future__ import annotations
+
 import logging
-from typing import Any
+from typing import TYPE_CHECKING, Any
 
 from gidgethub import routing
-from gidgethub.sansio import Event
 
 from algorithms_keeper import utils
-from algorithms_keeper.api import GitHubAPI
 from algorithms_keeper.constants import Label
 
+if TYPE_CHECKING:
+    from gidgethub.sansio import Event
+
+    from algorithms_keeper.api import GitHubAPI
+
 check_run_router = routing.Router()
 
 logger = logging.getLogger(__package__)

algorithms_keeper/event/commands.py

@@ -5,17 +5,24 @@
 including the modified files. As we cannot post review comments on lines not part of
 the diff, this command only modify the labels accordingly.
 """
+
+from __future__ import annotations
+
 import logging
 import re
-from typing import Any, Pattern
+from re import Pattern
+from typing import TYPE_CHECKING, Any
 
 from gidgethub import routing
-from gidgethub.sansio import Event
 
 from algorithms_keeper import utils
-from algorithms_keeper.api import GitHubAPI
 from algorithms_keeper.event.pull_request import check_pr_files
 
+if TYPE_CHECKING:
+    from gidgethub.sansio import Event
+
+    from algorithms_keeper.api import GitHubAPI
+
 commands_router = routing.Router()
 
 COMMAND_RE: Pattern[str] = re.compile(r"@algorithms-keeper\s+([a-z\-]+)", re.IGNORECASE)

algorithms_keeper/event/installation.py

@@ -1,12 +1,17 @@
+from __future__ import annotations
+
 import logging
-from typing import Any
+from typing import TYPE_CHECKING, Any
 
 from gidgethub import routing
-from gidgethub.sansio import Event
 
-from algorithms_keeper.api import GitHubAPI
 from algorithms_keeper.constants import GREETING_COMMENT
 
+if TYPE_CHECKING:
+    from gidgethub.sansio import Event
+
+    from algorithms_keeper.api import GitHubAPI
+
 installation_router = routing.Router()
 
 logger = logging.getLogger(__package__)

algorithms_keeper/event/pull_request.py

@@ -19,16 +19,17 @@
   "Awaiting changes" -> "Approved" [label="Review approves", color=green]
 }
 """
+
+from __future__ import annotations
+
 import asyncio
 import logging
 import re
-from typing import Any, Optional
+from typing import TYPE_CHECKING, Any
 
 from gidgethub import routing
-from gidgethub.sansio import Event
 
 from algorithms_keeper import utils
-from algorithms_keeper.api import GitHubAPI
 from algorithms_keeper.constants import (
     CHECKBOX_NOT_TICKED_COMMENT,
     EMPTY_PR_BODY_COMMENT,
@@ -37,8 +38,14 @@
     PR_REVIEW_COMMENT,
     Label,
 )
+from algorithms_keeper.event.check_run import check_ci_status_and_label
 from algorithms_keeper.parser import PythonParser
 
+if TYPE_CHECKING:
+    from gidgethub.sansio import Event
+
+    from algorithms_keeper.api import GitHubAPI
+
 # To disable this check, set the constant to 0.
 MAX_PR_PER_USER = 3
 STAGE_PREFIX = "awaiting"
@@ -50,7 +57,7 @@
 
 
 async def update_stage_label(
-    gh: GitHubAPI, *, pull_request: dict[str, Any], next_label: Optional[str] = None
+    gh: GitHubAPI, *, pull_request: dict[str, Any], next_label: str | None = None
 ) -> None:
     """Update the stage label of the given pull request.
 
@@ -266,8 +273,6 @@ async def check_ci_ready_for_review_pr(
     removed if the checks are passing or failing. Thus, we need to manually check it
     with respect to the latest commit on head.
     """
-    from algorithms_keeper.event.check_run import check_ci_status_and_label
-
     await check_ci_status_and_label(event, gh, *args, **kwargs)
 
 
@@ -343,7 +348,7 @@ async def check_merge_status(
     pull_request = event.data["pull_request"]
 
     for retry_interval in range(MAX_RETRIES):
-        mergeable: Optional[bool] = pull_request["mergeable"]
+        mergeable: bool | None = pull_request["mergeable"]
         if mergeable is None:
             # We will use the iter value we get as our sleep period between the polls.
             # In the webhook payload, the mergeable status will always be ``None``, so

algorithms_keeper/parser/files_parser.py

@@ -1,8 +1,14 @@
+from __future__ import annotations
+
 import logging
-from typing import Any, Collection, Iterable, Mapping
+from typing import TYPE_CHECKING, Any
 
 from algorithms_keeper.constants import Label
-from algorithms_keeper.utils import File
+
+if TYPE_CHECKING:
+    from collections.abc import Collection, Iterable, Mapping
+
+    from algorithms_keeper.utils import File
 
 # These files are updated automatically by a GitHub action in almost every pull request.
 IGNORE_FILES_FOR_TYPELABEL: set[str] = {"DIRECTORY.md"}