sqlalchemy.event.legacy

module documentation
(source)

Routines to handle adaption of legacy call signatures, generation of deprecation notes and docstrings.

Function _augment_fn_docs Undocumented
Function _indent Undocumented
Function _legacy_listen_examples Undocumented
Function _legacy_signature legacy sig decorator
Function _standard_listen_example Undocumented
Function _version_signature_changes Undocumented
Function _wrap_fn_for_legacy Undocumented
Type Alias _LegacySignatureType Undocumented
def _augment_fn_docs(dispatch_collection: _ClsLevelDispatch[_ET], parent_dispatch_cls: Type[_HasEventsDispatch[_ET]], fn: _ListenerFnType) -> str: (source)

Undocumented

def _indent(text: str, indent: str) -> str: (source)

Undocumented

def _legacy_listen_examples(dispatch_collection: _ClsLevelDispatch[_ET], sample_target: str, fn: _ListenerFnType) -> str: (source)

Undocumented

def _legacy_signature(since: str, argnames: List[str], converter: Optional[Callable[..., Any]] = None) -> Callable[[Callable[..., Any]], Callable[..., Any]]: (source)

legacy sig decorator :param since: string version for deprecation warning :param argnames: list of strings, which is *all* arguments that the legacy version accepted, including arguments that are still there :param converter: lambda that will accept tuple of this full arg signature and return tuple of new arg signature.

def _standard_listen_example(dispatch_collection: _ClsLevelDispatch[_ET], sample_target: Any, fn: _ListenerFnType) -> str: (source)

Undocumented

def _version_signature_changes(parent_dispatch_cls: Type[_HasEventsDispatch[_ET]], dispatch_collection: _ClsLevelDispatch[_ET]) -> str: (source)

Undocumented

def _wrap_fn_for_legacy(dispatch_collection: _ClsLevelDispatch[_ET], fn: _ListenerFnType, argspec: FullArgSpec) -> _ListenerFnType: (source)

Undocumented

_LegacySignatureType = (source)

Undocumented

Value
Tuple[str, List[str], Optional[Callable[..., Any]]]