summaryrefslogtreecommitdiff
path: root/docs/narr/assets.rst
diff options
context:
space:
mode:
authorMichael Merickel <michael@merickel.org>2015-02-20 17:02:09 -0600
committerMichael Merickel <michael@merickel.org>2015-02-20 17:02:09 -0600
commit2ce270cf141b90555d42ba2bf01b192b04e70dc3 (patch)
tree82bbb2b189b664170750a2441dbcc814aa5de57d /docs/narr/assets.rst
parent6e9e2dbb364f371b034b681dd44e6e6b831c5760 (diff)
parent1e02bbfc0df09259bf207112acf019c8dba44a90 (diff)
downloadpyramid-2ce270cf141b90555d42ba2bf01b192b04e70dc3.tar.gz
pyramid-2ce270cf141b90555d42ba2bf01b192b04e70dc3.tar.bz2
pyramid-2ce270cf141b90555d42ba2bf01b192b04e70dc3.zip
Merge branch 'master' into feature.py3-coverage
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