sqlalchemy.ext.associationproxy._AssociationDict

class documentation

class _AssociationDict(_AssociationCollection[_VT], MutableMapping[_KT, _VT]): (source)

View In Hierarchy

Generic, converting, dict-to-dict proxy.

Method __contains__ Undocumented
Method __delitem__ Undocumented
Method __eq__ Undocumented
Method __getitem__ Undocumented
Method __hash__ Undocumented
Method __iter__ Undocumented
Method __ne__ Undocumented
Method __repr__ Undocumented
Method __setitem__ Undocumented
Method clear Undocumented
Method copy Undocumented
Method get Undocumented
Method items Undocumented
Method keys Undocumented
Method pop Undocumented
Method popitem Undocumented
Method setdefault Undocumented
Method update Undocumented
Method values Undocumented
Class Variable col Undocumented
Class Variable creator A function that creates new target entities. Given one parameter: value. This assertion is assumed::
Class Variable setter A function. Given an associated object and a value, store that value on the object.
Method _bulk_replace Undocumented
Method _create Undocumented
Method _get Undocumented
Method _set Undocumented

Inherited from _AssociationCollection:

Method __bool__ Undocumented
Method __getstate__ Undocumented
Method __init__ Constructs an _AssociationCollection.
Method __len__ Undocumented
Method __setstate__ Undocumented
Instance Variable getter A function. Given an associated object, return the 'value'.
Instance Variable lazy_collection A callable returning a list-based collection of entities (usually an object attribute managed by a SQLAlchemy relationship())
Instance Variable parent Undocumented
def __contains__(self, key: object) -> bool: (source)

Undocumented

def __delitem__(self, key: _KT): (source)

Undocumented

def __eq__(self, other: object) -> bool: (source)

Undocumented

def __getitem__(self, key: _KT) -> _VT: (source)

Undocumented

def __hash__(self) -> NoReturn: (source)

Undocumented

def __iter__(self) -> Iterator[_KT]: (source)

Undocumented

def __ne__(self, other: object) -> bool: (source)

Undocumented

def __repr__(self) -> str: (source)

Undocumented

def __setitem__(self, key: _KT, value: _VT): (source)

Undocumented

def clear(self): (source)
overrides sqlalchemy.ext.associationproxy._AssociationCollection.clear

Undocumented

def copy(self) -> Dict[_KT, _VT]: (source)

Undocumented

@overload
def get(self, __key: _KT) -> Optional[_VT]:
@overload
def get(self, __key: _KT, default: Union[_VT, _T]) -> Union[_VT, _T]:
(source)

Undocumented

def items(self) -> ItemsView[_KT, _VT]: (source)

Undocumented

def keys(self) -> KeysView[_KT]: (source)

Undocumented

@overload
def pop(self, __key: _KT) -> _VT:
@overload
def pop(self, __key: _KT, default: Union[_VT, _T] = ...) -> Union[_VT, _T]:
(source)

Undocumented

def popitem(self) -> Tuple[_KT, _VT]: (source)

Undocumented

def setdefault(self, key: _KT, default: Optional[_VT] = None) -> _VT: (source)

Undocumented

@overload
def update(self, __m: SupportsKeysAndGetItem[_KT, _VT], **kwargs: _VT):
@overload
def update(self, __m: Iterable[tuple[_KT, _VT]], **kwargs: _VT):
@overload
def update(self, **kwargs: _VT):
(source)

Undocumented

def values(self) -> ValuesView[_VT]: (source)

Undocumented

col: MutableMapping[_KT, Optional[_VT]] = (source)
overrides sqlalchemy.ext.associationproxy._AssociationCollection.col

Undocumented

creator: _KeyCreatorProtocol[_VT] = (source)
overrides sqlalchemy.ext.associationproxy._AssociationCollection.creator

A function that creates new target entities. Given one parameter: value. This assertion is assumed:: obj = creator(somevalue) assert getter(obj) == somevalue

setter: _DictSetterProtocol[_VT] = (source)
overrides sqlalchemy.ext.associationproxy._AssociationCollection.setter

A function. Given an associated object and a value, store that value on the object.

def _bulk_replace(self, assoc_proxy: AssociationProxyInstance[Any], values: Mapping[_KT, _VT]): (source)

Undocumented

def _create(self, key: _KT, value: Optional[_VT]) -> Any: (source)

Undocumented

def _get(self, object_: Any) -> _VT: (source)

Undocumented

def _set(self, object_: Any, key: _KT, value: _VT): (source)

Undocumented