Added some typings to peewee stubs (#11284)

Author: mikeziminio

stubs/peewee/peewee.pyi

@@ -146,8 +146,8 @@ class _HashableSource:
     def __init__(self, *args, **kwargs) -> None: ...
     def alias(self, name) -> None: ...
     def __hash__(self) -> int: ...
-    def __eq__(self, other): ...
-    def __ne__(self, other): ...
+    def __eq__(self, other) -> bool: ...
+    def __ne__(self, other) -> bool: ...
     __lt__: Incomplete
     __le__: Incomplete
     __gt__: Incomplete
@@ -183,7 +183,7 @@ class Table(_HashableSource, BaseTable):
         name,
         columns: Incomplete | None = ...,
         primary_key: Incomplete | None = ...,
-        schema: Incomplete | None = ...,
+        schema: str | None = None,
         alias: Incomplete | None = ...,
         _model: Incomplete | None = ...,
         _database: Incomplete | None = ...,
@@ -249,8 +249,8 @@ class ColumnBase(Node):
     __rand__: Incomplete
     __ror__: Incomplete
     __rxor__: Incomplete
-    def __eq__(self, rhs): ...
-    def __ne__(self, rhs): ...
+    def __eq__(self, rhs) -> bool: ...
+    def __ne__(self, rhs) -> bool: ...
     __lt__: Incomplete
     __le__: Incomplete
     __gt__: Incomplete
@@ -797,10 +797,10 @@ class Database(_callable_context_manager):
         self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None
     ) -> None: ...
     def connection_context(self): ...
-    def connect(self, reuse_if_open: bool = ...): ...
-    def close(self): ...
-    def is_closed(self): ...
-    def is_connection_usable(self): ...
+    def connect(self, reuse_if_open: bool = False) -> bool: ...
+    def close(self) -> bool: ...
+    def is_closed(self) -> bool: ...
+    def is_connection_usable(self) -> bool: ...
     def connection(self): ...
     def cursor(self, commit: Incomplete | None = None, named_cursor: Incomplete | None = None): ...
     def execute_sql(self, sql, params: Incomplete | None = ..., commit=...): ...
@@ -828,22 +828,22 @@ class Database(_callable_context_manager):
     def commit(self): ...
     def rollback(self): ...
     def batch_commit(self, it, n) -> Generator[Incomplete, None, None]: ...
-    def table_exists(self, table_name, schema: Incomplete | None = ...): ...
-    def get_tables(self, schema: Incomplete | None = ...) -> None: ...
-    def get_indexes(self, table, schema: Incomplete | None = ...) -> None: ...
-    def get_columns(self, table, schema: Incomplete | None = ...) -> None: ...
-    def get_primary_keys(self, table, schema: Incomplete | None = ...) -> None: ...
-    def get_foreign_keys(self, table, schema: Incomplete | None = ...) -> None: ...
+    def table_exists(self, table_name, schema: str | None = None): ...
+    def get_tables(self, schema: str | None = None) -> None: ...
+    def get_indexes(self, table, schema: str | None = None) -> list[IndexMetadata]: ...
+    def get_columns(self, table, schema: str | None = None) -> list[ColumnMetadata]: ...
+    def get_primary_keys(self, table, schema: str | None = None) -> None: ...
+    def get_foreign_keys(self, table, schema: str | None = None) -> list[ForeignKeyMetadata]: ...
     def sequence_exists(self, seq) -> None: ...
-    def create_tables(self, models, **options) -> None: ...
-    def drop_tables(self, models, **kwargs) -> None: ...
+    def create_tables(self, models: Iterable[type[Model]], **options) -> None: ...
+    def drop_tables(self, models: Iterable[type[Model]], **kwargs) -> None: ...
     def extract_date(self, date_part, date_field) -> None: ...
     def truncate_date(self, date_part, date_field) -> None: ...
     def to_timestamp(self, date_field) -> None: ...
     def from_timestamp(self, date_field) -> None: ...
     def random(self): ...
-    def bind(self, models, bind_refs: bool = ..., bind_backrefs: bool = ...) -> None: ...
-    def bind_ctx(self, models, bind_refs: bool = ..., bind_backrefs: bool = ...): ...
+    def bind(self, models: Iterable[type[Model]], bind_refs: bool = ..., bind_backrefs: bool = ...) -> None: ...
+    def bind_ctx(self, models: Iterable[type[Model]], bind_refs: bool = ..., bind_backrefs: bool = ...): ...
     def get_noop_select(self, ctx): ...
     @property
     def Model(self) -> type[Model]: ...
@@ -861,7 +861,7 @@ class SqliteDatabase(Database):
     def init(
         self, database, pragmas: Incomplete | None = ..., timeout: int = ..., returning_clause: Incomplete | None = ..., **kwargs
     ) -> None: ...
-    def pragma(self, key, value=..., permanent: bool = ..., schema: Incomplete | None = ...): ...
+    def pragma(self, key, value=..., permanent: bool = ..., schema: str | None = None): ...
     cache_size: Incomplete
     foreign_keys: Incomplete
     journal_mode: Incomplete
@@ -900,12 +900,12 @@ class SqliteDatabase(Database):
     def last_insert_id(self, cursor, query_type: Incomplete | None = ...): ...
     def rows_affected(self, cursor): ...
     def begin(self, lock_type: Incomplete | None = ...) -> None: ...
