summaryrefslogtreecommitdiff
path: root/docs/narr/assets.rst
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2015-02-17 18:57:31 -0500
committerChris McDonough <chrism@plope.com>2015-02-17 18:57:31 -0500
commit4dacb8c24efe98cb14b3ef89f6c9a8b2fd196790 (patch)
tree039ca762ddcf6e4946a2570136927d2773374969 /docs/narr/assets.rst
parentc5802723a4ea035076573838138878caf01735c1 (diff)
parent75f85c57e0f4d1069cef9feb6ab6182b5f651492 (diff)
downloadpyramid-4dacb8c24efe98cb14b3ef89f6c9a8b2fd196790.tar.gz
pyramid-4dacb8c24efe98cb14b3ef89f6c9a8b2fd196790.tar.bz2
pyramid-4dacb8c24efe98cb14b3ef89f6c9a8b2fd196790.zip
Merge branch 'master' of github.com:Pylons/pyramid
Diffstat (limited to 'docs/narr/assets.rst')
-rw-r--r--docs/narr/assets.rst15
1 files changed, 8 insertions, 7 deletions
diff --git a/docs/narr/assets.rst b/docs/narr/assets.rst
index fc908c2b4..d6bc8cbb8 100644
--- a/docs/narr/assets.rst
+++ b/docs/narr/assets.rst
@@ -446,19 +446,20 @@ In order to implement your own cache buster, you can write your own class from
scratch which implements the :class:`~pyramid.interfaces.ICacheBuster`
interface. Alternatively you may choose to subclass one of the existing
implementations. One of the most likely scenarios is you'd want to change the
-way the asset token is generated. To do this just subclass an existing
-implementation and replace the :meth:`~pyramid.interfaces.ICacheBuster.token`
-method. Here is an example which just uses Git to get the hash of the
-currently checked out code:
+way the asset token is generated. To do this just subclass either
+:class:`~pyramid.static.PathSegmentCacheBuster` or
+:class:`~pyramid.static.QueryStringCacheBuster` and define a
+``tokenize(pathspec)`` method. Here is an example which just uses Git to get
+the hash of the currently checked out code:
.. code-block:: python
:linenos:
import os
import subprocess
- from pyramid.static import PathSegmentMd5CacheBuster
+ from pyramid.static import PathSegmentCacheBuster
- class GitCacheBuster(PathSegmentMd5CacheBuster):
+ class GitCacheBuster(PathSegmentCacheBuster):
"""
Assuming your code is installed as a Git checkout, as opposed to as an
egg from an egg repository like PYPI, you can use this cachebuster to
@@ -470,7 +471,7 @@ currently checked out code:
['git', 'rev-parse', 'HEAD'],
cwd=here).strip()
- def token(self, pathspec):
+ def tokenize(self, pathspec):
return self.sha1
Choosing a Cache Buster