qdk_chemistry.remote.cache package

Cache backends for QDK/Chemistry job results.

Built-in backends:

• folder: Plain-file content-addressed cache

• tiered: Layered cache that combines multiple backends

Custom backends can be registered with @register_cache or via the qdk_chemistry.cache_backends entry-point group.

qdk_chemistry.remote.cache.available_caches()

Return list of registered cache backend names.

Return type:

list[str]

qdk_chemistry.remote.cache.get_cache(name, **config)

Create a cache backend by name.

Parameters:

• name (str) – Backend name (e.g. "folder").

• **config (Any) – Backend-specific configuration.

Raises:

ValueError – If no cache is registered with that name.

Return type:

CacheBackend

qdk_chemistry.remote.cache.register_cache(name)

Decorator to register a cache backend class.

Parameters:

name (str) – The cache backend name (e.g. "folder").

Raises:

DuplicateRegistrationError – If the cache backend name or class is already registered.

qdk_chemistry.remote.cache.resolve_cache(cache, **kwargs)

Normalise a user-supplied cache argument.

Accepts any of the following:

• None returns None

• A CacheBackend instance → returned as-is

• A Path or path-like string → FolderCache(path=...)

• A registered name string → looked up in the registry; extra kwargs are forwarded to the backend constructor.

Parameters:

• cache (str | Path | CacheBackend | None) – Cache instance, registered backend name, filesystem path, or None.

• **kwargs (Any) – Backend-specific configuration for a name or filesystem path.

Return type:

CacheBackend | None

Submodules

• qdk_chemistry.remote.cache.base module
  • CoreDataClass
  • is_cacheable()
  • CacheBackend
    • CacheBackend.__init__()
    • CacheBackend.get_job()
    • CacheBackend.put_job()
    • CacheBackend.get_data()
    • CacheBackend.put_data()
    • CacheBackend.delete_job()
    • CacheBackend.delete_data()
    • CacheBackend.clear()
    • CacheBackend.is_shared
    • CacheBackend.has_data()
    • CacheBackend.to_config()
    • CacheBackend.for_remote()
• qdk_chemistry.remote.cache.folder module
  • CoreDataClass
  • instance_data_type_name()
  • get_dataclass_type()
  • CacheBackend
    • CacheBackend.__init__()
    • CacheBackend.get_job()
    • CacheBackend.put_job()
    • CacheBackend.get_data()
    • CacheBackend.put_data()
    • CacheBackend.delete_job()
    • CacheBackend.delete_data()
    • CacheBackend.clear()
    • CacheBackend.is_shared
    • CacheBackend.has_data()
    • CacheBackend.to_config()
    • CacheBackend.for_remote()
  • is_cacheable()
  • FolderCache
    • FolderCache.name
    • FolderCache.__init__()
    • FolderCache.get_job()
    • FolderCache.put_job()
    • FolderCache.get_data()
    • FolderCache.put_data()
    • FolderCache.has_data()
    • FolderCache.to_config()
    • FolderCache.delete_job()
    • FolderCache.delete_data()
    • FolderCache.clear()
• qdk_chemistry.remote.cache.tiered module
  • CacheBackend
    • CacheBackend.__init__()
    • CacheBackend.get_job()
    • CacheBackend.put_job()
    • CacheBackend.get_data()
    • CacheBackend.put_data()
    • CacheBackend.delete_job()
    • CacheBackend.delete_data()
    • CacheBackend.clear()
    • CacheBackend.is_shared
    • CacheBackend.has_data()
    • CacheBackend.to_config()
    • CacheBackend.for_remote()
  • TieredCache
    • TieredCache.name
    • TieredCache.__init__()
    • TieredCache.is_shared
    • TieredCache.tiers
    • TieredCache.for_remote()
    • TieredCache.to_config()
    • TieredCache.get_job()
    • TieredCache.put_job()
    • TieredCache.get_data()
    • TieredCache.put_data()
    • TieredCache.has_data()
    • TieredCache.delete_job()
    • TieredCache.delete_data()
    • TieredCache.clear()