Source code for django_latch.models

"""
Models to associate a user to the Latch service.
"""

# SPDX-License-Identifier: BSD-3-Clause

from django.db import models
from django.contrib.auth import get_user_model

UserModel = get_user_model()


def is_paired(user):
    """
    Check if a user has configured the Latch service, returning
    ``True`` if so, ``False`` otherwise.
    """
    return LatchUserConfig.objects.filter(user=user).exists()



[docs]
class LatchUserConfig(models.Model):
    """
    Store the necessary configuration to associate
    a user to the Latch service.

    .. attribute:: account_id

        A 64-long :class:`~django.db.models.CharField` that identifies the
        user in the Latch service.

    .. attribute:: user

        A :class:`~django.db.models.OneToOneField` that identifies the user
        who has configured the Latch service.
    """

    user = models.OneToOneField(
        UserModel,
        on_delete=models.CASCADE,
        related_name="latch_config",
    )
    account_id = models.CharField(unique=True, max_length=64, blank=False)