Giter VIP home page Giter VIP logo

nemoize's Introduction

nemoize

Simple Python Memoizer decorator for classes, functions, and methods.

Installation

nemoize is available on PyPi

python3 -m pip install nemoize

Or you can install manually via the built distribution (wheel)/source dist from PyPi or github.

How to Use

Import

from nemoize import memoize

Then use the @memoize decorator on various entities as seen below

Using on a Class

@memoize
class Test:
    def __init__(self, value):
        self._value = value

    @property
    def value(self):
        return self._value

Using on a function

@memoize
def test_func():
    return "hoot"

Using on an instance method

class Owl:
    def __init__(self):
        self.food = 1337
        pass

    @memoize(max_size=5)
    def eat(self, num):
        self.food -= num

Configuration

There are also various configuration parameters to memoize():

  • @memoize(max_size=13) : Max number of entries to keep in the cache:
  • @memoize(cache_exceptions=True) : Also cache exceptions, so any raised Exceptions will be the exact same Exception instance:
  • @memoize(max_size=13, cache_exceptions=True) : Together
  • @memoize(arg_hash_function=str) : Changes the hash function on arg and each keyword-arg to use the str() function, which can make lists "hashable"

Testing

The unit tests in test/unit/test_memoize.py run through various use cases of using the @memoize annotation on classes, functions, and instance methods.

Benchmarking

There is a benchmarking utility under benchmark/ that is used for benchmarking nemoize performance against other options and non-memoized scenarios.

Example numbers:

Benchmark test for Memoized vs Non-memoized classes with [1000] computations in their__init__() methods for [1000000] iterations
Non-memoized class creation + empty method call average time (ms): 0.01550699806213379
Memoized class creation + empty method call average time (ms): 0.0012589995861053468

Benchmark test for @memoize, non-memoized, a @simplified_memoize, and @functools.lru_cache comparison usingfunction calculating fibonacci sum for [100] fib numbers, for [10000000] iterations
@simplified_memoize fib average time (ms): 0.0001555999994277954
@memoize fib average time (ms): 4.4699978828430175e-05
@memoize(cache_exceptions=True) (to avoid delegation to functools.lru_cache) fib average time (ms): 0.00034309999942779544
@functools.lru_cache fib average time (ms): 4.440000057220459e-05

nemoize's People

Contributors

spoorn avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Forkers

ryan0751

nemoize's Issues

Named parameters are not handled correctly for key generation

If I memoize a class:

@memoize class TestManager:

And then use named parameters in the object construction:

test1 = TestManager("10.1.1.1", test_param="1.1.1.1")

The part of the library the computes the cache key fails:
/home/rruel/.pyenv/versions/3.10.8/envs/test/lib/python3.10/site-packages/nemoize/memoize.py:87: TypeError =========================================================================================================================================================== short test summary info =========================================================================================================================================================== FAILED test_connection.py::test_connmanager_memoization - TypeError: unsupported operand type(s) for +=: 'int' and 'object'

If I do not use named parameters, everything works fine.

Ideally I would like the keys to be computed such that if a user requests a new instance, it shouldn't matter the ordering of kwargs, or a mix of named vs. unamed parameters,

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.