wassname/cachier
1
0
Fork 0
mirror of https://github.com/wassname/cachier.git synced 2026-09-10 11:50:23 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update README.rst

Browse Source
This commit is contained in:
Shay Palachy
2017-09-28 11:03:28 +03:00
committed by GitHub
parent dfc10bafb3
commit 2931fe527e
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.rst
+5 -4
View File
@@ -56,12 +56,13 @@ Future features
* S3 core.
* Multi-core caching.
* `Cache replacement policies <https://en.wikipedia.org/wiki/Cache_replacement_policies>`_
Use
===
The positional and keyword arguments to the wrapped function must be hashable (i.e. Python's immutable built-in objects, not mutable containers). Also, notice that since objects which are instances of user-defined classes are hashable but all compare unequal (their hash value is their id), equal objects across different sessions will not yield identical keys.
Cachier provides a decorator which you can wrap arount your functions to give them a persistent cache. The positional and keyword arguments to the wrapped function must be hashable (i.e. Python's immutable built-in objects, not mutable containers). Also, notice that since objects which are instances of user-defined classes are hashable but all compare unequal (their hash value is their id), equal objects across different sessions will not yield identical keys.
Setting up a Cache
------------------
@@ -221,10 +222,10 @@ Credits
=======
Created by Shay Palachy (shay.palachy@gmail.com).
Contributers (in chronological order of first commit):
.. Contributers (in chronological order of first commit):
* `shaypal5 <https://github.com/shaypal5>`_ (Shay Palachy)
* `j-chad <https://github.com/j-chad>`_ (Jackson)
.. * `shaypal5 <https://github.com/shaypal5>`_ (Shay Palachy)
.. * `j-chad <https://github.com/j-chad>`_ (Jackson)