Skip to main content

register_lookup

Context manager to temporarily register lookups on a model field using lookup_name (or the lookup's lookup_name if not provided).

def register_lookup(
field: Field,
*lookups: Lookup,
lookup_name: str = None
) - > None

Context manager to temporarily register lookups on a model field using lookup_name (or the lookup's lookup_name if not provided).

Parameters

NameTypeDescription
fieldFieldThe Django model field instance where the lookups will be temporarily registered.
*lookupsLookupOne or more lookup classes or instances to be registered on the field.
lookup_namestr = NoneAn optional custom name to use for the lookup; if omitted, the lookup's default name is used.

Returns

TypeDescription
NoneA context manager that yields control to the wrapped block and ensures lookups are unregistered upon exit.