API регистрации¶

Django uses RegisterLookupMixin to give a class the interface to register lookups on itself. The two prominent examples are Field, the base class of all model fields, and Transform, the base class of all Django transforms.

class lookups.RegisterLookupMixin¶

Миксин, реализующий API поиска в классе.

classmethod register_lookup(lookup, lookup_name=None)¶

Registers a new lookup in the class. For example DateField.register_lookup(YearExact) will register YearExact lookup on DateField. It overrides a lookup that already exists with the same name. lookup_name will be used for this lookup if provided, otherwise lookup.lookup_name will be used.

get_lookup(lookup_name)¶

Returns the Lookup named lookup_name registered in the class. The default implementation looks recursively on all parent classes and checks if any has a registered lookup named lookup_name, returning the first match.

get_lookups()¶

Returns a dictionary of each lookup name registered in the class mapped to the Lookup class.

get_transform(transform_name)¶

Returns a Transform named transform_name. The default implementation looks recursively on all parent classes to check if any has the registered transform named transform_name, returning the first match.

Чтобы класс был поисковым, он должен следовать Query Expression API. Lookup и Transform естественным образом следуют этому API.

API выражения запроса¶

API выражений запросов — это общий набор методов, которые классы определяют для использования в выражениях запросов для преобразования себя в выражения SQL. Прямые ссылки на поля, агрегаты и «Преобразование» — это примеры, которые следуют за этим API. Говорят, что класс следует API выражения запроса, когда он реализует следующие методы:

as_sql(compiler, connection)¶

Создает фрагмент SQL для выражения. Возвращает кортеж (sql, params), где sql — это строка SQL, а params — это список или кортеж параметров запроса. Компилятор — это объект SQLCompiler, который имеет метод compile(), который можно использовать для компиляции других выражений. Соединение — это соединение, используемое для выполнения запроса.

Вызов expression.as_sql() обычно неверен - вместо этого следует использовать compiler.compile(expression). Метод compiler.compile() позаботится о вызове методов выражения, специфичных для поставщика.

В этом методе могут быть определены аргументы пользовательского ключевого слова, если вероятно, что методам или подклассам as_vendorname() потребуется предоставить данные для переопределения генерации строки SQL. См. пример использования Func.as_sql().

as_vendorname(compiler, connection)¶

Работает как метод as_sql(). Когда выражение компилируется с помощью compiler.compile(), Django сначала попытается вызвать as_vendorname(), где vendorname — это имя поставщика бэкэнда, используемого для выполнения запроса. vendorname — это одно из postgresql, oracle, sqlite или mysql для встроенных бэкэндов Django.

get_lookup(lookup_name)¶

Должен вернуть поиск с именем «имя_искателя». Например, вернув self.output_field.get_lookup(lookup_name).

get_transform(transform_name)¶

Должен вернуть поиск с именем «transform_name». Например, вернув self.output_field.get_transform(transform_name).

output_field¶

Определяет тип класса, возвращаемого методом get_lookup(). Это должен быть экземпляр Field.

Ссылка Преобразование¶

class Transform¶

«Transform» — это универсальный класс для реализации преобразований полей. Ярким примером является __year, который преобразует DateField в IntegerField.

Обозначение для использования Transform в выражении поиска: <expression>__<transformation> (например, date__year).

Этот класс соответствует Query Expression API, что подразумевает, что вы можете использовать <выражение>__<transform1>__<transform2>. Это специализированное выражение Func(), которое принимает только один аргумент. Его также можно использовать в правой части фильтра или непосредственно в качестве аннотации.

bilateral¶

Логическое значение, указывающее, должно ли это преобразование применяться как к lhs, так и к rhs. Двусторонние преобразования будут применены к rhs в том же порядке, в котором они появляются в выражении поиска. По умолчанию установлено значение «False». Пример использования см. в Custom Lookups.

lhs¶

Левая часть – что трансформируется. Оно должно соответствовать Query Expression API.

lookup_name¶

Имя поиска, используемое для его идентификации при анализе выражений запроса. Он не может содержать строку "__".

output_field¶

Определяет класс, который выводит это преобразование. Это должен быть экземпляр Field. По умолчанию это то же самое, что и его lhs.output_field.

Справочник Поиск¶

class Lookup¶

«Lookup» — это универсальный класс для реализации поиска. Поиск — это выражение запроса с левой частью: lhs; правая часть: rhs; и ищу_имя, которое используется для создания логического сравнения между lhs и rhs, например, lhs в rhs или lhs > rhs.

The notation to use a lookup in an expression is <lhs>__<lookup_name>=<rhs>.

This class acts as a query expression, but, since it has =<rhs> on its construction, lookups must always be the end of a lookup expression.

lhs¶

The left-hand side - what is being looked up. The object must follow the Query Expression API.

rhs¶

Правая часть — с чем сравнивается «левая сторона». Это может быть простое значение или что-то, что компилируется в SQL, обычно это объект F() или QuerySet.

lookup_name¶

Имя этого поиска, используемое для его идентификации при анализе выражений запроса. Он не может содержать строку "__".

process_lhs(compiler, connection, lhs=None)¶

Возвращает кортеж (lhs_string, lhs_params), возвращенный compiler.compile(lhs). Этот метод можно переопределить, чтобы настроить обработку lhs.

компилятор — это объект SQLCompiler, который можно использовать как compiler.compile(lhs) для компиляции lhs. Соединение может использоваться для компиляции SQL, специфичного для конкретного поставщика. Если lhs не равен None, используйте его как обработанный lhs вместо self.lhs.

process_rhs(compiler, connection)¶

В правой части ведет себя так же, как process_lhs().