[X2Go-Commits] [python-x2go] 02/04: sphinx docs: Update loads of param and type fields to sphinxy format.

This is an automated email from the git hooks/post-receive script. x2go pushed a commit to branch master in repository python-x2go. commit 945066ee18d4fc8e4012a976381e9a5a7daa484b Author: Mike Gabriel <mike.gabriel@das-netzwerkteam.de> Date: Thu Sep 6 17:51:40 2018 +0200 sphinx docs: Update loads of param and type fields to sphinxy format. --- x2go/backends/info/plain.py | 8 +- x2go/backends/printing/file.py | 16 ++-- x2go/backends/printing/winreg.py | 12 +-- x2go/backends/profiles/base.py | 20 ++--- x2go/backends/profiles/httpbroker.py | 20 ++--- x2go/backends/profiles/sshbroker.py | 12 +-- x2go/backends/profiles/winreg.py | 12 +-- x2go/backends/proxy/base.py | 32 +++---- x2go/backends/terminal/plain.py | 156 +++++++++++++++++------------------ x2go/cache.py | 12 +-- x2go/checkhosts.py | 8 +- x2go/client.py | 112 ++++++++++++------------- x2go/forward.py | 32 +++---- x2go/gevent_subprocess.py | 2 +- x2go/guardian.py | 36 ++++---- x2go/inifiles.py | 26 +++--- x2go/log.py | 12 +-- x2go/mimebox.py | 24 +++--- x2go/mimeboxactions.py | 50 +++++------ x2go/printactions.py | 90 ++++++++++---------- x2go/printqueue.py | 30 +++---- x2go/pulseaudio.py | 18 ++-- x2go/registry.py | 23 +++--- x2go/rforward.py | 32 +++---- x2go/session.py | 154 +++++++++++++++++----------------- x2go/sftpserver.py | 56 ++++++------- x2go/sshproxy.py | 130 ++++++++++++++--------------- x2go/telekinesis.py | 24 +++--- x2go/utils.py | 8 +- x2go/xserver.py | 32 +++---- 30 files changed, 598 insertions(+), 601 deletions(-) diff --git a/x2go/backends/info/plain.py b/x2go/backends/info/plain.py index 17bd45b..b01bb59 100644 --- a/x2go/backends/info/plain.py +++ b/x2go/backends/info/plain.py @@ -340,12 +340,12 @@ class X2GoServerSessionList(object): """ def __init__(self, x2go_output=None, info_backend=X2GoServerSessionInfo): """\ - @param x2go_output: X2Go server's ``x2golistsessions`` command output, each + :param x2go_output: X2Go server's ``x2golistsessions`` command output, each session separated by a newline character. Session values are separated by Unix Pipe Symbols ('|') - @type x2go_output: str - @param info_backend: the session info backend to use - @type info_backend: ``X2GoServerSessionInfo*`` + :type x2go_output: str + :param info_backend: the session info backend to use + :type info_backend: ``X2GoServerSessionInfo*`` """ self.sessions = {} diff --git a/x2go/backends/printing/file.py b/x2go/backends/printing/file.py index 0cef1c5..bb7b49d 100644 --- a/x2go/backends/printing/file.py +++ b/x2go/backends/printing/file.py @@ -83,18 +83,18 @@ class X2GoClientPrinting(inifiles.X2GoIniFile): def __init__(self, config_files=_X2GO_PRINTING_CONFIGFILES, defaults=_X2GO_CLIENTPRINTING_DEFAULTS, client_instance=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param config_files: a list of configuration files names (e.g. a global filename and a user's home + :param config_files: a list of configuration files names (e.g. a global filename and a user's home directory filename) - @type config_files: ``list`` - @param defaults: a cascaded Python dicitionary structure with ini file defaults (to override + :type config_files: ``list`` + :param defaults: a cascaded Python dicitionary structure with ini file defaults (to override Python X2Go's hard coded defaults in :module:`x2go.defaults` - @type defaults: ``dict`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :type defaults: ``dict`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.printactions.X2GoPrintAction` constructor - @type logger: ``obj`` - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type logger: ``obj`` + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ self.client_instance = client_instance diff --git a/x2go/backends/printing/winreg.py b/x2go/backends/printing/winreg.py index c2a037e..fdc3410 100644 --- a/x2go/backends/printing/winreg.py +++ b/x2go/backends/printing/winreg.py @@ -63,15 +63,15 @@ class X2GoClientPrinting(object): def __init__(self, defaults=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param defaults: a cascaded Python dicitionary structure with ini file defaults (to override + :param defaults: a cascaded Python dicitionary structure with ini file defaults (to override Python X2Go's hard coded defaults in :module:`x2go.defaults` - @type defaults: ``dict`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :type defaults: ``dict`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.printactions.X2GoPrintAction` constructor - @type logger: ``obj`` - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type logger: ``obj`` + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ raise X2GoNotImplementedYetException('WINREG backend support is not implemented yet') diff --git a/x2go/backends/profiles/base.py b/x2go/backends/profiles/base.py index d3e3d06..008dd94 100644 --- a/x2go/backends/profiles/base.py +++ b/x2go/backends/profiles/base.py @@ -54,14 +54,14 @@ class X2GoSessionProfiles(object): Retrieve X2Go session profiles. Base class for the different specific session profile configuration backends. - @param session_profile_defaults: a default session profile - @type session_profile_defaults: ``dict`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :param session_profile_defaults: a default session profile + :type session_profile_defaults: ``dict`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.backends.profiles.httpbroker.X2GoSessionProfiles` constructor - @type logger: :class:`x2go.logger.X2GoLogger` instance - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type logger: :class:`x2go.logger.X2GoLogger` instance + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ self.defaultValues = {} @@ -86,11 +86,11 @@ class X2GoSessionProfiles(object): """\ Retrieve the session profile configuration for a given session profile ID (or name) - @param profile_id_or_name: profile ID or profile name - @type profile_id_or_name: ``str`` + :param profile_id_or_name: profile ID or profile name + :type profile_id_or_name: ``str`` - @return: the profile ID's / name's profile configuration - @rtype: ``dict`` + :returns: the profile ID's / name's profile configuration + :rtype: ``dict`` """ _profile_id = self.check_profile_id_or_name(self, profile_id_or_name) diff --git a/x2go/backends/profiles/httpbroker.py b/x2go/backends/profiles/httpbroker.py index a13ddbd..62805b3 100644 --- a/x2go/backends/profiles/httpbroker.py +++ b/x2go/backends/profiles/httpbroker.py @@ -61,19 +61,19 @@ class X2GoSessionProfiles(base.X2GoSessionProfiles): """\ Retrieve X2Go session profiles from a HTTP(S) session broker. - @param session_profile_defaults: a default session profile - @type session_profile_defaults: ``dict`` - @param broker_url: URL for accessing the X2Go Session Broker - @type broker_url: ``str`` - @param broker_password: use this password for authentication against the X2Go Session Broker (avoid + :param session_profile_defaults: a default session profile + :type session_profile_defaults: ``dict`` + :param broker_url: URL for accessing the X2Go Session Broker + :type broker_url: ``str`` + :param broker_password: use this password for authentication against the X2Go Session Broker (avoid password string in the ``broker_URL`` parameter is highly recommended) - @type broker_password: ``str`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :type broker_password: ``str`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.backends.profiles.httpbroker.X2GoSessionProfiles` constructor - @type logger: :class:`x2go.logger.X2GoLogger` instance - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type logger: :class:`x2go.logger.X2GoLogger` instance + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ if broker_url.upper() != "HTTP": diff --git a/x2go/backends/profiles/sshbroker.py b/x2go/backends/profiles/sshbroker.py index 27f83d4..19b5769 100644 --- a/x2go/backends/profiles/sshbroker.py +++ b/x2go/backends/profiles/sshbroker.py @@ -49,14 +49,14 @@ class X2GoSessionProfiles(base.X2GoSessionProfiles): """\ Retrieve X2Go session profiles from a SSH session broker. - @param session_profile_defaults: a default session profile - @type session_profile_defaults: ``dict`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :param session_profile_defaults: a default session profile + :type session_profile_defaults: ``dict`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.backends.profiles.httpbroker.X2GoSessionProfiles` constructor - @type logger: :class:`x2go.logger.X2GoLogger` instance - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type logger: :class:`x2go.logger.X2GoLogger` instance + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ raise X2GoNotImplementedYetException('HTTPSBROKER backend support is not implemented yet') diff --git a/x2go/backends/profiles/winreg.py b/x2go/backends/profiles/winreg.py index df9101c..450bad1 100644 --- a/x2go/backends/profiles/winreg.py +++ b/x2go/backends/profiles/winreg.py @@ -50,14 +50,14 @@ class X2GoSessionProfilesWINREG(base.X2GoSessionProfiles): """\ Retrieve X2Go session profiles from the Windows registry. - @param session_profile_defaults: a default session profile - @type session_profile_defaults: ``dict`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :param session_profile_defaults: a default session profile + :type session_profile_defaults: ``dict`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.backends.profiles.winreg.X2GoSessionProfilesWINREG` constructor - @type logger: :class:`x2go.logger.X2GoLogger` instance - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type logger: :class:`x2go.logger.X2GoLogger` instance + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ raise X2GoNotImplementedYetException('WINREG backend support is not implemented yet') diff --git a/x2go/backends/proxy/base.py b/x2go/backends/proxy/base.py index 5c2c745..e733c48 100644 --- a/x2go/backends/proxy/base.py +++ b/x2go/backends/proxy/base.py @@ -79,26 +79,26 @@ class X2GoProxy(threading.Thread): session_instance=None, logger=None, loglevel=log.loglevel_DEFAULT, ): """\ - @param session_info: session information provided as an ``X2GoServerSessionInfo*`` backend + :param session_info: session information provided as an ``X2GoServerSessionInfo*`` backend instance - @type session_info: ``X2GoServerSessionInfo*`` instance - @param ssh_transport: SSH transport object from ``paramiko.SSHClient`` - @type ssh_transport: ``paramiko.Transport`` instance - @param session_log: name of the proxy's session logfile - @type session_log: ``str`` - @param sessions_rootdir: base dir where X2Go session files are stored (by default: ~/.x2go) - @type sessions_rootdir: ``str`` - @param proxy_options: a set of very :class:`X2GoProxy <x2go.backends.proxy.base.X2GoProxy>` backend specific options; any option that is not known + :type session_info: ``X2GoServerSessionInfo*`` instance + :param ssh_transport: SSH transport object from ``paramiko.SSHClient`` + :type ssh_transport: ``paramiko.Transport`` instance + :param session_log: name of the proxy's session logfile + :type session_log: ``str`` + :param sessions_rootdir: base dir where X2Go session files are stored (by default: ~/.x2go) + :type sessions_rootdir: ``str`` + :param proxy_options: a set of very :class:`X2GoProxy <x2go.backends.proxy.base.X2GoProxy>` backend specific options; any option that is not known to the :class:`x2go.backends.proxy.base.X2GoProxy` backend will simply be ignored - @type proxy_options: ``dict`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :type proxy_options: ``dict`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.backends.proxy.base.X2GoProxy` constructor - @param session_instance: the :class:`x2go.session.X2GoSession` instance this :class:`x2go.backends.proxy.base.X2GoProxy` instance belongs to - @type session_instance: :class:`x2go.session.X2GoSession` instance - @type logger: :class:`x2go.logger.X2GoLogger` instance - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :param session_instance: the :class:`x2go.session.X2GoSession` instance this :class:`x2go.backends.proxy.base.X2GoProxy` instance belongs to + :type session_instance: :class:`x2go.session.X2GoSession` instance + :type logger: :class:`x2go.logger.X2GoLogger` instance + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: int + :type loglevel: int """ if logger is None: diff --git a/x2go/backends/terminal/plain.py b/x2go/backends/terminal/plain.py index 18217b1..48cd500 100644 --- a/x2go/backends/terminal/plain.py +++ b/x2go/backends/terminal/plain.py @@ -237,95 +237,95 @@ class X2GoTerminalSession(object): new X2Go sessions, resume suspended sessions or suspend resp. terminate currently running sessions on a connected X2Go server. - @param geometry: screen geometry of the X2Go session. Can be either ``<width>x<height>``, + :param geometry: screen geometry of the X2Go session. Can be either ``<width>x<height>``, ``maximize`` or ``fullscreen`` - @type geometry: ``str`` - @param depth: color depth in bits (common values: ``16``, ``24``) - @type depth: ``int`` - @param link: network link quality (either one of ``modem``, ``isdn``, ``adsl``, ``wan`` or ``lan``) - @type link: ``str`` - @param pack: compression method for NX based session proxying - @type pack: ``str`` - @param dpi: dots-per-inch value for the session screen (has an impact on the font size on screen) - @type dpi: ``str`` - @param cache_type: a dummy parameter that is passed to the :class:`x2go.backends.proxy.base.X2GoProxy`. In NX Proxy + :type geometry: ``str`` + :param depth: color depth in bits (common values: ``16``, ``24``) + :type depth: ``int`` + :param link: network link quality (either one of ``modem``, ``isdn``, ``adsl``, ``wan`` or ``lan``) + :type link: ``str`` + :param pack: compression method for NX based session proxying + :type pack: ``str`` + :param dpi: dots-per-inch value for the session screen (has an impact on the font size on screen) + :type dpi: ``str`` + :param cache_type: a dummy parameter that is passed to the :class:`x2go.backends.proxy.base.X2GoProxy`. In NX Proxy (class ``X2GoProxyNX3``) this originally is the session name. With X2Go it defines the name of the NX cache directory. Best is to leave it untouched. - @type cache_type: ``str`` - @param kbtype: keyboard type, e.g. ``pc105/us`` (default), ``pc105/de``, ... - @type kbtype: ``str`` - @param kblayout: keyboard layout, e.g. ``us`` (default), ``de``, ``fr``, ... - @type kblayout: ``str`` - @param kbvariant: keyboard variant, e.g. ``nodeadkeys`` (for ``de`` layout), ``intl`` (for ``us`` layout), etc. - @type kbvariant: ``str`` - @param clipboard: clipboard mode (``both``: bidirectional copy+paste, ``server``: copy+paste from server to + :type cache_type: ``str`` + :param kbtype: keyboard type, e.g. ``pc105/us`` (default), ``pc105/de``, ... + :type kbtype: ``str`` + :param kblayout: keyboard layout, e.g. ``us`` (default), ``de``, ``fr``, ... + :type kblayout: ``str`` + :param kbvariant: keyboard variant, e.g. ``nodeadkeys`` (for ``de`` layout), ``intl`` (for ``us`` layout), etc. + :type kbvariant: ``str`` + :param clipboard: clipboard mode (``both``: bidirectional copy+paste, ``server``: copy+paste from server to client, ``client``: copy+paste from client to server, ``none``: disable clipboard completely - @param xinerama: enable/disable Xinerama support in remote X2Go session - @type xinerama: ``bool`` - @type clipboard: ``str`` - @param session_type: either ``desktop``, ``application`` (rootless session) or ``shared`` - @type session_type: ``str`` - @param snd_system: sound system to be used on server (``none``, ``pulse`` (default), + :param xinerama: enable/disable Xinerama support in remote X2Go session + :type xinerama: ``bool`` + :type clipboard: ``str`` + :param session_type: either ``desktop``, ``application`` (rootless session) or ``shared`` + :type session_type: ``str`` + :param snd_system: sound system to be used on server (``none``, ``pulse`` (default), ``arts`` (obsolete) or ``esd``) - @type snd_system: ``str`` - @param snd_port: local sound port for network capable audio system - @type snd_port: ``int`` - @param cmd: command to be run on X2Go server after session start (only used + :type snd_system: ``str`` + :param snd_port: local sound port for network capable audio system + :type snd_port: ``int`` + :param cmd: command to be run on X2Go server after session start (only used when :class:`x2go.backends.terminal.plain.X2GoTerminalSession.start()` is called, ignored on resume, suspend etc. - @type cmd: ``str`` - @param published_applications: session is published applications provider - @type published_applications: ``bool`` - @param set_session_title: modify the session title (i.e. the Window title) of desktop or shared desktop sessions - @type set_session_title: ``bool`` - @param session_title: session title for this (desktop or shared desktop) session - @type session_title: ``str`` - @param applications: applications available for rootless application execution - @type applications: ``list`` - @param rdp_server: host name of server-side RDP server - @type rdp_server: ``str`` - @param rdp_options: options for the ``rdesktop`` command executed on the X2Go server (RDP proxy mode of X2Go) - @type rdp_options: ``str`` - @param xdmcp_server: XDMCP server to connect to - @type xdmcp_server: ``str`` - @param convert_encoding: convert file system encodings between server and client (for client-side shared folders) - @type convert_encoding: ``bool`` - @param server_encoding: server-side file system / session encoding - @type server_encoding: ``str`` - @param client_encoding: client-side file system encoding (if client-side is MS Windows, this parameter gets overwritten to WINDOWS-1252) - @type client_encoding: ``str`` - @param rootdir: X2Go session directory, normally ``~/.x2go`` - @type rootdir: ``str`` - @param profile_name: the session profile name for this terminal session - @type profile_name: ``str`` - @param profile_id: the session profile ID for this terminal session - @type profile_id: ``str`` - @param print_action: either a print action short name (PDFVIEW, PDFSAVE, PRINT, PRINTCMD) or the + :type cmd: ``str`` + :param published_applications: session is published applications provider + :type published_applications: ``bool`` + :param set_session_title: modify the session title (i.e. the Window title) of desktop or shared desktop sessions + :type set_session_title: ``bool`` + :param session_title: session title for this (desktop or shared desktop) session + :type session_title: ``str`` + :param applications: applications available for rootless application execution + :type applications: ``list`` + :param rdp_server: host name of server-side RDP server + :type rdp_server: ``str`` + :param rdp_options: options for the ``rdesktop`` command executed on the X2Go server (RDP proxy mode of X2Go) + :type rdp_options: ``str`` + :param xdmcp_server: XDMCP server to connect to + :type xdmcp_server: ``str`` + :param convert_encoding: convert file system encodings between server and client (for client-side shared folders) + :type convert_encoding: ``bool`` + :param server_encoding: server-side file system / session encoding + :type server_encoding: ``str`` + :param client_encoding: client-side file system encoding (if client-side is MS Windows, this parameter gets overwritten to WINDOWS-1252) + :type client_encoding: ``str`` + :param rootdir: X2Go session directory, normally ``~/.x2go`` + :type rootdir: ``str`` + :param profile_name: the session profile name for this terminal session + :type profile_name: ``str`` + :param profile_id: the session profile ID for this terminal session + :type profile_id: ``str`` + :param print_action: either a print action short name (PDFVIEW, PDFSAVE, PRINT, PRINTCMD) or the resp. ``X2GoPrintActionXXX`` class (where XXX equals one of the given short names) - @type print_action: ``str`` or ``class`` - @param print_action_args: optional arguments for a given print_action (for further info refer to + :type print_action: ``str`` or ``class`` + :param print_action_args: optional arguments for a given print_action (for further info refer to :class:`x2go.printactions.X2GoPrintActionPDFVIEW`, :class:`x2go.printactions.X2GoPrintActionPDFSAVE`, :class:`x2go.printactions.X2GoPrintActionPRINT` and :class:`x2go.printactions.X2GoPrintActionPRINTCMD`) - @type print_action_args: ``dict`` - @param info_backend: backend for handling storage of server session information - @type info_backend: ``X2GoServerSessionInfo*`` instance - @param list_backend: backend for handling storage of session list information - @type list_backend: ``X2GoServerSessionList*`` instance - @param proxy_backend: backend for handling the X-proxy connections - @type proxy_backend: ``X2GoProxy*`` instance - @param proxy_options: a set of very ``X2GoProxy`` backend specific options; any option that is not known + :type print_action_args: ``dict`` + :param info_backend: backend for handling storage of server session information + :type info_backend: ``X2GoServerSessionInfo*`` instance + :param list_backend: backend for handling storage of session list information + :type list_backend: ``X2GoServerSessionList*`` instance + :param proxy_backend: backend for handling the X-proxy connections + :type proxy_backend: ``X2GoProxy*`` instance + :param proxy_options: a set of very ``X2GoProxy`` backend specific options; any option that is not known to the ``X2GoProxy`` backend will simply be ignored - @type proxy_options: ``dict`` - @param client_rootdir: client base dir (default: ~/.x2goclient) - @type client_rootdir: ``str`` - @param sessions_rootdir: sessions base dir (default: ~/.x2go) - @type sessions_rootdir: ``str`` - @param session_instance: the :class:`x2go.session.X2GoSession` instance that is parent to this terminal session - @type session_instance: ``obj`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :type proxy_options: ``dict`` + :param client_rootdir: client base dir (default: ~/.x2goclient) + :type client_rootdir: ``str`` + :param sessions_rootdir: sessions base dir (default: ~/.x2go) + :type sessions_rootdir: ``str`` + :param session_instance: the :class:`x2go.session.X2GoSession` instance that is parent to this terminal session + :type session_instance: ``obj`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.backends.terminal.plain.X2GoTerminalSession` constructor - @type logger: :class:`x2go.logger.X2GoLogger` instance - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type logger: :class:`x2go.logger.X2GoLogger` instance + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ self.proxy = None diff --git a/x2go/cache.py b/x2go/cache.py index 18f0249..170bd8f 100644 --- a/x2go/cache.py +++ b/x2go/cache.py @@ -58,13 +58,13 @@ class X2GoListSessionsCache(object): def __init__(self, client_instance, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param client_instance: the :class:`x2go.client.X2GoClient` instance that uses this :class:`x2go.cache.X2GoListSessionsCache` - @type client_instance: ``obj`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.cache.X2GoListSessionsCache` constructor - @type logger: ``obj`` - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :param client_instance: the :class:`x2go.client.X2GoClient` instance that uses this :class:`x2go.cache.X2GoListSessionsCache` + :type client_instance: ``obj`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.cache.X2GoListSessionsCache` constructor + :type logger: ``obj`` + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ self.x2go_listsessions_cache = {} diff --git a/x2go/checkhosts.py b/x2go/checkhosts.py index 3e125e4..293037a 100644 --- a/x2go/checkhosts.py +++ b/x2go/checkhosts.py @@ -47,10 +47,10 @@ class X2GoMissingHostKeyPolicy(paramiko.MissingHostKeyPolicy): """ def __init__(self, caller=None, session_instance=None, fake_hostname=None): """\ - @param caller: calling instance - @type caller: ``class`` - @param session_instance: an X2Go session instance - @type session_instance: :class:`x2go.session.X2GoSession` instance + :param caller: calling instance + :type caller: ``class`` + :param session_instance: an X2Go session instance + :type session_instance: :class:`x2go.session.X2GoSession` instance """ self.caller = caller diff --git a/x2go/client.py b/x2go/client.py index 2b46866..210fa67 100644 --- a/x2go/client.py +++ b/x2go/client.py @@ -201,64 +201,64 @@ class X2GoClient(object): pulseaudio_installdir=os.path.join(os.getcwd(), 'pulseaudio'), logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param control_backend: X2Go control session backend to use - @type control_backend: ``str`` - @param terminal_backend: X2Go terminal session backend to use - @type terminal_backend: ``str`` - @param info_backend: X2Go session info backend to use - @type info_backend: ``str`` - @param list_backend: X2Go session list backend to use - @type list_backend: ``str`` - @param proxy_backend: X2Go proxy backend to use - @type proxy_backend: ``str`` - @param profiles_backend: X2Go session profiles backend to use - @type profiles_backend: ``str`` - @param settings_backend: X2Go client settings backend to use - @type settings_backend: ``str`` - @param printing_backend: X2Go client printing backend to use - @type printing_backend: ``str`` - @param broker_url: URL pointing to the X2Go Session Broker - @type broker_url: ``str`` - @param broker_password: use this password for authentication against the X2Go Session Broker - @type broker_password: ``str`` - @param broker_noauth: accessing the X2Go Session Broker works without credentials - @type broker_noauth: ``bool`` - @param client_rootdir: client base dir (default: ~/.x2goclient) - @type client_rootdir: ``str`` - @param sessions_rootdir: sessions base dir (default: ~/.x2go) - @type sessions_rootdir: ``str`` - @param ssh_rootdir: ssh base dir (default: ~/.ssh) - @type ssh_rootdir: ``str`` - @param start_xserver: start XServer when registering an :class:`x2go.client.X2GoClient` instance - @type start_xserver: ``bool`` - @param start_pulseaudio: start Pulseaudio daemon when registering an :class:`x2go.client.X2GoClient` instance - @type start_pulseaudio: ``bool`` - @param use_cache: alias for ``use_listsessions_cache`` - @type use_cache: ``bool`` - @param use_listsessions_cache: activate the X2Go session list cache in (:class:`x2go.cache.X2GoListSessionsCache`) - @type use_listsessions_cache: ``bool`` - @param auto_update_listsessions_cache: activate automatic updates of the X2Go session list cache (:class:`x2go.cache.X2GoListSessionsCache`) - @type auto_update_listsessions_cache: ``bool`` - @param auto_update_listdesktops_cache: activate automatic updates of desktop lists in (:class:`x2go.cache.X2GoListSessionsCache`) - @type auto_update_listdesktops_cache: ``bool`` - @param auto_update_listmounts_cache: activate automatic updates of mount lists in (:class:`x2go.cache.X2GoListSessionsCache`) - @type auto_update_listmounts_cache: ``bool`` - @param auto_update_sessionregistry: activate automatic updates of the X2Go session registry - @type auto_update_sessionregistry: ``bool`` - @param auto_register_sessions: activate automatic X2Go session registration - @type auto_register_sessions: ``bool`` - @param no_auto_reg_pubapp_sessions: skip automatic X2Go session registration for suspended/running published applications sessions - @type no_auto_reg_pubapp_sessions: ``bool`` - @param refresh_interval: refresh session list cache and session status every ``refresh_interval`` seconds - @type refresh_interval: ``int`` - @param pulseaudio_installdir: install path of Pulseaudio binary - @type pulseaudio_installdir: ``str`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :param control_backend: X2Go control session backend to use + :type control_backend: ``str`` + :param terminal_backend: X2Go terminal session backend to use + :type terminal_backend: ``str`` + :param info_backend: X2Go session info backend to use + :type info_backend: ``str`` + :param list_backend: X2Go session list backend to use + :type list_backend: ``str`` + :param proxy_backend: X2Go proxy backend to use + :type proxy_backend: ``str`` + :param profiles_backend: X2Go session profiles backend to use + :type profiles_backend: ``str`` + :param settings_backend: X2Go client settings backend to use + :type settings_backend: ``str`` + :param printing_backend: X2Go client printing backend to use + :type printing_backend: ``str`` + :param broker_url: URL pointing to the X2Go Session Broker + :type broker_url: ``str`` + :param broker_password: use this password for authentication against the X2Go Session Broker + :type broker_password: ``str`` + :param broker_noauth: accessing the X2Go Session Broker works without credentials + :type broker_noauth: ``bool`` + :param client_rootdir: client base dir (default: ~/.x2goclient) + :type client_rootdir: ``str`` + :param sessions_rootdir: sessions base dir (default: ~/.x2go) + :type sessions_rootdir: ``str`` + :param ssh_rootdir: ssh base dir (default: ~/.ssh) + :type ssh_rootdir: ``str`` + :param start_xserver: start XServer when registering an :class:`x2go.client.X2GoClient` instance + :type start_xserver: ``bool`` + :param start_pulseaudio: start Pulseaudio daemon when registering an :class:`x2go.client.X2GoClient` instance + :type start_pulseaudio: ``bool`` + :param use_cache: alias for ``use_listsessions_cache`` + :type use_cache: ``bool`` + :param use_listsessions_cache: activate the X2Go session list cache in (:class:`x2go.cache.X2GoListSessionsCache`) + :type use_listsessions_cache: ``bool`` + :param auto_update_listsessions_cache: activate automatic updates of the X2Go session list cache (:class:`x2go.cache.X2GoListSessionsCache`) + :type auto_update_listsessions_cache: ``bool`` + :param auto_update_listdesktops_cache: activate automatic updates of desktop lists in (:class:`x2go.cache.X2GoListSessionsCache`) + :type auto_update_listdesktops_cache: ``bool`` + :param auto_update_listmounts_cache: activate automatic updates of mount lists in (:class:`x2go.cache.X2GoListSessionsCache`) + :type auto_update_listmounts_cache: ``bool`` + :param auto_update_sessionregistry: activate automatic updates of the X2Go session registry + :type auto_update_sessionregistry: ``bool`` + :param auto_register_sessions: activate automatic X2Go session registration + :type auto_register_sessions: ``bool`` + :param no_auto_reg_pubapp_sessions: skip automatic X2Go session registration for suspended/running published applications sessions + :type no_auto_reg_pubapp_sessions: ``bool`` + :param refresh_interval: refresh session list cache and session status every ``refresh_interval`` seconds + :type refresh_interval: ``int`` + :param pulseaudio_installdir: install path of Pulseaudio binary + :type pulseaudio_installdir: ``str`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.client.X2GoClient` constructor - @type logger: :class:`x2go.logger.X2GoLogger` instance - @param loglevel: if no X2GoLogger object has been supplied a new one will be + :type logger: :class:`x2go.logger.X2GoLogger` instance + :param loglevel: if no X2GoLogger object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ self.listsessions_cache = None diff --git a/x2go/forward.py b/x2go/forward.py index 0e2d5c2..89b18c1 100644 --- a/x2go/forward.py +++ b/x2go/forward.py @@ -52,25 +52,25 @@ class X2GoFwServer(StreamServer): ssh_transport, session_instance=None, session_name=None, subsystem=None, logger=None, loglevel=log.loglevel_DEFAULT,): """\ - @param listener: listen on TCP/IP socket ``(<IP>, <Port>)`` - @type listener: ``tuple`` - @param remote_host: hostname or IP of remote host (in case of X2Go mostly 127.0.0.1) - @type remote_host: ``str`` - @param remote_port: port of remote host - @type remote_port: ``int`` - @param ssh_transport: a valid Paramiko/SSH transport object - @type ssh_transport: ``obj`` - @param session_instance: the complete :class:`x2go.session.X2GoSession` instance of the X2Go session this port forwarding server belongs to. + :param listener: listen on TCP/IP socket ``(<IP>, <Port>)`` + :type listener: ``tuple`` + :param remote_host: hostname or IP of remote host (in case of X2Go mostly 127.0.0.1) + :type remote_host: ``str`` + :param remote_port: port of remote host + :type remote_port: ``int`` + :param ssh_transport: a valid Paramiko/SSH transport object + :type ssh_transport: ``obj`` + :param session_instance: the complete :class:`x2go.session.X2GoSession` instance of the X2Go session this port forwarding server belongs to. Note: for new :class:`x2go.session.X2GoSession` instances the object has the session name not yet set(!!!) - @type session_instance: ``obj`` - @param session_name: the session name of the X2Go session this port forwarding server belongs to - @type session_name: ``str`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :type session_instance: ``obj`` + :param session_name: the session name of the X2Go session this port forwarding server belongs to + :type session_name: ``str`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.forward.X2GoFwServer` constructor - @type logger: ``obj`` - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type logger: ``obj`` + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ if logger is None: diff --git a/x2go/gevent_subprocess.py b/x2go/gevent_subprocess.py index 821471a..da521b4 100644 --- a/x2go/gevent_subprocess.py +++ b/x2go/gevent_subprocess.py @@ -40,7 +40,7 @@ __package__ = 'x2go' __name__ = 'x2go.gevent_subprocess' -"""Implementation of the standard :mod:`subprocess` module that spawns greenlets""" +"""Implementation of the standard :module:`subprocess` module that spawns greenlets""" from builtins import object import errno import sys diff --git a/x2go/guardian.py b/x2go/guardian.py index 909f526..6b4d80f 100644 --- a/x2go/guardian.py +++ b/x2go/guardian.py @@ -58,26 +58,26 @@ class X2GoSessionGuardian(threading.Thread): refresh_interval=5, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param auto_update_listsessions_cache: let :class:`x2go.guardian.X2GoSessionGuardian` refresh the session list cache for all :class:`x2go.session.X2GoSession` objects - @type auto_update_listsessions_cache: ``bool`` - @param auto_update_listdesktops_cache: let :class:`x2go.guardian.X2GoSessionGuardian` refresh desktop lists in the session list cache for all :class:`x2go.session.X2GoSession` objects - @type auto_update_listdesktops_cache: ``bool`` - @param auto_update_listmounts_cache: let :class:`x2go.guardian.X2GoSessionGuardian` refresh mount lists in the session list cache for all :class:`x2go.session.X2GoSession` objects - @type auto_update_listmounts_cache: ``bool`` - @param auto_update_sessionregistry: if set to ``True`` the session status will be updated in regular intervals - @type auto_update_sessionregistry: ``bool`` - @param auto_register_sessions: register new sessions automatically once they appear in the X2Go session (e.g. + :param auto_update_listsessions_cache: let :class:`x2go.guardian.X2GoSessionGuardian` refresh the session list cache for all :class:`x2go.session.X2GoSession` objects + :type auto_update_listsessions_cache: ``bool`` + :param auto_update_listdesktops_cache: let :class:`x2go.guardian.X2GoSessionGuardian` refresh desktop lists in the session list cache for all :class:`x2go.session.X2GoSession` objects + :type auto_update_listdesktops_cache: ``bool`` + :param auto_update_listmounts_cache: let :class:`x2go.guardian.X2GoSessionGuardian` refresh mount lists in the session list cache for all :class:`x2go.session.X2GoSession` objects + :type auto_update_listmounts_cache: ``bool`` + :param auto_update_sessionregistry: if set to ``True`` the session status will be updated in regular intervals + :type auto_update_sessionregistry: ``bool`` + :param auto_register_sessions: register new sessions automatically once they appear in the X2Go session (e.g. instantiated by another client that is connected to the same X2Go server under same user ID) - @type auto_register_sessions: ``bool`` - @param no_auto_reg_pubapp_sessions: do not auto-register published applications sessions - @type no_auto_reg_pubapp_sessions: ``bool`` - @param refresh_interval: refresh cache and session registry every <refresh_interval> seconds - @type refresh_interval: ``int`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.guardian.X2GoSessionGuardian` constructor - @type logger: ``obj`` - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type auto_register_sessions: ``bool`` + :param no_auto_reg_pubapp_sessions: do not auto-register published applications sessions + :type no_auto_reg_pubapp_sessions: ``bool`` + :param refresh_interval: refresh cache and session registry every <refresh_interval> seconds + :type refresh_interval: ``int`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.guardian.X2GoSessionGuardian` constructor + :type logger: ``obj`` + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ if logger is None: diff --git a/x2go/inifiles.py b/x2go/inifiles.py index def313a..07de61c 100644 --- a/x2go/inifiles.py +++ b/x2go/inifiles.py @@ -57,25 +57,23 @@ class X2GoIniFile(object): default values (as hard coded in Python X2Go), so the resulting objects always contain the same fields. + :param config_files: a list of configuration file names (e.g. a global filename and a user's home + directory filename) + :type config_files: ``list`` + :param defaults: a cascaded Python dicitionary structure with ini file defaults (to override + Python X2Go's hard coded defaults in :module:`x2go.defaults` + :type defaults: ``dict`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :class:`x2go.inifiles.X2GoIniFile` constructor + :type logger: :class:`x2go.logger.X2GoLogger` instance + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + constructed with the given loglevel + :type loglevel: ``int`` """ def __init__(self, config_files, defaults=None, logger=None, loglevel=log.loglevel_DEFAULT): - """\ - @param config_files: a list of configuration file names (e.g. a global filename and a user's home - directory filename) - @type config_files: ``list`` - @param defaults: a cascaded Python dicitionary structure with ini file defaults (to override - Python X2Go's hard coded defaults in :module:`x2go.defaults` - @type defaults: ``dict`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the - :class:`x2go.inifiles.X2GoIniFile` constructor - @type logger: :class:`x2go.logger.X2GoLogger` instance - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be - constructed with the given loglevel - @type loglevel: ``int`` - """ self.user_config_file = None self._write_user_config = True diff --git a/x2go/log.py b/x2go/log.py index d0537c3..053261d 100644 --- a/x2go/log.py +++ b/x2go/log.py @@ -70,12 +70,12 @@ class X2GoLogger(object): def __init__(self, name=sys.argv[0], loglevel=loglevel_DEFAULT, tag=None): """\ - @param name: name of the programme that uses Python X2Go - @type name: ``str`` - @param loglevel: log level for Python X2Go - @type loglevel: ``int`` - @param tag: additional tag for all log entries - @type tag: ``str`` + :param name: name of the programme that uses Python X2Go + :type name: ``str`` + :param loglevel: log level for Python X2Go + :type loglevel: ``int`` + :param tag: additional tag for all log entries + :type tag: ``str`` """ self.name = os.path.basename(name) diff --git a/x2go/mimebox.py b/x2go/mimebox.py index 3afc05c..d6c5f27 100644 --- a/x2go/mimebox.py +++ b/x2go/mimebox.py @@ -64,20 +64,20 @@ class X2GoMIMEboxQueue(threading.Thread): mimebox_dir=None, mimebox_action=None, mimebox_extensions=[], client_instance=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param profile_name: name of the session profile this X2Go MIME box belongs to - @type profile_name: ``str`` - @param mimebox_dir: local directory for incoming MIME box files - @type mimebox_dir: ``str`` - @param mimebox_action: name or instance of either of the possible X2Go MIME box action classes - @type mimebox_action: ``str`` or instance - @param client_instance: the underlying :class:`x2go.client.X2GoClient` instance - @type client_instance: ``obj`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :param profile_name: name of the session profile this X2Go MIME box belongs to + :type profile_name: ``str`` + :param mimebox_dir: local directory for incoming MIME box files + :type mimebox_dir: ``str`` + :param mimebox_action: name or instance of either of the possible X2Go MIME box action classes + :type mimebox_action: ``str`` or instance + :param client_instance: the underlying :class:`x2go.client.X2GoClient` instance + :type client_instance: ``obj`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.mimebox.X2GoMIMEboxQueue` constructor - @type logger: ``obj`` - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type logger: ``obj`` + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ if logger is None: diff --git a/x2go/mimeboxactions.py b/x2go/mimeboxactions.py index f8dc293..d018178 100644 --- a/x2go/mimeboxactions.py +++ b/x2go/mimeboxactions.py @@ -60,14 +60,14 @@ class X2GoMIMEboxAction(object): This is a meta class and has no functionality as such. It is used as parent class by »real« X2Go MIME box actions. - @param client_instance: the underlying :class:`x2go.client.X2GoClient` instance - @type client_instance: ``obj`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :param client_instance: the underlying :class:`x2go.client.X2GoClient` instance + :type client_instance: ``obj`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.mimeboxactions.X2GoMIMEboxAction` constructor - @type logger: ``obj`` - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type logger: ``obj`` + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ if logger is None: @@ -148,14 +148,14 @@ class X2GoMIMEboxActionOPEN(X2GoMIMEboxAction): def __init__(self, client_instance=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param client_instance: the underlying :class:`x2go.client.X2GoClient` instance - @type client_instance: ``obj`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :param client_instance: the underlying :class:`x2go.client.X2GoClient` instance + :type client_instance: ``obj`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.mimeboxactions.X2GoMIMEboxActionOPEN` constructor - @type logger: ``obj`` - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type logger: ``obj`` + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ self.client_instance = client_instance @@ -207,14 +207,14 @@ class X2GoMIMEboxActionOPENWITH(X2GoMIMEboxAction): def __init__(self, client_instance=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param client_instance: the underlying :class:`x2go.client.X2GoClient` instance - @type client_instance: ``obj`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :param client_instance: the underlying :class:`x2go.client.X2GoClient` instance + :type client_instance: ``obj`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.mimeboxactions.X2GoMIMEboxActionOPENWITH` constructor - @type logger: ``obj`` - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type logger: ``obj`` + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ self.client_instance = client_instance @@ -266,18 +266,18 @@ class X2GoMIMEboxActionSAVEAS(X2GoMIMEboxAction): def __init__(self, client_instance=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param client_instance: an :class:`x2go.client.X2GoClient` instance, within your customized :class:`x2go.client.X2GoClient` make sure + :param client_instance: an :class:`x2go.client.X2GoClient` instance, within your customized :class:`x2go.client.X2GoClient` make sure you have a ``HOOK_open_mimebox_saveas_dialog(filename=<str>)`` method defined that will actually handle the incoming mimebox file. - @type client_instance: ``obj`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :type client_instance: ``obj`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.mimeboxactions.X2GoMIMEboxActionSAVEAS` constructor - @type logger: ``obj`` - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type logger: ``obj`` + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` - @raise X2GoMIMEboxActionException: if the client_instance has not been passed to the SAVEAS MIME box action + :raises X2GoMIMEboxActionException: if the client_instance has not been passed to the SAVEAS MIME box action """ if client_instance is None: diff --git a/x2go/printactions.py b/x2go/printactions.py index 4da200f..78fd928 100644 --- a/x2go/printactions.py +++ b/x2go/printactions.py @@ -69,14 +69,14 @@ class X2GoPrintAction(object): This is a meta class and has no functionality as such. It is used as parent class by »real« X2Go print actions. - @param client_instance: the underlying :class:`x2go.client.X2GoClient` instance - @type client_instance: ``obj`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :param client_instance: the underlying :class:`x2go.client.X2GoClient` instance + :type client_instance: ``obj`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.printactions.X2GoPrintAction` constructor - @type logger: ``obj`` - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type logger: ``obj`` + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ if logger is None: @@ -186,16 +186,16 @@ class X2GoPrintActionPDFVIEW(X2GoPrintAction): def __init__(self, client_instance=None, pdfview_cmd=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param client_instance: the underlying :class:`x2go.client.X2GoClient` instance - @type client_instance: ``obj`` - @param pdfview_cmd: command that starts the external PDF viewer application - @type pdfview_cmd: ``str`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :param client_instance: the underlying :class:`x2go.client.X2GoClient` instance + :type client_instance: ``obj`` + :param pdfview_cmd: command that starts the external PDF viewer application + :type pdfview_cmd: ``str`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.printactions.X2GoPrintActionPDFVIEW` constructor - @type logger: ``obj`` - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type logger: ``obj`` + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ if pdfview_cmd is None: @@ -264,16 +264,16 @@ class X2GoPrintActionPDFSAVE(X2GoPrintAction): def __init__(self, client_instance=None, save_to_folder=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param client_instance: the underlying :class:`x2go.client.X2GoClient` instance - @type client_instance: ``obj`` - @param save_to_folder: saving location for incoming print jobs (PDF files) - @type save_to_folder: ``str`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :param client_instance: the underlying :class:`x2go.client.X2GoClient` instance + :type client_instance: ``obj`` + :param save_to_folder: saving location for incoming print jobs (PDF files) + :type save_to_folder: ``str`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.printactions.X2GoPrintActionPDFSAVE` constructor - @type logger: ``obj`` - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type logger: ``obj`` + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ if save_to_folder is None: @@ -320,16 +320,16 @@ class X2GoPrintActionPRINT(X2GoPrintAction): def __init__(self, client_instance=None, printer=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param client_instance: the underlying :class:`x2go.client.X2GoClient` instance - @type client_instance: ``obj`` - @param printer: name of the preferred printer, if ``None`` the system's/user's default printer will be used - @type printer: ``str`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :param client_instance: the underlying :class:`x2go.client.X2GoClient` instance + :type client_instance: ``obj`` + :param printer: name of the preferred printer, if ``None`` the system's/user's default printer will be used + :type printer: ``str`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.printactions.X2GoPrintActionPRINT` constructor - @type logger: ``obj`` - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type logger: ``obj`` + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ self.printer = printer @@ -450,16 +450,16 @@ class X2GoPrintActionPRINTCMD(X2GoPrintAction): def __init__(self, client_instance=None, print_cmd=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param client_instance: the underlying :class:`x2go.client.X2GoClient` instance - @type client_instance: ``obj`` - @param print_cmd: external command to be called on incoming print jobs - @type print_cmd: ``str`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :param client_instance: the underlying :class:`x2go.client.X2GoClient` instance + :type client_instance: ``obj`` + :param print_cmd: external command to be called on incoming print jobs + :type print_cmd: ``str`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.printactions.X2GoPrintActionPRINTCMD` constructor - @type logger: ``obj`` - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type logger: ``obj`` + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ if print_cmd is None: @@ -511,18 +511,18 @@ class X2GoPrintActionDIALOG(X2GoPrintAction): def __init__(self, client_instance=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param client_instance: an :class:`x2go.client.X2GoClient` instance, within your customized :class:`x2go.client.X2GoClient` make sure + :param client_instance: an :class:`x2go.client.X2GoClient` instance, within your customized :class:`x2go.client.X2GoClient` make sure you have a ``HOOK_open_print_dialog(filename=<str>)`` method defined that will actually open the print dialog. - @type client_instance: ``obj`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :type client_instance: ``obj`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.printactions.X2GoPrintActionDIALOG` constructor - @type logger: ``obj`` - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type logger: ``obj`` + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` - @raise X2GoPrintActionException: if the client_instance has not been passed to the DIALOG print action + :raises X2GoPrintActionException: if the client_instance has not been passed to the DIALOG print action """ if client_instance is None: diff --git a/x2go/printqueue.py b/x2go/printqueue.py index f331c4a..d53d0a0 100644 --- a/x2go/printqueue.py +++ b/x2go/printqueue.py @@ -68,25 +68,25 @@ class X2GoPrintQueue(threading.Thread): logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param profile_name: name of the session profile this print queue belongs to - @type profile_name: ``str`` - @param spool_dir: local spool directory for incoming print job files - @type spool_dir: ``str`` - @param print_action: name or instance of either of the possible X2Go print action classes - @type print_action: ``str`` or instance - @param print_action_args: depending of the chosen ``print_action`` this dictionary may contain different + :param profile_name: name of the session profile this print queue belongs to + :type profile_name: ``str`` + :param spool_dir: local spool directory for incoming print job files + :type spool_dir: ``str`` + :param print_action: name or instance of either of the possible X2Go print action classes + :type print_action: ``str`` or instance + :param print_action_args: depending of the chosen ``print_action`` this dictionary may contain different values; the ``print_action_args`` will be passed on to the X2Go print action instance constructor, so refer to either of these: :class:`x2go.printactions.X2GoPrintActionPDFVIEW`, :class:`x2go.printactions.X2GoPrintActionPRINT` et al. - @param client_instance: the underlying :class:`x2go.client.X2GoClient` instance - @type client_instance: ``obj`` - @param printing_backend: the client printing configuration backend class - @type printing_backend: ``obj`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :param client_instance: the underlying :class:`x2go.client.X2GoClient` instance + :type client_instance: ``obj`` + :param printing_backend: the client printing configuration backend class + :type printing_backend: ``obj`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.printing.X2GoPrintQueue` constructor - @type logger: ``obj`` - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type logger: ``obj`` + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ if logger is None: diff --git a/x2go/pulseaudio.py b/x2go/pulseaudio.py index c6aaeac..21b20f1 100644 --- a/x2go/pulseaudio.py +++ b/x2go/pulseaudio.py @@ -59,17 +59,17 @@ class X2GoPulseAudio(threading.Thread): """\ Initialize a Pulse Audio daemon instance. - @param path: full path to pulseaudio.exe - @type path: ``str`` - @param client_instance: the calling :class:`x2go.client.X2GoClient` instance - @type client_instance: :class:`x2go.client.X2GoClient` instance - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.xserver.X2GoClientXConfig` constructor - @type logger: ``obj`` - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :param path: full path to pulseaudio.exe + :type path: ``str`` + :param client_instance: the calling :class:`x2go.client.X2GoClient` instance + :type client_instance: :class:`x2go.client.X2GoClient` instance + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.xserver.X2GoClientXConfig` constructor + :type logger: ``obj`` + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` - @raise OSNotSupportedException: on non-Windows platforms Python X2Go presumes that pulseaudio is already launched + :raises OSNotSupportedException: on non-Windows platforms Python X2Go presumes that pulseaudio is already launched """ if _X2GOCLIENT_OS not in ("Windows"): diff --git a/x2go/registry.py b/x2go/registry.py index e9fcc8b..bbc3daf 100644 --- a/x2go/registry.py +++ b/x2go/registry.py @@ -60,13 +60,13 @@ class X2GoSessionRegistry(object): def __init__(self, client_instance, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param client_instance: the :class:`x2go.client.X2GoClient` instance that instantiated this :class:`x2go.registry.X2GoSessionRegistry` instance. - @type client_instance: :class:`x2go.client.X2GoClient` instance - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.xserver.X2GoClientXConfig` constructor - @type logger: ``obj`` - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :param client_instance: the :class:`x2go.client.X2GoClient` instance that instantiated this :class:`x2go.registry.X2GoSessionRegistry` instance. + :type client_instance: :class:`x2go.client.X2GoClient` instance + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.xserver.X2GoClientXConfig` constructor + :type logger: ``obj`` + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ if logger is None: @@ -91,7 +91,6 @@ class X2GoSessionRegistry(object): :returns: session registry key list - :rtype: ``list`` """ @@ -109,13 +108,13 @@ class X2GoSessionRegistry(object): """\ Returns the :class:`x2go.session.X2GoSession` instance for a given session UUID hash. - @param session_uuid: the X2Go session's UUID registry hash - @type session_uuid: ``str`` + :param session_uuid: the X2Go session's UUID registry hash + :type session_uuid: ``str`` - @return: the corresponding :class:`x2go.session.X2GoSession` instance - @rtype: :class:`x2go.session.X2GoSession` instance + :returns: the corresponding :class:`x2go.session.X2GoSession` instance + :rtype: :class:`x2go.session.X2GoSession` instance - @raise X2GoSessionRegistryException: if the given session UUID could not be found + :raises X2GoSessionRegistryException: if the given session UUID could not be found """ try: diff --git a/x2go/rforward.py b/x2go/rforward.py index 37ce774..cc17818 100644 --- a/x2go/rforward.py +++ b/x2go/rforward.py @@ -98,23 +98,23 @@ class X2GoRevFwTunnel(threading.Thread): notification (:func:`X2GoRevFwTunnel.notify() <x2go.rforward.X2GoRevFwTunnel.notify()>` gets called from within the transport's TCP handler function :func:`x2go_transport_tcp_handler()` of the :class:`x2go.session.X2GoSession` instance. - @param server_port: the TCP/IP port on the X2Go server (starting point of the tunnel), + :param server_port: the TCP/IP port on the X2Go server (starting point of the tunnel), normally some number above 30000 - @type server_port: int - @param remote_host: the target address for reversely tunneled traffic. With X2Go this should + :type server_port: int + :param remote_host: the target address for reversely tunneled traffic. With X2Go this should always be set to the localhost (IPv4) address. - @type remote_host: str - @param remote_port: the TCP/IP port on the X2Go client (end point of the tunnel), + :type remote_host: str + :param remote_port: the TCP/IP port on the X2Go client (end point of the tunnel), normally an application's standard port (22 for SSH, 4713 for pulse audio, etc.) - @type remote_port: int - @param ssh_transport: the :class:`x2go.session.X2GoSession`'s Paramiko/SSH transport instance - @type ssh_transport: ``paramiko.Transport`` instance - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :type remote_port: int + :param ssh_transport: the :class:`x2go.session.X2GoSession`'s Paramiko/SSH transport instance + :type ssh_transport: ``paramiko.Transport`` instance + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.rforward.X2GoRevFwTunnel` constructor - @type logger: :class:`x2go.logger.X2GoLogger` instance - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type logger: :class:`x2go.logger.X2GoLogger` instance + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: int + :type loglevel: int """ if logger is None: @@ -363,11 +363,11 @@ class X2GoRevFwChannelThread(threading.Thread): """\ Initializes a reverse forwarding channel thread. - @param channel: incoming Paramiko/SSH channel from the :class:`x2go.session.X2GoSession`'s transport + :param channel: incoming Paramiko/SSH channel from the :class:`x2go.session.X2GoSession`'s transport accept queue - @type channel: class - @param remote: tuple (addr, port) that specifies the data endpoint of the channel - @type remote: ``tuple(str, int)`` + :type channel: class + :param remote: tuple (addr, port) that specifies the data endpoint of the channel + :type remote: ``tuple(str, int)`` """ self.channel = channel diff --git a/x2go/session.py b/x2go/session.py index b174c38..68465c2 100644 --- a/x2go/session.py +++ b/x2go/session.py @@ -167,84 +167,84 @@ class X2GoSession(object): client_instance=None, **params): """\ - @param server: hostname of X2Go server - @type server: ``str`` - @param control_session: an already initialized ``X2GoControlSession*`` instance - @type control_session: ``X2GoControlSession*`` instance - @param use_sshproxy: for communication with X2Go server use an SSH proxy host - @type use_sshproxy: ``bool`` - @param sshproxy_reuse_authinfo: for proxy authentication re-use the X2Go session's password / key file - @type sshproxy_reuse_authinfo: ``bool`` - @param profile_id: profile ID - @type profile_id: ``str`` - @param profile_name: profile name - @type profile_name: ``str`` - @param session_name: session name (if available) - @type session_name: ``str`` - @param auto_start_or_resume: automatically start a new or resume latest session after connect - @type auto_start_or_resume: ``bool`` - @param auto_connect: call a hook method that handles connecting the session profile automatically after a session for this profile has been registered - @type auto_connect: ``bool`` - @param printing: enable X2Go printing - @type printing: ``bool`` - @param allow_mimebox: enable X2Go MIME box support - @type allow_mimebox: ``bool`` - @param mimebox_extensions: whitelist of allowed X2Go MIME box extensions - @type mimebox_extensions: ``list`` - @param mimebox_action: action for incoming X2Go MIME box files - @type mimebox_action: ``X2GoMimeBoxAction*`` or ``str`` - @param allow_share_local_folders: enable local folder sharing support - @type allow_share_local_folders: ``bool`` - @param share_local_folders: list of local folders to share with the remote X2Go session - @type share_local_folders: ``list`` - @param restore_shared_local_folders: store actual list of shared local folders after session has been suspended or terminated - @type restore_shared_local_folders: ``bool`` - @param control_backend: X2Go control session backend to use - @type control_backend: ``str`` - @param terminal_backend: X2Go terminal session backend to use - @type terminal_backend: ``str`` - @param info_backend: X2Go session info backend to use - @type info_backend: ``str`` - @param list_backend: X2Go session list backend to use - @type list_backend: ``str`` - @param proxy_backend: X2Go proxy backend to use - @type proxy_backend: ``str`` - @param settings_backend: X2Go client settings backend to use - @type settings_backend: ``str`` - @param printing_backend: X2Go client printing backend to use - @type printing_backend: ``str`` - @param client_rootdir: client base dir (default: ~/.x2goclient) - @type client_rootdir: ``str`` - @param sessions_rootdir: sessions base dir (default: ~/.x2go) - @type sessions_rootdir: ``str`` - @param ssh_rootdir: ssh base dir (default: ~/.ssh) - @type ssh_rootdir: ``str`` - @param keep_controlsession_alive: On last :func:`X2GoSession.disconnect() <x2go.session.X2GoSession.disconnect()>` keep the associated ``X2GoControlSession*`` instance alive? + :param server: hostname of X2Go server + :type server: ``str`` + :param control_session: an already initialized ``X2GoControlSession*`` instance + :type control_session: ``X2GoControlSession*`` instance + :param use_sshproxy: for communication with X2Go server use an SSH proxy host + :type use_sshproxy: ``bool`` + :param sshproxy_reuse_authinfo: for proxy authentication re-use the X2Go session's password / key file + :type sshproxy_reuse_authinfo: ``bool`` + :param profile_id: profile ID + :type profile_id: ``str`` + :param profile_name: profile name + :type profile_name: ``str`` + :param session_name: session name (if available) + :type session_name: ``str`` + :param auto_start_or_resume: automatically start a new or resume latest session after connect + :type auto_start_or_resume: ``bool`` + :param auto_connect: call a hook method that handles connecting the session profile automatically after a session for this profile has been registered + :type auto_connect: ``bool`` + :param printing: enable X2Go printing + :type printing: ``bool`` + :param allow_mimebox: enable X2Go MIME box support + :type allow_mimebox: ``bool`` + :param mimebox_extensions: whitelist of allowed X2Go MIME box extensions + :type mimebox_extensions: ``list`` + :param mimebox_action: action for incoming X2Go MIME box files + :type mimebox_action: ``X2GoMimeBoxAction*`` or ``str`` + :param allow_share_local_folders: enable local folder sharing support + :type allow_share_local_folders: ``bool`` + :param share_local_folders: list of local folders to share with the remote X2Go session + :type share_local_folders: ``list`` + :param restore_shared_local_folders: store actual list of shared local folders after session has been suspended or terminated + :type restore_shared_local_folders: ``bool`` + :param control_backend: X2Go control session backend to use + :type control_backend: ``str`` + :param terminal_backend: X2Go terminal session backend to use + :type terminal_backend: ``str`` + :param info_backend: X2Go session info backend to use + :type info_backend: ``str`` + :param list_backend: X2Go session list backend to use + :type list_backend: ``str`` + :param proxy_backend: X2Go proxy backend to use + :type proxy_backend: ``str`` + :param settings_backend: X2Go client settings backend to use + :type settings_backend: ``str`` + :param printing_backend: X2Go client printing backend to use + :type printing_backend: ``str`` + :param client_rootdir: client base dir (default: ~/.x2goclient) + :type client_rootdir: ``str`` + :param sessions_rootdir: sessions base dir (default: ~/.x2go) + :type sessions_rootdir: ``str`` + :param ssh_rootdir: ssh base dir (default: ~/.ssh) + :type ssh_rootdir: ``str`` + :param keep_controlsession_alive: On last :func:`X2GoSession.disconnect() <x2go.session.X2GoSession.disconnect()>` keep the associated ``X2GoControlSession*`` instance alive? @ŧype keep_controlsession_alive: ``bool`` - @param add_to_known_hosts: Auto-accept server host validity? - @type add_to_known_hosts: ``bool`` - @param known_hosts: the underlying Paramiko/SSH systems ``known_hosts`` file - @type known_hosts: ``str`` - @param forward_sshagent: forward SSH agent authentication requests to the SSH agent on the X2Go client-side - @type forward_sshagent: ``bool`` - @param connected: manipulate session state »connected« by giving a pre-set value - @type connected: ``bool`` - @param activated: normal leave this untouched, an activated session is a session that is about to be used - @type activated: ``bool`` - @param virgin: manipulate session state »virgin« by giving a pre-set value - @type virgin: ``bool`` - @param running: manipulate session state »running« by giving a pre-set value - @type running: ``bool`` - @param suspended: manipulate session state »suspended« by giving a pre-set value - @type suspended: ``bool`` - @param terminated: manipulate session state »terminated« by giving a pre-set value - @type terminated: ``bool`` - @param faulty: manipulate session state »faulty« by giving a pre-set value - @type faulty: ``bool`` - @param client_instance: if available, the underlying :class:`x2go.client.X2GoClient` instance - @type client_instance: ``X2GoClient`` instance - @param params: further control session, terminal session and SSH proxy class options - @type params: ``dict`` + :param add_to_known_hosts: Auto-accept server host validity? + :type add_to_known_hosts: ``bool`` + :param known_hosts: the underlying Paramiko/SSH systems ``known_hosts`` file + :type known_hosts: ``str`` + :param forward_sshagent: forward SSH agent authentication requests to the SSH agent on the X2Go client-side + :type forward_sshagent: ``bool`` + :param connected: manipulate session state »connected« by giving a pre-set value + :type connected: ``bool`` + :param activated: normal leave this untouched, an activated session is a session that is about to be used + :type activated: ``bool`` + :param virgin: manipulate session state »virgin« by giving a pre-set value + :type virgin: ``bool`` + :param running: manipulate session state »running« by giving a pre-set value + :type running: ``bool`` + :param suspended: manipulate session state »suspended« by giving a pre-set value + :type suspended: ``bool`` + :param terminated: manipulate session state »terminated« by giving a pre-set value + :type terminated: ``bool`` + :param faulty: manipulate session state »faulty« by giving a pre-set value + :type faulty: ``bool`` + :param client_instance: if available, the underlying :class:`x2go.client.X2GoClient` instance + :type client_instance: ``X2GoClient`` instance + :param params: further control session, terminal session and SSH proxy class options + :type params: ``dict`` """ if logger is None: diff --git a/x2go/sftpserver.py b/x2go/sftpserver.py index 02997d0..9a88efe 100644 --- a/x2go/sftpserver.py +++ b/x2go/sftpserver.py @@ -58,15 +58,15 @@ class _SSHServer(paramiko.ServerInterface): """\ Initialize a new sFTP server interface. - @param auth_key: Server key that the client has to authenticate against - @type auth_key: ``paramiko.RSAKey`` instance - @param session_instance: the calling :class:`x2go.session.X2GoSession` instance - @type session_instance: :class:`x2go.session.X2GoSession` instance - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.xserver.X2GoClientXConfig` constructor - @type logger: ``obj`` - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :param auth_key: Server key that the client has to authenticate against + :type auth_key: ``paramiko.RSAKey`` instance + :param session_instance: the calling :class:`x2go.session.X2GoSession` instance + :type session_instance: :class:`x2go.session.X2GoSession` instance + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.xserver.X2GoClientXConfig` constructor + :type logger: ``obj`` + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ if logger is None: @@ -164,17 +164,17 @@ class _SFTPServerInterface(paramiko.SFTPServerInterface): """\ Make user information accessible as well as set chroot jail directory. - @param server: a ``paramiko.ServerInterface`` instance to use with this SFTP server interface - @type server: ``paramiko.ServerInterface`` instance - @param chroot: chroot environment for this SFTP interface - @type chroot: ``str`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.xserver.X2GoClientXConfig` constructor - @type logger: ``obj`` - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :param server: a ``paramiko.ServerInterface`` instance to use with this SFTP server interface + :type server: ``paramiko.ServerInterface`` instance + :param chroot: chroot environment for this SFTP interface + :type chroot: ``str`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.xserver.X2GoClientXConfig` constructor + :type logger: ``obj`` + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` - @param server_event: a ``threading.Event`` instance that can signal SFTP session termination - @type server_event: ``threading.Event`` instance + :type loglevel: ``int`` + :param server_event: a ``threading.Event`` instance that can signal SFTP session termination + :type server_event: ``threading.Event`` instance """ if logger is None: @@ -498,20 +498,20 @@ class X2GoRevFwTunnelToSFTP(rforward.X2GoRevFwTunnel): Start a Paramiko/SSH reverse forwarding tunnel, that has an sFTP server listening at the endpoint of the tunnel. - @param server_port: the TCP/IP port on the X2Go server (starting point of the tunnel), + :param server_port: the TCP/IP port on the X2Go server (starting point of the tunnel), normally some number above 30000 - @type server_port: ``int`` - @param ssh_transport: the :class:`x2go.session.X2GoSession`'s Paramiko/SSH transport instance - @type ssh_transport: ``paramiko.Transport`` instance - @param auth_key: Paramiko/SSH RSAkey object that has to be authenticated against by + :type server_port: ``int`` + :param ssh_transport: the :class:`x2go.session.X2GoSession`'s Paramiko/SSH transport instance + :type ssh_transport: ``paramiko.Transport`` instance + :param auth_key: Paramiko/SSH RSAkey object that has to be authenticated against by the remote sFTP client - @type auth_key: ``paramiko.RSAKey`` instance - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :type auth_key: ``paramiko.RSAKey`` instance + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.sftpserver.X2GoRevFwTunnelToSFTP` constructor - @type logger: :class:`x2go.logger.X2GoLogger` instance - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type logger: :class:`x2go.logger.X2GoLogger` instance + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ self.ready = False diff --git a/x2go/sshproxy.py b/x2go/sshproxy.py index 1bdd17c..1770385 100644 --- a/x2go/sshproxy.py +++ b/x2go/sshproxy.py @@ -77,79 +77,79 @@ class X2GoSSHProxy(paramiko.SSHClient, threading.Thread): a proxying SSH server (i.e. to subLANs that are separated by firewalls or to private IP subLANs that are NATted behind routers). - @param username: login user name to be used on the SSH proxy host - @type username: ``str`` - @param password: user's password on the SSH proxy host, with private key authentication it will be + :param username: login user name to be used on the SSH proxy host + :type username: ``str`` + :param password: user's password on the SSH proxy host, with private key authentication it will be used to unlock the key (if needed) - @type password: ``str`` - @param passphrase: a passphrase to use for unlocking + :type password: ``str`` + :param passphrase: a passphrase to use for unlocking a private key in case the password is already needed for two-factor authentication - @type passphrase: {str} - @param key_filename: name of a SSH private key file - @type key_filename: ``str`` - @param pkey: a private DSA/RSA key object (as provided by Paramiko/SSH) - @type pkey: ``RSA/DSA key instance`` - @param force_password_auth: enforce password authentication even if a key(file) is present - @type force_password_auth: ``bool`` - @param look_for_keys: look for key files with standard names and try those if any can be found - @type look_for_keys: ``bool`` - @param allow_agent: try authentication via a locally available SSH agent - @type allow_agent: ``bool`` - @param local_host: bind SSH tunnel to the ``local_host`` IP socket address (default: localhost) - @type local_host: ``str`` - @param local_port: IP socket port to bind the SSH tunnel to (default; 22022) - @type local_port: ``int`` - @param remote_host: remote endpoint of the SSH proxying/forwarding tunnel (default: localhost) - @type remote_host: ``str`` - @param remote_port: remote endpoint's IP socket port for listening SSH daemon (default: 22) - @type remote_port: ``int`` - @param known_hosts: full path to a custom ``known_hosts`` file - @type known_hosts: ``str`` - @param add_to_known_hosts: automatically add host keys of unknown SSH hosts to the ``known_hosts`` file - @type add_to_known_hosts: ``bool`` - @param hostname: alias for ``local_host`` - @type hostname: ``str`` - @param port: alias for ``local_port`` - @type port: ``int`` - @param sshproxy_host: alias for ``hostname`` - @type sshproxy_host: ``str`` - @param sshproxy_port: alias for ``post`` - @type sshproxy_port: ``int`` - @param sshproxy_user: alias for ``username`` - @type sshproxy_user: ``str`` - @param sshproxy_password: alias for ``password`` - @type sshproxy_password: ``str`` - @param sshproxy_passphrase: alias for ``passphrase`` - @type sshproxy_passphrase: ``str`` - @param sshproxy_key_filename: alias for ``key_filename`` - @type sshproxy_key_filename: ``str`` - @param sshproxy_pkey: alias for ``pkey`` - @type sshproxy_pkey: ``RSA/DSA key instance`` (Paramiko) - @param sshproxy_force_password_auth: alias for ``force_password_auth`` - @type sshproxy_force_password_auth: ``bool`` - @param sshproxy_look_for_keys: alias for ``look_for_keys`` - @type sshproxy_look_for_keys: ``bool`` - @param sshproxy_allow_agent: alias for ``allow_agent`` - @type sshproxy_allow_agent: ``bool`` - - @param sshproxy_tunnel: a string of the format <local_host>:<local_port>:<remote_host>:<remote_port> + :type passphrase: {str} + :param key_filename: name of a SSH private key file + :type key_filename: ``str`` + :param pkey: a private DSA/RSA key object (as provided by Paramiko/SSH) + :type pkey: ``RSA/DSA key instance`` + :param force_password_auth: enforce password authentication even if a key(file) is present + :type force_password_auth: ``bool`` + :param look_for_keys: look for key files with standard names and try those if any can be found + :type look_for_keys: ``bool`` + :param allow_agent: try authentication via a locally available SSH agent + :type allow_agent: ``bool`` + :param local_host: bind SSH tunnel to the ``local_host`` IP socket address (default: localhost) + :type local_host: ``str`` + :param local_port: IP socket port to bind the SSH tunnel to (default; 22022) + :type local_port: ``int`` + :param remote_host: remote endpoint of the SSH proxying/forwarding tunnel (default: localhost) + :type remote_host: ``str`` + :param remote_port: remote endpoint's IP socket port for listening SSH daemon (default: 22) + :type remote_port: ``int`` + :param known_hosts: full path to a custom ``known_hosts`` file + :type known_hosts: ``str`` + :param add_to_known_hosts: automatically add host keys of unknown SSH hosts to the ``known_hosts`` file + :type add_to_known_hosts: ``bool`` + :param hostname: alias for ``local_host`` + :type hostname: ``str`` + :param port: alias for ``local_port`` + :type port: ``int`` + :param sshproxy_host: alias for ``hostname`` + :type sshproxy_host: ``str`` + :param sshproxy_port: alias for ``post`` + :type sshproxy_port: ``int`` + :param sshproxy_user: alias for ``username`` + :type sshproxy_user: ``str`` + :param sshproxy_password: alias for ``password`` + :type sshproxy_password: ``str`` + :param sshproxy_passphrase: alias for ``passphrase`` + :type sshproxy_passphrase: ``str`` + :param sshproxy_key_filename: alias for ``key_filename`` + :type sshproxy_key_filename: ``str`` + :param sshproxy_pkey: alias for ``pkey`` + :type sshproxy_pkey: ``RSA/DSA key instance`` (Paramiko) + :param sshproxy_force_password_auth: alias for ``force_password_auth`` + :type sshproxy_force_password_auth: ``bool`` + :param sshproxy_look_for_keys: alias for ``look_for_keys`` + :type sshproxy_look_for_keys: ``bool`` + :param sshproxy_allow_agent: alias for ``allow_agent`` + :type sshproxy_allow_agent: ``bool`` + + :param sshproxy_tunnel: a string of the format <local_host>:<local_port>:<remote_host>:<remote_port> which will override---if used---the options: ``local_host``, ``local_port``, ``remote_host`` and ``remote_port`` - @type sshproxy_tunnel: ``str`` + :type sshproxy_tunnel: ``str`` - @param ssh_rootdir: local user's SSH base directory (default: ~/.ssh) - @type ssh_rootdir: ``str`` - @param session_instance: the :class:`x2go.session.X2GoSession` instance that builds up this SSH proxying tunnel - @type session_instance: :class:`x2go.session.X2GoSession` instance - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :param ssh_rootdir: local user's SSH base directory (default: ~/.ssh) + :type ssh_rootdir: ``str`` + :param session_instance: the :class:`x2go.session.X2GoSession` instance that builds up this SSH proxying tunnel + :type session_instance: :class:`x2go.session.X2GoSession` instance + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.sshproxy.X2GoSSHProxy` constructor - @type logger: :class:`x2go.logger.X2GoLogger` instance - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :type logger: :class:`x2go.logger.X2GoLogger` instance + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: int + :type loglevel: int - @raise X2GoSSHProxyAuthenticationException: if the SSH proxy caused a ``paramiko.AuthenticationException`` - @raise X2GoSSHProxyException: if the SSH proxy caused a ``paramiko.SSHException`` + :raises X2GoSSHProxyAuthenticationException: if the SSH proxy caused a ``paramiko.AuthenticationException`` + :raises X2GoSSHProxyException: if the SSH proxy caused a ``paramiko.SSHException`` """ if logger is None: self.logger = log.X2GoLogger(loglevel=loglevel) diff --git a/x2go/telekinesis.py b/x2go/telekinesis.py index 97ef4c1..f1b988c 100644 --- a/x2go/telekinesis.py +++ b/x2go/telekinesis.py @@ -73,21 +73,21 @@ class X2GoTelekinesisClient(threading.Thread): session_instance=None, logger=None, loglevel=log.loglevel_DEFAULT, ): """\ - @param session_info: session information provided as an ``X2GoServerSessionInfo*`` backend + :param session_info: session information provided as an ``X2GoServerSessionInfo*`` backend instance - @type session_info: ``X2GoServerSessionInfo*`` instance - @param ssh_transport: SSH transport object from ``paramiko.SSHClient`` - @type ssh_transport: ``paramiko.Transport`` instance - @param sessions_rootdir: base dir where X2Go session files are stored (by default: ~/.x2go) - @type sessions_rootdir: ``str`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the + :type session_info: ``X2GoServerSessionInfo*`` instance + :param ssh_transport: SSH transport object from ``paramiko.SSHClient`` + :type ssh_transport: ``paramiko.Transport`` instance + :param sessions_rootdir: base dir where X2Go session files are stored (by default: ~/.x2go) + :type sessions_rootdir: ``str`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.telekinesis.X2GoTelekinesisClient` constructor - @param session_instance: the :class:`x2go.session.X2GoSession` instance this ``X2GoProxy*`` instance belongs to - @type session_instance: :class:`x2go.session.X2GoSession` instance - @type logger: :class:`x2go.logger.X2GoLogger` instance - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :param session_instance: the :class:`x2go.session.X2GoSession` instance this ``X2GoProxy*`` instance belongs to + :type session_instance: :class:`x2go.session.X2GoSession` instance + :type logger: :class:`x2go.logger.X2GoLogger` instance + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: int + :type loglevel: int """ self.tekiclient_log_stdout = None diff --git a/x2go/utils.py b/x2go/utils.py index 6f6e015..f873546 100644 --- a/x2go/utils.py +++ b/x2go/utils.py @@ -807,10 +807,10 @@ class ProgressStatus(object): """ def __init__(self, progress_event, progress_func=list(range(0, 100, 10))): """\ - @param progress_event: a threading.Event() object that gets notified on progress - @type progress_event: ``obj`` - @param progress_func: a function that delivers a value between 0 and 100 (progress percentage value) - @type progress_func: ``func`` + :param progress_event: a threading.Event() object that gets notified on progress + :type progress_event: ``obj`` + :param progress_func: a function that delivers a value between 0 and 100 (progress percentage value) + :type progress_func: ``func`` """ self.ev = progress_event diff --git a/x2go/xserver.py b/x2go/xserver.py index fa3a0e2..ff27b4c 100644 --- a/x2go/xserver.py +++ b/x2go/xserver.py @@ -71,15 +71,15 @@ class X2GoClientXConfig(inifiles.X2GoIniFile): set in the user configuration file (``~/.x2goclient/xconfig``) override global options set in ``/etc/x2goclient/xconfig``. - @param config_files: a list of configuration file names - @type config_files: ``list`` - @param defaults: a Python dictionary with configuration file defaults (use on your own risk) - @type defaults: ``dict`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.xserver.X2GoClientXConfig` constructor - @type logger: ``obj`` - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :param config_files: a list of configuration file names + :type config_files: ``list`` + :param defaults: a Python dictionary with configuration file defaults (use on your own risk) + :type defaults: ``dict`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.xserver.X2GoClientXConfig` constructor + :type logger: ``obj`` + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ if _X2GOCLIENT_OS not in ("Windows"): @@ -284,15 +284,15 @@ class X2GoXServer(threading.Thread): """\ Initialize an XServer thread. - @param xserver_name: name of the XServer to start (refer to the xconfig file for available names) - @type xserver_name: ``str`` - @param xserver_config: XServer configuration node (as derived from :func:`X2GoClientXConfig.get_xserver_config() <x2go.xserver.X2GoClientXConfig.get_xserver_config()>` - @type xserver_config: ``dict`` - @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.xserver.X2GoClientXConfig` constructor - @type logger: ``obj`` - @param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be + :param xserver_name: name of the XServer to start (refer to the xconfig file for available names) + :type xserver_name: ``str`` + :param xserver_config: XServer configuration node (as derived from :func:`X2GoClientXConfig.get_xserver_config() <x2go.xserver.X2GoClientXConfig.get_xserver_config()>` + :type xserver_config: ``dict`` + :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the :class:`x2go.xserver.X2GoClientXConfig` constructor + :type logger: ``obj`` + :param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be constructed with the given loglevel - @type loglevel: ``int`` + :type loglevel: ``int`` """ if _X2GOCLIENT_OS not in ("Windows"): -- Alioth's /home/x2go-admin/maintenancescripts/git/hooks/post-receive-email on /srv/git/code.x2go.org/python-x2go.git