Add config stores, update authentification flow, remove obsolete code, etc.

[ren3104]

@SecondThundeR, решил не документировать классы и методы, пока не утвердим реализацию. Вообще хотел бы это оставить на тебя, потому что мой бедный английский, в связке с DeepL, с трудом справляется.

• Реализовал три класса для хранения конфигов:
  • Store - абстрактный класс
  • MemoryStore - хранит конфиги в dict переменной
  • JsonStore - хранит конфиги в файле .shikithon, в формате json
• Переделал систему авторизации
• Добавил обновление токенов при ошибке 401
• Удалил protected декоратор со всех ресурсов
• Удалил передачу headers при отправке запроса во всех ресурсах
• Удалил теперь уже неиспользуемые utils методы convert_app_name_to_filename, get_new_expire_time
• Добавил классам клиентов и хранилищ __slots__

Примеры использования:

from shikithon import ShikimoriAPI, JsonStore

api = ShikimoriAPI(app_name="Api Test", store=JsonStore(), logging=False)

async def main():

    # Без авторизации
    async with api:
        ...

    # async with api.auth(...) нельзя вкладывать друг в друга

    # При авторизации app_name будет использовано из __init__
    # scopes можно не указывать, т.к оно будет получено при запросе токена
    # scopes разделяются пробелами
    async with api.auth(
        client_id="...",
        client_secret="...",
        auth_code="..."
    ):
        ...

    api_2 = ShikimoriAPI(app_name="Api Test", store=None, logging=False)
    # app_name в __init__ не будет перезаписан
    # Токен будет обновлен при ошибке 401
    api_auth_maker = api_2.auth(
        app_name="...",
        client_id="...",
        client_secret="...",
        access_token="...",
        refresh_token="..."
    )
    # Можно использовать сколько угодно раз
    async with api_auth_maker:
        ...

asyncio.run(main())

Можно еще добавить клиенту property для store и config. Не обновлять токен, если refresh_token == None и выводить ошибку 401. (Это не сделано)

[ren3104]

Добавить property store для таких случаев:

api = ShikimoriAPI(app_name="Api Test", store=JsonStore(), logging=False)

# Будет работать и проблем возникнуть не должно
api.store = None
api.store = MemoryStore()

# Могут быть проблемы, потому что предыдущий store при
# async with был открыт, но не закрыт, т.к. мы изменили store
# находясь в контекстном менеджере
# (добавить в store property status, чтобы отследить этот момент?)
async with api.auth(...):
    ...
    # Будут ли ошибки, если мы так изменим store? (Думаю нет)
    api.store = JsonStore()
    ...

...

В property config можно делать валидацию конфига.

Еще вспомнил, что можно добавить property scopes.

Напишу FAQ по сторам чуть позже. Если ты согласен с добавлением этих property, то сделаю это.

[SecondThundeR]

В принципе можно попробовать добавить такие property, так как подобный юзкейс все же может в теории возникнуть

[ren3104]

Думаю правильнее всего будет добавить property store и добавить опциональный параметр store для метода auth, если он назначен, то он будет использован при авторизации и обновлении токена, пока мы находимся в контекстном менеджере.

api = ShikimoriAPI(app_name="Api Test", logging=False)

print(api.store) # NullStore()

api.store = MemoryStore()

print(api.store) # MemoryStore()

async with api.auth(...):
    api.store = JsonStore()

    print(api.store) # JsonStore()

print(api.store) # JsonStore() !!!

api = ShikimoriAPI(app_name="Api Test", logging=False)

print(api.store) # NullStore()

api.store = MemoryStore()

print(api.store) # MemoryStore()

async with api.auth(..., store=JsonStore()):
    print(api.store) # JsonStore()

print(api.store) # MemoryStore()

[SecondThundeR]

Да, лучше сделать так, чтобы уже по надобности для контекста выбирать другое хранилище

[ren3104]

Скорее всего сделаю перерыв на день.

Что имеем на текущий момент:

• Нужно переписать метод request, чтобы он выводил ошибки с помощью raise и возвращал response только при статусе 200
• Мне не нравится этот момент https://github.com/ren3104/shikithon/blob/7a893fcf9b0fddd3b18ffa7e600a910e45a8a6b5/shikithon/base_client.py#L86. Скорее всего удалю property.setter store, но оставлю параметр store в .auth()
• Реализовать параметр store в .auth()
• Возможно получится изменить property status для хранилищ, чтобы не требовалась переменная _is_open
• Переименовать property status для хранилищ в closed

В memory хранилище изменить метод close на это:

async def close(self) -> None:
        self._configs.clear()
        return await super().close()

[SecondThundeR]

Добавил пока базовую документацию к хранилищам, новым методам в BaseClient, подправил документацию у некоторых текущих методов и переименовал JsonStore в JSONStore чтобы было все таки немного правильно с точки зрения того, что это аббревиатура.

Еще добавил пару исключений, чтобы не использовать базовый Exception и в хранилищах немного почистил код с помощью ранних выходов, чтобы слегка убрать вложенность в условиях

[ren3104]

Сохранение конфигов для авторизации

По умолчанию клиент использует хранилище NullStore, которое не сохраняет конфиги, но это можно изменить передав клиенту при инициализации в параметре store одно из готовых хранилищ:

• MemoryStore - сохраняет конфиги в dict переменной
• JSONStore - сохраняет конфиги в файле .shikithon, в JSON форматe (путь к файлу можно изменить при инициализации хранилища в параметре file_path)

  
  from shikithon import ShikimoriAPI, JSONStore

api = ShikimoriAPI(store=JSONStore())

Все хранилища закрываются при выходе из контекстного менеджера `.auth()`! Напрмер `MemoryStore` будет очищен при закрытии, что может стать причиной ошибок в последующих авторизациях.
Это поведение можно отключить изменив при инициализации клиента параметр `auto_close_store` на `False`.

## Создание своего хранилища
Если вам не подходит ни одно из готовых хранилищ, то вы можете реализовать свое хранилище создав класс, который наследует абстрактный класс `Store` и переопределяет его методы.
```python
# Создаем класс своего хранилища и наследуем Store
class MyStore(Store):
    # Переопределяем методы класса Store
    ...

[ren3104]

Думаю это все. Не стал добавлять возможность изменить store, т.к. с этим много проблем и не особо нужно

[SecondThundeR]

Хорошо, в принципе это такой уже edge-кейс получается, так что можно пренебречь. Единственное я счас еще перепроверю все и поменяю наверное название пулл реквеста, потому что немного больше изменений вышло

p.s. чет веб интерфейс херово резолвит конфликты, поэтому потом это починю

[SecondThundeR]

Спасибо еще раз за такой классный пулл реквест! Через пару часов отредачу ридми и уже сделаю релиз