Best way to receive the return value when the type hint is Union[Awaitable[int], int]?

[hyperstarkkk]

I noticed the return value type hint of redis-py functions are always like: Union[Awaitable[int], int]: (e.g. redis.commands.core.py:L4824)

def hlen(self, name: str) -> Union[Awaitable[int], int]:
    """
    Return the number of elements in hash ``name``

    For more information see https://redis.io/commands/hlen
    """
    return self.execute_command("HLEN", name)

When I receive the value as normal

dict_size = redis.hlen("dict_key")
assert dict_size < 10

Pylance will remind me

Operator "<=" not supported for types "Awaitable[int] | int" and "Literal[10]"
  Operator "<=" not supported for types "Awaitable[int]" and "Literal[10]"

How to let Pylance know I am not calling the function in asynchronous way, so I can mitigate this type checking error?

[akx]

That smells like a typing bug in the library. Awaitables should really only be returned when using the async client...

[balazser]

I'm also facing this issue. I there any update?

    def llen(self, name: str) -> Union[Awaitable[int], int]:
        """
        Return the length of the list ``name``

        For more information see https://redis.io/commands/llen
        """

Many of the methods with Union[Awaitable[int], int] require a type guard check, or what is the best way to get around it? 🤔

[Kyle-sandeman-mrdfood]

Similarly for almost ALL functions in commands/core.py, they're annotated to return ResponseT (or similar) which is Union[Awaitable, Any] which is picked up by PyCharm as just Awaitable. So passing e.g. r.get(key)'s result to anything that expects bytes/str results in a warning

[github-actions]

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

[Kyle-sandeman-mrdfood]

Still relevant, I presume

[divad]

I'm hitting this, but in the reverse; mypy complains when using the asyncio version that it might return int, even when I'm importing from redis.asyncio and calling await against the function. Any update?