Comment fixes

This commit is contained in:
Tim Bentley 2013-02-09 17:23:35 +00:00
parent f9dc608984
commit f92adad31d
1 changed files with 34 additions and 1 deletions

View File

@ -69,6 +69,9 @@ class Registry(object):
def get(self, key): def get(self, key):
""" """
Extracts the registry value from the list based on the key passed in Extracts the registry value from the list based on the key passed in
``key``
The service to be retrieved.
""" """
if key in self.service_list: if key in self.service_list:
return self.service_list[key] return self.service_list[key]
@ -79,6 +82,12 @@ class Registry(object):
def register(self, key, reference): def register(self, key, reference):
""" """
Registers a component against a key. Registers a component against a key.
``key``
The service to be created.
``reference``
The service address to be saved.
""" """
if key in self.service_list: if key in self.service_list:
log.error(u'Duplicate service exception %s' % key) log.error(u'Duplicate service exception %s' % key)
@ -89,7 +98,10 @@ class Registry(object):
def remove(self, key): def remove(self, key):
""" """
Removes the registry value from the list based on the key passed in Removes the registry value from the list based on the key passed in
(Only valid and active for testing framework) (Only valid and active for testing framework).
``key``
The service to be deleted.
""" """
if self.running_under_test is False: if self.running_under_test is False:
log.error(u'Invalid Method call for key %s' % key) log.error(u'Invalid Method call for key %s' % key)
@ -101,6 +113,12 @@ class Registry(object):
def register_function(self, event, function): def register_function(self, event, function):
""" """
Register a function and a handler to be called later Register a function and a handler to be called later
``event``
The function description..
``function``
The function to be called when the event happens.
""" """
if not self.functions_list.has_key(event): if not self.functions_list.has_key(event):
self.functions_list[event] = [function] self.functions_list[event] = [function]
@ -110,6 +128,12 @@ class Registry(object):
def remove_function(self, event, function): def remove_function(self, event, function):
""" """
Register a function and a handler to be called later Register a function and a handler to be called later
``event``
The function description..
``function``
The function to be called when the event happens.
""" """
if self.running_under_test is False: if self.running_under_test is False:
log.error(u'Invalid Method call for key %s' % event) log.error(u'Invalid Method call for key %s' % event)
@ -121,6 +145,15 @@ class Registry(object):
def execute(self, event, *args, **kwargs): def execute(self, event, *args, **kwargs):
""" """
Execute all the handlers registered passing the data to the handler and returning results Execute all the handlers registered passing the data to the handler and returning results
``event``
The function to be processed
``*args``
Parameters to be passed to the function.
``*kwargs``
Parameters to be passed to the function.
""" """
results = [] results = []
if event in self.functions_list: if event in self.functions_list: