diff options
author | Thomas Kemmer <tkemmer@computer.org> | 2014-09-25 18:06:23 +0200 |
---|---|---|
committer | Thomas Kemmer <tkemmer@computer.org> | 2014-09-25 18:06:23 +0200 |
commit | a837142c8d9232d26f8a9b5bc143f1dc4017983b (patch) | |
tree | bbd2cf666132241dfc39d9dda6f13b966e38fe9b /README.rst | |
parent | d5ef9cc6f386e3d4e94590b2651eb77aa1bc7658 (diff) | |
download | cachetools-a837142c8d9232d26f8a9b5bc143f1dc4017983b.tar.gz |
Fix #11: Update README.rst file.
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 15 |
1 files changed, 6 insertions, 9 deletions
@@ -22,15 +22,12 @@ including a variant of the Python 3 Standard Library For the purpose of this module, a *cache* is a mutable_ mapping_ of a -fixed maximum *size*. When the cache is full, i.e. the current size -of the cache exceeds its maximum size, the cache must choose which -item(s) to discard based on a suitable `cache algorithm`_. - -In general, a cache's size is the sum of the size of its items. If -the size of each items is 1, a cache's size is equal to the number of -its items, i.e. ``len(cache)``. An items's size may also be a -property or function of its value, e.g. the result of -``sys.getsizeof()``, or ``len()`` for string and sequence values. +fixed maximum size. When the cache is full, i.e. the size of the +cache would exceed its maximum size, the cache must choose which +item(s) to discard based on a suitable `cache algorithm`_. A cache's +size is the sum of the size of its items, and an item's size in +general is a property or function of its value, e.g. the result of +``sys.getsizeof``, or ``len`` for string and sequence values. This module provides various cache implementations based on different cache algorithms, as well as decorators for easily memoizing function |