diff options
| author | Eli Collins <elic@assurancetechnologies.com> | 2011-09-14 14:59:28 -0400 |
|---|---|---|
| committer | Eli Collins <elic@assurancetechnologies.com> | 2011-09-14 14:59:28 -0400 |
| commit | 1fedd51079e49f124bc22d3bdba475afa9095726 (patch) | |
| tree | ac8c9b3a546f59be469ac40b417dc3d1a72a2811 /passlib/utils | |
| parent | 88d3f1f1486bc88833beea07e9a71766d014ed20 (diff) | |
| download | passlib-1fedd51079e49f124bc22d3bdba475afa9095726.tar.gz | |
misc doc changes
Diffstat (limited to 'passlib/utils')
| -rw-r--r-- | passlib/utils/__init__.py | 9 | ||||
| -rw-r--r-- | passlib/utils/handlers.py | 18 |
2 files changed, 14 insertions, 13 deletions
diff --git a/passlib/utils/__init__.py b/passlib/utils/__init__.py index f3fabe0..6c897bb 100644 --- a/passlib/utils/__init__.py +++ b/passlib/utils/__init__.py @@ -113,10 +113,15 @@ Undef = UndefType() NoneType = type(None) class MissingBackendError(RuntimeError): - """error raised if multi-backend handler has no available backends; + """Error raised if multi-backend handler has no available backends; or if specifically requested backend is not available. - see :class:`~passlib.utils.handlers.HasManyBackends`. + :exc:`!MissingBackendError` derives + from :exc:`RuntimeError`, since this usually indicates + lack of an external library or OS feature. + + This is primarily used by handlers which derive + from :class:`~passlib.utils.handlers.HasManyBackends`. """ #========================================================== diff --git a/passlib/utils/handlers.py b/passlib/utils/handlers.py index 1f906a2..ff40b89 100644 --- a/passlib/utils/handlers.py +++ b/passlib/utils/handlers.py @@ -1015,7 +1015,7 @@ class HasManyBackends(GenericHandler): if no backend has been loaded, loads and returns name of default backend. - :raises MissingBackendError: if no backends are available. + :raises passlib.utils.MissingBackendError: if no backends are available. :returns: name of active backend """ @@ -1078,20 +1078,16 @@ class HasManyBackends(GenericHandler): the current backend if one has been loaded, else acts like ``"default"``. - :raises MissingBackendError: - * if a specific backend was specified, + :raises passlib.utils.MissingBackendError: + * ... if a specific backend was requested, but is not currently available. - * if ``"any"`` or ``"default"`` was specified, - and NO backends are currently available. + * ... if ``"any"`` or ``"default"`` was specified, + and *no* backends are currently available. - return value should be ignored. - - .. note:: + :returns: - :exc:`~passlib.utils.MissingBackendError` derives - from :exc:`RuntimeError`, since this usually indicates - lack of an external library or OS feature. + The return value of this function should be ignored. """ if name == "any": name = cls._backend |