1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
|
import collections
from collections.abc import Callable, Iterable, Iterator, Sequence
from typing import Any, Literal, NamedTuple
from django.db.backends.utils import CursorWrapper
from django.db.models import Field, FilteredRelation, Model, Q
from django.db.models.expressions import BaseExpression, Combinable, Expression
from django.db.models.lookups import Lookup, Transform
from django.db.models.options import Options
from django.db.models.query import _OrderByFieldName
from django.db.models.query_utils import PathInfo
from django.db.models.sql.datastructures import BaseTable, Join
from django.db.models.sql.where import WhereNode
from django.utils.functional import cached_property
class JoinInfo(NamedTuple):
final_field: Field
targets: tuple[Any, ...]
opts: Any
joins: list[str]
path: list[Any]
transform_function: Callable[[Field, str], Expression]
class RawQuery:
high_mark: int | None
low_mark: int | None
params: Any
sql: str
using: str
extra_select: dict[Any, Any]
annotation_select: dict[Any, Any]
cursor: CursorWrapper | None
def __init__(self, sql: str, using: str, params: Any = ()) -> None: ...
def chain(self, using: str) -> RawQuery: ...
def clone(self, using: str) -> RawQuery: ...
def get_columns(self) -> list[str]: ...
def __iter__(self) -> Iterator[Any]: ...
@property
def params_type(self) -> type[dict | tuple] | None: ...
class Query(BaseExpression):
related_ids: list[int] | None
related_updates: dict[type[Model], list[tuple[Field, None, int | str]]]
values: list[Any]
alias_prefix: str
subq_aliases: frozenset[Any]
compiler: str
base_table_class: type[BaseTable]
model: type[Model] | None
alias_refcount: dict[str, int]
alias_map: dict[str, BaseTable | Join]
external_aliases: dict[str, bool]
table_map: dict[str, list[str]]
default_cols: bool
default_ordering: bool
standard_ordering: bool
used_aliases: set[str]
where: WhereNode
filter_is_sticky: bool
subquery: bool
group_by: None | Sequence[Combinable] | Sequence[str] | Literal[True]
order_by: Sequence[_OrderByFieldName]
distinct: bool
distinct_fields: tuple[str, ...]
select: Sequence[BaseExpression]
select_for_update: bool
select_for_update_nowait: bool
select_for_update_skip_locked: bool
select_for_update_of: tuple
select_for_no_key_update: bool
select_related: dict[str, Any] | bool
max_depth: int
join_class: type[Join]
values_select: tuple
selected: dict[str, int | str | Expression] | None
annotation_select_mask: list[str] | None
combinator: str | None
combinator_all: bool
combined_queries: tuple
extra_select_mask: set[str] | None
extra_tables: tuple
extra_order_by: Sequence[_OrderByFieldName]
deferred_loading: tuple[set[str] | frozenset[str], bool]
explain_query: bool
explain_format: str | None
explain_options: dict[str, int]
high_mark: int | None
low_mark: int
extra: dict[str, Any]
annotations: dict[str, Expression]
empty_result_set_value: Any | None
explain_info: Any | None
def __init__(self, model: type[Model] | None, alias_cols: bool = True) -> None: ...
@property
def output_field(self) -> Field: ...
@property
def has_select_fields(self) -> bool: ...
@cached_property
def base_table(self) -> str: ...
def add_annotation(self, annotation: Any, alias: str, select: bool = True) -> None: ...
def sql_with_params(self) -> tuple[str, tuple]: ...
def __deepcopy__(self, memo: dict[int, Any]) -> Query: ...
def get_compiler(
self, using: str | None = None, connection: Any | None = None, elide_empty: bool = True
) -> Any: ...
def join_parent_model(self, opts: Any, model: Any | None, alias: str, seen: dict[Any, str]) -> str: ...
def names_to_path(
self, names: list[str], opts: Any, allow_many: bool = True, fail_on_missing: bool = False
) -> tuple[list[Any], Any, tuple[Any, ...], list[str]]: ...
def get_meta(self) -> Options: ...
def clone(self) -> Query: ...
def chain(self, klass: type[Query] | None = None) -> Query: ...
def get_count(self, using: str) -> int: ...
def get_group_by_cols(self, wrapper: Any | None = None) -> list[Any]: ...
def has_filters(self) -> WhereNode: ...
def get_external_cols(self) -> list[Any]: ...
def exists(self, limit: bool = True) -> Any: ...
def has_results(self, using: str) -> bool: ...
def explain(self, using: str, format: str | None = None, **options: Any) -> str: ...
def combine(self, rhs: Query, connector: str) -> None: ...
def ref_alias(self, alias: str) -> None: ...
def unref_alias(self, alias: str, amount: int = 1) -> None: ...
def promote_joins(self, aliases: Iterable[str]) -> None: ...
def demote_joins(self, aliases: Iterable[str]) -> None: ...
def reset_refcounts(self, to_counts: dict[str, int]) -> None: ...
def check_alias(self, alias: str) -> None: ...
def check_related_objects(self, field: Any, value: Any, opts: Any) -> None: ...
def check_query_object_type(self, value: Any, opts: Any, field: Any) -> None: ...
def change_aliases(self, change_map: dict[str | None, str]) -> None: ...
def bump_prefix(self, other_query: Query, exclude: Any | None = None) -> None: ...
def get_initial_alias(self) -> str: ...
def count_active_tables(self) -> int: ...
def resolve_expression(self, query: Query, *args: Any, **kwargs: Any) -> Query: ... # type: ignore[override]
def resolve_lookup_value(
self, value: Any, can_reuse: set[str] | None, allow_joins: bool, summarize: bool = False
) -> Any: ...
def solve_lookup_type(
self, lookup: str, summarize: bool = False
) -> tuple[Sequence[str], Sequence[str], Expression | Literal[False]]: ...
def table_alias(
self, table_name: str, create: bool = False, filtered_relation: Any | None = None
) -> tuple[str, bool]: ...
def get_aggregation(self, using: Any, aggregate_exprs: dict[str, Any]) -> dict[str, Any]: ...
def build_filter(
self,
filter_expr: Q | Expression | dict[str, str] | tuple[str, Any],
branch_negated: bool = False,
current_negated: bool = False,
can_reuse: set[str] | None = None,
allow_joins: bool = True,
split_subq: bool = True,
check_filterable: bool = True,
summarize: bool = False,
update_join_types: bool = True,
) -> tuple[WhereNode, Iterable[str]]: ...
def add_select_col(self, col: Any, name: str) -> None: ...
def add_filter(self, filter_lhs: tuple[str, Any], filter_rhs: tuple[str, Any]) -> None: ...
def add_q(self, q_object: Q, reuse_all: bool = False) -> None: ...
def build_where(self, filter_expr: Q | Expression | dict[str, str] | tuple[str, Any]) -> WhereNode: ...
def add_filtered_relation(self, filtered_relation: FilteredRelation, alias: str) -> None: ...
def setup_joins(
self,
names: Sequence[str],
opts: Any,
alias: str,
can_reuse: set[str] | None = None,
allow_many: bool = True,
) -> JoinInfo: ...
def trim_joins(
self, targets: tuple[Field, ...], joins: list[str], path: list[PathInfo]
) -> tuple[tuple[Field, ...], str, list[str]]: ...
def resolve_ref(
self, name: str, allow_joins: bool = True, reuse: set[str] | None = None, summarize: bool = False
) -> Expression: ...
def split_exclude(
self,
filter_expr: tuple[str, Any],
can_reuse: set[str],
names_with_path: list[tuple[str, list[PathInfo]]],
) -> tuple[WhereNode, Iterable[str]]: ...
def set_empty(self) -> None: ...
def is_empty(self) -> bool: ...
def set_limits(self, low: int | None = None, high: int | None = None) -> None: ...
def clear_limits(self) -> None: ...
@property
def is_sliced(self) -> bool: ...
def has_limit_one(self) -> bool: ...
def can_filter(self) -> bool: ...
def clear_select_clause(self) -> None: ...
def clear_select_fields(self) -> None: ...
def set_select(self, cols: list[Expression]) -> None: ...
def add_distinct_fields(self, *field_names: str) -> None: ...
def add_fields(self, field_names: Iterable[str], allow_m2m: bool = True) -> None: ...
def add_ordering(self, *ordering: _OrderByFieldName) -> None: ...
def clear_where(self) -> None: ...
def clear_ordering(self, force: bool = False, clear_default: bool = True) -> None: ...
def set_group_by(self, allow_aliases: bool = True) -> None: ...
def add_select_related(self, fields: Iterable[str]) -> None: ...
def add_extra(
self,
select: dict[str, Any] | None,
select_params: Iterable[Any] | None,
where: Sequence[str] | None,
params: Sequence[str] | None,
tables: Sequence[str] | None,
order_by: Sequence[_OrderByFieldName] | None,
) -> None: ...
def clear_deferred_loading(self) -> None: ...
def add_deferred_loading(self, field_names: Iterable[str]) -> None: ...
def add_immediate_loading(self, field_names: Iterable[str]) -> None: ...
def get_select_mask(self) -> dict[str, Any]: ...
def set_annotation_mask(self, names: Iterable[str] | None) -> None: ...
def append_annotation_mask(self, names: Iterable[str]) -> None: ...
def set_extra_mask(self, names: Iterable[str] | None) -> None: ...
def set_values(self, fields: Iterable[str] | None) -> None: ...
@property
def annotation_select(self) -> dict[str, Any]: ...
@property
def extra_select(self) -> dict[str, Any]: ...
def trim_start(self, names_with_path: list[tuple[str, list[PathInfo]]]) -> tuple[str, bool]: ...
def is_nullable(self, field: Field) -> bool: ...
def check_filterable(self, expression: Any) -> None: ...
def build_lookup(self, lookups: Sequence[str], lhs: Expression | Query, rhs: Any) -> Lookup: ...
def try_transform(self, lhs: Expression | Query, name: str, lookups: Sequence[str] | None = ...) -> Transform: ...
def join(
self,
join: BaseTable | Join,
reuse: str | None = None,
) -> str: ...
class JoinPromoter:
connector: str
negated: bool
effective_connector: str
num_children: int
votes: collections.Counter
def __init__(self, connector: str, num_children: int, negated: bool) -> None: ...
def add_votes(self, votes: Iterable[str]) -> None: ...
def update_join_types(self, query: Query) -> set[str]: ...
__all__ = ["Query", "RawQuery"]
|