openstack/oslo.messaging
Code Issues Proposed changes

Cleanup parameter docstrings

Browse Source 
Change-Id: I301fdd51446bf0c0a6dd0d05b26da0556db8367d
This commit is contained in:
Davanum Srinivas 2015-12-11 11:04:13 +03:00
parent 0a0e6d0d50
commit 46daf85814
2 changed files with 1 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
oslo_messaging/_drivers/common.py
View File

@ -109,7 +109,7 @@ class Timeout(RPCException):
:param info: Extra info to convey to the user :param info: Extra info to convey to the user
:param topic: The topic that the rpc call was sent to :param topic: The topic that the rpc call was sent to
:param rpc_method_name: The name of the rpc method being :param method: The name of the rpc method being
called called
""" """
self.info = info self.info = info

24
oslo_messaging/server.py
View File

@ -342,14 +342,6 @@ class MessageHandlingServer(service.ServiceBase, _OrderedTaskRunner):
registering a callback with an event loop. Similarly, the executor may registering a callback with an event loop. Similarly, the executor may
choose to dispatch messages in a new thread, coroutine or simply the choose to dispatch messages in a new thread, coroutine or simply the
current thread. current thread.
:param log_after: Emit a log message if waiting longer than `log_after`
seconds to run this task. If set to zero, no log
message will be emitted. Defaults to 30 seconds.
:type log_after: int
:param timeout: Raise `TaskTimeout` if the task has to wait longer than
`timeout` seconds before executing.
:type timeout: int
""" """
# Warn that restarting will be deprecated # Warn that restarting will be deprecated
if self._started: if self._started:
@ -382,14 +374,6 @@ class MessageHandlingServer(service.ServiceBase, _OrderedTaskRunner):
the server. However, the server may still be in the process of handling the server. However, the server may still be in the process of handling
some messages, and underlying driver resources associated to this some messages, and underlying driver resources associated to this
server are still in use. See 'wait' for more details. server are still in use. See 'wait' for more details.
:param log_after: Emit a log message if waiting longer than `log_after`
seconds to run this task. If set to zero, no log
message will be emitted. Defaults to 30 seconds.
:type log_after: int
:param timeout: Raise `TaskTimeout` if the task has to wait longer than
`timeout` seconds before executing.
:type timeout: int
""" """
self._executor_obj.stop() self._executor_obj.stop()
@ -403,14 +387,6 @@ class MessageHandlingServer(service.ServiceBase, _OrderedTaskRunner):
Once it's finished, the underlying driver resources associated to this Once it's finished, the underlying driver resources associated to this
server are released (like closing useless network connections). server are released (like closing useless network connections).
:param log_after: Emit a log message if waiting longer than `log_after`
seconds to run this task. If set to zero, no log
message will be emitted. Defaults to 30 seconds.
:type log_after: int
:param timeout: Raise `TaskTimeout` if the task has to wait longer than
`timeout` seconds before executing.
:type timeout: int
""" """
try: try:
self._executor_obj.wait() self._executor_obj.wait()