мета-данные страницы
  •  

Это старая версия документа!


Исключения

Имя Предок Описание
JWTError aw_web_tools.Error Базовый класс ошибок для модуля
JWTAuthError JWTError Провалена проверка токена на допустимость по подписи, времени действия или прочее

Класс JWTHelper

Упрощает общие задачи по оперированию JWT токенами.

Конструктор

JWTHelper(key)
Параметр Тип Описание
key str Ключ подписи токена

encode()

Создаёт токен на основе полученный в параметрах данных.

obj.encode(data, [timeout])

Возвращает: Строку, содержащую сформированный токен.

Параметр Тип По умолчанию Описание
data dict Данные на формирование токена в форме словаря.
timeout int None Время жизни токена в секундах

decode()

Получение данных из JWT токена.

obj.decode(token, [check_timeout])

Возвращает: Словарь с данными, сохранёнными в JWT токен.

Параметр Тип По умолчанию Описание
token str JWT токен
check_timeout bool False Если True и токен просрочен, будет возбуждено исключение JWTAuthError

Кроме того, исключение JWTAuthError возбуждается и в случае, когда токен имеет неверную подпись.

make_fabric()

Инициализирует фабрику объектов класса JWTHelper

JWTHelper.make_fabric(key)

Возвращает: Фабрику для получения объектов JWTHelper с данным ключём.

jwt_fabric = JWTHelper.make_fabric('S0me K3y!')
 
jwt_helper = jwt_fabric()