ucsschool.kelvin.client package

Submodules

• ucsschool.kelvin.client.base module
  • KelvinObject
    • KelvinObject.as_dict()
    • KelvinObject.delete()
    • KelvinObject.reload()
    • KelvinObject.save()
  • KelvinResource
    • KelvinResource.Meta
      • KelvinResource.Meta.kelvin_object
      • KelvinResource.Meta.required_get_attrs
      • KelvinResource.Meta.required_head_attrs
      • KelvinResource.Meta.required_search_attrs
    • KelvinResource.exists()
    • KelvinResource.get()
    • KelvinResource.get_from_url()
    • KelvinResource.search()
• ucsschool.kelvin.client.exceptions module
  • InvalidRequest
  • InvalidToken
  • KelvinClientError
  • NoObject
  • ServerError
• ucsschool.kelvin.client.role module
  • Role
    • Role.as_dict()
    • Role.delete()
    • Role.save()
  • RoleResource
    • RoleResource.Meta
      • RoleResource.Meta.kelvin_object
      • RoleResource.Meta.required_get_attrs
      • RoleResource.Meta.required_head_attrs
      • RoleResource.Meta.required_search_attrs
• ucsschool.kelvin.client.school module
  • School
    • School.delete()
    • School.save()
  • SchoolResource
    • SchoolResource.Meta
      • SchoolResource.Meta.kelvin_object
      • SchoolResource.Meta.required_get_attrs
      • SchoolResource.Meta.required_head_attrs
      • SchoolResource.Meta.required_save_attrs
      • SchoolResource.Meta.required_search_attrs
• ucsschool.kelvin.client.school_class module
  • SchoolClass
  • SchoolClassResource
    • SchoolClassResource.Meta
      • SchoolClassResource.Meta.kelvin_object
      • SchoolClassResource.Meta.required_get_attrs
      • SchoolClassResource.Meta.required_head_attrs
      • SchoolClassResource.Meta.required_save_attrs
      • SchoolClassResource.Meta.required_search_attrs
• ucsschool.kelvin.client.session module
  • BadSettingsWarning
  • KelvinClientWarning
  • Session
    • Session.client
    • Session.close()
    • Session.delete()
    • Session.get()
    • Session.head()
    • Session.json_headers
    • Session.open()
    • Session.post()
    • Session.put()
    • Session.request()
    • Session.token
  • Token
    • Token.expiry
    • Token.from_str()
    • Token.is_valid()
    • Token.value
• ucsschool.kelvin.client.user module
  • PasswordsHashes
    • PasswordsHashes.as_dict()
    • PasswordsHashes.as_dict_with_ldap_attr_names()
    • PasswordsHashes.krb5_key_version_number
    • PasswordsHashes.krb_5_key
    • PasswordsHashes.krb_5_key_as_bytes
    • PasswordsHashes.samba_nt_password
    • PasswordsHashes.samba_pwd_last_set
    • PasswordsHashes.user_password
  • User
  • UserResource
    • UserResource.Meta
      • UserResource.Meta.kelvin_object
      • UserResource.Meta.required_get_attrs
      • UserResource.Meta.required_head_attrs
      • UserResource.Meta.required_save_attrs
      • UserResource.Meta.required_search_attrs
• ucsschool.kelvin.client.workgroup module
  • WorkGroup
  • WorkGroupResource
    • WorkGroupResource.Meta
      • WorkGroupResource.Meta.kelvin_object
      • WorkGroupResource.Meta.required_get_attrs
      • WorkGroupResource.Meta.required_head_attrs
      • WorkGroupResource.Meta.required_save_attrs
      • WorkGroupResource.Meta.required_search_attrs

Module contents

exception ucsschool.kelvin.client.InvalidRequest(msg: str | None = None, status: int | None = None, reason: str | None = None, url: str | None = None)

Bases: KelvinClientError

exception ucsschool.kelvin.client.InvalidToken(msg: str | None = None, status: int | None = None, reason: str | None = None, url: str | None = None)

Bases: KelvinClientError

exception ucsschool.kelvin.client.KelvinClientError(msg: str | None = None, status: int | None = None, reason: str | None = None, url: str | None = None)

Bases: Exception

class ucsschool.kelvin.client.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.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]

exception ucsschool.kelvin.client.NoObject(msg: str | None = None, status: int | None = None, reason: str | None = None, url: str | None = None)

