Fix cache_throttle typo

This commit is contained in:
Tom Christie 2014-08-20 12:32:24 +01:00
parent 6ffc97c808
commit 59b47eac14
3 changed files with 13 additions and 1 deletions

View File

@ -97,6 +97,17 @@ Here's an example of using the new decorators. Firstly we have a detail-type rou
For more details, see the [viewsets documentation](../api-guide/viewsets.md). For more details, see the [viewsets documentation](../api-guide/viewsets.md).
## Throttle behavior
There's one bugfix in 2.4 that's worth calling out, as it will *invalidate existing throttle caches* when you upgrade.
We've now fixed a typo on the `cache_format` attribute. Previously this was named `"throtte_%(scope)s_%(ident)s"`, it is now `"throttle_%(scope)s_%(ident)s"`.
If you're concerned about the invalidation you have two options.
* Manually pre-populate your cache with the fixed version.
* Set the `cache_format` attribute on your throttle class in order to retain the previous incorrect spelling.
## Other features ## Other features
There are also a number of other features and bugfixes as [listed in the release notes][2-4-release-notes]. In particular these include: There are also a number of other features and bugfixes as [listed in the release notes][2-4-release-notes]. In particular these include:

View File

@ -62,6 +62,7 @@ You can determine your currently installed version using `pip freeze`:
* Bugfix: Copy `filter_backends` list before returning it, in order to prevent view code from mutating the class attribute itself. * Bugfix: Copy `filter_backends` list before returning it, in order to prevent view code from mutating the class attribute itself.
* Bugfix: Set the `.action` attribute on viewsets when introspected by `OPTIONS` for testing permissions on the view. * Bugfix: Set the `.action` attribute on viewsets when introspected by `OPTIONS` for testing permissions on the view.
* Bugfix: Ensure `ValueError` raised during deserialization results in a error list rather than a single error. This is now consistent with other validation errors. * Bugfix: Ensure `ValueError` raised during deserialization results in a error list rather than a single error. This is now consistent with other validation errors.
* Bugfix: Fix `cache_format` typo on throttle classes, was `"throtte_%(scope)s_%(ident)s"`. Note that this will invalidate existing throttle caches.
--- ---

View File

@ -60,7 +60,7 @@ class SimpleRateThrottle(BaseThrottle):
cache = default_cache cache = default_cache
timer = time.time timer = time.time
cache_format = 'throtte_%(scope)s_%(ident)s' cache_format = 'throttle_%(scope)s_%(ident)s'
scope = None scope = None
THROTTLE_RATES = api_settings.DEFAULT_THROTTLE_RATES THROTTLE_RATES = api_settings.DEFAULT_THROTTLE_RATES