Function cache_item

src/wrf/cache.py:37–91

Store an item in the threadlocal cache. The cache should be viewed as two nested dictionaries. The outer key is usually the id for the sequence where the cached item was generated. The inner key is the product type. Storing a cached item behaves like: cache[key][product]

(key, product, value)

def cache_item(key, product, value):
    """Store an item in the threadlocal cache.

    The cache should be viewed as two nested dictionaries.  The outer key is
    usually the id for the sequence where the cached item was generated.  The
    inner key is the product type.

    Storing a cached item behaves like:

        cache[key][product] = value

    The cache is thread local, so stored items are only available in
    the thread that cached them.

    Args:

        key (:obj:`int`): The outer dictionary cache key, which is typically
            the id of the sequence where the cached item was generated.

        product (:obj:`str`): The inner dictionary cache key, which is a
            string for the product type.

        value (:obj:`object`): The object to store in the cache.

    Returns:

        None.

    See Also:

        :meth:`get_cached_item`

    """
    global _local_storage

    _shrink_cache()

    if key is None or get_cache_size() == 0:
        return

    try:
        cache = _local_storage.cache
    except AttributeError:
        _local_storage.cache = OrderedDict()
        cache = _local_storage.cache

    try:
        _ = cache[key]
    except KeyError:
        if len(cache) >= get_cache_size():
            cache.popitem(last=False)  # Remove the oldest dataset

        cache[key] = OrderedDict()

    cache[key][product] = value


def get_cached_item(key, product):