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 _typeshed import Self
from _typeshed.dbapi import DBAPIConnection
from abc import abstractmethod
from collections.abc import Callable, Mapping
from types import TracebackType
from typing import Any, TypeVar, overload
from typing_extensions import Concatenate, ParamSpec, TypeAlias
from ..log import Identified, _EchoFlag, echo_property
from ..pool import Pool
from ..sql.compiler import Compiled
from ..sql.ddl import DDLElement
from ..sql.elements import ClauseElement
from ..sql.functions import FunctionElement
from ..sql.schema import DefaultGenerator
from .cursor import CursorResult
from .interfaces import Connectable as Connectable, Dialect, ExceptionContext
from .url import URL
from .util import TransactionalContext
_T = TypeVar("_T")
_P = ParamSpec("_P")
_Executable: TypeAlias = ClauseElement | FunctionElement | DDLElement | DefaultGenerator | Compiled
class Connection(Connectable):
engine: Engine
dialect: Dialect
should_close_with_result: bool
dispatch: Any
def __init__(
self,
engine: Engine,
connection: DBAPIConnection | None = ...,
close_with_result: bool = ...,
_branch_from: Any | None = ...,
_execution_options: Any | None = ...,
_dispatch: Any | None = ...,
_has_events: Any | None = ...,
_allow_revalidate: bool = ...,
) -> None: ...
def schema_for_object(self, obj) -> str | None: ...
def __enter__(self: Self) -> Self: ...
def __exit__(
self, type_: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None
) -> None: ...
def execution_options(self, **opt): ...
def get_execution_options(self): ...
@property
def closed(self) -> bool: ...
@property
def invalidated(self) -> bool: ...
@property
def connection(self) -> DBAPIConnection: ...
def get_isolation_level(self): ...
@property
def default_isolation_level(self): ...
@property
def info(self): ...
def connect(self, close_with_result: bool = ...): ... # type: ignore[override]
def invalidate(self, exception: Exception | None = ...) -> None: ...
def detach(self) -> None: ...
def begin(self) -> Transaction: ...
def begin_nested(self) -> Transaction | None: ...
def begin_twophase(self, xid: Any | None = ...) -> TwoPhaseTransaction: ...
def recover_twophase(self): ...
def rollback_prepared(self, xid, recover: bool = ...) -> None: ...
def commit_prepared(self, xid, recover: bool = ...) -> None: ...
def in_transaction(self) -> bool: ...
def in_nested_transaction(self) -> bool: ...
def get_transaction(self) -> Transaction | None: ...
def get_nested_transaction(self) -> Transaction | None: ...
def close(self) -> None: ...
@overload
def scalar(self, object_: _Executable, *multiparams: Mapping[str, Any], **params: Any) -> Any: ...
@overload
def scalar(self, object_: str, *multiparams: Any | tuple[Any, ...] | Mapping[str, Any], **params: Any) -> Any: ...
def scalars(self, object_, *multiparams, **params): ...
@overload # type: ignore[override]
def execute(self, statement: _Executable, *multiparams: Mapping[str, Any], **params) -> CursorResult: ...
@overload
def execute(self, statement: str, *multiparams: Any | tuple[Any, ...] | Mapping[str, Any], **params) -> CursorResult: ...
def exec_driver_sql(self, statement: str, parameters: Any | None = ..., execution_options: Any | None = ...): ...
def transaction(self, callable_: Callable[Concatenate[Connection, _P], _T], *args: _P.args, **kwargs: _P.kwargs) -> _T: ...
def run_callable(self, callable_: Callable[Concatenate[Connection, _P], _T], *args: _P.args, **kwargs: _P.kwargs) -> _T: ...
class ExceptionContextImpl(ExceptionContext):
engine: Any
connection: Any
sqlalchemy_exception: Any
original_exception: Any
execution_context: Any
statement: Any
parameters: Any
is_disconnect: Any
invalidate_pool_on_disconnect: Any
def __init__(
self,
exception,
sqlalchemy_exception,
engine,
connection,
cursor,
statement,
parameters,
context,
is_disconnect,
invalidate_pool_on_disconnect,
) -> None: ...
class Transaction(TransactionalContext):
def __init__(self, connection: Connection) -> None: ...
@property
def is_valid(self) -> bool: ...
def close(self) -> None: ...
def rollback(self) -> None: ...
def commit(self) -> None: ...
# The following field are technically not defined on Transaction, but on
# all sub-classes.
@property
@abstractmethod
def connection(self) -> Connection: ...
@property
@abstractmethod
def is_active(self) -> bool: ...
class MarkerTransaction(Transaction):
connection: Connection
@property
def is_active(self) -> bool: ...
class RootTransaction(Transaction):
connection: Connection
is_active: bool
class NestedTransaction(Transaction):
connection: Connection
is_active: bool
class TwoPhaseTransaction(RootTransaction):
xid: Any
def __init__(self, connection: Connection, xid) -> None: ...
def prepare(self) -> None: ...
class Engine(Connectable, Identified):
pool: Pool
url: URL
dialect: Dialect
logging_name: str # only exists if not None during initialization
echo: echo_property
hide_parameters: bool
def __init__(
self,
pool: Pool,
dialect: Dialect,
url: str | URL,
logging_name: str | None = ...,
echo: _EchoFlag = ...,
query_cache_size: int = ...,
execution_options: Mapping[str, Any] | None = ...,
hide_parameters: bool = ...,
) -> None: ...
@property
def engine(self) -> Engine: ...
def clear_compiled_cache(self) -> None: ...
def update_execution_options(self, **opt) -> None: ...
def execution_options(self, **opt): ...
def get_execution_options(self): ...
@property
def name(self) -> str: ...
@property
def driver(self): ...
def dispose(self, close: bool = ...) -> None: ...
class _trans_ctx:
conn: Connection
transaction: Transaction
close_with_result: bool
def __init__(self, conn: Connection, transaction: Transaction, close_with_result: bool) -> None: ...
def __enter__(self) -> Connection: ...
def __exit__(
self, type_: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None
) -> None: ...
def begin(self, close_with_result: bool = ...) -> _trans_ctx: ...
def transaction(
self, callable_: Callable[Concatenate[Connection, _P], _T], *args: _P.args, **kwargs: _P.kwargs
) -> _T | None: ...
def run_callable(self, callable_: Callable[Concatenate[Connection, _P], _T], *args: _P.args, **kwargs: _P.kwargs) -> _T: ...
@overload # type: ignore[override]
def execute(self, statement: _Executable, *multiparams: Mapping[str, Any], **params: Any) -> CursorResult: ...
@overload
def execute(self, statement: str, *multiparams: Any | tuple[Any, ...] | Mapping[str, Any], **params: Any) -> CursorResult: ...
@overload # type: ignore[override]
def scalar(self, statement: _Executable, *multiparams: Mapping[str, Any], **params: Any) -> Any: ...
@overload
def scalar(self, statement: str, *multiparams: Any | tuple[Any, ...] | Mapping[str, Any], **params: Any) -> Any: ...
def connect(self, close_with_result: bool = ...) -> Connection: ... # type: ignore[override]
def table_names(self, schema: Any | None = ..., connection: Connection | None = ...): ...
def has_table(self, table_name: str, schema: Any | None = ...) -> bool: ...
def raw_connection(self, _connection: Connection | None = ...) -> DBAPIConnection: ...
class OptionEngineMixin:
url: URL
dialect: Dialect
logging_name: str
echo: bool
hide_parameters: bool
dispatch: Any
def __init__(self, proxied, execution_options) -> None: ...
pool: Pool
class OptionEngine(OptionEngineMixin, Engine): ... # type: ignore[misc]
|