ucsschool.kelvin.client.base module

class ucsschool.kelvin.client.base.KelvinObject(*, name: str | None = None, ucsschool_roles: List[str] | None = None, udm_properties: Dict[str, Any] | None = None, dn: str | None = None, url: str | None = None, session: Session | None = None, language: str | None = None, **kwargs)

Bases: object

as_dict() → Dict[str, Any]

async delete() → None

async reload() → KelvinObjectType

Reload properties of object from the Kelvin API.

Raises:

ucsschool.kelvin.client.NoObject – if the object cannot be found

Returns:

self

async save() → KelvinObjectType

class ucsschool.kelvin.client.base.KelvinResource(session: Session, language: str | None = None)

Bases: object

class Meta

Bases: object

kelvin_object

alias of KelvinObject

required_get_attrs: Iterable[str] = ('name',)

required_head_attrs: Iterable[str] = ('name',)

required_search_attrs: Iterable[str] = ('school',)

async exists(**kwargs) → bool

async get(**kwargs) → KelvinObjectType

async get_from_url(url: str) → KelvinObjectType

async search(**kwargs) → AsyncIterator[KelvinObjectType]