Нужно ли закрывать сессию при requests?

Question

[zilevsky]

Есть сервис с api с которого я хочу получать данные.
Для доступа сервис выдаёт токены, которые живут 12 часов.

Порядок действий:
1. Создаю сессию session_requests = Session()
2. Создаю запрос через requests на получение токена
3. Добавляю токен в header и создаю запрос на получение данных

Вопросов несколько
1. Я пока не использую базу данных, но поскольку токен живёт 12 часов думаю излишне запрашивать его каждый раз.
Какие есть практики для такого случая?
Как я понимаю есть несколько вариантов, но все сомнительные.
Первый, хранить токен в глобальной переменной. Второй, хранить в файле. Третий, хранить в env. Ну и четвёртый не хранить и запрашивать каждый раз.

2. Стоит ли разбивать на отдельные методы запрос на получение токена и запрос на получение данных?
Какие есть практики на этот случай?

3. Нужно ли закрывать сессию по типу такой конструкции?

with Session() as s:
    s.get(...)
    s.get(...)
    s.get(...)

3.1 Если разбивать получение токена и данных на отдельные методы, то нужно ли закрывать сессии в каждом методе?

Скорее всего для таких случаев есть какие-то отработанные паттерны, но я их к сожалению не знаю:)

Answer 1

[Vindicar]

1. Чем не устраивают обозначенные варианты? Если токен должен переживать перезапуск, храни его в конфигурации. Если не должен, храни его только в памяти - в глобальной переменной или в атрибуте класса.
2. Конечно стоит. Просто для того, чтобы при истечении токена на полпути его можно было перезапросить прозрачно для клиентского кода. Например, декоратор вида:

def requires_token(func):
    @functools.wraps(func)
    def wrapper(self, *args, **kwargs):  #оборачиваем метод, а не функцию
        try:
            result = func(self, *args, **kwargs)  # пробуем вызвать метод как есть
        except InvalidToken:  # кастомное исключение, которое должны выбрасывать методы
            self._acquire_new_token()  # получаем новый токен
            result = func(self, *args, **kwargs)  # пробуем еще раз
        return result

    return wrapper

Тогда любой декорированный метод, который выбрасывает исключение InvalidToken, спровоцирует автоматический запрос нового токена и одну повторную попытку выполнения операции.
Но можно делать это и явно, в каждом методе.
3. Под закрытием сессии ты понимаешь инвалидацию токена, т.е. невозможность его дальнейшего использования? Ну так это тебя нужно спрашивать, нужно ли закрывать сессию и требует ли используемое API явного закрытия сессии. Планируешь ли ты выполнять дальнейшие операции в рамках этой сессии? Если точно нет, можешь закрывать - например, при выходе из скрипта. Заодно снимется вопрос о хранении токена. Если не хочешь дёргать получение токена понапрасну, тогда храни токен, но не закрывай.
Делать это в КАЖДОМ методе точно бессмысленно.

Comments

[zilevsky]

Добрый день.
Спасибо за развёрнутый ответ.
Попробовал использовать декоратор, но в моём случае нужно передавать некоторые параметры и декоратор приходится оборачивать дополнительно.
В противном случае ругается на отсутвующий параметр func в такой конструкции

@requires_token
def get_messages(self, param1, param2, param3)
...

Пока я решил сделать через try и проверять время получения токена и если оно близко в 12 часам, то обновлять. В принципе тоже самое, но без декоратора.

[Vindicar]

zilevsky, я надеюсь, requires_token - это не метод того же класса? Это должна быть свободно стоящая функция.

Ну и да, я бы обновлял токен по факту облома. А вдруг они поменяют время жизни токена.

[zilevsky]

Vindicar, каюсь, ступил:)
Если вынести отдельным методом, то работает норм в таком виде.

На счёт обновления да, вы правы. Проще проверять статус ответа и по нему уже решать что делать дальше.

Вопрос остаётся лишь в хранении токена без redis или файлов.
Пробовал хранить его в глобальной переменной вне класса и в классе, но при вызове метода класса происходит переинициализация и переменная оказывается пустой до момента пока я не обращусь к методу получения токена и снова запишу его в переменную.

[Vindicar]

zilevsky, не знаю почему у тебя переинициализация. Я это вижу так.

class APIError(Exception):
    pass

class InvalidToken(APIError):
    pass

class APIWrapper:
    def __init__(self, token=None):
        self.token = token # публичное поле

    def _acquire_new_token(self):
        response = ask_actual_api_for_token() # пусть мы получаем словарь из JSON
        if error := response.get('error', None):
            raise APIError(error)
        else:
            self.token = response['token']

    @requires_token
    def do_stuff(self):
        response = ask_actual_api_for_stuff(self.token, params='foobar')
        if error := response.get('error', None):
            if error == 'Invalid token':
                raise InvalidToken()
            else:
                raise APIError(error)
        #  делаем что нужно с данными
        do_stuff_with_response(response)

Тогда мы по желанию можем сохранять и восстанавливать токен извне класса.
А вот куда - уже второй вопрос. Я без понятия, почему тебе недоступны даже файлы.

[zilevsky]

Vindicar, ну всё примерно так и есть.
У нас не очень любят хранение подобных вещей в файлах.
В любом случае огромное спасибо.
Подход усвоил.