docs: move decorator docs into core.py and use autodecorator
This commit is contained in:
parent
284dda53e8
commit
379dca90b9
23
docs/api.rst
23
docs/api.rst
|
@ -26,29 +26,10 @@ mitogen.core
|
|||
.. automodule:: mitogen.core
|
||||
|
||||
.. currentmodule:: mitogen.core
|
||||
.. decorator:: takes_econtext
|
||||
|
||||
Decorator that marks a function or class method to automatically receive a
|
||||
kwarg named `econtext`, referencing the
|
||||
:class:`mitogen.core.ExternalContext` active in the context in which the
|
||||
function is being invoked in. The decorator is only meaningful when the
|
||||
function is invoked via :data:`CALL_FUNCTION
|
||||
<mitogen.core.CALL_FUNCTION>`.
|
||||
|
||||
When the function is invoked directly, `econtext` must still be passed to
|
||||
it explicitly.
|
||||
.. autodecorator:: takes_econtext
|
||||
|
||||
.. currentmodule:: mitogen.core
|
||||
.. decorator:: takes_router
|
||||
|
||||
Decorator that marks a function or class method to automatically receive a
|
||||
kwarg named `router`, referencing the :class:`mitogen.core.Router`
|
||||
active in the context in which the function is being invoked in. The
|
||||
decorator is only meaningful when the function is invoked via
|
||||
:data:`CALL_FUNCTION <mitogen.core.CALL_FUNCTION>`.
|
||||
|
||||
When the function is invoked directly, `router` must still be passed to it
|
||||
explicitly.
|
||||
.. autodecorator:: takes_router
|
||||
|
||||
|
||||
mitogen.master
|
||||
|
|
|
@ -7,7 +7,7 @@ VERSION = '%s.%s.%s' % mitogen.__version__
|
|||
|
||||
author = u'Network Genomics'
|
||||
copyright = u'2019, Network Genomics'
|
||||
exclude_patterns = ['_build']
|
||||
exclude_patterns = ['_build', '.venv']
|
||||
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinxcontrib.programoutput']
|
||||
html_show_copyright = False
|
||||
html_show_sourcelink = False
|
||||
|
|
|
@ -448,11 +448,31 @@ def fire(obj, name, *args, **kwargs):
|
|||
|
||||
|
||||
def takes_econtext(func):
|
||||
"""
|
||||
Decorator that marks a function or class method to automatically receive a
|
||||
kwarg named `econtext`, referencing the
|
||||
:class:`mitogen.core.ExternalContext` active in the context in which the
|
||||
function is being invoked in. The decorator is only meaningful when the
|
||||
function is invoked via :data:`CALL_FUNCTION <mitogen.core.CALL_FUNCTION>`.
|
||||
|
||||
When the function is invoked directly, `econtext` must still be passed to
|
||||
it explicitly.
|
||||
"""
|
||||
func.mitogen_takes_econtext = True
|
||||
return func
|
||||
|
||||
|
||||
def takes_router(func):
|
||||
"""
|
||||
Decorator that marks a function or class method to automatically receive a
|
||||
kwarg named `router`, referencing the :class:`mitogen.core.Router` active
|
||||
in the context in which the function is being invoked in. The decorator is
|
||||
only meaningful when the function is invoked via :data:`CALL_FUNCTION
|
||||
<mitogen.core.CALL_FUNCTION>`.
|
||||
|
||||
When the function is invoked directly, `router` must still be passed to it
|
||||
explicitly.
|
||||
"""
|
||||
func.mitogen_takes_router = True
|
||||
return func
|
||||
|
||||
|
|
Loading…
Reference in New Issue