Turn NOTE into docstring

conductor.base_manager._register_and_validate_hardware_interfaces had a
note at the top about what exceptions might be raised. Turn this into a
proper docstring.

Change-Id: I60b3e864f4cfba38ed7d12caf3bf723d73ab9e39
Partial-Bug: #1524745
This commit is contained in:
Jim Rollenhagen 2017-01-19 20:43:17 +00:00
parent 814cf5bf83
commit 1dc154033f
1 changed files with 13 additions and 3 deletions

View File

@ -235,10 +235,20 @@ class BaseConductorManager(object):
self._started = False
def _register_and_validate_hardware_interfaces(self):
# NOTE(jroll) may raise ConductorHardwareInterfacesAlreadyRegistered
# or InterfaceNotFoundInEntrypoint,
# we intentionally let this bubble up to the caller.
"""Register and validate hardware interfaces for this conductor.
Registers a row in the database for each combination of
(hardware type, interface type, interface) that is supported and
enabled.
TODO: Validates against other conductors to check if the
set of registered hardware interfaces for a given hardware type is the
same, and warns if not (we can't error out, otherwise all conductors
must be restarted at once to change configuration).
:raises: ConductorHardwareInterfacesAlreadyRegistered
:raises: InterfaceNotFoundInEntrypoint
"""
# first unregister, in case we have cruft laying around
self.conductor.unregister_all_hardware_interfaces()