Add stubs for flask-migrate

As discussed in miguelgrinberg/Flask-Migrate#492 types should be added to typeshed.

Author: kasium

pyrightconfig.stricter.json

@@ -37,6 +37,7 @@
         "stubs/cryptography",
         "stubs/dateparser",
         "stubs/docutils",
+        "stubs/Flask-Migrate",
         "stubs/Flask-SQLAlchemy",
         "stubs/fpdf2",
         "stubs/html5lib",

stubs/Flask-Migrate/METADATA.toml

@@ -0,0 +1,2 @@
+version = "3.1.*"
+requires = ["types-Flask-SQLAlchemy", "types-SQLAlchemy"]

stubs/Flask-Migrate/flask_migrate/__init__.pyi

@@ -0,0 +1,87 @@
+from collections.abc import Callable
+from logging import Logger
+from typing import Any, TypeVar
+from typing_extensions import ParamSpec
+
+from flask_sqlalchemy import SQLAlchemy
+from sqlalchemy import MetaData
+
+_T = TypeVar("_T")
+_P = ParamSpec("_P")
+_App = Any  # flask.Flask is not possible as a dependency yet
+
+alembic_version: tuple[int, int, int]
+log: Logger
+
+class _MigrateConfig:
+    migrate: Migrate
+    db: SQLAlchemy | None
+    directory: str
+    configure_args: dict[str, Any]
+    def __init__(self, migrate: Migrate, db: SQLAlchemy | None, **kwargs) -> None: ...
+    @property
+    def metadata(self) -> MetaData: ...
+
+class Config:  # should inherit from alembic.config.Config which is not possible yet
+    template_directory: str | None
+    def __init__(self, *args, **kwargs) -> None: ...
+    def get_template_directory(self) -> str: ...
+
+class Migrate:
+    configure_callbacks: list[Callable[[Config], None]]
+    db: SQLAlchemy | None
+    directory: str
+    alembic_ctx_kwargs: dict[str, Any]
+    def __init__(self, app: _App | None = ..., db: SQLAlchemy | None = ..., directory: str = ..., **kwargs) -> None: ...
+    def init_app(self, app: _App, db: SQLAlchemy | None = ..., directory: str | None = ..., **kwargs) -> None: ...
+    def configure(self, f: Callable[[Config], None]) -> Callable[[Config], None]: ...
+    def call_configure_callbacks(self, config: Config): ...
+    def get_config(self, directory: str | None = ..., x_arg: tuple[str] | None = ..., opts: list[str] | None = ...): ...
+
+def catch_errors(f: Callable[_P, _T]) -> Callable[_P, _T]: ...
+def list_templates() -> None: ...
+def init(directory: str | None = ..., multidb: bool = ..., template: str | None = ..., package: bool = ...) -> None: ...
+def revision(
+    directory: str | None = ...,
+    message: str | None = ...,
+    autogenerate: bool = ...,
+    sql: bool = ...,
+    head: str = ...,
+    splice: bool = ...,
+    branch_label: str | None = ...,
+    version_path: str | None = ...,
+    rev_id: str | None = ...,
+) -> None: ...
+def migrate(
+    directory: str | None = ...,
+    message: str | None = ...,
+    sql: bool = ...,
+    head: str = ...,
+    splice: bool = ...,
+    branch_label: str | None = ...,
+    version_path: str | None = ...,
+    rev_id: str | None = ...,
+    x_arg: tuple[str] | None = ...,
+) -> None: ...
+def edit(directory: str | None = ..., revision: str = ...) -> None: ...
+def merge(
+    directory: str | None = ...,
+    revisions: str = ...,
+    message: str | None = ...,
+    branch_label: str | None = ...,
+    rev_id: str | None = ...,
+) -> None: ...
+def upgrade(
+    directory: str | None = ..., revision: str = ..., sql: bool = ..., tag: str | None = ..., x_arg: tuple[str] | None = ...
+) -> None: ...
+def downgrade(
+    directory: str | None = ..., revision: str = ..., sql: bool = ..., tag: str | None = ..., x_arg: tuple[str] | None = ...
+) -> None: ...
+def show(directory: str | None = ..., revision: str = ...) -> None: ...
+def history(
+    directory: str | None = ..., rev_range: str | None = ..., verbose: bool = ..., indicate_current: bool = ...
+) -> None: ...
+def heads(directory: str | None = ..., verbose: bool = ..., resolve_dependencies: bool = ...) -> None: ...
+def branches(directory: str | None = ..., verbose: bool = ...) -> None: ...
+def current(directory: str | None = ..., verbose: bool = ...) -> None: ...
+def stamp(directory: str | None = ..., revision: str = ..., sql: bool = ..., tag: str | None = ...) -> None: ...

stubs/Flask-Migrate/flask_migrate/cli.pyi

@@ -0,0 +1,37 @@
+def db() -> None: ...
+def list_templates() -> None: ...
+def init(directory: str | None, multidb: bool, template: str | None, package: bool) -> None: ...
+def revision(
+    directory: str | None,
+    message: str | None,
+    autogenerate: bool,
+    sql: bool,
+    head: str,
+    splice: bool,
+    branch_label: None | str,
+    version_path: str | None,
+    rev_id: str | None,
+) -> None: ...
+def migrate(
+    directory: str | None,
+    message: str | None,
+    sql: bool,
+    head: str,
+    splice: bool,
+    branch_label: None | str,
+    version_path: str | None,
+    rev_id: str | None,
+    x_arg: tuple[str],
+) -> None: ...
+def edit(directory: str | None, revision: str) -> None: ...
+def merge(
+    directory: str | None, message: str | None, branch_label: None | str, rev_id: str | None, revisions: tuple[str]
+) -> None: ...
+def upgrade(directory: str | None, sql: bool, tag: str | None, x_arg: tuple[str], revision: str) -> None: ...
+def downgrade(directory: str | None, sql: bool, tag: str | None, x_arg: tuple[str], revision: str) -> None: ...
+def show(directory: str | None, revision: str) -> None: ...
+def history(directory: str | None, rev_range: str | None, verbose: bool, indicate_current: bool) -> None: ...
+def heads(directory: str | None, verbose: bool, resolve_dependencies: bool) -> None: ...
+def branches(directory: str | None, verbose: bool) -> None: ...
+def current(directory: str | None, verbose: bool) -> None: ...
+def stamp(directory: str | None, sql: bool, tag: str | None, revision: str) -> None: ...