From 613a1f3404f93780d2883a833e5164eae490efe9 Mon Sep 17 00:00:00 2001 From: Prodesire Date: Thu, 14 Dec 2017 20:12:07 +0800 Subject: [PATCH] format misc doc --- docs/misc.rst | 128 +++++++++++++++++++++++++------------------------- 1 file changed, 64 insertions(+), 64 deletions(-) diff --git a/docs/misc.rst b/docs/misc.rst index 71b8530..0c2f2b1 100644 --- a/docs/misc.rst +++ b/docs/misc.rst @@ -3,89 +3,89 @@ Miscellanea .. py:function:: pydu.misc.timeout(seconds) - This func decorates any func which may be hang for a while. The param ``seconds`` - can be either integer or float. - In `test.py`, you may write like below: + This func decorates any func which may be hang for a while. The param ``seconds`` + can be either integer or float. + In `test.py`, you may write like below: - .. code-block:: python + .. code-block:: python - import time - from pydu.misc import unix_timeout - @timeout(1) - def f(): - time.sleep(1.01) - f() + import time + from pydu.misc import unix_timeout + @timeout(1) + def f(): + time.sleep(1.01) + f() - And run `test.py`, will see ``TimeoutError``. + And run `test.py`, will see ``TimeoutError``. .. py:function:: pydu.misc.trace(obj) - Tracing every statement and line number for running program, like ``bash -x``. - In `test.py`, you may write like below: + Tracing every statement and line number for running program, like ``bash -x``. + In `test.py`, you may write like below: - .. code-block:: python + .. code-block:: python - from pydu.misc import trace - @trace - def f(): - print(1) - a = 1 + 5 - b = [a] - print(2) - f() + from pydu.misc import trace + @trace + def f(): + print(1) + a = 1 + 5 + b = [a] + print(2) + f() - And run `test.py`, will see below output from console: + And run `test.py`, will see below output from console: - .. code-block:: console + .. code-block:: console - test.py(4): print(1) - 1 - test.py(5): a = 1 + 5 - test.py(6): b = [a] - test.py(7): print(2) - 2 + test.py(4): print(1) + 1 + test.py(5): a = 1 + 5 + test.py(6): b = [a] + test.py(7): print(2) + 2 .. py:function:: pydu.misc.memoize(obj) - A simple memoize decorator for functions supporting (hashable) - positional arguments. - It also provides a ``cache_clear()`` function for clearing the cache. + A simple memoize decorator for functions supporting (hashable) + positional arguments. + It also provides a ``cache_clear()`` function for clearing the cache. - >>> @memoize - ... def foo() - ... return 1 - ... - >>> foo() - 1 - >>> foo.cache_clear() - >>> + >>> @memoize + ... def foo() + ... return 1 + ... + >>> foo() + 1 + >>> foo.cache_clear() + >>> .. py:function:: pydu.misc.memoize_when_activated(obj) - A memoize decorator which is disabled by default. It can be - activated and deactivated on request. - For efficiency reasons it can be used only against class methods - accepting no arguments. + A memoize decorator which is disabled by default. It can be + activated and deactivated on request. + For efficiency reasons it can be used only against class methods + accepting no arguments. - >>> class Foo: - ... @memoize - ... def foo() - ... print(1) - ... - >>> f = Foo() - >>> # deactivated (default) - >>> foo() - 1 - >>> foo() - 1 - >>> - >>> # activated - >>> foo.cache_activate() - >>> foo() - 1 - >>> foo() - >>> foo() - >>> + >>> class Foo: + ... @memoize + ... def foo() + ... print(1) + ... + >>> f = Foo() + >>> # deactivated (default) + >>> foo() + 1 + >>> foo() + 1 + >>> + >>> # activated + >>> foo.cache_activate() + >>> foo() + 1 + >>> foo() + >>> foo() + >>>