The branch, twofactorauth has been updated via 314423ef7cff66d3c165b7b5193e14db418807cd (commit) from 23b38533e89e80dc69d2ba5a100fc1b5f91944dc (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- ----------------------------------------------------------------------- Summary of changes: x2go/cleanup.py | 1 + x2go/inifiles.py | 1 + x2go/log.py | 1 + x2go/pulseaudio.py | 5 ++ x2go/registry.py | 139 +++++++++++++++++++++++++++++++++++++++++++--------- x2go/rforward.py | 1 + 6 files changed, 126 insertions(+), 22 deletions(-) The diff of changes is: diff --git a/x2go/cleanup.py b/x2go/cleanup.py index b0d00ed..8b72614 100644 --- a/x2go/cleanup.py +++ b/x2go/cleanup.py @@ -19,6 +19,7 @@ """\ A recommended X2go session clean up helper function. + """ import gevent diff --git a/x2go/inifiles.py b/x2go/inifiles.py index 8036edd..3269483 100644 --- a/x2go/inifiles.py +++ b/x2go/inifiles.py @@ -25,6 +25,7 @@ """\ X2goProcessIniFile - helper class for parsing .ini files + """ __NAME__ = 'x2goinifiles-pylib' diff --git a/x2go/log.py b/x2go/log.py index 21ebb0b..564fa16 100644 --- a/x2go/log.py +++ b/x2go/log.py @@ -19,6 +19,7 @@ """\ X2goLogger class - flexible handling of log and debug output. + """ __NAME__ = 'x2gologger-pylib' diff --git a/x2go/pulseaudio.py b/x2go/pulseaudio.py index fed1795..ea6b4b4 100644 --- a/x2go/pulseaudio.py +++ b/x2go/pulseaudio.py @@ -20,6 +20,11 @@ # Other contributors: # none so far +"""\ +X2goPulseAudio class - a Pulseaudio daemon guardian thread. + +""" + __NAME__ = 'x2gopulseaudio-pylib' from defaults import X2GOCLIENT_OS as _X2GOCLIENT_OS diff --git a/x2go/registry.py b/x2go/registry.py index af5d108..e9d3663 100644 --- a/x2go/registry.py +++ b/x2go/registry.py @@ -19,6 +19,7 @@ """\ X2goSessionRegistry class - the X2goClient's session registry backend + """ __NAME__ = 'x2gosessregistry-pylib' @@ -362,8 +363,6 @@ class X2goSessionRegistry(object): @type list_backend: C{class} @param proxy_backend: X2go proxy backend to use @type proxy_backend: C{class} - @param profiles_backend: X2go session profiles backend to use - @type profiles_backend: C{class} @param settings_backend: X2go client settings backend to use @type settings_backend: C{class} @param printing_backend: X2go client printing backend to use @@ -515,42 +514,115 @@ class X2goSessionRegistry(object): def connected_sessions(self, return_objects=True, return_profile_names=False, return_profile_ids=False, return_session_names=False): """\ - STILL UNDOCUMENTED + Retrieve a list of sessions that the underlying L{X2goClient} instances is currently connected to. + If none of the C{return_*} options is specified a list of session UUID hashes will be returned. + + @param return_objects: return as list of L{X2goSession} instances + @type return_objects: C{bool} + @param return_profile_names: return as list of profile names + @type return_profile_names: C{bool} + @param return_profile_ids: return as list of profile IDs + @type return_profile_ids: C{bool} + @param return_session_names: return as list of X2go session names + @type return_session_names: C{bool} + @return: a session list (as UUID hashes, objects, profile names/IDs or session names) + @rtype: C{list} """ return self._sessionsWithState('connected', return_objects=return_objects, return_profile_names=return_profile_names, return_profile_ids=return_profile_ids, return_session_names=return_session_names) def associated_sessions(self, return_objects=True, return_profile_names=False, return_profile_ids=False, return_session_names=False): """\ - STILL UNDOCUMENTED + Retrieve a list of sessions that are currently associated by an C{X2goTerminalSession*} to the underlying L{X2goClient} instance. + If none of the C{return_*} options is specified a list of session UUID hashes will be returned. + + @param return_objects: return as list of L{X2goSession} instances + @type return_objects: C{bool} + @param return_profile_names: return as list of profile names + @type return_profile_names: C{bool} + @param return_profile_ids: return as list of profile IDs + @type return_profile_ids: C{bool} + @param return_session_names: return as list of X2go session names + @type return_session_names: C{bool} + @return: a session list (as UUID hashes, objects, profile names/IDs or session names) + @rtype: C{list} """ return self._sessionsWithState('associated', return_objects=return_objects, return_profile_names=return_profile_names, return_profile_ids=return_profile_ids, return_session_names=return_session_names) def virgin_sessions(self, return_objects=True, return_profile_names=False, return_profile_ids=False, return_session_names=False): """\ - STILL UNDOCUMENTED + Retrieve a list of sessions that are currently still in virgin state (not yet connected, associated etc.). + If none of the C{return_*} options is specified a list of session UUID hashes will be returned. + + @param return_objects: return as list of L{X2goSession} instances + @type return_objects: C{bool} + @param return_profile_names: return as list of profile names + @type return_profile_names: C{bool} + @param return_profile_ids: return as list of profile IDs + @type return_profile_ids: C{bool} + @param return_session_names: return as list of X2go session names + @type return_session_names: C{bool} + @return: a session list (as UUID hashes, objects, profile names/IDs or session names) + @rtype: C{list} + """ return self._sessionsWithState('virgin', return_objects=return_objects, return_profile_names=return_profile_names, return_profile_ids=return_profile_ids, return_session_names=return_session_names) def running_sessions(self, return_objects=True, return_profile_names=False, return_profile_ids=False, return_session_names=False): """\ - STILL UNDOCUMENTED + Retrieve a list of sessions that are currently in running state. + If none of the C{return_*} options is specified a list of session UUID hashes will be returned. + + @param return_objects: return as list of L{X2goSession} instances + @type return_objects: C{bool} + @param return_profile_names: return as list of profile names + @type return_profile_names: C{bool} + @param return_profile_ids: return as list of profile IDs + @type return_profile_ids: C{bool} + @param return_session_names: return as list of X2go session names + @type return_session_names: C{bool} + @return: a session list (as UUID hashes, objects, profile names/IDs or session names) + @rtype: C{list} """ return self._sessionsWithState('running', return_objects=return_objects, return_profile_names=return_profile_names, return_profile_ids=return_profile_ids, return_session_names=return_session_names) def suspended_sessions(self, return_objects=True, return_profile_names=False, return_profile_ids=False, return_session_names=False): """\ - STILL UNDOCUMENTED + Retrieve a list of sessions that are currently in suspended state. + If none of the C{return_*} options is specified a list of session UUID hashes will be returned. + + @param return_objects: return as list of L{X2goSession} instances + @type return_objects: C{bool} + @param return_profile_names: return as list of profile names + @type return_profile_names: C{bool} + @param return_profile_ids: return as list of profile IDs + @type return_profile_ids: C{bool} + @param return_session_names: return as list of X2go session names + @type return_session_names: C{bool} + @return: a session list (as UUID hashes, objects, profile names/IDs or session names) + @rtype: C{list} """ return self._sessionsWithState('suspended', return_objects=return_objects, return_profile_names=return_profile_names, return_profile_ids=return_profile_ids, return_session_names=return_session_names) def terminated_sessions(self, return_objects=True, return_profile_names=False, return_profile_ids=False, return_session_names=False): """\ - STILL UNDOCUMENTED + Retrieve a list of sessions that have terminated recently. + If none of the C{return_*} options is specified a list of session UUID hashes will be returned. + + @param return_objects: return as list of L{X2goSession} instances + @type return_objects: C{bool} + @param return_profile_names: return as list of profile names + @type return_profile_names: C{bool} + @param return_profile_ids: return as list of profile IDs + @type return_profile_ids: C{bool} + @param return_session_names: return as list of X2go session names + @type return_session_names: C{bool} + @return: a session list (as UUID hashes, objects, profile names/IDs or session names) + @rtype: C{list} """ return self._sessionsWithState('terminated', return_objects=return_objects, return_profile_names=return_profile_names, return_profile_ids=return_profile_ids, return_session_names=return_session_names) @@ -558,7 +630,7 @@ class X2goSessionRegistry(object): @property def has_running_sessions(self): """\ - STILL UNDOCUMENTED + Equals C{True} if the underlying L{X2goClient} instance has any running sessions at hand. """ return self.running_sessions() and len(self.running_sessions()) > 0 @@ -566,30 +638,53 @@ class X2goSessionRegistry(object): @property def has_suspended_sessions(self): """\ - STILL UNDOCUMENTED + Equals C{True} if the underlying L{X2goClient} instance has any suspended sessions at hand. """ return self.suspended_sessions and len(self.suspended_sessions) > 0 def registered_sessions(self, return_objects=True, return_profile_names=False, return_profile_ids=False, return_session_names=False): """\ - STILL UNDOCUMENTED + Retrieve a list of all registered sessions. + If none of the C{return_*} options is specified a list of session UUID hashes will be returned. + + @param return_objects: return as list of L{X2goSession} instances + @type return_objects: C{bool} + @param return_profile_names: return as list of profile names + @type return_profile_names: C{bool} + @param return_profile_ids: return as list of profile IDs + @type return_profile_ids: C{bool} + @param return_session_names: return as list of X2go session names + @type return_session_names: C{bool} + @return: a session list (as UUID hashes, objects, profile names/IDs or session names) + @rtype: C{list} """ return self._sessionsWithState('registered', return_objects=return_objects, return_profile_names=return_profile_names, return_profile_ids=return_profile_ids, return_session_names=return_session_names) - @property - def non_running_sessions(self): + def non_running_sessions(self, return_objects=True, return_profile_names=False, return_profile_ids=False, return_session_names=False): """\ - STILL UNDOCUMENTED + Retrieve a list of sessions that are currently _NOT_ in running state. + If none of the C{return_*} options is specified a list of session UUID hashes will be returned. + + @param return_objects: return as list of L{X2goSession} instances + @type return_objects: C{bool} + @param return_profile_names: return as list of profile names + @type return_profile_names: C{bool} + @param return_profile_ids: return as list of profile IDs + @type return_profile_ids: C{bool} + @param return_session_names: return as list of X2go session names + @type return_session_names: C{bool} + @return: a session list (as UUID hashes, objects, profile names/IDs or session names) + @rtype: C{list} """ - return [ s for s in self.registry.values() if s not in self.running_sessions() ] + return [ s for s in self.registered_sessions(return_objects=return_objects, return_profile_names=return_profile_names, return_profile_ids=return_profile_ids, return_session_names=return_session_names) if s not in self.running_sessions(return_objects=return_objects, return_profile_names=return_profile_names, return_profile_ids=return_profile_ids, return_session_names=return_session_names) ] def connected_sessions_of_profile_name(self, profile_name, return_objects=True, return_session_names=False): """\ For a given session profile name retrieve a list of sessions that are currently connected to the profile's X2go server. - If none of the return_* options is specified a list of session UUID hashes will be returned. + If none of the C{return_*} options is specified a list of session UUID hashes will be returned. @param profile_name: session profile name @type profile_name: C{str} @@ -610,8 +705,8 @@ class X2goSessionRegistry(object): def associated_sessions_of_profile_name(self, profile_name, return_objects=True, return_session_names=False): """\ - For a given session profile name retrieve a list of sessions that are currently associated to this L{X2goClient} instance. - If none of the return_* options is specified a list of session UUID hashes will be returned. + For a given session profile name retrieve a list of sessions that are currently associated by an C{X2goTerminalSession*} to this L{X2goClient} instance. + If none of the C{return_*} options is specified a list of session UUID hashes will be returned. @param profile_name: session profile name @type profile_name: C{str} @@ -633,7 +728,7 @@ class X2goSessionRegistry(object): def registered_sessions_of_profile_name(self, profile_name, return_objects=True, return_session_names=False): """\ For a given session profile name retrieve a list of sessions that are currently registered with this L{X2goClient} instance. - If none of the return_* options is specified a list of session UUID hashes will be returned. + If none of the C{return_*} options is specified a list of session UUID hashes will be returned. @param profile_name: session profile name @type profile_name: C{str} @@ -656,7 +751,7 @@ class X2goSessionRegistry(object): def virgin_sessions_of_profile_name(self, profile_name, return_objects=True, return_session_names=False): """\ For a given session profile name retrieve a list of sessions that are registered with this L{X2goClient} instance but have not - yet been started (i.e. sessions that are in virgin state). If none of the return_* options is specified a list of + yet been started (i.e. sessions that are in virgin state). If none of the C{return_*} options is specified a list of session UUID hashes will be returned. @param profile_name: session profile name @@ -679,7 +774,7 @@ class X2goSessionRegistry(object): def running_sessions_of_profile_name(self, profile_name, return_objects=True, return_session_names=False): """\ For a given session profile name retrieve a list of sessions that are currently running. - If none of the return_* options is specified a list of session UUID hashes will be returned. + If none of the C{return_*} options is specified a list of session UUID hashes will be returned. @param profile_name: session profile name @type profile_name: C{str} @@ -701,7 +796,7 @@ class X2goSessionRegistry(object): def suspended_sessions_of_profile_name(self, profile_name, return_objects=True, return_session_names=False): """\ For a given session profile name retrieve a list of sessions that are currently in suspended state. - If none of the return_* options is specified a list of session UUID hashes will be returned. + If none of the C{return_*} options is specified a list of session UUID hashes will be returned. @param profile_name: session profile name @type profile_name: C{str} diff --git a/x2go/rforward.py b/x2go/rforward.py index ed4d495..6259a83 100644 --- a/x2go/rforward.py +++ b/x2go/rforward.py @@ -21,6 +21,7 @@ X2go reverse SSH/Paramiko tunneling provides X2go sound, X2go printing and X2go sshfs for folder sharing and mounting remote devices in X2go terminal server sessions. + """ __NAME__ = 'x2gorevtunnel-pylib' hooks/post-receive -- python-x2go.git (Python X2Go Client API) This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "python-x2go.git" (Python X2Go Client API).