Complete type hints #122

mjpieters · 2023-04-27T15:38:53Z

This series of commits brings FastAPI-Cache up to type completeness, as verified by
pyright:

$ pyright --verifytypes fastapi_cache --ignoreexternal
Module name: "fastapi_cache"
Package directory: "/Users/mj/Development/Projects/OSS/fastapi-cache/fastapi_cache"
Module directory: "/Users/mj/Development/Projects/OSS/fastapi-cache/fastapi_cache"
Path of py.typed file: "/Users/mj/Development/Projects/OSS/fastapi-cache/fastapi_cache/py.typed"

Public modules: 10
   fastapi_cache
   fastapi_cache.backends
   fastapi_cache.backends.dynamodb
   fastapi_cache.backends.inmemory
   fastapi_cache.backends.memcached
   fastapi_cache.backends.redis
   fastapi_cache.coder
   fastapi_cache.decorator
   fastapi_cache.key_builder
   fastapi_cache.types

Symbols used in public interface:

Symbols exported by "fastapi_cache": 76
  With known type: 76
  With ambiguous type: 0
  With unknown type: 0
    (Ignoring unknown types imported from other packages)
  Functions without docstring: 40
  Functions without default param: 1
  Classes without docstring: 11

Other symbols referenced but not exported by "fastapi_cache": 0
  With known type: 0
  With ambiguous type: 0
  With unknown type: 0

Type completeness score: 100%

Completed in 0.478sec

Correct type hint: namespace is not optional
Mark up the class variables as such
Remove a type: ignore comment
JSONResponse.body is UTF-8 bytes and must be decoded
Define keybuilder protocol
Simplify key_builder calling
Use complete type hints with all generic parameters filled
Provide annotation for the session attribute
The backend needs an async redis client with a pipeline method

The namespace argument is positional and will never be `None` so should not be marked as Optional. It is always a string, and the default is to pass in an empty string.

There is never an instance of this class, so these are not instance attributes.

GIve the type checker more information about the converters instead.

This lets others create key builders that are type checked fully.

The keybuilder is either returning a string, or a coroutine or other awaitable. If the latter, await on the return value to get the string.

This makes the core fastapi_cache pass all strict type checker tests.

The Abstract* classes lack the pipeline method so are not sufficient.

mkdir700

nice.

long2ice · 2023-04-28T06:28:52Z

Thanks!

mjpieters added 9 commits April 27, 2023 16:11

Correct type hint: namespace is not optional

32acafa

The namespace argument is positional and will never be `None` so should not be marked as Optional. It is always a string, and the default is to pass in an empty string.

Mark up the class variables as such

0d0fe1f

There is never an instance of this class, so these are not instance attributes.

Remove a type: ignore comment

059793d

GIve the type checker more information about the converters instead.

JSONResponse.body is UTF-8 bytes and must be decoded

d4cd787

Define keybuilder protocol

255f401

This lets others create key builders that are type checked fully.

Simplify key_builder calling

a52f6b1

The keybuilder is either returning a string, or a coroutine or other awaitable. If the latter, await on the return value to get the string.

Use complete type hints with all generic parameters filled

9c96628

This makes the core fastapi_cache pass all strict type checker tests.

Provide annotation for the session attribute

6af14be

The backend needs an async redis client with a pipeline method

72c4232

The Abstract* classes lack the pipeline method so are not sufficient.

mkdir700 approved these changes Apr 28, 2023

View reviewed changes

long2ice merged commit b26059b into long2ice:main Apr 28, 2023

mjpieters deleted the type-hinting branch April 28, 2023 11:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Complete type hints #122

Complete type hints #122

mjpieters commented Apr 27, 2023

mkdir700 left a comment

long2ice commented Apr 28, 2023

Complete type hints #122

Complete type hints #122

Conversation

mjpieters commented Apr 27, 2023

mkdir700 left a comment

Choose a reason for hiding this comment

long2ice commented Apr 28, 2023