.. note::
    :class: sphx-glr-download-link-note

    Click :ref:`here <sphx_glr_download_auto_examples_example_timer.py>` to download the full example code
.. rst-class:: sphx-glr-example-title

.. _sphx_glr_auto_examples_example_timer.py:


============================================================================
Example: decorating specified methods of a custom class with timer decorator
============================================================================

This example shows how to decorate methods of a custom class with a timer
decorator.


.. code-block:: default

    import time

    from pydeco import Decorator, MethodsDecorator







Create timer decorator


.. code-block:: default



    class Timer(Decorator):
        """Timer decorator."""

        def __init__(self, *args, **kwargs):
            self.run = 0
            self.run_by_func = dict()
            self.total_runtime = 0
            Decorator.__init__(self, *args, **kwargs)

        def __repr__(self):
            """Return the string representation."""
            return ('Timer(run={}, run_by_func={}, total_runtime={:2.2f} ms)'
                    .format(self.run, self.run_by_func, self.total_runtime))

        def wrapper(self, instance, func, *args, **kwargs):
            """Wrap input instance method with runtime measurement."""
            # increment run attributes
            self.run += 1
            if func.__name__ not in self.run_by_func:
                self.run_by_func[func.__name__] = 1
            else:
                self.run_by_func[func.__name__] += 1

            # save current time
            ts = time.time()

            # call `func` on inputs
            outs = func(instance, *args, **kwargs)

            # compute elapsed time
            te = time.time()
            runtime = (te - ts) * 1000
            # Update total runtime of timer
            self.total_runtime += runtime

            print('[Log] runtime {!r} : {:2.2f} ms'.format(func.__name__, runtime))

            # return outputs of `func`
            return outs








Create custom class and decorate some of its methods with :class:`Timer`


.. code-block:: default


    # instantiate decorator
    timer = Timer()


    # create class :class:`MyClass` and decorate `method_1` and `method_2` with
    # decorator `timer`
    @MethodsDecorator(mapping={timer: ['method_1', 'method_2']})
    class MyClass():
        """Custom class."""

        def __init__(self, *args, **kwargs):
            pass

        def method_1(self, sleep=.01, **kwargs):
            print('Running \'method_1\' (sleep {:2.2f} ms)'.format(sleep * 1000))
            time.sleep(sleep)

        def method_2(self, sleep=.02, **kwargs):
            print('Running \'method_2\' (sleep {:2.2f} ms)'.format(sleep * 1000))
            time.sleep(sleep)

        def method_3(self, sleep=.03, **kwargs):
            print('Running \'method_3\' (sleep {:2.2f} ms)'.format(sleep * 1000))
            time.sleep(sleep)





.. rst-class:: sphx-glr-script-out

 Out:

 .. code-block:: none

    WARNING:root:No dispatching as `n_dispatch` is null.



Run tests


.. code-block:: default


    # instantiate the class
    instance = MyClass()

    # run methods
    instance.method_1()
    instance.method_2()
    instance.method_3()

    print(timer)

    # deactivate timer for all methods of linked decorated instances
    timer.deactivate()

    # run methods
    instance.method_1()
    instance.method_2()
    instance.method_3()

    print(timer)

    # activate timer back for all methods of linked decorated instances
    timer.activate()

    # run methods
    instance.method_1()
    instance.method_2()
    instance.method_3()

    print(timer)




.. rst-class:: sphx-glr-script-out

 Out:

 .. code-block:: none

    Running 'method_1' (sleep 10.00 ms)
    [Log] runtime 'method_1' : 10.22 ms
    Running 'method_2' (sleep 20.00 ms)
    [Log] runtime 'method_2' : 20.12 ms
    Running 'method_3' (sleep 30.00 ms)
    Timer(run=2, run_by_func={'method_1': 1, 'method_2': 1}, total_runtime=30.33 ms)
    Running 'method_1' (sleep 10.00 ms)
    Running 'method_2' (sleep 20.00 ms)
    Running 'method_3' (sleep 30.00 ms)
    Timer(run=2, run_by_func={'method_1': 1, 'method_2': 1}, total_runtime=30.33 ms)
    Running 'method_1' (sleep 10.00 ms)
    [Log] runtime 'method_1' : 10.16 ms
    Running 'method_2' (sleep 20.00 ms)
    [Log] runtime 'method_2' : 20.15 ms
    Running 'method_3' (sleep 30.00 ms)
    Timer(run=4, run_by_func={'method_1': 2, 'method_2': 2}, total_runtime=60.64 ms)




.. rst-class:: sphx-glr-timing

   **Total running time of the script:** ( 0 minutes  0.205 seconds)


.. _sphx_glr_download_auto_examples_example_timer.py:


.. only :: html

 .. container:: sphx-glr-footer
    :class: sphx-glr-footer-example



  .. container:: sphx-glr-download

     :download:`Download Python source code: example_timer.py <example_timer.py>`



  .. container:: sphx-glr-download

     :download:`Download Jupyter notebook: example_timer.ipynb <example_timer.ipynb>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_