openstack
/
stevedore
Code Issues Proposed changes

Update docs for NameDispatchExtensionManager 

Add missing parameter to the table.

Resolves issue #13

Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
This commit is contained in:
Doug Hellmann 2013-06-03 10:59:47 -04:00
parent fd365c497a
commit 7e7f9c7c5f
2 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
stevedore/dispatch.py
View File

@ -76,8 +76,14 @@ class NameDispatchExtensionManager(DispatchExtensionManager):
different inputs to different extensions and can predict the name
of the extensions before calling them.
The check_func argument should return a boolean, with ``True``
indicating that the extension should be loaded and made available
and ``False`` indicating that the extension should be ignored.
:param namespace: The namespace for the entry points.
:type namespace: str
:param check_func: Function to determine which extensions to load.
:type check_func: callable
:param invoke_on_load: Boolean controlling whether to invoke the
object returned by the entry point after the driver is loaded.
:type invoke_on_load: bool
@ -89,6 +95,7 @@ class NameDispatchExtensionManager(DispatchExtensionManager):
the object returned by the entry point. Only used if invoke_on_load
is True.
:type invoke_kwds: dict
"""
def __init__(self, namespace, check_func, invoke_on_load=False,

7
stevedore/enabled.py
View File

@ -9,9 +9,9 @@ LOG = logging.getLogger(__name__)
class EnabledExtensionManager(ExtensionManager):
"""Loads only plugins that pass a check function.
The check_func should return a boolean, with ``True`` indicating
that the extension should be loaded and made available and
``False`` indicating that the extension should be ignored.
The check_func argument should return a boolean, with ``True``
indicating that the extension should be loaded and made available
and ``False`` indicating that the extension should be ignored.
:param namespace: The namespace for the entry points.
:type namespace: str
@ -28,6 +28,7 @@ class EnabledExtensionManager(ExtensionManager):
the object returned by the entry point. Only used if invoke_on_load
is True.
:type invoke_kwds: dict
"""
def __init__(self, namespace, check_func, invoke_on_load=False,