https://github.com/youknowone/methodtools

Expand functools features(lru_cache) to class - methods, classmethods, staticmethods and even for (unofficial) hybrid methods.
https://github.com/youknowone/methodtools

class classmethod functools lru-cache method ring staticmethod wirerope

Last synced: 9 months ago
JSON representation

Expand functools features(lru_cache) to class - methods, classmethods, staticmethods and even for (unofficial) hybrid methods.

• Host: GitHub
• URL: https://github.com/youknowone/methodtools
• Owner: youknowone
• License: other
• Created: 2019-05-05T09:15:06.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-08-23T10:02:33.000Z (over 1 year ago)
• Last Synced: 2024-10-13T09:07:10.810Z (about 1 year ago)
• Topics: class, classmethod, functools, lru-cache, method, ring, staticmethod, wirerope
• Language: Python
• Homepage: https://pypi.org/project/methodtools/
• Size: 26.4 KB
• Stars: 75
• Watchers: 4
• Forks: 11
• Open Issues: 10
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
methodtools

===========

.. image:: https://github.com/youknowone/methodtools/actions/workflows/python-package.yml/badge.svg

.. image:: https://codecov.io/gh/youknowone/methodtools/graph/badge.svg

    :target: https://codecov.io/gh/youknowone/methodtools

Expand functools features to methods, classmethods, staticmethods and even for

(unofficial) hybrid methods.

For now, methodtools only provides `methodtools.lru_cache`.

Use `methodtools` module instead of `functools` module. Than it will work as

you expected.

.. code:: python

    from methodtools import lru_cache

    class A(object):

        # cached method. the storage lifetime follows `self` object

        @lru_cache()

        def cached_method(self, args):

            ...

        # cached classmethod. the storage lifetime follows `A` class

        @lru_cache()  # the order is important!

        @classmethod  # always lru_cache on top of classmethod

        def cached_classmethod(self, args):

            ...

        # cached staticmethod. the storage lifetime follows `A` class

        @lru_cache()  # the order is important!

        @staticmethod  # always lru_cache on top of staticmethod

        def cached_staticmethod(self, args):

            ...

    @lru_cache()  # just same as functools.lru_cache

    def cached_function():

        ...

Installation

------------

PyPI is the recommended way.

.. sourcecode:: shell

    $ pip install methodtools

To browse versions and tarballs, visit:

    ``_

.. note::

    If you are working on Python 2, install also `functools32`.

See also

--------

- `Documentation `_

- This project is derived from `Ring `_,

  a rich cache interface using the same method handling technique.

- To learn more about bound method dispatching, see also

  `wirerope `_.