tldap.database package

Submodules

tldap.database.helpers module

Various helper functions to aid applications processing schema specific functions.

tldap.database.helpers.add_group_member(changes: Changeset, member: LdapObject) → Changeset

tldap.database.helpers.get_fields_account() → Dict[str, Field]

tldap.database.helpers.get_fields_common() → Dict[str, Field]

tldap.database.helpers.get_fields_group() → Dict[str, Field]

tldap.database.helpers.get_fields_password_object() → Dict[str, Field]

tldap.database.helpers.get_fields_person() → Dict[str, Field]

tldap.database.helpers.get_fields_pwdpolicy() → Dict[str, Field]

tldap.database.helpers.get_fields_shadow() → Dict[str, Field]

tldap.database.helpers.get_fields_shibboleth() → Dict[str, Field]

tldap.database.helpers.load_account(python_data: LdapObject, group_table: Type[LdapObject]) → LdapObject

tldap.database.helpers.load_group(python_data: LdapObject, account_table: Type[LdapObject]) → LdapObject

tldap.database.helpers.load_password_object(python_data: LdapObject) → LdapObject

tldap.database.helpers.load_person(python_data: LdapObject, group_table: Type[LdapObject]) → LdapObject

tldap.database.helpers.load_pwdpolicy(python_data: LdapObject) → LdapObject

tldap.database.helpers.load_shadow(python_data: LdapObject) → LdapObject

tldap.database.helpers.load_shibboleth(python_data: LdapObject) → LdapObject

tldap.database.helpers.rdn_to_dn(changes: Changeset, name: str, base_dn: str) → Changeset

Convert the rdn to a fully qualified DN for the specified LDAP connection.

Parameters:

• changes – The changes object to lookup.

• name – rdn to convert.

• base_dn – The base_dn to lookup.

Returns:

fully qualified DN.

tldap.database.helpers.remove_group_member(changes: Changeset, member: LdapObject) → Changeset

tldap.database.helpers.save_account(changes: Changeset, database: Database, format_fields: Set[str] | None = None) → Changeset

tldap.database.helpers.save_group(changes: Changeset) → Changeset

tldap.database.helpers.save_password_object(changes: Changeset) → Changeset

tldap.database.helpers.save_person(changes: Changeset, database: Database, format_fields: Set[str] | None = None) → Changeset

tldap.database.helpers.save_pwdpolicy(changes: Changeset) → Changeset

tldap.database.helpers.save_shadow(changes: Changeset) → Changeset

tldap.database.helpers.save_shibboleth(changes: Changeset, database: Database) → Changeset

tldap.database.helpers.set_object_class(changes: Changeset, object_class: List[str]) → Changeset

Module contents

High level database interaction.

class tldap.database.Changeset(fields: Dict[str, Field], src: LdapObject, d: dict | None = None)

Bases: ImmutableDict

Represents a set of changes to an LdapObject.

property changes: Dict[str, List[Tuple[MODIFY_ADD, List[Any]]]]

property errors: List[str]

force_add(key: str, value: Any) → Changeset

force_delete(key: str, value: Any) → Changeset

force_replace(key: str, value: Any) → Changeset

get_value_as_list(key: str) → List[Any]

get_value_as_single(key: str) → any

property is_valid: bool

property src: LdapObject

class tldap.database.Database(connection: LdapBase, settings: dict | None = None)

Bases: object

property connection: LdapBase

property settings: dict

class tldap.database.LdapObject(d: dict | None = None)

Bases: ImmutableDict

A high level python representation of a LDAP object.

get_as_list(key: str) → List[Any]

get_as_single(key: str) → Any

classmethod get_fields() → Dict[str, Field]

classmethod get_search_options(database: Database) → SearchOptions

classmethod on_load(python_data: LdapObject, database: Database) → LdapObject

classmethod on_save(changes: Changeset, database: Database) → Changeset

class tldap.database.NotLoaded

Bases: object

Base class to represent a related field that has not been loaded.

load(database: Database | None = None) → LdapObject

class tldap.database.NotLoadedList(*, table: Type[LdapObject], key: str, value: str)

Bases: NotLoaded

Represents a list of objects that needs to be loaded via a single key.

load(database: Database | None = None) → List[LdapObject]

class tldap.database.NotLoadedObject(*, table: Type[LdapObject], key: str, value: str)

Bases: NotLoaded

Represents a single object that needs to be loaded.

load(database: Database | None = None) → LdapObject

class tldap.database.SearchOptions(base_dn: str, object_class: Set[str], pk_field: str)

Bases: object

Application specific search options.

tldap.database.changeset(python_data: LdapObject, d: dict) → Changeset

Generate changes object for ldap object.

tldap.database.delete(python_data: LdapObject, database: Database | None = None) → None

Delete a LdapObject from the database.

tldap.database.get_database(database: Database | None) → Database

tldap.database.get_default_database()

tldap.database.get_one(table: Type[LdapObject], query: Q | None = None, database: Database | None = None, base_dn: str | None = None) → LdapObject

Get exactly one result from the database or fail.

tldap.database.insert(python_data: LdapObject, database: Database | None = None) → LdapObject

Insert a new python_data object in the database.

tldap.database.preload(python_data: LdapObject, database: Database | None = None) → LdapObject

Preload all NotLoaded fields in LdapObject.

tldap.database.rename(python_data: LdapObject, new_base_dn: str | None = None, database: Database | None = None, **kwargs) → LdapObject

Move/rename a LdapObject in the database.

tldap.database.save(changes: Changeset, database: Database | None = None) → LdapObject

Save all changes in a LdapChanges.

tldap.database.search(table: Type[LdapObject], query: Q | None = None, database: Database | None = None, base_dn: str | None = None) → Iterator[LdapObject]

Search for a object of given type in the database.