Source code for ldap_sync.concepts.types

#  Copyright (c) 2022. The Pycroft Authors. See the AUTHORS file.
#  This file is part of the Pycroft project and licensed under the terms of
#  the Apache License, Version 2.0. See the LICENSE file for details
"""
ldap_sync.concepts.types
~~~~~~~~~~~~~~~~~~~~~~~~
Type aliases, :class:`NewTypes <typing.NewType>`, etc.
"""
import typing
from typing import Union

AttributeValues = Union[
    str, bytes, int,
    typing.Collection[str], typing.Collection[bytes], typing.Collection[int],
    None
]
Attributes = dict[str, AttributeValues]
# Depending on the LDAP scheme, attributes may be single-valued or multi-valued
# (e.g. `mail`, `memberOf`, `objectClass` as opposed to `uid`)
# canonicalized to a list
NormalizedAttributes = dict[
    str,
    typing.Collection[str] | typing.Collection[bytes] | typing.Collection[int],
]

#: An LDAP Distinguished Name
DN = typing.NewType('DN', str)


# an ldap record, as represented by the `ldap3` response dict.
# see https://ldap3.readthedocs.io/en/latest/connection.html#responses


class LdapRecord(typing.TypedDict):
    dn: DN
    attributes: Attributes
    raw_attributes: dict[str, list[bytes]]