Dogpile.cache

Released: Sun May 5 2024
usecase


- **[usecase] [memcached]** Added support for an additional pymemcached client parameter
`PyMemcacheBackend.memcached_expire_time`. Pull request
courtesy Takashi Kajinami.

bug


- **[bug] [typing]** Fixed the return type for `CacheRegion.get()`, which was inadvertently
hardcoded to use `CacheReturnType` that only resolved to `CachedValue`
or `NoValue`. Fixed to return `ValuePayload` which resolves to
`Any`, as well as a new literal indicating an enum constant for
:data:`.api.NO_VALUE`. The :data:`.api.NO_VALUE` constant remains
available as the single element of this enum.

Unknown interpreted text role "data".

Unknown interpreted text role "data".


rel_1_3_2

Released: Wed Feb 21 2024
usecase


- **[usecase] [redis]** Added a new backend `RedisClusterBackend`, allowing support for
Redis Cluster. Pull request courtesy Maël Naccache Tüfekçi.

References: [250](https://github.com/sqlalchemy/dogpile.cache/issues/250)

- **[usecase] [redis]** Added support for additional Redis client parameters
`RedisBackend.socket_connect_timeout`,
`RedisBackend.socket_keepalive` and
`RedisBackend.socket_keepalive_options`. Pull request courtesy
Takashi Kajinami.

References: [252](https://github.com/sqlalchemy/dogpile.cache/issues/252)


rel_1_3_1

Released: Wed Feb 7 2024
usecase


- **[usecase] [redis]** Added new parameter `RedisBackend.username` to the Redis
backend, and `RedisSentinelBackend.username` to the Redis
Sentinel backend. These parameters allow for username authentication in
Redis when RBAC is enabled. Pull request courtesy Takashi Kajinami.


rel_1_3_0

Released: Wed Dec 20 2023
feature


- **[feature] [region]** Added new method `CacheRegion.get_value_metadata()` which can be used
to get a value from the cache along with its metadata, including timestamp
of when the value was cached. The `CachedValue` object is returned
which features new accessors to retrieve cached time and current age. Pull
request courtesy Grégoire Deveaux.

References: [37](https://github.com/sqlalchemy/dogpile.cache/issues/37)

misc


- **[change] [setup]** Minimum Python version is now Python 3.8; prior versions Python 3.7 and 3.6
are EOL.

- **[change] [setup]** Project setup is now based on pep-621 `pyproject.toml` configuration.


rel_1_2_2

Released: Sat Jul 8 2023
bug


- **[bug] [typing]** Made use of pep-673 `Self` type for method chained methods such as
`CacheRegion.configure()` and `ProxyBackend.wrap()`. Pull request
courtesy Viicos.

References: [240](https://github.com/sqlalchemy/dogpile.cache/issues/240)


rel_1_2_1

Released: Sat May 20 2023
bug


- **[bug] [typing]** Added py.typed file to root so that typing tools such as Mypy recognize
dogpile as typed. Pull request courtesy Daverball.

References: [238](https://github.com/sqlalchemy/dogpile.cache/issues/238)


rel_1_2_0