Значения констант влияют на работу функций и процедур. Если по каким-то причинам значения заданные здесь не подходят, можно после импорта переназначить эти константы.

proxy_set_header X-Request-Id $request_id;

proxy_set_header X-Conn-ID $connection-$connection_requests;

Получение реального адреса клиента.

Пытается получить адрес клиента из специальной переменной реверс-прокси. В случае неудачи, берёт IP узла, откуда пришёл запрос.

Проверки на установку IP доверенным источником не производится. Поскольку приложения не выставляются наружу без прикрытия nginx, который можно соответственно настроить, это не считается проблемой.

get_client_ip([request])

Возвращает: Строку с IP клиента.

Конструируем некий отпечаток пользовательской сессии.

В качестве параметра принимается всё, что должно участвовать в создании отпечатка. Это всё превращается в строку и подмешивается в хэш. То есть функции можно передать всё, что необходимо для идентификации сессии, и что в состоянии дать значимую строку (при преобразовании str() это должно быть что-то получше чем имя класса и спецсимволы)

get_session_fingerprint(add_params..., [request])

Возвращает: Строку с значением SHA512 от соединённых элементов, данных в параметрах, и некоторых значимых элементов самого запроса (идентификатор браузера и IP источника запроса.

Возвращает значения из хранилища контекста запроса bottle. Данный контекст уникален для каждого запроса и в нём могут хранится различные объекты Python, сохранённые обрабатывающим приложением.

get_env(name, [default], [request])

Возвращает: Имеющееся в контексте значение, или default, если его сохранили. Тип объекта контролируется разработчиком.

Добавляет в контекст переменную, которую затем можно запрашивать через get_env.

set_env(name, value, [request])

Формирование JSON ответа.

Полезно при программировании JSON REST-API. Даёт больший контроль над ответом.

make_response([data], [status], [cookies], [remove_cookies])

Возвращает: bottle.HTTPResponse, включающий все заданные функции параметры, который можно отдавать в качестве ответа обработчика URL в bottle

В качестве значения data может быть задана любая осмысленная конструкция. Функция способна к преобразованию в json-вид всех базовых конструкций языка (числа, строки, словари, списки, кортежи). Остальное она приводит к строке и возвращает строку. Конструкции могут быть вложены друг в друга.

Если запрос имеет тело JSON, и фреймворк это распознал, то функция вернёт этот JSON.

get_request_json()

Возвращает: Словарь, содержащий данный JSON

Получить значение cookie с заданным именем из текущего запроса.

get_cookie(name, [request])

Возвращает: Строку со значением cookie или None

Получить из запроса переданный пользователем параметр.

get_param(name, [param_type], [default], [postprocess], [param_source], [request])

Возвращает: Переданное пользователем значение

Приведение параметров к типу - очень базовая функциональность. Функция не пытается догадываться. Если целевой тип bool то применяется следующее соответствие:

Если будет что-то ещё, будет возбуждено исключение.

Обработка результата одна: если целевой тип - строка, то удаляются лидирующие и завершающие пробелы. Чего не ожидается, скажем, в полях паролей.

Сгенерировать подходящий префикс журналирования для данного запроса.

Помогает в журналировании событий, связанных с запросом.

make_log_topic([user], [request])

Возвращает: Строку, которую можно использовать для инициализации объекта лога

Создание сообщения об ошибке для JSON REST API сервисов.

make_error_response(code, err, [msg], [remove_cookies], [cookies])

Возвращает: bottle.HTTPResponse, включающий все заданные функции параметры, который можно отдавать в качестве ответа обработчика URL в bottle