[X2Go-Commits] [x2gobroker] 04/05: add @raise information to __doc__ strings

git-admin at x2go.org git-admin at x2go.org
Sun Nov 2 20:28:50 CET 2014


This is an automated email from the git hooks/post-receive script.

x2go pushed a commit to branch master
in repository x2gobroker.

commit 8a21ac30272ff6d3878f7586130f171f34a90940
Author: Mike Gabriel <mike.gabriel at das-netzwerkteam.de>
Date:   Sun Nov 2 20:27:50 2014 +0100

    add @raise information to __doc__ strings
---
 x2gobroker/agent.py |    9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/x2gobroker/agent.py b/x2gobroker/agent.py
index a253f94..e4bef4d 100644
--- a/x2gobroker/agent.py
+++ b/x2gobroker/agent.py
@@ -77,6 +77,7 @@ def has_remote_broker_agent_setup():
         return True
     return False
 
+
 def call_broker_agent(username, task, cmdline_args=[], remote_agent=None, **kwargs):
     """\
     Launch X2Go Broker Agent and process its output.
@@ -90,6 +91,8 @@ def call_broker_agent(username, task, cmdline_args=[], remote_agent=None, **kwar
     @param remote_agent: if not C{None} call a remote broker agent via SSH
     @type remoate_agent: C{dict}
 
+    @raise: L{X2GoBrokerAgentException}
+
     """
     if remote_agent in (u'LOCAL', None):
         result = _call_local_broker_agent(username=username, task=task, cmdline_args=cmdline_args)
@@ -97,6 +100,7 @@ def call_broker_agent(username, task, cmdline_args=[], remote_agent=None, **kwar
         result = _call_remote_broker_agent(username=username, task=task, cmdline_args=cmdline_args, remote_agent=remote_agent)
     return result
 
+
 def _call_local_broker_agent(username, task, cmdline_args=[]):
     """\
     Launch X2Go Broker Agent locally and process its output.
@@ -108,6 +112,8 @@ def _call_local_broker_agent(username, task, cmdline_args=[]):
     @param cmdline_args: additional command line parameters for the broker agent
     @type cmdline_args: C{list}
 
+    @raise: L{X2GoBrokerAgentException}
+
     """
     cmd_line = [
         '{x2gobroker_agent_binary}'.format(x2gobroker_agent_binary=x2gobroker.defaults.X2GOBROKER_AGENT_CMD),
@@ -153,6 +159,8 @@ def _call_remote_broker_agent(username, task, cmdline_args=[], remote_agent=None
     @param remote_agent: information about the remote agent that is to be called.
     @type remote_agent: C{dict}
 
+    @raise: L{X2GoBrokerAgentException}
+
     """
     if remote_agent is None:
         logger_error.error('With the SSH agent-query-mode a remote agent host (hostname, port) has to be specified!')
@@ -209,6 +217,7 @@ def _call_remote_broker_agent(username, task, cmdline_args=[], remote_agent=None
 
     raise x2gobroker.x2gobroker_exceptions.X2GoBrokerAgentException('Query to remote X2Go Broker Agent failed with no response')
 
+
 def icmp_ping(hostname):
     """\
     Perform an ICMP ping to the requested hostname.

--
Alioth's /srv/git/_hooks_/post-receive-email on /srv/git/code.x2go.org/x2gobroker.git


More information about the x2go-commits mailing list