Dogpile.cache

Released: Thu Apr 4 2013
- **[bug]** Added support for the `cache_timeout` Mako
argument to the Mako plugin, which will pass
the value to the `expiration_time` argument
of `CacheRegion.get_or_create()`.

- **[feature]** `CacheRegion.get_or_create()` and
`CacheRegion.cache_on_arguments()` now accept a new
argument `should_cache_fn`, receives the value
returned by the "creator" and then returns True or
False, where True means "cache plus return",
False means "return the value but don't cache it."

References: [pull request 13](pullreq:13)


rel_0_4_2

Released: Sat Jan 19 2013
- **[feature]** An "async creator" function can be specified to
`CacheRegion` which allows the "creation" function
to be called asynchronously or be subsituted for
another asynchronous creation scheme. Courtesy
Ralph Bean.

References: [pull request 10](pullreq:10)


rel_0_4_1

Released: Sat Dec 15 2012
- **[feature]** The function decorated by `CacheRegion.cache_on_arguments()`
now includes a `set()` method, in addition to the existing
`invalidate()` method. Like `invalidate()`, it accepts
a set of function arguments, but additionally accepts as the
first positional argument a new value to place in the cache,
to take the place of that key. Courtesy Antoine Bertin.

References: [pull request 9](pullreq:9)

- **[bug]** Fixed bug in DBM backend whereby if an error occurred
during the "write" operation, the file lock, if enabled,
would not be released, thereby deadlocking the app.

References: [15](ticket:15)

- **[bug]** The `util.function_key_generator()` used by the
function decorator no longer coerces non-unicode
arguments into a Python unicode object on Python 2.x;
this causes failures on backends such as DBM which
on Python 2.x apparently require bytestrings. The
key_mangler is still needed if actual unicode arguments
are being used by the decorated function, however.

References: [12](ticket:12)

- **[feature]** Redis backend now accepts optional "url" argument,
will be passed to the new `StrictRedis.from_url()`
method to determine connection info. Courtesy
Jon Rosebaugh.

- **[feature]** Redis backend now accepts optional "password"
argument. Courtesy Jon Rosebaugh.

- **[feature]** DBM backend has "fallback" when calling dbm.get() to
instead use dictionary access + KeyError, in the case
that the "gdbm" backend is used which does not include
.get(). Courtesy Jon Rosebaugh.


rel_0_4_0

Released: Tue Oct 30 2012
- **[bug]** Using dogpile.core 0.4.0 now, fixes a critical
bug whereby dogpile pileup could occur on first value
get across multiple processes, due to reliance upon
a non-shared creation time. This is a dogpile.core
issue.

References: [1](ticket:1)

- **[bug]** Fixed missing __future__ with_statement
directive in region.py.


rel_0_3_1

Released: Tue Sep 25 2012
- **[bug]** Fixed the mako_cache plugin which was not yet
covered, and wasn't implementing the mako plugin
API correctly; fixed docs as well. Courtesy
Ben Hayden.

- **[bug]** Fixed setup so that the tests/* directory
isn't yanked into the install. Courtesy Ben Hayden.


rel_0_3_0

Released: Thu Jun 14 2012
- **[feature]** get() method now checks expiration time
by default. Use ignore_expiration=True
to bypass this.

- **[feature]** Added new invalidate() method. Sets the current
timestamp as a minimum value that all retrieved
values must be created after. Is honored by the
get_or_create() and get() methods.

References: [7](ticket:7)

- **[bug]** Fixed bug whereby region.get() didn't
work if the value wasn't present.

References: [8](ticket:8)


rel_0_2_3