adsfolio.pubcache

Persistent user-level cache for the user’s ADS publication universe.

class adsfolio.pubcache.CachedPublications(fetched_at, profile, documents)

Bases: object

Publication cache payload loaded from disk.

Parameters:

• fetched_at (str)

• profile (dict[str, Any])

• documents (list[dict[str, Any]])

documents: list[dict[str, Any]]

fetched_at: str

profile: dict[str, Any]

adsfolio.pubcache.cache_path()

Return the user-level publication cache path.

Return type:

pathlib.Path

adsfolio.pubcache.clear()

Remove the publication cache and report whether it existed.

Return type:

bool

adsfolio.pubcache.load_publications()

Load the cache, returning None for missing or invalid data.

Return type:

adsfolio.pubcache.CachedPublications | None

adsfolio.pubcache.profile_matches(cached_profile, current_profile)

Return whether a cache profile snapshot equals the current profile.

Parameters:

• cached_profile (collections.abc.Mapping[str, Any])

• current_profile (collections.abc.Mapping[str, Any] | Any)

Return type:

bool

adsfolio.pubcache.save_publications(profile, documents)

Atomically save a publication cache.

Parameters:

• profile (mapping or dataclass) – Snapshot of the setup profile used for the query.

• documents (list of mapping) – ADS document dictionaries.

Returns:

The written cache path.

Return type:

pathlib.Path