The branch, twofactorauth has been updated via 13a3bb439d1242f1103976a1f86448b405043d47 (commit) from afbac212b70eb97ce83c00d86498daf4199582a2 (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/checkhosts.py | 3 ++- x2go/cleanup.py | 2 +- x2go/client.py | 61 ++++++++++++++++++++++++++-------------------------- 3 files changed, 34 insertions(+), 32 deletions(-) The diff of changes is: diff --git a/x2go/checkhosts.py b/x2go/checkhosts.py index 934f531..d204527 100644 --- a/x2go/checkhosts.py +++ b/x2go/checkhosts.py @@ -198,7 +198,8 @@ class X2goInteractiveAddPolicy(paramiko.MissingHostKeyPolicy): def check_ssh_host_key(x2go_sshclient_instance, hostname, port=22): """\ Perform a Paramiko/SSH host key check by connecting to the host and - validating the results (raised exceptions). + validating the results (i.e. by validating raised exceptions during the + connect process). @param x2go_sshclient_instance: a Paramiko/SSH client instance to be used for testing host key validity. @type x2go_sshclient_instance: C{X2goControlSession*} instance diff --git a/x2go/cleanup.py b/x2go/cleanup.py index c8a1dd2..b0d00ed 100644 --- a/x2go/cleanup.py +++ b/x2go/cleanup.py @@ -37,7 +37,7 @@ if _X2GOCLIENT_OS == 'Windows': def x2go_cleanup(e=None, threads=None): """\ For every Python X2go application you write, please make sure to - capture the KeyboardInterrupt and the SystemExit exceptions and + capture the C{KeyboardInterrupt} and the C{SystemExit} exceptions and call this function if either of the exceptions occurs. Example:: diff --git a/x2go/client.py b/x2go/client.py index c886ecc..85d3600 100644 --- a/x2go/client.py +++ b/x2go/client.py @@ -223,17 +223,17 @@ class X2goClient(object): @type ssh_rootdir: C{str} @param start_xserver: start XServer when registering an L{X2goClient} instance @type start_xserver: C{bool} - @param start_pulseaudio: start PulseAudio daemon when registering an L{X2goClient} instance + @param start_pulseaudio: start Pulseaudio daemon when registering an L{X2goClient} instance @type start_pulseaudio: C{bool} - @param use_listsessions_cache: activate the X2go list sessions cache (L{X2goListSessionsCache}) + @param use_listsessions_cache: activate the X2go session list cache (L{X2goListSessionsCache}) @type use_listsessions_cache: C{bool} - @param auto_update_listsessions_cache: activate automatic updates of the X2go list sessions cache (L{X2goListSessionsCache}) + @param auto_update_listsessions_cache: activate automatic updates of the X2go session list cache (L{X2goListSessionsCache}) @type auto_update_listsessions_cache: C{bool} @param auto_update_sessionregistry: activate automatic updates of the X2go session registry @type auto_update_sessionregistry: C{bool} @param auto_register_sessions: activate automatic X2go session registration @type auto_register_sessions: C{bool} - @param refresh_interval: refresh list sessions cache and session status every C{<refresh_interval} seconds + @param refresh_interval: refresh session list cache and session status every C{<refresh_interval>} seconds @type refresh_interval: C{int} @param pulseaudio_installdir: install path of Pulseaudio binary @type pulseaudio_installdir: C{str} @@ -331,8 +331,8 @@ class X2goClient(object): def HOOK_open_print_dialog(self, profile_name='UNKNOWN', session_name='UNKNOWN'): """\ - HOOK method: called if an incoming print job has been detected by X2goClient and a print dialog box is - detected. + HOOK method: called if an incoming print job has been detected by L{X2goPrintQueue} and a print dialog box is + requested. @param profile_name: profile name of session that called this hook method @type profile_name: C{str} @@ -344,7 +344,7 @@ class X2goClient(object): def HOOK_no_such_command(self, cmd, profile_name='UNKNOWN', session_name='UNKNOWN'): """\ - HOOK: the command <cmd> is not available for X2go server. + HOOK: the command <cmd> is not available on the connected X2go server. @param cmd: the command that failed @type cmd: C{str} @@ -393,7 +393,7 @@ class X2goClient(object): def HOOK_check_host_dialog(self, profile_name='UNKNOWN', host='UNKNOWN', port=22, fingerprint='no fingerprint', fingerprint_type='RSA'): """\ - HOOK method: called if a host check is requested. This hook has to either return C{True} (default) or C{false}. + HOOK method: called if a host check is requested. This hook has to either return C{True} (default) or C{False}. @param profile_name: profile name of session that called this hook method @type profile_name: C{str} @@ -405,7 +405,7 @@ class X2goClient(object): @type fingerprint: C{str} @param fingerprint_type: finger print type (like RSA, DSA, ...) @type fingerprint_type: C{str} - @return: if host validity is verified, the hook method should return C{True} + @return: if host validity is verified, this hook method should return C{True} @rtype: C{bool} """ @@ -463,7 +463,7 @@ class X2goClient(object): def HOOK_forwarding_tunnel_setup_failed(self, profile_name='UNKNOWN', session_name='UNKNOWN', chain_host='UNKNOWN', chain_port=0): """\ - HOOK method: called if a forwarding tunnel setup failed. + HOOK method: called if a port forwarding tunnel setup failed. @param profile_name: profile name of session that called this hook method @type profile_name: C{str} @@ -666,7 +666,7 @@ class X2goClient(object): def get_client_rootdir(self): """\ - Retrieve the root dir for settings of this L{X2goClient} instance. + Retrieve the settings root directory of this L{X2goClient} instance. @return: X2go client root directory @rtype: C{str} @@ -678,7 +678,7 @@ class X2goClient(object): def has_custom_client_rootdir(self): """\ Does this L{X2goClient} instance have a customized root dir path? - Returns C{True} in case it has. + Equals C{True} in case it has. """ return self._has_custom_client_rootdir @@ -686,7 +686,7 @@ class X2goClient(object): def get_sessions_rootdir(self): """\ - Retrieve the sessions root dir of this L{X2goClient} instance. + Retrieve the sessions root directory of this L{X2goClient} instance. @return: X2go sessions root directory @rtype: C{str} @@ -708,7 +708,7 @@ class X2goClient(object): """\ Query the local user's username (i.e. the user running the X2go client). - @return: the local username this X2goClient instance runs as + @return: the local username this L{X2goClient} instance runs as @rtype: C{str} """ @@ -721,12 +721,12 @@ class X2goClient(object): as potential X2go sessions. @param return_objects: if set to C{True} this methods returns a list of L{X2goSession} - instances, otherwise a list of session uuids representing the corresponding + instances, otherwise a list of session UUIDs representing the corresponding registered sessions is returned @type return_objects: C{bool} @return: a Python dictionary containing one registered session for each available session profile - configuration, whereas the profile names are used as dictiionary keys and L{X2goSession} + configuration, whereas the profile names are used as dictionary keys and L{X2goSession} instances as their values @rtype: C{list} @@ -744,19 +744,20 @@ class X2goClient(object): add_to_known_hosts=False, known_hosts=None, return_object=False, **kwargs): """\ - Register a new X2go client session. Within one L{X2goClient} - instance you can manage several sessions on serveral + Register a new L{X2goSession}. Within one L{X2goClient} + instance you can manage several L{X2goSession} instances on serveral remote X2go servers under different user names. These sessions can be instantiated by passing direct L{X2goSession} - parameters to this method or by naming a session profile. + parameters to this method or by specifying the name of an existing session profile + (as found in the L{X2goClient}'s C{sessions} configuration node. - A profile is a pre-defined set of session options stored in a sessions - profile node (i.e. a configuration file). With the FILE backend such session - profiles are stored in C{~/.x2goclient/sessions} or globally (for all users on the - client) in C{/etc/x2goclient/sessions}. + A session profile is a pre-defined set of session options stored in a sessions + profile node (e.g. a configuration file). With the FILE backend such session + profiles are stored as a file (by default: C{~/.x2goclient/sessions} or globally (for all users on the + client) in C{/etc/x2goclient/sessions}). - Python X2go also supports starting multiple X2go sessions from the same + Python X2go also supports starting multiple X2go sessions for the same session profile simultaneously. This method (L{X2goClient.register_session()}) accepts a similar set of parameters @@ -893,7 +894,7 @@ class X2goClient(object): def get_session_username(self, session_uuid): """\ - After an X2go session has been set up you can query the + After an L{X2goSession} has been set up you can query the username that the remote sessions runs as. @param session_uuid: the X2go session's UUID registry hash @@ -925,7 +926,7 @@ class X2goClient(object): def get_session_server_hostname(self, session_uuid): """\ - Retrieve the server hostname as provide by the calling + Retrieve the server hostname as provided by the calling application (e.g. like it has been specified in the session profile). @@ -974,7 +975,7 @@ class X2goClient(object): def set_session_username(self, session_uuid, username): """\ - Set the session username for the session that has been registered under C{session_uuid}. + Set the session username for the L{X2goSession} that has been registered under C{session_uuid}. This can be helpful for modifying user credentials during an authentication phase. @param session_uuid: the X2go session's UUID registry hash @@ -2072,7 +2073,7 @@ class X2goClient(object): def update_cache_by_profile_name(self, profile_name): """\ - Update the list sessions cache by profile name. + Update the session list cache by profile name. @param profile_name: the X2go session profile name @type profile_name: C{str} @@ -2088,7 +2089,7 @@ class X2goClient(object): def update_cache_by_session_uuid(self, session_uuid): """\ - Update the list sessions cache of a specific L{X2goSession} instance with + Update the session list cache of a specific L{X2goSession} instance with session identifier <session_uuid>. @param session_uuid: the X2go session's UUID registry hash @@ -2101,7 +2102,7 @@ class X2goClient(object): def update_cache_all_profiles(self): """\ - Update the list sessions cache of all session profiles. + Update the session list cache of all session profiles. """ if self.listsessions_cache is not None: 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).