Пакет utils¶

Модуль doc¶

Средства мультиязычной документации к методам API.

В этом модуле реализованы функции с отложенным переводом и унифицированные заготовки переводов для составления документации к методам.

apidoc_lazy(header, params=_('Nothing'), data='', footer='')¶

Возвращает отложенный вызов форматирования документации по шаблону. Пример использования.

string_lazy(string, args=None)¶

Возвращает отложенный вызов соединения шаблонной строки с приняными аргументами. Пример использования.

JS_BOOLEAN_TEMPLATE¶

Шаблон для ответа истинностью.

RETURN_BOOLEAN_SUCCESS¶

Шаблонный ответ метода.

true // если успешно, иначе false

RETURN_BOOLEAN_NOTSUCCESS¶

Шаблонный ответ метода.

true // если не успешно, иначе false

RETURN_BOOLEAN_EXISTS¶

Шаблонный ответ метода.

true // если существует, иначе false

RETURN_BOOLEAN_NOTEXISTS¶

Шаблонный ответ метода.

true // если не существует, иначе false

PARAMS_UPDATE_FIELD_TEMPLATE¶

Шаблон для параметров метода обновления обекта.

PARAMS_UPDATE_FIELD¶

Шаблонная мультиязычная документация по принимаемым парамерам для метода обновления обекта.

1. "pk"    - первичный ключ;
2. "field" - имя поля;
3. "value" - новое значение для поля.

QUICKTABLE_PARAMS¶

Шаблонная мультиязычная документация по принимаемым парамерам для методов с QuickTables.

1. "filters"  - фильтры;
2. "ordering" - сортировка;
3. "page"     - номер страницы;
4. "limit"    - объектов на страницу.

QUICKTABLE_DATA¶

Шаблонная мультиязычная документация ответов для методов с QuickTables.

{
    objects: [],  // список объектов
    page: 1,      // номер страницы
    num_pages: 3, // количество страниц
    info: null    // или специальная информация
}

Модуль filters¶

Средства фильтрации Queryset.

construct_search(field_name)¶

Вспомогательная функция для построения поисковых полей.

filter_queryset(queryset, search_fields, query)¶

Фильтрация по нескольким полям.

Модуль lang¶

Функции обработки переключения языков.

switch_language(request, code=None)¶

Переключает язык для приложения, если такое переключение не запрещено в настройках.

Модуль method¶

Средства для обработки методов.

class Collection(object)¶

Класс, реализующий отсортированный словарь методов

import_string(dotted_path)¶

Импортирует разделённый точками путь к модулю и возвращает атрибут/класс определённый последним именем в этом пути. Вызывает ImportError если импорт невозможен.

get_methods(list_or_dict=QUICKAPI_DEFINED_METHODS, sort=True)¶

Преобразует словарь или список заданных строками методов, реальными объектами функций. Форматы list_or_dict: ((‘’,’‘),(‘’,’‘)) либо [[‘’,’‘],[‘’,’‘]] либо {‘’:’‘, ‘’:’‘}

Модуль requests¶

Средства для обработки запросов.

parse_auth(request, data)¶

Производит поиск авторизационных данных, возвращает кортеж из двух элементов: username и password.

login_from_request(request, data=None)¶

Авторизует пользователя извлекая учётные значения из запроса или переданного словаря данных.

clean_kwargs(request, data)¶

Очищает данные запроса от зарезервированных ключей.

clean_uri(request)¶

Очищает путь от параметров GET-запроса, оставляя только сам адрес.

warning_auth_in_get(request)¶

Проверка наличия данных авторизации в GET-запросах. Выполняется с кешированием проверки в атрибут _warning_auth_in_get запроса.

is_callable(request)¶

Проверка вызова метода.

Когда в POST запросе есть ключ jsonData или method, то это вызов метода. Когда в GET запросе есть ключ method, то это тоже вызов метода. Иначе - это просмотр документации.