view sat/tools/common/async_utils.py @ 3902:32b38dd3ac18

plugin events: update following `Events` protoXEP submission: update the plugin to follow the specification proposed at https://github.com/xsf/xeps/pull/1206 Events are internally converted to a dict following a format described in `event_data_2_event_elt` docstring. RSVP mechanism now uses Pubsub Attachments (XEP-0470), with a user extensible data form. Bridge methods signatures have changed. rel 372
author Goffi <goffi@goffi.org>
date Wed, 21 Sep 2022 22:41:49 +0200
parents 9b45f0f168cf
children ebe45ea2df3b
line wrap: on
line source

#!/usr/bin/env python3


# Libervia: an XMPP client
# Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.

# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

"""tools to launch process in a async way (using Twisted)"""

from collections import OrderedDict
from typing import Optional, Callable, Awaitable
from sat.core.log import getLogger


log = getLogger(__name__)


def async_lru(maxsize: Optional[int] = None) -> Callable:
    """Decorator to cache async function results using LRU algorithm"""
    def decorator(func: Callable) -> Callable:
        cache = OrderedDict()
        async def wrapper(*args) -> Awaitable:
            if args in cache:
                log.debug(f"using result in cache for {args}")
                cache.move_to_end(args)
                result = cache[args]
                return result
            log.debug(f"caching result for {args}")
            result = await func(*args)
            cache[args] = result
            if maxsize is not None and len(cache) > maxsize:
                value = cache.popitem(False)
                log.debug(f"Removing LRU value: {value}")
            return result
        return wrapper
    return decorator