chore: modernize Beanie codebase and types for py39+

* Removed future annotations imports.
* Set maximum line length to 100 from 79.
* Re-formatted all files due to above change.
* Enabled more Ruff rules (most notably pyupgrade - "UP").
* Fixed "RUF029" rule violation in tests.
* Minor docstring fixes.
* Introduced is_generic_alias() to beanie.odm.utils.typing
  module. Provides better support for both new generic
  types and older generic types from the typing module
  (e.g. typing.List[str]).

Author: staticxterm

.github/scripts/handlers/gh.py

@@ -1,7 +1,6 @@
 import subprocess
 from dataclasses import dataclass
 from datetime import datetime
-from typing import List
 
 import requests  # type: ignore
 
@@ -31,7 +30,7 @@ def __init__(
         self.commits = self.get_commits_after_tag(current_version)
         self.prs = [self.get_pr_for_commit(commit) for commit in self.commits]
 
-    def get_commits_after_tag(self, tag: str) -> List[str]:
+    def get_commits_after_tag(self, tag: str) -> list[str]:
         result = subprocess.run(
             ["git", "log", f"{tag}..HEAD", "--pretty=format:%H"],
             stdout=subprocess.PIPE,
@@ -64,9 +63,7 @@ def build_markdown_for_many_prs(self) -> str:
         return markdown
 
     def commit_changes(self):
-        self.run_git_command(
-            ["git", "config", "--global", "user.name", "github-actions[bot]"]
-        )
+        self.run_git_command(["git", "config", "--global", "user.name", "github-actions[bot]"])
         self.run_git_command(
             [
                 "git",
@@ -77,15 +74,13 @@ def commit_changes(self):
             ]
         )
         self.run_git_command(["git", "add", "."])
-        self.run_git_command(
-            ["git", "commit", "-m", f"Bump version to {self.new_version}"]
-        )
+        self.run_git_command(["git", "commit", "-m", f"Bump version to {self.new_version}"])
         self.run_git_command(["git", "tag", self.new_version])
         self.git_push()
 
     def git_push(self):
         self.run_git_command(["git", "push", "origin", "main", "--tags"])
 
     @staticmethod
-    def run_git_command(command: List[str]):
+    def run_git_command(command: list[str]):
         subprocess.run(command, check=True)

.github/scripts/handlers/version.py

@@ -31,9 +31,7 @@ def __gt__(self, other):
             (self.major > other.major)
             or (self.major == other.major and self.minor > other.minor)
             or (
-                self.major == other.major
-                and self.minor == other.minor
-                and self.patch > other.patch
+                self.major == other.major and self.minor == other.minor and self.patch > other.patch
             )
         )
 
@@ -47,9 +45,7 @@ def __init__(self):
         self.init_py = self.ROOT_PATH / "beanie" / "__init__.py"
         self.changelog = self.ROOT_PATH / "docs" / "changelog.md"
 
-        self.current_version = self.parse_version_from_pyproject(
-            self.pyproject
-        )
+        self.current_version = self.parse_version_from_pyproject(self.pyproject)
         self.pypi_version = self.get_version_from_pypi()
 
         if self.current_version < self.pypi_version:
@@ -68,9 +64,7 @@ def parse_version_from_pyproject(pyproject: Path) -> SemVer:
         return SemVer(toml_data["project"]["version"])
 
     def get_version_from_pypi(self) -> SemVer:
-        response = requests.get(
-            f"https://pypi.org/pypi/{self.PACKAGE_NAME}/json"
-        )
+        response = requests.get(f"https://pypi.org/pypi/{self.PACKAGE_NAME}/json")
         if response.status_code == 200:
             return SemVer(response.json()["info"]["version"])
         raise ValueError("Can't get version from pypi")
@@ -90,9 +84,7 @@ def update_pyproject_version(self):
     def update_file_versions(self, files_to_update):
         for file_path in files_to_update:
             content = file_path.read_text()
-            content = content.replace(
-                str(self.pypi_version), str(self.current_version)
-            )
+            content = content.replace(str(self.pypi_version), str(self.current_version))
             file_path.write_text(content)
 
     def update_changelog(self):

beanie/executors/migrate.py

@@ -48,9 +48,7 @@ def __init__(self, **kwargs: Any):
             or self.get_from_toml("database_name")
         )
         self.path = Path(
-            kwargs.get("path")
-            or self.get_env_value("path")
-            or self.get_from_toml("path")
+            kwargs.get("path") or self.get_env_value("path") or self.get_from_toml("path")
         )
         self.allow_index_dropping = bool(
             kwargs.get("allow_index_dropping")
@@ -85,9 +83,9 @@ def get_env_value(field_name) -> Any:
                 or os.environ.get("beanie_database_name")
             )
         else:
