diskcache-stubs

What it is and what it does

diskcache-stubs is a type-hints-only package that provides static type information for the diskcache library. It does not contain runtime code; instead, it supplies .pyi stub files and type annotations so that type checkers like mypy, pyright, and similar tools can understand the types used in diskcache code. This allows developers to catch type errors during development rather than at runtime.

The package depends only on typing-extensions and installs with low friction. However, it is archived and abandoned as of October 2024, meaning type hints may fall behind as diskcache itself evolves. The package's own TODO list indicates incomplete coverage of several diskcache classes and methods, particularly around Cache.pull, Cache.peek, Cache.peekitem, BaseCache.get, BaseCache.pop, and DjangoCache.

Use it for:

• Enable mypy or pyright to type-check code that imports and uses diskcache for disk-based caching.
• Provide IDE autocomplete and inline type hints when working with diskcache objects in an editor.
• Catch type mismatches in cache key/value operations before runtime in a typed Python project.
• Support gradual typing migration in a codebase that uses diskcache by adding type annotations incrementally.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides type hints and stubs for the diskcache library to enable static type checking in projects that use disk-based caching.

Yes, if you use diskcache and want static type checking—but with caveats. Install it alongside python-diskcache to get type hints for your type checker. Be aware that the package is abandoned and may not cover all diskcache APIs or stay current with future diskcache releases. If you need comprehensive, actively maintained type support, verify that the stubs cover the specific diskcache methods your code relies on.

Install

diskcache-stubs on PyPI

pip install diskcache-stubs

uv add diskcache-stubs

poetry add diskcache-stubs

Installing diskcache-stubs

Before you install

Low install friction with a single lightweight dependency on typing-extensions. However, the package is abandoned as of October 2024 with no active maintenance, which may leave type hints out of sync with future diskcache releases.

License in practice

Licensed under Apache License 2.0, a permissive open-source license that allows free use, modification, and distribution with minimal restrictions.

Quickstart

pip install diskcache-stubs

import diskcache

cache = diskcache.Cache('/tmp/mycache')
cache['key'] = 'value'

This package provides type hints only; you must separately install the runtime diskcache package (python-diskcache) for actual functionality.

Verify before relying

• Coverage of diskcache.core.Cache methods (pull, peek, peekitem) is incomplete per the TODO list.
• Coverage of diskcache.djangocache.DjangoCache is incomplete and auto-generated.
• Whether type hints remain accurate with newer diskcache versions given the abandoned maintenance status.

Package facts

Evidence: diskcache_stubs-5.6.3.6.20240818-py3-none-any.whl

Tags

More Software Development packages