Skip to content

refactor: add type hints to flask_sqlalchemy.model #8389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 31, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions stubs/Flask-SQLAlchemy/flask_sqlalchemy/model.pyi
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
from re import Pattern
from typing import Any
from typing import Any, Generic, TypeVar

from sqlalchemy import Table
from sqlalchemy.ext.declarative import DeclarativeMeta
from sqlalchemy.orm import Query

_ModelT = TypeVar("_ModelT")

def should_set_tablename(cls: type) -> bool: ...

Expand All @@ -10,14 +14,14 @@ camelcase_re: Pattern[str]
def camel_to_snake_case(name: str) -> str: ...

class NameMetaMixin(type):
def __init__(cls, name, bases, d) -> None: ...
def __table_cls__(cls, *args, **kwargs): ...
def __init__(cls, name: str, bases: tuple[type, ...], d: dict[str, Any]) -> None: ...
def __table_cls__(cls, *args, **kwargs) -> Table | None: ...

class BindMetaMixin(type):
def __init__(cls, name, bases, d) -> None: ...
def __init__(cls, name: str, bases: tuple[type, ...], d: dict[str, Any]) -> None: ...

class DefaultMeta(NameMetaMixin, BindMetaMixin, DeclarativeMeta): ...

class Model:
query_class: Any | None
query: Any | None
class Model(Generic[_ModelT]):
query_class: type[Query[_ModelT]] | None
query: Query[_ModelT] | None