Skip to main content

Simple LRU cache for asyncio

Project description

info:

Simple lru cache for asyncio

GitHub Actions CI/CD workflows status async-lru @ PyPI https://codecov.io/gh/aio-libs/async-lru/branch/master/graph/badge.svg Matrix Room — #aio-libs:matrix.org Matrix Space — #aio-libs-space:matrix.org

Installation

pip install async-lru

Usage

This package is a port of Python’s built-in functools.lru_cache function for asyncio. To better handle async behaviour, it also ensures multiple concurrent calls will only result in 1 call to the wrapped function, with all awaits receiving the result of that call when it completes.

import asyncio

import aiohttp
from async_lru import alru_cache


@alru_cache(maxsize=32)
async def get_pep(num):
    resource = 'http://www.python.org/dev/peps/pep-%04d/' % num
    async with aiohttp.ClientSession() as session:
        try:
            async with session.get(resource) as s:
                return await s.read()
        except aiohttp.ClientError:
            return 'Not Found'


async def main():
    for n in 8, 290, 308, 320, 8, 218, 320, 279, 289, 320, 9991:
        pep = await get_pep(n)
        print(n, len(pep))

    print(get_pep.cache_info())
    # CacheInfo(hits=3, misses=8, maxsize=32, currsize=8)

    # closing is optional, but highly recommended
    await get_pep.cache_close()


asyncio.run(main())

TTL (time-to-live in seconds, expiration on timeout) is supported by accepting ttl configuration parameter (off by default):

@alru_cache(ttl=5)
async def func(arg):
    return arg * 2

The library supports explicit invalidation for specific function call by cache_invalidate():

@alru_cache(ttl=5)
async def func(arg1, arg2):
    return arg1 + arg2

func.cache_invalidate(1, arg2=2)

The method returns True if corresponding arguments set was cached already, False otherwise.

Thanks

The library was donated by Ocean S.A.

Thanks to the company for contribution.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

async_lru-2.0.5.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

async_lru-2.0.5-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file async_lru-2.0.5.tar.gz.

File metadata

  • Download URL: async_lru-2.0.5.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for async_lru-2.0.5.tar.gz
Algorithm Hash digest
SHA256 481d52ccdd27275f42c43a928b4a50c3bfb2d67af4e78b170e3e0bb39c66e5bb
MD5 c972e8755626506ca019085e0620e192
BLAKE2b-256 b24d71ec4d3939dc755264f680f6c2b4906423a304c3d18e96853f0a595dfe97

See more details on using hashes here.

Provenance

The following attestation bundles were made for async_lru-2.0.5.tar.gz:

Publisher: ci-cd.yml on aio-libs/async-lru

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file async_lru-2.0.5-py3-none-any.whl.

File metadata

  • Download URL: async_lru-2.0.5-py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for async_lru-2.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ab95404d8d2605310d345932697371a5f40def0487c03d6d0ad9138de52c9943
MD5 1064bd5395ed81979bf4f4767bc97ef1
BLAKE2b-256 0349d10027df9fce941cb8184e78a02857af36360d33e1721df81c5ed2179a1a

See more details on using hashes here.

Provenance

The following attestation bundles were made for async_lru-2.0.5-py3-none-any.whl:

Publisher: ci-cd.yml on aio-libs/async-lru

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page