Dogpile.cache

Released: Thu May 20 2021
bug


- **[bug] [regression] [tests]** Repaired the test suite to work with the 5.x series of the `decorator`
module, which now appears to make use of the `__signature__` attribute.

- **[bug] [regression]** Fixed regression where `ProxyBackend` was missing several methods
that were added as part of the 1.1 release.

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


rel_1_1_2

Released: Tue Jan 26 2021
feature


- **[feature] [region]** Added new region method `CacheRegion.key_is_locked()`. Returns True if
the given key is subject to the dogpile lock, which would indicate that the
generator function is running at that time. Pull request courtesy Bastien
Gerard.

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

- **[feature] [memcached]** Added support for the pymemcache backend, using the
`"dogpile.cache.pymemcache"` backend identifier. Pull request courtesy
Moisés Guimarães de Medeiros.

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


rel_1_1_1

Released: Mon Nov 23 2020
bug


- **[bug] [region]** Fixed regression where the serialization and deserialization functions
could be inadvertently turned into instance methods with an unexpected
argument signature, namely when pickle.dumps and pickle.loads are the pure
Python version as is the case in pypy.

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


rel_1_1_0

Released: Sun Nov 15 2020
feature


- **[feature] [region]** Reworked the means by which values are serialized and deserialized from
backends, and provided for custom serialization of values. Added the
`CacheRegion.serializer` and
`CacheRegion.deserializer` parameters which may be set to any
serializer.

Serialization and deserialization now take place within the
`CacheRegion` so that backends may now assume string values
in all cases. This simplifies the existing backends and also makes
custom backends easier to write and maintain.

Additionally, the serializer is now applied to the user-defined value
portion of the `CachedValue` and not to the metadata or other
portions of `CachedValue` object itself, so the serialized portion
is effectively a "payload" within the larger `CachedValue`
structure that is passed as part of the larger string format. The overall
format is a separate JSON of the cached value metadata, followed by the
serialized form. This allows for end-user serialization schemes that are
hardwired to the values themselves without the need to serialize dogpile's
internal structures as well.

Existing custom backends should continue to work without issue; they
now have the option to forego any separate serialization steps, and
can also subclass a new backend `BytesBackend` that marks them
as a backend that only deals with bytes coming in and out; all
internal serialization logic from such a backend can be removed.

Pull request courtesy Alessio Bogon.

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

misc


- **[change]** Added pep-484 annotations to most of the dogpile.cache package.


rel_1_0_2

Released: Fri Aug 7 2020
feature


- **[feature] [memcached]** Added support for TLS connections to the bmemcached backend. Pull request
courtesy Moisés Guimarães de Medeiros.

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

bug


- **[bug] [installation]** Repaired the setup.cfg file so that the source and wheel distributions will
not add the "tests" directory to the Python environment. Pull request
courtesy Michał Górny.


rel_1_0_1

Released: Tue Jul 21 2020
bug


- **[bug] [install]** dogpile.cache 1.0.0 was released with a minimum Python version of 3.5.
However, due to a dependency issue, the minimum version is now Python 3.6.
The 1.0.0 release will be removed from PyPI so that Python versions prior
to 3.6 will continue to make use of the previous dogpile.cache 0.9.2.

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

- **[bug] [installation]** Removed the "universal=1" directive from setup.cfg as this would create
py2/py3 wheels. dogpile 1.0.x is Python 3 only so a py3-only wheel is now
created.

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


rel_1_0_0