django-stubs/django-stubs/db/models/constraints.pyi

from enum import Enum
from typing import Any, Optional, Sequence, Tuple, Type, TypeVar, Union, overload

from django.db.backends.base.schema import BaseDatabaseSchemaEditor
from django.db.models.base import Model
from django.db.models.expressions import Combinable
from django.db.models.query_utils import Q

_T = TypeVar("_T", bound="BaseConstraint")

class Deferrable(Enum):
    DEFERRED: str
    IMMEDIATE: str

class BaseConstraint:
    name: str
    def __init__(self, name: str) -> None: ...
    def constraint_sql(
        self, model: Optional[Type[Model]], schema_editor: Optional[BaseDatabaseSchemaEditor]
    ) -> str: ...
    def create_sql(self, model: Optional[Type[Model]], schema_editor: Optional[BaseDatabaseSchemaEditor]) -> str: ...
    def remove_sql(self, model: Optional[Type[Model]], schema_editor: Optional[BaseDatabaseSchemaEditor]) -> str: ...
    def deconstruct(self) -> Any: ...
    def clone(self: _T) -> _T: ...

class CheckConstraint(BaseConstraint):
    check: Q
    def __init__(self, *, check: Q, name: str) -> None: ...

class UniqueConstraint(BaseConstraint):
    expressions: Tuple[Combinable, ...]
    fields: Tuple[str, ...]
    condition: Optional[Q]
    deferrable: Optional[Deferrable]

    @overload
    def __init__(
        self,
        *expressions: Union[str, Combinable],
        fields: None = ...,
        name: str,
        condition: Optional[Q] = ...,
        deferrable: Optional[Deferrable] = ...,
        include: Optional[Sequence[str]] = ...,
        opclasses: Sequence[Any] = ...,
    ) -> None: ...
    @overload
    def __init__(
        self,
        *,
        fields: Sequence[str],
        name: str,
        condition: Optional[Q] = ...,
        deferrable: Optional[Deferrable] = ...,
        include: Optional[Sequence[str]] = ...,
        opclasses: Sequence[Any] = ...,
    ) -> None: ...