angee.base.identity

Transport-neutral public-identity adapters for Django models.

SqidPublicIdentity

@dataclass(frozen=True, slots=True)
class SqidPublicIdentity()

Sqid adapter for a third-party model that Angee cannot add a field to.

public_id_from_pk

def public_id_from_pk(value: Any) -> str

Return the public id encoded from a primary-key value.

public_id_to_pk

def public_id_to_pk(value: str) -> int | None

Decode one public id to the backing primary-key value.

public_id_lookup

def public_id_lookup(model: type[models.Model], value: str) -> dict[str, Any]

Return a Django lookup for value against model.

sqid_field

@property
def sqid_field() -> SqidField

Return the owner field used to encode and decode this adapter's ids.

public_data_id_field

def public_data_id_field(model: type[models.Model]) -> SqidField | None

Return the sqid field that makes model safe for public data surfaces.

instance_from_public_id

def instance_from_public_id(
        model: type[_ModelT],
        value: str,
        *,
        queryset: models.QuerySet[_ModelT] | None = None,
        public_identity: SqidPublicIdentity | None = None) -> _ModelT | None

Resolve a generic model or third-party identity; known Angee owners delegate.

public_id_of

def public_id_of(instance: models.Model) -> str

Return the public id for a generic model instance.

public_id_for

def public_id_for(model: type[models.Model],
                  pk: Any,
                  *,
                  public_identity: SqidPublicIdentity | None = None) -> str

Return a generic model's public id when only its primary key is known.