diskcache-community 5.7.0__tar.gz → 5.8.0__tar.gz

diskcache_community-5.8.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed 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 at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless 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.

diskcache_community-5.8.0/PKG-INFO

@@ -0,0 +1,256 @@
+Metadata-Version: 2.4
+Name: diskcache-community
+Version: 5.8.0
+Summary: Disk Cache -- Disk and file backed persistent cache.
+Author: Grant Jenks
+Maintainer: diskcache-community contributors
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/secondwindoss/diskcache-community
+Project-URL: Documentation, https://diskcache-community.readthedocs.io/
+Project-URL: Source, https://github.com/secondwindoss/diskcache-community
+Project-URL: Tracker, https://github.com/secondwindoss/diskcache-community/issues
+Project-URL: Upstream, https://github.com/grantjenks/python-diskcache
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Dynamic: license-file
+
+<br />
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/secondwindoss/diskcache-community/master/docs/_static/logo-dark.png">
+    <img alt="diskcache" src="https://raw.githubusercontent.com/secondwindoss/diskcache-community/master/docs/_static/logo-light.png" width="40%">
+  </picture>
+</p>
+
+<h1 align="center">diskcache-community</h1>
+
+<h2><p align="center">Disk and file backed persistent cache for Python, built on SQLite</p></h2>
+
+<h4><p align="center">
+<a href="https://diskcache-community.readthedocs.io/en/latest/tutorial.html">[Tutorial]</a>
+- <a href="https://diskcache-community.readthedocs.io/en/latest/api.html">[API]</a>
+- <a href="https://diskcache-community.readthedocs.io/en/latest/benchmarks.html">[Benchmarks]</a>
+- <a href="https://diskcache-community.readthedocs.io/en/latest/">[Docs]</a>
+- <a href="https://github.com/secondwindoss/diskcache-community/blob/master/CHANGELOG.md">[Changelog]</a>
+</p></h4>
+
+<p align="center">
+  <a href="https://pypi.org/project/diskcache-community/"><img alt="Python versions" src="https://img.shields.io/pypi/pyversions/diskcache-community"></a>
+  <a href="https://pypi.org/project/diskcache-community/"><img alt="PyPI version" src="https://img.shields.io/pypi/v/diskcache-community"></a>
+  <a href="https://github.com/secondwindoss/diskcache-community/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/secondwindoss/diskcache-community/actions/workflows/ci.yml/badge.svg"></a>
+  <a href="https://diskcache-community.readthedocs.io/en/latest/"><img alt="Documentation" src="https://app.readthedocs.org/projects/diskcache-community/badge/?version=latest"></a>
+  <a href="https://github.com/secondwindoss/diskcache-community/blob/master/LICENSE"><img alt="License" src="https://img.shields.io/badge/License-Apache%202.0-green.svg"></a>
+</p>
+<br />
+
+> [!IMPORTANT]
+> This is a community fork of [python-diskcache](https://github.com/grantjenks/python-diskcache),
+> whose last release was 5.6.3 in August 2023. It is published on PyPI as
+> `diskcache-community` and imported as `diskcache_community`, so it installs
+> next to the upstream `diskcache` package. It carries the fix path for
+> [CVE-2025-69872](https://github.com/advisories/GHSA-w8v5-vhqr-4h9v) and
+> reads and writes the same cache directories as 5.6.3.
+> See [Why this fork](#why-this-fork), [Migrating from diskcache](#migrating-from-diskcache)
+> and [Fix CVE-2025-69872 in diskcache](https://diskcache-community.readthedocs.io/en/latest/fix-cve-2025-69872.html).
+
+## Install
+
+```sh
+pip install diskcache-community
+```
+
+The package is imported as `diskcache_community` and never touches the
+upstream `diskcache` package, so both can be installed in the same environment;
+see [Migrating from diskcache](#migrating-from-diskcache).
+
+## Usage
+
+```python
+from diskcache_community import Cache
+
+cache = Cache('cache')                 # the directory is created with mode 0700
+cache.set('answer', 42, expire=3600, tag='math')
+cache['config'] = {'debug': False}
+cache.get('answer')                    # 42
+cache.get('missing', default=None)
+cache.evict('math')                    # delete every key tagged 'math'
+```
+
+Memoize function results across processes and restarts:
+
+```python
+@cache.memoize(expire=600, ignore={'session'})
+def fetch(url, session):
+    return session.get(url).text
+```
+
+Shard across several SQLite files for higher write throughput, and plug the
+same cache into Django:
+
+```python
+from diskcache_community import FanoutCache
+
+cache = FanoutCache('cache', shards=8, timeout=1)
+```
+
+```python
+# settings.py
+CACHES = {
+    'default': {
+        'BACKEND': 'diskcache_community.DjangoCache',
+        'LOCATION': '/var/tmp/django_cache',
+        'SHARDS': 8,
+        'DISK': 'diskcache_community.SafeDisk',  # restricted unpickling, see below
+    }
+}
+```
+
+Caches shared with untrusted writers should use `SafeDisk`, which unpickles
+only a fixed set of built-in types and keeps file reads inside the cache
+directory:
+
+```python
+from diskcache_community import Cache, SafeDisk
+
+cache = Cache('cache', disk=SafeDisk)
+```
+
+[Fix CVE-2025-69872 in diskcache](https://diskcache-community.readthedocs.io/en/latest/fix-cve-2025-69872.html) covers caches
+that libraries create for you, your own classes, and entries already in the
+cache.
+
+## Features
+
+- `Cache`, `FanoutCache` and `DjangoCache` for key-value caching with
+  expiry, tags, size limits and LRU, LFU and other eviction policies
+- `Deque` and `Index`: persistent, cross-process `collections.deque` and `dict`
+- Recipes for memoization with stampede prevention, cross-process locks,
+  semaphores and throttling
+- Thread-safe and process-safe, with fork-safe connection handling
+- Read-only mode, automatic when the directory is not writable
+- Opt-in `SafeDisk` for caches whose directory other users can write to
+- Pure Python on top of the standard library `sqlite3`; no server, no compiler
+- Tested on CPython 3.10 to 3.14 on Linux, macOS and Windows
+- Gets in about 2.6 µs and sets in about 19 µs on an Apple M5 Pro in the
+  [benchmarks](https://diskcache-community.readthedocs.io/en/latest/benchmarks.html)
+  against memcached, Redis, lmdb, sqlitedict and shelve; sets are 9 to 14 %
+  faster than in diskcache 5.6.3, and twice as fast for 1 MB values
+
+## Why this fork
+
+The upstream project stopped releasing after 5.6.3 (August 2023) and its last
+commit landed in March 2024. In 2025, CVE-2025-69872 was published against
+every released version: the cache reads pickled values with `pickle.load`, so
+anyone who can write into the cache directory can run code in the process
+that reads from it. The package still works, but scanners flag it and there
+is no fixed upstream version.
+
+This fork publishes the same library as `diskcache-community`. It keeps the
+`cache.db` schema, the file layout, the serialization modes and the memoize
+key format unchanged, so a 5.6.3 process opens a directory written by this
+fork and the reverse. It adds the opt-in `SafeDisk`, creates cache directories
+with mode `0700`, opens read-only directories read-only, closes the per-thread
+SQLite connections it used to leak, and survives `fork`. The package is
+imported as `diskcache_community`, so a project can move to it while other
+dependencies in the same environment still use the upstream `diskcache`.
+The [changelog](CHANGELOG.md) lists every change and
+[SECURITY.md](SECURITY.md) describes what is and is not fixed.
+
+DiskCache was written and maintained by Grant Jenks from 2016 to 2023. This
+fork keeps his license, copyright and author credit; see [NOTICE](NOTICE).
+
+## Migrating from diskcache
+
+The public API and the files on disk are unchanged; only the import name
+differs. Install the fork and change the imports:
+
+```sh
+pip install diskcache-community
+```
+
+```python
+import diskcache_community as diskcache       # was: import diskcache
+from diskcache_community import Cache          # was: from diskcache import Cache
+```
+
+In Django settings, use `'diskcache_community.DjangoCache'` and
+`'diskcache_community.SafeDisk'`. Existing cache directories open as they
+are, and a 5.6.3 process still opens directories written by the fork.
+
+The [migration guide](https://diskcache-community.readthedocs.io/en/latest/migrating.html) lists the few behaviour changes
+since 5.6.3 and how to go back.
+
+The upstream `diskcache` package can stay installed, for example when another
+dependency requires it. Each library uses the package it imports. A library
+that wants to support both can import whichever is present:
+
+```python
+try:
+    import diskcache_community as diskcache
+except ImportError:
+    import diskcache
+```
+
+## Documentation
+
+The documentation is at
+[diskcache-community.readthedocs.io](https://diskcache-community.readthedocs.io/en/latest/):
+
+- [Fix CVE-2025-69872 in diskcache](https://diskcache-community.readthedocs.io/en/latest/fix-cve-2025-69872.html)
+- [Migrating from diskcache 5.6.3](https://diskcache-community.readthedocs.io/en/latest/migrating.html)
+- [Tutorial](https://diskcache-community.readthedocs.io/en/latest/tutorial.html)
+- [API reference](https://diskcache-community.readthedocs.io/en/latest/api.html)
+- [Benchmarks](https://diskcache-community.readthedocs.io/en/latest/benchmarks.html)
+  against memcached, Redis, lmdb, sqlitedict and shelve, the Django cache
+  backends, and diskcache 5.6.3 (measured 2026-10-12)
+- Old benchmarks from 2019, measured by upstream for version 4:
+  [Cache](https://diskcache-community.readthedocs.io/en/latest/cache-benchmarks.html)
+  and [DjangoCache](https://diskcache-community.readthedocs.io/en/latest/djangocache-benchmarks.html)
+- [Comparisons](https://diskcache-community.readthedocs.io/en/latest/comparisons.html)
+  with other key-value stores and caching libraries
+- Case studies:
+  [web crawler](https://diskcache-community.readthedocs.io/en/latest/case-study-web-crawler.html),
+  [landing page caching](https://diskcache-community.readthedocs.io/en/latest/case-study-landing-page-caching.html)
+- [Development](https://diskcache-community.readthedocs.io/en/latest/development.html)
+
+## Comparison
+
+| | diskcache | dbm | shelve | sqlitedict | pickleDB |
+|---|---|---|---|---|---|
+| Atomic | Always | Maybe | Maybe | Maybe | No |
+| Thread-safe | Yes | No | No | Yes | No |
+| Process-safe | Yes | No | No | Maybe | No |
+| Eviction | LRU, LFU, more | None | None | None | None |
+| Serialization | Customizable | None | Pickle | Customizable | JSON |
+| Data types | Mapping, deque | Mapping | Mapping | Mapping | Mapping |
+
+The full [comparisons page](https://diskcache-community.readthedocs.io/en/latest/comparisons.html)
+covers features, quality and timings in detail.
+
+## Contributing and security
+
+Bug reports and pull requests are welcome on
+[GitHub](https://github.com/secondwindoss/diskcache-community/issues).
+[CONTRIBUTING.md](CONTRIBUTING.md) explains the compatibility contract and
+how to run the tests. Report vulnerabilities privately as described in
+[SECURITY.md](SECURITY.md).
+
+## License
+
+Copyright 2016-2023 Grant Jenks. Modifications in this fork are copyright
+2026 diskcache-community contributors. Licensed under the
+[Apache License, Version 2.0](LICENSE).