Pylance type checking issues with async redis.hset

[epicwhale]

Version: What redis-py and what redis version is the issue happening on?
5.0.2

Platform: What platform / version? (For example Python 3.5.1 on Windows 7 / Ubuntu 15.10 / Azure)
3.12

Description: Description of your issue, stack traces from errors and code that reproduces the issue

Pylance throws a type checking issue while trying to use await with hset using a redis.asyncio.client.Redis instance

"int" is not awaitable
  "int" is incompatible with protocol "Awaitable[_T_co@Awaitable]"
    "__await__" is not presentPylance[reportGeneralTypeIssues](https://github.com/microsoft/pyright/blob/main/docs/configuration.md#reportGeneralTypeIssues)
(method) def hset(
    name: str,
    key: str | None = None,
    value: str | None = None,
    mapping: dict[Unknown, Unknown] | None = None,
    items: list[Unknown] | None = None
) -> (Awaitable[int] | int)

import redis.asyncio as aio_redis
pool = aio_redis.ConnectionPool.from_url(
    f"redis://{settings.redis_host}:{settings.redis_port}/{settings.redis_db}"
)
client = await aio_redis.Redis.from_pool(pool)

await client.hset(key, field, publish_data_json)  # <--- pylance type check error here

Is this working as intended?

[richin13]

I have the exact same issue. The async client is not typed and instead relies on the core commands, for example hset defined here:

redis-py/redis/commands/core.py

Lines 5000 to 5007 in 9df2225

	def hset(
	self,
	name: str,
	key: Optional[str] = None,
	value: Optional[str] = None,
	mapping: Optional[dict] = None,
	items: Optional[list] = None,
	) -> Union[Awaitable[int], int]:

Notice the Union[Awaitable[int], int]. Then the async client extends from this alias class:

redis-py/redis/commands/core.py

Line 5087 in 9df2225

AsyncHashCommands = HashCommands

Now pyright (and pylance) complain because it still thinks that either of the two options is a possibility, when it actually isn't.

The solution would be to define the actual AsyncHashCommands class and add each method as async def but that sounds like a lot of work 😛

I've decided to live with it and simply # type: ignore it

---

Edit:

Alternatively, you can use inspect.isawaitable and act accordingly:

if inspect.isawaitable(rset := self._redis.set(key, data)):
    await rset

[JamesTann]

Related issue here (but non async): #2399

[github-actions]

This issue is marked stale. It will be closed in 30 days if it is not updated.

[suhjohn]

This issue is not stale and it's super annoying?

[minamikik]

same

[aiguofer]

Interested in this as well, along with #3574. The PR above looks interesting!!!