budosystems.models.contact.ContactList

class ContactList

Bases: Entity, MutableMapping[Optional[Union[str, ellipsis]], Union[CT, MissingContact]]

Aggregate class for Contacts. Each list has a ‘preferred’ contact from the list, which can be accessed by passing (Ellipsis) or None as the key to the map operations.

data: dict[str, CT_Missing[CT]]

preferred: th.OptStr

keys() → KeysView[str]

See dict.keys

items() → ItemsView[str, CT | MissingContact]

See dict.items

values() → ValuesView[CT | MissingContact]

See dict.values

get(key: budosystems.models.contact.OptStrEllipsis, default: ~budosystems.models.contact.CT | ~budosystems.models.contact.MissingContact = <singleton MissingContact>) → CT | MissingContact

See dict.get

pop(key: budosystems.models.contact.OptStrEllipsis, default: ~budosystems.models.contact.CT | ~budosystems.models.contact.MissingContact = <singleton MissingContact>) → CT | MissingContact

See dict.pop

popitem() → tuple[str, CT | MissingContact]

See dict.popitem

clear() → None

See dict.clear

update(values: Mapping[str, CT] | Iterable[tuple[str, CT]] | None = None, **kwargs: CT) → None

See dict.update

setdefault(key: budosystems.models.contact.OptStrEllipsis, default: ~budosystems.models.contact.CT | ~budosystems.models.contact.MissingContact = <singleton MissingContact>) → CT | MissingContact

See dict.setdefault

__init__(*, id_name: str = _Nothing.NOTHING, entity_id: UUID = <singleton MissingUUID>, data: dict[str, CT_Missing[CT]] = _Nothing.NOTHING, preferred: th.OptStr = None) → None

Method generated by attrs for class ContactList.