Package: diskcache
DiskCacheis an Apache2 licensed disk and file backed cache library, written
in pure-Python, and compatible with Django.The cloud-based computing of 2023 puts a premium on memory. Gigabytes of empty
space is left on disks as processes vie for memory. Among these processes is
Memcached (and sometimes Redis) which is used as a cache. Wouldn’t it be nice
to leverage empty disk space for caching?Django is Python’s most popular web framework and ships with several caching
backends. Unfortunately the file-based cache in Django is essentially
broken. The culling method is random and large caches repeatedly scan a cache
directory which slows linearly with growth. Can you really allow it to take
sixty milliseconds to store a key in a cache with a thousand items?In Python, we can do better. And we can do it in pure-Python!In [1]: import pylibmc
In [2]: client = pylibmc.Client(['127.0.0.1'], binary=True)
In [3]: client[b'key'] = b'value'
In [4]: %timeit client[b'key']

10000 loops, best of 3: 25.4 µs per loop

In [5]: import diskcache as dc
In [6]: cache = dc.Cache('tmp')
In [7]: cache[b'key'] = b'value'
In [8]: %timeit cache[b'key']

100000 loops, best of 3: 11.8 µs per loopNote:Micro-benchmarks have their place but are not a substitute for real
measurements. DiskCache offers cache benchmarks to defend its performance
claims. Micro-optimizations are avoided but your mileage may vary.DiskCache efficiently makes gigabytes of storage space available for
caching. By leveraging rock-solid database libraries and memory-mapped files,
cache performance can match and exceed industry-standard solutions. There’s no
need for a C compiler or running another process. Performance is a feature and
testing has 100% coverage with unit tests and hours of stress.TestimonialsDaren Hasenkamp, Founder –“It’s a useful, simple API, just like I love about Redis. It has reduced
the amount of queries hitting my Elasticsearch cluster by over 25% for a
website that gets over a million users/day (100+ hits/second).”Mathias Petermann, Senior Linux System Engineer –“I implemented it into a wrapper for our Ansible lookup modules and we were
able to speed up some Ansible runs by almost 3 times. DiskCache is saving
us a ton of time.”Does your company or website useDiskCache? Send us amessageand let us know.FeaturesPure-PythonFully DocumentedBenchmark comparisons (alternatives, Django cache backends)100% test coverageHours of stress testingPerformance mattersDjango compatible APIThread-safe and process-safeSupports multiple eviction policies (LRU and LFU included)Keys support “tag” metadata and evictionDeveloped on Python 3.10Tested on CPython 3.6, 3.7, 3.8, 3.9, 3.10Tested on Linux, Mac OS X, and WindowsTested using GitHub ActionsQuickstartInstallingDiskCacheis simple withpip:$ pip install diskcacheYou can access documentation in the interpreter with Python’s built-in help
function:>>> import diskcache
>>> help(diskcache)                             # doctest: +SKIPThe core ofDiskCacheis three data types intended for caching.Cacheobjects manage a SQLite database and filesystem directory to store key and
value pairs.FanoutCacheprovides a sharding layer to utilize multiple
caches andDjangoCacheintegrates that withDjango:>>> from diskcache import Cache, FanoutCache, DjangoCache
>>> help(Cache)                                 # doctest: +SKIP
>>> help(FanoutCache)                           # doctest: +SKIP
>>> help(DjangoCache)                           # doctest: +SKIPBuilt atop the caching data types, areDequeandIndexwhich work as a
cross-process, persistent replacements for Python’scollections.dequeanddict. These implement the sequence and mapping container base classes:>>> from diskcache import Deque, Index
>>> help(Deque)                                 # doctest: +SKIP
>>> help(Index)                                 # doctest: +SKIPFinally, a number ofrecipesfor cross-process synchronization are provided
using an underlying cache. Features like memoization with cache stampede
prevention, cross-process locking, and cross-process throttling are available:>>> from diskcache import memoize_stampede, Lock, throttle
>>> help(memoize_stampede)                      # doctest: +SKIP
>>> help(Lock)                                  # doctest: +SKIP
>>> help(throttle)                              # doctest: +SKIPPython’s docstrings are a quick way to get started but not intended as a
replacement for theDiskCache TutorialandDiskCache API Reference.User GuideFor those wanting more details, this part of the documentation describes
tutorial, benchmarks, API, and development.DiskCache TutorialDiskCache Cache BenchmarksDiskCache DjangoCache BenchmarksCase Study: Web CrawlerCase Study: Landing Page CachingTalk: All Things Cached - SF Python 2017 MeetupDiskCache API ReferenceDiskCache DevelopmentComparisonsComparisons to popular projects related toDiskCache.Key-Value StoresDiskCacheis mostly a simple key-value store. Feature comparisons with four
other projects are shown in the tables below.dbmis part of Python’s standard library and implements a generic
interface to variants of the DBM database — dbm.gnu or dbm.ndbm. If none of
these modules is installed, the slow-but-simple dbm.dumb is used.shelveis part of Python’s standard library and implements a “shelf” as a
persistent, dictionary-like object. The difference with “dbm” databases is
that the values can be anything that the pickle module can handle.sqlitedictis a lightweight wrapper around Python’s sqlite3 database with
a simple, Pythonic dict-like interface and support for multi-thread
access. Keys are arbitrary strings, values arbitrary pickle-able objects.pickleDBis a lightweight and simple key-value store. It is built upon
Python’s simplejson module and was inspired by Redis. It is licensed with the
BSD three-clause license.FeaturesFeaturediskcachedbmshelvesqlitedictpickleDBAtomic?AlwaysMaybeMaybeMaybeNoPersistent?YesYesYesYesYesThread-safe?YesNoNoYesNoProcess-safe?YesNoNoMaybeNoBackend?SQLiteDBMDBMSQLiteFileSerialization?CustomizableNonePickleCustomizableJSONData Types?Mapping/DequeMappingMappingMappingMappingOrdering?Insert/SortedNoneNoneNoneNoneEviction?LRU/LFU/moreNoneNoneNoneNoneVacuum?AutomaticMaybeMaybeManualAutomaticTransactions?YesNoNoMaybeNoMultiprocessing?YesNoNoNoNoForkable?YesNoNoNoNoMetadata?YesNoNoNoNoQualityProjectdiskcachedbmshelvesqlitedictpickleDBTests?YesYesYesYesYesCoverage?YesYesYesYesNoStress?YesNoNoNoNoCI Tests?Linux/WindowsYesYesLinuxNoPython?2/3/PyPyAllAll2/32/3License?Apache2PythonPythonApache23-Clause BSDDocs?ExtensiveSummarySummaryReadmeSummaryBenchmarks?YesNoNoNoNoSources?GitHubGitHubGitHubGitHubGitHubPure-Python?YesYesYesYesYesServer?NoNoNoNoNoIntegrations?DjangoNoneNoneNoneNoneTimingsThese are rough measurements. SeeDiskCache Cache Benchmarksfor more
rigorous data.ProjectdiskcachedbmshelvesqlitedictpickleDBget25 µs36 µs41 µs513 µs92 µsset198 µs900 µs928 µs697 µs1,020 µsdelete248 µs740 µs702 µs1,717 µs1,020 µsCaching Librariesjoblib.Memoryprovides caching functions and works by explicitly saving
the inputs and outputs to files. It is designed to work with non-hashable and
potentially large input and output data types such as numpy arrays.kleptoextends Python’slru_cacheto utilize different keymaps and
alternate caching algorithms, such aslfu_cacheandmru_cache. Klepto
uses a simple dictionary-sytle interface for all caches and archives.Data Structuresdictis a mapping object that maps hashable keys to arbitrary
values. Mappings are mutable objects. There is currently only one standard
Python mapping type, the dictionary.pandasis a Python package providing fast, flexible, and expressive data
structures designed to make working with “relational” or “labeled” data both
easy and intuitive.Sorted Containersis an Apache2 licensed sorted collections library,
written in pure-Python, and fast as C-extensions. Sorted Containers
implements sorted list, sorted dictionary, and sorted set data types.Pure-Python DatabasesZODBsupports an isomorphic interface for database operations which means
there’s little impact on your code to make objects persistent and there’s no
database mapper that partially hides the datbase.CodernityDBis an open source, pure-Python, multi-platform, schema-less,
NoSQL database and includes an HTTP server version, and a Python client
library that aims to be 100% compatible with the embedded version.TinyDBis a tiny, document oriented database optimized for your
happiness. If you need a simple database with a clean API that just works
without lots of configuration, TinyDB might be the right choice for you.Object Relational Mappings (ORM)Django ORMprovides models that are the single, definitive source of
information about data and contains the essential fields and behaviors of the
stored data. Generally, each model maps to a single SQL database table.SQLAlchemyis the Python SQL toolkit and Object Relational Mapper that
gives application developers the full power and flexibility of SQL. It
provides a full suite of well known enterprise-level persistence patterns.Peeweeis a simple and small ORM. It has few (but expressive) concepts,
making it easy to learn and intuitive to use. Peewee supports Sqlite, MySQL,
and PostgreSQL with tons of extensions.SQLObjectis a popular Object Relational Manager for providing an object
interface to your database, with tables as classes, rows as instances, and
columns as attributes.Pony ORMis a Python ORM with beautiful query syntax. Use Python syntax
for interacting with the database. Pony translates such queries into SQL and
executes them in the database in the most efficient way.SQL DatabasesSQLiteis part of Python’s standard library and provides a lightweight
disk-based database that doesn’t require a separate server process and allows
accessing the database using a nonstandard variant of the SQL query language.MySQLis one of the world’s most popular open source databases and has
become a leading database choice for web-based applications. MySQL includes a
standardized database driver for Python platforms and development.PostgreSQLis a powerful, open source object-relational database system
with over 30 years of active development. Psycopg is the most popular
PostgreSQL adapter for the Python programming language.Oracle DBis a relational database management system (RDBMS) from the
Oracle Corporation. Originally developed in 1977, Oracle DB is one of the
most trusted and widely used enterprise relational database engines.Microsoft SQL Serveris a relational database management system developed
by Microsoft. As a database server, it stores and retrieves data as requested
by other software applications.Other DatabasesMemcachedis free and open source, high-performance, distributed memory
object caching system, generic in nature, but intended for use in speeding up
dynamic web applications by alleviating database load.Redisis an open source, in-memory data structure store, used as a
database, cache and message broker. It supports data structures such as
strings, hashes, lists, sets, sorted sets with range queries, and more.MongoDBis a cross-platform document-oriented database program. Classified
as a NoSQL database program, MongoDB uses JSON-like documents with
schema. PyMongo is the recommended way to work with MongoDB from Python.LMDBis a lightning-fast, memory-mapped database. With memory-mapped
files, it has the read performance of a pure in-memory database while
retaining the persistence of standard disk-based databases.BerkeleyDBis a software library intended to provide a high-performance
embedded database for key/value data. Berkeley DB is a programmatic toolkit
that provides built-in database support for desktop and server applications.LevelDBis a fast key-value storage library written at Google that
provides an ordered mapping from string keys to string values. Data is stored
sorted by key and users can provide a custom comparison function.ReferenceDiskCache DocumentationDiskCache at PyPIDiskCache at GitHubDiskCache Issue TrackerLicenseCopyright 2016-2023 Grant JenksLicensed under the Apache License, Version 2.0 (the “License”); you may not use
this file except in compliance with the License.  You may obtain a copy of the
License athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.