-            value = os.environ.get(
-                f"BEANIE_{field_name.upper()}"
-            ) or os.environ.get(f"beanie_{field_name.lower()}")
+            value = os.environ.get(f"BEANIE_{field_name.upper()}") or os.environ.get(
+                f"beanie_{field_name.lower()}"
+            )
         return value
 
     @staticmethod
@@ -96,11 +94,7 @@ def get_from_toml(field_name) -> Any:
         if path.is_file():
             with path.open("rb") as f:
                 toml_data = tomllib.load(f)
-            val = (
-                toml_data.get("tool", {})
-                .get("beanie", {})
-                .get("migrations", {})
-            )
+            val = toml_data.get("tool", {}).get("beanie", {}).get("migrations", {})
         else:
             val = {}
         return val.get(field_name)
@@ -114,9 +108,7 @@ def migrations():
 async def run_migrate(settings: MigrationSettings):
     DBHandler.set_db(settings.connection_uri, settings.database_name)
     root = await MigrationNode.build(settings.path)
-    mode = RunningMode(
-        direction=settings.direction, distance=settings.distance
-    )
+    mode = RunningMode(direction=settings.direction, distance=settings.distance)
     await root.run(
         mode=mode,
         allow_index_dropping=settings.allow_index_dropping,
@@ -158,9 +150,7 @@ async def run_migrate(settings: MigrationSettings):
     type=str,
     help="MongoDB connection URI",
 )
