sqlalchemy2-stubs/sqlalchemy-stubs/orm/decl_m.pyi at a436c381ae7ae36b31941765ebaf9a0530233ef9 · sqlalchemy/sqlalchemy2-stubs · GitHub

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
from typing import AbstractSet
from typing import Any
from typing import Callable
from typing import Literal
from typing import Mapping
from typing import MutableMapping
from typing import Optional
from typing import overload
from typing import Sequence
from typing import Tuple
from typing import Type
from typing import TypeVar
from typing import Union

from sqlalchemy.sql.elements import ColumnElement
from .attributes import Mapped as Mapped
from .relationships import _OrderByArgument
from ..sql import schema
from ..sql import sqltypes
from ..sql.schema import _ServerDefaultType
from ..sql.schema import FetchedValue
from ..sql.schema import SchemaEventTarget

_T = TypeVar("_T")

_BackrefResult = Tuple[str, Mapping[str, Any]]

class MappedColumn(Mapped[_T]):
    def __init__(self, expr: _T) -> None: ...
    def operate(self, op: Any, *other: Any, **kwargs: Any): ...
    def reverse_operate(self, op: Any, other: Any, **kwargs: Any): ...

@overload
def column(
    __name: str,
    *args: SchemaEventTarget,
    autoincrement: Union[bool, Literal["auto", "ignore_fk"]] = ...,
    default: Optional[Any] = ...,
    doc: Optional[str] = ...,
    key: Optional[str] = ...,
    index: Optional[bool] = ...,
    info: MutableMapping[Any, Any] = ...,
    nullable: bool = ...,
    onupdate: Optional[Any] = ...,
    primary_key: bool = ...,
    server_default: Optional[_ServerDefaultType[Any]] = ...,
    server_onupdate: Optional[FetchedValue] = ...,
    quote: Optional[bool] = ...,
    unique: Optional[bool] = ...,
    system: bool = ...,
    comment: Optional[str] = ...,
    **kwargs: Any,
) -> Mapped[Any]: ...
@overload
def column(
    *args: SchemaEventTarget,
    autoincrement: Union[bool, Literal["auto", "ignore_fk"]] = ...,
    default: Optional[Any] = ...,
    doc: Optional[str] = ...,
    key: Optional[str] = ...,
    index: Optional[bool] = ...,
    info: MutableMapping[Any, Any] = ...,
    nullable: bool = ...,
    onupdate: Optional[Any] = ...,
    primary_key: bool = ...,
    server_default: Optional[_ServerDefaultType[Any]] = ...,
    server_onupdate: Optional[FetchedValue] = ...,
    quote: Optional[bool] = ...,
    unique: Optional[bool] = ...,
    system: bool = ...,
    comment: Optional[str] = ...,
    **kwargs: Any,
) -> Mapped[Any]: ...
@overload
def column(
    __name: str,
    _type: Union[sqltypes.TypeEngine[_T], Type[sqltypes.TypeEngine[_T]]],
    *args: SchemaEventTarget,
    autoincrement: Union[bool, Literal["auto", "ignore_fk"]] = ...,
    default: Optional[Any] = ...,
    doc: Optional[str] = ...,
    key: Optional[str] = ...,
    index: Optional[bool] = ...,
    info: MutableMapping[Any, Any] = ...,
    nullable: Literal[False],
    onupdate: Optional[Any] = ...,
    primary_key: bool = ...,
    server_default: Optional[_ServerDefaultType[schema._TE]] = ...,
    server_onupdate: Optional[FetchedValue] = ...,
    quote: Optional[bool] = ...,
    unique: Optional[bool] = ...,
    system: bool = ...,
    comment: Optional[str] = ...,
    **kwargs: Any,
) -> Mapped[_T]: ...
@overload
def column(
    _type: Union[sqltypes.TypeEngine[_T], Type[sqltypes.TypeEngine[_T]]],
    *args: SchemaEventTarget,
    autoincrement: Union[bool, Literal["auto", "ignore_fk"]] = ...,
    default: Optional[Any] = ...,
    doc: Optional[str] = ...,
    key: Optional[str] = ...,
    index: Optional[bool] = ...,
    info: MutableMapping[Any, Any] = ...,
    nullable: Literal[False],
    onupdate: Optional[Any] = ...,
    primary_key: bool = ...,
    server_default: Optional[_ServerDefaultType[schema._TE]] = ...,
    server_onupdate: Optional[FetchedValue] = ...,
    quote: Optional[bool] = ...,
    unique: Optional[bool] = ...,
    system: bool = ...,
    comment: Optional[str] = ...,
    **kwargs: Any,
) -> Mapped[_T]: ...
@overload
def column(
    __name: str,
    _type: Union[sqltypes.TypeEngine[_T], Type[sqltypes.TypeEngine[_T]]],
    *args: SchemaEventTarget,
    autoincrement: Union[bool, Literal["auto", "ignore_fk"]] = ...,
    default: Optional[Any] = ...,
    doc: Optional[str] = ...,
    key: Optional[str] = ...,
    index: Optional[bool] = ...,
    info: MutableMapping[Any, Any] = ...,
    nullable: bool = ...,
    onupdate: Optional[Any] = ...,
    primary_key: bool = ...,
    server_default: Optional[_ServerDefaultType[schema._TE]] = ...,
    server_onupdate: Optional[FetchedValue] = ...,
    quote: Optional[bool] = ...,
    unique: Optional[bool] = ...,
    system: bool = ...,
    comment: Optional[str] = ...,
    **kwargs: Any,
) -> Mapped[Optional[_T]]: ...
@overload
def column(
    _type: Union[sqltypes.TypeEngine[_T], Type[sqltypes.TypeEngine[_T]]],
    *args: SchemaEventTarget,
    autoincrement: Union[bool, Literal["auto", "ignore_fk"]] = ...,
    default: Optional[Any] = ...,
    doc: Optional[str] = ...,
    key: Optional[str] = ...,
    index: Optional[bool] = ...,
    info: MutableMapping[Any, Any] = ...,
    nullable: bool = ...,
    onupdate: Optional[Any] = ...,
    primary_key: bool = ...,
    server_default: Optional[_ServerDefaultType[schema._TE]] = ...,
    server_onupdate: Optional[FetchedValue] = ...,
    quote: Optional[bool] = ...,
    unique: Optional[bool] = ...,
    system: bool = ...,
    comment: Optional[str] = ...,
    **kwargs: Any,
) -> Mapped[Optional[_T]]: ...
def column_property(
    expr: ColumnElement[sqltypes.TypeEngine[_T]],
    *addl: ColumnElement[Any],
    **kw: Any,
) -> Mapped[_T]: ...
def composite(cls: _T, *arg: Any, **kw: Any) -> Mapped[_T]: ...
def deferred(
    expr: ColumnElement[sqltypes.TypeEngine[_T]],
    *addl: ColumnElement[Any],
    **kw: Any,
) -> Mapped[_T]: ...
def query_expression(
    typ: sqltypes.TypeEngine[_T], default_expr: Any = ...
) -> Mapped[_T]: ...
def synonym(*arg, **kw) -> Any: ...
def related(
    entity: Optional[_T] = ...,
    secondary: Optional[Any] = ...,
    primaryjoin: Optional[Any] = ...,
    secondaryjoin: Optional[Any] = ...,
    foreign_keys: Optional[Any] = ...,
    uselist: Optional[bool] = ...,
    order_by: _OrderByArgument = ...,
    backref: Union[str, _BackrefResult] = ...,
    back_populates: str = ...,
    overlaps: Union[AbstractSet[str], str] = ...,
    post_update: bool = ...,
    cascade: Union[Literal[False], Sequence[str]] = ...,
    viewonly: bool = ...,
    lazy: str = ...,
    collection_class: Optional[Union[Type[Any], Callable[[], Any]]] = ...,
    passive_deletes: Union[bool, Literal["all"]] = ...,
    passive_updates: bool = ...,
    remote_side: Optional[Any] = ...,
    enable_typechecks: bool = ...,  # NOTE: not documented
    join_depth: Optional[int] = ...,
    comparator_factory: Optional[Any] = ...,
    single_parent: bool = ...,
    innerjoin: Union[bool, str] = ...,
    distinct_target_key: Optional[bool] = ...,
    doc: Optional[str] = ...,
    active_history: bool = ...,
    cascade_backrefs: bool = ...,
    load_on_pending: bool = ...,
    bake_queries: bool = ...,
    _local_remote_pairs: Optional[Any] = ...,
    query_class: Optional[Any] = ...,
    info: Optional[MutableMapping[Any, Any]] = ...,
    omit_join: Optional[Literal[False]] = ...,
    sync_backref: Optional[Any] = ...,
) -> Mapped[_T]: ...
def declared_attr(
    fget: Callable[[Any], Mapped[_T]], cascading: bool = ...
) -> Mapped[_T]: ...