-    def get_tables(self, schema: Incomplete | None = ...): ...
-    def get_views(self, schema: Incomplete | None = ...): ...
-    def get_indexes(self, table, schema: Incomplete | None = ...): ...
-    def get_columns(self, table, schema: Incomplete | None = ...): ...
-    def get_primary_keys(self, table, schema: Incomplete | None = ...): ...
-    def get_foreign_keys(self, table, schema: Incomplete | None = ...): ...
+    def get_tables(self, schema: str | None = None): ...
+    def get_views(self, schema: str | None = None) -> list[ViewMetadata]: ...
+    def get_indexes(self, table, schema: str | None = None) -> list[IndexMetadata]: ...
+    def get_columns(self, table, schema: str | None = None) -> list[ColumnMetadata]: ...
+    def get_primary_keys(self, table, schema: str | None = None): ...
+    def get_foreign_keys(self, table, schema: str | None = None) -> list[ForeignKeyMetadata]: ...
     def get_binary_type(self): ...
     def conflict_statement(self, on_conflict, query): ...
     def conflict_update(self, oc, query): ...
@@ -933,16 +933,16 @@ class PostgresqlDatabase(Database):
         isolation_level: Incomplete | None = ...,
         **kwargs,
     ) -> None: ...
-    def is_connection_usable(self): ...
+    def is_connection_usable(self) -> bool: ...
     def last_insert_id(self, cursor, query_type: Incomplete | None = ...): ...
     def rows_affected(self, cursor): ...
     def begin(self, isolation_level: str | None = None) -> None: ...
-    def get_tables(self, schema: Incomplete | None = ...): ...
-    def get_views(self, schema: Incomplete | None = ...): ...
-    def get_indexes(self, table, schema: Incomplete | None = ...): ...
-    def get_columns(self, table, schema: Incomplete | None = ...): ...
-    def get_primary_keys(self, table, schema: Incomplete | None = ...): ...
-    def get_foreign_keys(self, table, schema: Incomplete | None = ...): ...
+    def get_tables(self, schema: str | None = None): ...
+    def get_views(self, schema: str | None = None) -> list[ViewMetadata]: ...
+    def get_indexes(self, table, schema: str | None = None) -> list[IndexMetadata]: ...
+    def get_columns(self, table, schema: str | None = None) -> list[ColumnMetadata]: ...
+    def get_primary_keys(self, table, schema: str | None = None): ...
+    def get_foreign_keys(self, table, schema: str | None = None) -> list[ForeignKeyMetadata]: ...
     def sequence_exists(self, sequence): ...
     def get_binary_type(self): ...
     def conflict_statement(self, on_conflict, query) -> None: ...
@@ -968,15 +968,15 @@ class MySQLDatabase(Database):
     safe_drop_index: bool
     sql_mode: str
     def init(self, database, **kwargs) -> None: ...
-    def is_connection_usable(self): ...
+    def is_connection_usable(self) -> bool: ...
     def default_values_insert(self, ctx): ...
     def begin(self, isolation_level: str | None = None) -> None: ...
-    def get_tables(self, schema: Incomplete | None = ...): ...
-    def get_views(self, schema: Incomplete | None = ...): ...
-    def get_indexes(self, table, schema: Incomplete | None = ...): ...
-    def get_columns(self, table, schema: Incomplete | None = ...): ...
-    def get_primary_keys(self, table, schema: Incomplete | None = ...): ...
-    def get_foreign_keys(self, table, schema: Incomplete | None = ...): ...
+    def get_tables(self, schema: str | None = None): ...
+    def get_views(self, schema: str | None = None) -> list[ViewMetadata]: ...
+    def get_indexes(self, table, schema: str | None = None) -> list[IndexMetadata]: ...
+    def get_columns(self, table, schema: str | None = None) -> list[ColumnMetadata]: ...
+    def get_primary_keys(self, table, schema: str | None = None): ...
+    def get_foreign_keys(self, table, schema: str | None = None) -> list[ForeignKeyMetadata]: ...
     def get_binary_type(self): ...
     def conflict_statement(self, on_conflict, query): ...
     def conflict_update(self, on_conflict, query): ...
@@ -1438,8 +1438,8 @@ class CompositeKey(MetaField):
     def safe_field_names(self): ...
     def __get__(self, instance, instance_type: Incomplete | None = ...): ...
     def __set__(self, instance, value) -> None: ...
-    def __eq__(self, other): ...
-    def __ne__(self, other): ...
+    def __eq__(self, other) -> bool: ...
+    def __ne__(self, other) -> bool: ...
     def __hash__(self) -> int: ...
     def __sql__(self, ctx): ...
     model: Incomplete
@@ -1514,7 +1514,7 @@ class Metadata:
         indexes: Incomplete | None = ...,
         primary_key: Incomplete | None = ...,
         constraints: Incomplete | None = ...,
-        schema: Incomplete | None = ...,
+        schema: str | None = None,
         only_save_dirty: bool = ...,
         depends_on: Incomplete | None = ...,
         options: Incomplete | None = ...,
@@ -1635,14 +1635,14 @@ class Model(metaclass=ModelBase):
     def filter(cls, *dq_nodes, **filters): ...
     def get_id(self): ...
     def save(self, force_insert: bool = ..., only: Incomplete | None = ...): ...
-    def is_dirty(self): ...
+    def is_dirty(self) -> bool: ...
     @property
     def dirty_fields(self): ...
     def dependencies(self, search_nullable: bool = ...) -> Generator[Incomplete, None, None]: ...
     def delete_instance(self, recursive: bool = ..., delete_nullable: bool = ...): ...
     def __hash__(self) -> int: ...
-    def __eq__(self, other): ...
-    def __ne__(self, other): ...
+    def __eq__(self, other) -> bool: ...
+    def __ne__(self, other) -> bool: ...
     def __sql__(self, ctx): ...
     @classmethod
     def bind(cls, database, bind_refs: bool = ..., bind_backrefs: bool = ..., _exclude: Incomplete | None = ...): ...