Bases: KelvinClientError

class ucsschool.kelvin.client.PasswordsHashes(user_password: List[str], samba_nt_password: str, krb_5_key: List[str], krb5_key_version_number: int, samba_pwd_last_set: int)

Bases: object

as_dict() → Dict[str, Any]

as_dict_with_ldap_attr_names() → Dict[str, Any]

Wrapper around as_dict() that renames the keys to those used in a UCS’ OpenLDAP.

krb5_key_version_number: int

krb_5_key: List[str]

property krb_5_key_as_bytes: List[bytes]

Value of krb_5_key as a list of bytes.

samba_nt_password: str

samba_pwd_last_set: int

user_password: List[str]

class ucsschool.kelvin.client.Role(name: str, *, display_name: str | None = None, url: str | None = None, session: Session | None = None, language: str | None = None, **kwargs)

Bases: KelvinObject

as_dict() → Dict[str, Any]

async delete() → None

async save() → RoleResource

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

Bases: KelvinResource

class Meta

Bases: object

kelvin_object

alias of Role

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

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

required_search_attrs: Iterable[str] = ()

class ucsschool.kelvin.client.School(name: str, *, display_name: str | None = None, educational_servers: List[str] | None = None, administrative_servers: List[str] | None = None, class_share_file_server: str | None = None, home_share_file_server: 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: KelvinObject

async delete() → None

async save() → SchoolResource

class ucsschool.kelvin.client.SchoolClass(name: str, school: str, *, description: str | None = None, users: List[str] | None = None, create_share: bool = True, 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: KelvinObject

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

Bases: KelvinResource

class Meta

Bases: object

kelvin_object

alias of SchoolClass

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

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

required_save_attrs: Iterable[str] = ('name', 'school')

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

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

Bases: KelvinResource

class Meta

Bases: object

kelvin_object

alias of School

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

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

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

required_search_attrs: Iterable[str] = ()

exception ucsschool.kelvin.client.ServerError(msg: str | None = None, status: int | None = None, reason: str | None = None, url: str | None = None)

Bases: KelvinClientError

class ucsschool.kelvin.client.Session(username: str, password: str, host: str, max_client_tasks: int = 10, request_id: str | None = None, request_id_header: str = 'X-Request-ID', language: str | None = None, retries: int = 0, **kwargs)

Bases: object

property client: AsyncClient

async close() → None

async delete(url: str, **kwargs) → None

async get(url: str, **kwargs) → Dict[str, Any] | List[Dict[str, Any]]

async head(url: str, **kwargs) → bool

json_headers

open() → AsyncClient

async post(url: str, **kwargs) → Dict[str, Any]

async put(url: str, **kwargs) → Dict[str, Any]

async request(async_request_method: Any, url: str, return_json: bool = True, **kwargs) → str | int | Dict[str, Any]

token

class ucsschool.kelvin.client.User(name: str | None = None, school: str | None = None, *, firstname: str | None = None, lastname: str | None = None, birthday: date | None = None, disabled: bool = False, email: str | None = None, expiration_date: date | None = None, password: str | None = None, record_uid: str | None = None, roles: List[str], schools: List[str], school_classes: Dict[str, List[str]] | None = None, workgroups: Dict[str, List[str]] | None = None, source_uid: str | None = None, udm_properties: Dict[str, Any] | None = None, ucsschool_roles: List[str] | None = None, kelvin_password_hashes: PasswordsHashes | None = None, dn: str | None = None, url: str | None = None, session: Session | None = None, language: str | None = None, legal_guardians: List[str] | None = None, legal_wards: List[str] | None = None, **kwargs)

Bases: KelvinObject

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

Bases: KelvinResource

class Meta

Bases: object

kelvin_object

alias of User

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

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

required_save_attrs: Iterable[str] = ('school', 'roles')

required_search_attrs: Iterable[str] = ()

class ucsschool.kelvin.client.WorkGroup(name: str, school: str, *, description: str | None = None, users: List[str] | None = None, email: str | None = None, allowed_email_senders_users: List[str] | None = None, allowed_email_senders_groups: List[str] | None = None, create_share: bool = True, 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)

Bases: KelvinObject

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

Bases: KelvinResource

class Meta

Bases: object

kelvin_object

alias of WorkGroup

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

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

required_save_attrs: Iterable[str] = ('name', 'school')

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