-@click.option(
-    "-db", "--database_name", required=False, type=str, help="DataBase name"
-)
+@click.option("-db", "--database_name", required=False, type=str, help="DataBase name")
 @click.option(
     "-p",
     "--path",

beanie/migrations/controllers/base.py

@@ -1,5 +1,4 @@
 from abc import ABC, abstractmethod
-from typing import List, Type
 
 from beanie.odm.documents import Document
 
@@ -14,5 +13,5 @@ async def run(self, session):
 
     @property
     @abstractmethod
-    def models(self) -> List[Type[Document]]:
+    def models(self) -> list[type[Document]]:
         pass

beanie/migrations/controllers/free_fall.py

@@ -1,11 +1,11 @@
 from inspect import signature
-from typing import Any, List, Type
+from typing import Any
 
 from beanie.migrations.controllers.base import BaseMigrationController
 from beanie.odm.documents import Document
 
 
-def free_fall_migration(document_models: List[Type[Document]]):
+def free_fall_migration(document_models: list[type[Document]]):
     class FreeFallMigrationController(BaseMigrationController):
         def __init__(self, function):
             self.function = function
@@ -16,7 +16,7 @@ def __call__(self, *args: Any, **kwargs: Any):
             pass
 
         @property
-        def models(self) -> List[Type[Document]]:
+        def models(self) -> list[type[Document]]:
             return self.document_models
 
         async def run(self, session):

beanie/migrations/controllers/iterative.py

@@ -1,6 +1,7 @@
 import asyncio
+from collections.abc import Callable
 from inspect import isclass, signature
-from typing import Any, List, Optional, Type, Union
+from typing import Any, Optional, Union
 
 from beanie.migrations.controllers.base import BaseMigrationController
 from beanie.migrations.utils import update_dict
@@ -10,7 +11,7 @@
 
 class DummyOutput:
     def __init__(self):
-        super(DummyOutput, self).__setattr__("_internal_structure_dict", {})
+        super().__setattr__("_internal_structure_dict", {})
 
     def __setattr__(self, key, value):
         self._internal_structure_dict[key] = value
@@ -26,9 +27,7 @@ def dict(self, to_parse: Optional[Union[dict, "DummyOutput"]] = None):
         if to_parse is None:
             to_parse = self
         input_dict = (
-            to_parse._internal_structure_dict
-            if isinstance(to_parse, DummyOutput)
-            else to_parse
+            to_parse._internal_structure_dict if isinstance(to_parse, DummyOutput) else to_parse
         )
         result_dict = {}
         for key, value in input_dict.items():
@@ -40,29 +39,21 @@ def dict(self, to_parse: Optional[Union[dict, "DummyOutput"]] = None):
 
 
 def iterative_migration(
-    document_models: Optional[List[Type[Document]]] = None,
+    document_models: Optional[list[type[Document]]] = None,
     batch_size: int = 10000,
 ):
     class IterativeMigration(BaseMigrationController):
-        def __init__(self, function):
+        def __init__(self, function: Callable) -> None:
             self.function = function
             self.function_signature = signature(function)
-            input_signature = self.function_signature.parameters.get(
-                "input_document"
-            )
+            input_signature = self.function_signature.parameters.get("input_document")
             if input_signature is None:
                 raise RuntimeError("input_signature must not be None")
-            self.input_document_model: Type[Document] = (
-                input_signature.annotation
-            )
-            output_signature = self.function_signature.parameters.get(
-                "output_document"
-            )
+            self.input_document_model: type[Document] = input_signature.annotation
+            output_signature = self.function_signature.parameters.get("output_document")
             if output_signature is None:
                 raise RuntimeError("output_signature must not be None")
-            self.output_document_model: Type[Document] = (
-                output_signature.annotation
-            )
+            self.output_document_model: type[Document] = output_signature.annotation
 
             if (
                 not isclass(self.input_document_model)
@@ -71,8 +62,7 @@ def __init__(self, function):
                 or not issubclass(self.output_document_model, Document)
             ):
                 raise TypeError(
-                    "input_document and output_document "
-                    "must have annotation of Document subclass"
+                    "input_document and output_document must have annotation of Document subclass"
                 )
 
             self.batch_size = batch_size
@@ -81,7 +71,7 @@ def __call__(self, *args: Any, **kwargs: Any):
             pass
 
         @property
-        def models(self) -> List[Type[Document]]:
+        def models(self) -> list[type[Document]]:
             preset_models = document_models
             if preset_models is None:
                 preset_models = []
@@ -93,9 +83,7 @@ def models(self) -> List[Type[Document]]:
         async def run(self, session):
             output_documents = []
             all_migration_ops = []
-            async for input_document in self.input_document_model.find_all(
-                session=session
-            ):
+            async for input_document in self.input_document_model.find_all(session=session):
                 output = DummyOutput()
                 function_kwargs = {
                     "input_document": input_document,
@@ -105,14 +93,10 @@ async def run(self, session):
                     function_kwargs["self"] = None
                 await self.function(**function_kwargs)
                 output_dict = (
-                    input_document.dict()
-                    if not IS_PYDANTIC_V2
-                    else input_document.model_dump()
+                    input_document.dict() if not IS_PYDANTIC_V2 else input_document.model_dump()
                 )
                 update_dict(output_dict, output.dict())
-                output_document = parse_model(
-                    self.output_document_model, output_dict
-                )
+                output_document = parse_model(self.output_document_model, output_dict)
                 output_documents.append(output_document)
 
                 if len(output_documents) == self.batch_size:

beanie/migrations/models.py

@@ -1,6 +1,6 @@
 from datetime import datetime
 from enum import Enum
-from typing import List, Optional
+from typing import Optional
 
 from pydantic import Field
 from pydantic.main import BaseModel
@@ -29,5 +29,5 @@ class RunningMode(BaseModel):
 
 class ParsedMigrations(BaseModel):
     path: str
-    names: List[str]
+    names: list[str]
     current: Optional[MigrationLog] = None