From 86e144b6d736756e1af4ff7bd5453813e6377ec5 Mon Sep 17 00:00:00 2001 From: violetc <58360096+s-yh-china@users.noreply.github.com> Date: Sun, 13 Oct 2024 21:38:07 +0800 Subject: [PATCH] [peewee] Some methods return `Self` (#12788) --- stubs/peewee/peewee.pyi | 128 ++++++++++++++++++++-------------------- 1 file changed, 64 insertions(+), 64 deletions(-) diff --git a/stubs/peewee/peewee.pyi b/stubs/peewee/peewee.pyi index 8299d6ca7..c02589ccf 100644 --- a/stubs/peewee/peewee.pyi +++ b/stubs/peewee/peewee.pyi @@ -135,7 +135,7 @@ class Star(Node): class Source(Node): c: Incomplete def __init__(self, alias: Incomplete | None = ...) -> None: ... - def alias(self, name) -> None: ... + def alias(self, name) -> Self: ... def select(self, *columns): ... @property def __star__(self) -> Star: ... @@ -148,7 +148,7 @@ class Source(Node): class _HashableSource: def __init__(self, *args, **kwargs) -> None: ... - def alias(self, name) -> None: ... + def alias(self, name) -> Self: ... def __hash__(self) -> int: ... def __eq__(self, other) -> Expression | bool: ... # type: ignore[override] def __ne__(self, other) -> Expression | bool: ... # type: ignore[override] @@ -178,7 +178,7 @@ class _BoundTableContext(_callable_context_manager): self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None ) -> None: ... -class Table(_HashableSource, BaseTable): +class Table(_HashableSource, BaseTable): # type: ignore[misc] __name__: Incomplete c: Incomplete primary_key: Incomplete @@ -210,12 +210,12 @@ class Join(BaseTable): def on(self, predicate): ... def __sql__(self, ctx): ... -class ValuesList(_HashableSource, BaseTable): +class ValuesList(_HashableSource, BaseTable): # type: ignore[misc] def __init__(self, values, columns: Incomplete | None = ..., alias: Incomplete | None = ...) -> None: ... - def columns(self, *names) -> None: ... + def columns(self, *names) -> Self: ... def __sql__(self, ctx): ... -class CTE(_HashableSource, Source): +class CTE(_HashableSource, Source): # type: ignore[misc] def __init__( self, name, query, recursive: bool = ..., columns: Incomplete | None = ..., materialized: Incomplete | None = ... ) -> None: ... @@ -227,7 +227,7 @@ class CTE(_HashableSource, Source): def __sql__(self, ctx): ... class ColumnBase(Node): - def converter(self, converter: Incomplete | None = ...) -> None: ... + def converter(self, converter: Incomplete | None = ...) -> Self: ... def alias(self, alias): ... def unalias(self): ... def bind_to(self, dest): ... @@ -395,9 +395,9 @@ class Function(ColumnBase): arguments: Incomplete def __init__(self, name, arguments, coerce: bool = ..., python_value: Incomplete | None = ...) -> None: ... def __getattr__(self, attr: str): ... - def filter(self, where: Incomplete | None = ...) -> None: ... - def order_by(self, *ordering) -> None: ... - def python_value(self, func: Incomplete | None = ...) -> None: ... + def filter(self, where: Incomplete | None = ...) -> Self: ... + def order_by(self, *ordering) -> Self: ... + def python_value(self, func: Incomplete | None = ...) -> Self: ... def over( self, partition_by: Incomplete | None = ..., @@ -438,11 +438,11 @@ class Window(Node): _inline: bool = ..., ) -> None: ... def alias(self, alias: Incomplete | None = ...): ... - def as_range(self) -> None: ... - def as_rows(self) -> None: ... - def as_groups(self) -> None: ... - def extends(self, window: Incomplete | None = ...) -> None: ... - def exclude(self, frame_exclusion: Incomplete | None = ...) -> None: ... + def as_range(self) -> Self: ... + def as_rows(self) -> Self: ... + def as_groups(self) -> Self: ... + def extends(self, window: Incomplete | None = ...) -> Self: ... + def exclude(self, frame_exclusion: Incomplete | None = ...) -> Self: ... @staticmethod def following(value: Incomplete | None = ...): ... @staticmethod @@ -487,7 +487,7 @@ EXCLUDED: Incomplete class DQ(ColumnBase): query: Incomplete def __init__(self, **query) -> None: ... - def __invert__(self) -> None: ... + def __invert__(self) -> Self: ... def clone(self): ... Tuple: Incomplete @@ -508,22 +508,22 @@ class OnConflict(Node): ) -> None: ... def get_conflict_statement(self, ctx, query): ... def get_conflict_update(self, ctx, query): ... - def preserve(self, *columns) -> None: ... - def update(self, _data: Incomplete | None = ..., **kwargs) -> None: ... - def where(self, *expressions) -> None: ... - def conflict_target(self, *constraints) -> None: ... - def conflict_where(self, *expressions) -> None: ... - def conflict_constraint(self, constraint) -> None: ... + def preserve(self, *columns) -> Self: ... + def update(self, _data: Incomplete | None = ..., **kwargs) -> Self: ... + def where(self, *expressions) -> Self: ... + def conflict_target(self, *constraints) -> Self: ... + def conflict_where(self, *expressions) -> Self: ... + def conflict_constraint(self, constraint) -> Self: ... class BaseQuery(Node): default_row_type: Incomplete def __init__(self, _database: Incomplete | None = ..., **kwargs) -> None: ... def bind(self, database: Incomplete | None = ...): ... def clone(self): ... - def dicts(self, as_dict: bool = ...): ... - def tuples(self, as_tuple: bool = ...): ... - def namedtuples(self, as_namedtuple: bool = ...): ... - def objects(self, constructor: Incomplete | None = ...): ... + def dicts(self, as_dict: bool = ...) -> Self: ... + def tuples(self, as_tuple: bool = ...) -> Self: ... + def namedtuples(self, as_namedtuple: bool = ...) -> Self: ... + def objects(self, constructor: Incomplete | None = ...) -> Self: ... def __sql__(self, ctx) -> None: ... def sql(self): ... def execute(self, database): ... @@ -545,14 +545,14 @@ class Query(BaseQuery): offset: Incomplete | None = ..., **kwargs, ) -> None: ... - def with_cte(self, *cte_list) -> None: ... - def where(self, *expressions) -> None: ... - def orwhere(self, *expressions) -> None: ... - def order_by(self, *values) -> None: ... - def order_by_extend(self, *values) -> None: ... - def limit(self, value: Incomplete | None = ...) -> None: ... - def offset(self, value: Incomplete | None = ...) -> None: ... - def paginate(self, page, paginate_by: int = ...) -> None: ... + def with_cte(self, *cte_list) -> Self: ... + def where(self, *expressions) -> Self: ... + def orwhere(self, *expressions) -> Self: ... + def order_by(self, *values) -> Self: ... + def order_by_extend(self, *values) -> Self: ... + def limit(self, value: Incomplete | None = ...) -> Self: ... + def offset(self, value: Incomplete | None = ...) -> Self: ... + def paginate(self, page, paginate_by: int = ...) -> Self: ... def __sql__(self, ctx): ... class SelectQuery(Query): @@ -570,7 +570,7 @@ class SelectQuery(Query): __rsub__: Incomplete def select_from(self, *columns): ... -class SelectBase(_HashableSource, Source, SelectQuery): +class SelectBase(_HashableSource, Source, SelectQuery): # type: ignore[misc] def peek(self, database, n: int = ...): ... def first(self, database, n: int = ...): ... def scalar(self, database, as_tuple: bool = ..., as_dict: bool = ...): ... @@ -603,23 +603,23 @@ class Select(SelectBase): **kwargs, ) -> None: ... def clone(self): ... - def columns(self, *columns, **kwargs) -> None: ... + def columns(self, *columns, **kwargs) -> Self: ... select: Incomplete - def select_extend(self, *columns) -> None: ... + def select_extend(self, *columns) -> Self: ... @property def selected_columns(self): ... @selected_columns.setter def selected_columns(self, value) -> None: ... - def from_(self, *sources) -> None: ... - def join(self, dest, join_type=..., on: Incomplete | None = ...) -> None: ... + def from_(self, *sources) -> Self: ... + def join(self, dest, join_type=..., on: Incomplete | None = ...) -> Self: ... def left_outer_join(self, dest, on: Incomplete | None = ...): ... - def group_by(self, *columns) -> None: ... + def group_by(self, *columns) -> Self: ... def group_by_extend(self, *values): ... - def having(self, *expressions) -> None: ... - def distinct(self, *columns) -> None: ... - def window(self, *windows) -> None: ... - def for_update(self, for_update: bool = ..., of: Incomplete | None = ..., nowait: Incomplete | None = ...) -> None: ... - def lateral(self, lateral: bool = ...) -> None: ... + def having(self, *expressions) -> Self: ... + def distinct(self, *columns) -> Self: ... + def window(self, *windows) -> Self: ... + def for_update(self, for_update: bool = ..., of: Incomplete | None = ..., nowait: Incomplete | None = ...) -> Self: ... + def lateral(self, lateral: bool = ...) -> Self: ... def __sql_selection__(self, ctx, is_subquery: bool = ...): ... def __sql__(self, ctx): ... @@ -627,7 +627,7 @@ class _WriteQuery(Query): table: Incomplete def __init__(self, table, returning: Incomplete | None = ..., **kwargs) -> None: ... def cte(self, name, recursive: bool = ..., columns: Incomplete | None = ..., materialized: Incomplete | None = ...): ... - def returning(self, *returning) -> None: ... + def returning(self, *returning) -> Self: ... def apply_returning(self, ctx): ... def execute_returning(self, database): ... def handle_result(self, database, cursor): ... @@ -635,7 +635,7 @@ class _WriteQuery(Query): class Update(_WriteQuery): def __init__(self, table, update: Incomplete | None = ..., **kwargs) -> None: ... - def from_(self, *sources) -> None: ... + def from_(self, *sources) -> Self: ... def __sql__(self, ctx): ... class Insert(_WriteQuery): @@ -653,11 +653,11 @@ class Insert(_WriteQuery): on_conflict: Incomplete | None = ..., **kwargs, ) -> None: ... - def where(self, *expressions) -> None: ... - def as_rowcount(self, _as_rowcount: bool = ...) -> None: ... - def on_conflict_ignore(self, ignore: bool = ...) -> None: ... - def on_conflict_replace(self, replace: bool = ...) -> None: ... - def on_conflict(self, *args, **kwargs) -> None: ... + def where(self, *expressions) -> None: ... # type: ignore[override] + def as_rowcount(self, _as_rowcount: bool = ...) -> Self: ... + def on_conflict_ignore(self, ignore: bool = ...) -> Self: ... + def on_conflict_replace(self, replace: bool = ...) -> Self: ... + def on_conflict(self, *args, **kwargs) -> Self: ... def get_default_data(self): ... def get_default_columns(self): ... def __sql__(self, ctx): ... @@ -677,9 +677,9 @@ class Index(Node): where: Incomplete | None = ..., using: Incomplete | None = ..., ) -> None: ... - def safe(self, _safe: bool = ...) -> None: ... - def where(self, *expressions) -> None: ... - def using(self, _using: Incomplete | None = ...) -> None: ... + def safe(self, _safe: bool = ...) -> Self: ... + def where(self, *expressions) -> Self: ... + def using(self, _using: Incomplete | None = ...) -> Self: ... def __sql__(self, ctx): ... class ModelIndex(Index): @@ -1723,9 +1723,9 @@ class FieldAlias(Field): class _ModelQueryHelper: default_row_type: Incomplete def __init__(self, *args, **kwargs) -> None: ... - def objects(self, constructor: Incomplete | None = ...) -> None: ... + def objects(self, constructor: Incomplete | None = ...) -> Self: ... -class ModelRaw(_ModelQueryHelper, RawQuery): +class ModelRaw(_ModelQueryHelper, RawQuery): # type: ignore[misc] model: Incomplete def __init__(self, model, sql, params, **kwargs) -> None: ... def get(self): ... @@ -1743,13 +1743,13 @@ class BaseModelSelect(_ModelQueryHelper): def prefetch(self, *subqueries): ... def get(self, database: Incomplete | None = ...): ... def get_or_none(self, database: Incomplete | None = ...): ... - def group_by(self, *columns) -> None: ... + def group_by(self, *columns) -> Self: ... -class ModelCompoundSelectQuery(BaseModelSelect, CompoundSelectQuery): +class ModelCompoundSelectQuery(BaseModelSelect, CompoundSelectQuery): # type: ignore[misc] model: Incomplete def __init__(self, model, *args, **kwargs) -> None: ... -class ModelSelect(BaseModelSelect, Select): +class ModelSelect(BaseModelSelect, Select): # type: ignore[misc] model: Incomplete def __init__(self, model, fields_or_models, is_default: bool = ...) -> None: ... def clone(self): ... @@ -1758,7 +1758,7 @@ class ModelSelect(BaseModelSelect, Select): def switch(self, ctx: Incomplete | None = ...): ... def join( self, dest, join_type=..., on: Incomplete | None = ..., src: Incomplete | None = ..., attr: Incomplete | None = ... - ) -> None: ... + ) -> Self: ... def left_outer_join(self, dest, on: Incomplete | None = ..., src: Incomplete | None = ..., attr: Incomplete | None = ...): ... def join_from(self, src, dest, join_type=..., on: Incomplete | None = ..., attr: Incomplete | None = ...): ... def ensure_join(self, lm, rm, on: Incomplete | None = ..., **join_kwargs): ... @@ -1775,16 +1775,16 @@ class _ModelWriteQueryHelper(_ModelQueryHelper): def __init__(self, model, *args, **kwargs) -> None: ... def returning(self, *returning): ... -class ModelUpdate(_ModelWriteQueryHelper, Update): ... +class ModelUpdate(_ModelWriteQueryHelper, Update): ... # type: ignore[misc] -class ModelInsert(_ModelWriteQueryHelper, Insert): +class ModelInsert(_ModelWriteQueryHelper, Insert): # type: ignore[misc] default_row_type: Incomplete def __init__(self, *args, **kwargs) -> None: ... def returning(self, *returning): ... def get_default_data(self): ... def get_default_columns(self): ... -class ModelDelete(_ModelWriteQueryHelper, Delete): ... +class ModelDelete(_ModelWriteQueryHelper, Delete): ... # type: ignore[misc] class ManyToManyQuery(ModelSelect): def __init__(self, instance, accessor, rel, *args, **kwargs) -> None: ...