Switch redis libraries

[euri10]

Fixes #55

it was not too complicate, imho it's cool to swap an unmaintained dependency to a more "official" one, see this message in the readme https://github.com/aio-libs/aioredis-py

Aioredis is now in redis-py 4.2.0rc1+
To install, just do pip install redis>=4.2.0rc1. The code is almost the exact same. You will just need to import like so:

[euri10]

I had to rename the redis.py in store to redis_store to avoid namespace conflicts with the new redis library that is called also redis

[alex-oleshkevich]

The previous solution always sets the connection. This change makes connection optional because it doesn't handle "else" case. Please replace "elif" with "else". We check configuration in the code above.

[euri10]

yep sorry that was bad

[euri10]

well I now know why I did this to please mypy, is the assert ok for you ?

[alex-oleshkevich]

Yes, totally. Just make sure it always truthy.

[alex-oleshkevich]

The documentation may still recommend the old library.

[euri10]

The documentation may still recommend the old library.

hopefully I didnt forget something now ;)

[alex-oleshkevich]

Will it pass mypy checks if typing library is not installed?

[euri10]

nope. see below

❯ poetry remove --dev types-redis
Updating dependencies
Resolving dependencies... (0.6s)

Writing lock file

Package operations: 0 installs, 0 updates, 1 removal

  • Removing types-redis (4.3.20)
❯ mypy --config-file pyproject.toml starsessions/ tests
starsessions/stores/redis.py:4: error: Library stubs not installed for "redis.asyncio.client" (or incompatible with Python 3.9)  [import]
    from redis.asyncio.client import Redis
    ^
starsessions/stores/redis.py:4: note: Hint: "python3 -m pip install types-redis"
starsessions/stores/redis.py:4: note: (or run "mypy --install-types" to install all missing stub packages)
starsessions/stores/redis.py:4: note: See https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports
starsessions/stores/redis.py:5: error: Library stubs not installed for "redis.asyncio.utils" (or incompatible with Python 3.9)  [import]
    from redis.asyncio.utils import from_url
    ^
starsessions/stores/redis.py:27: error: Variable "starsessions.stores.redis.BaseRedis" is not valid as a type  [valid-type]
            connection: typing.Optional[BaseRedis] = None,
                                        ^
starsessions/stores/redis.py:27: note: See https://mypy.readthedocs.io/en/stable/common_issues.html#variables-vs-type-aliases
starsessions/stores/redis.py:50: error: Variable "starsessions.stores.redis.BaseRedis" is not valid as a type  [valid-type]
                self._connection: BaseRedis = connection
                                  ^
starsessions/stores/redis.py:50: note: See https://mypy.readthedocs.io/en/stable/common_issues.html#variables-vs-type-aliases
starsessions/stores/redis.py:56: error: BaseRedis? has no attribute "get"  [attr-defined]
            value = await self._connection.get(self.prefix(session_id))
                          ^
starsessions/stores/redis.py:59: error: Returning Any from function declared to return "bytes"  [no-any-return]
            return value
            ^
starsessions/stores/redis.py:69: error: BaseRedis? has no attribute "set"  [attr-defined]
            await self._connection.set(self.prefix(session_id), data, ex=ttl)
                  ^
starsessions/stores/redis.py:73: error: BaseRedis? has no attribute "delete"  [attr-defined]
            await self._connection.delete(self.prefix(session_id))
                  ^
starsessions/stores/redis.py:76: error: BaseRedis? has no attribute "exists"  [attr-defined]
            result: int = await self._connection.exists(self.prefix(session_id))
                                ^
Found 9 errors in 1 file (checked 23 source files)
  ~/Py/starsessions on   switch_redis_library !2 ❯     

[alex-oleshkevich]

Sorry, i meant in the client app, not in the library itself.

I am aware if someone using starsessions and redis without typings installed will have his app won't pass mypy checks.

[euri10]

mmm not sure how to test that,

[euri10]

well not sure I understand you, but tested in a project I'm using and I have no mypy issue without the stubs installed:

❯ poetry remove starsessions
Updating dependencies
Resolving dependencies... (5.1s)

Writing lock file

Package operations: 0 installs, 1 update, 2 removals

  • Removing aioredis (2.0.1)
  • Removing starsessions (2.0.1)
  • Updating transitions (0.9.0 3836dc4 -> 0.9.0)
❯ poetry add git+https://github.com/euri10/starsessions@switch_redis_library

Updating dependencies
Resolving dependencies... (2.9s)

Writing lock file

Package operations: 1 install, 1 update, 0 removals

  • Installing starsessions (2.0.1 834ae98)
  • Updating transitions (0.9.0 3836dc4 -> 0.9.0)
❯ make check-mypy
mypy src management tests
Success: no issues found in 45 source files