[X2Go-Commits] [python-x2go] 01/07: API documentation: Convert class name only links to reST links.
git-admin at x2go.org
git-admin at x2go.org
Tue Mar 6 20:34:47 CET 2018
This is an automated email from the git hooks/post-receive script.
x2go pushed a commit to branch master
in repository python-x2go.
commit e769baf24fd5061ba8c193f88a1223f3669ad073
Author: Mike Gabriel <mike.gabriel at das-netzwerkteam.de>
Date: Tue Mar 6 16:59:36 2018 +0100
API documentation: Convert class name only links to reST links.
---
x2go/__init__.py | 54 +++++++-------
x2go/backends/control/plain.py | 16 ++--
x2go/backends/info/plain.py | 8 +-
x2go/backends/printing/file.py | 11 +--
x2go/backends/printing/winreg.py | 15 ++--
x2go/backends/profiles/base.py | 18 ++---
x2go/backends/profiles/file.py | 10 +--
x2go/backends/profiles/httpbroker.py | 10 +--
x2go/backends/profiles/sshbroker.py | 10 +--
x2go/backends/profiles/winreg.py | 14 ++--
x2go/backends/proxy/base.py | 10 +--
x2go/backends/proxy/nx3.py | 2 +-
x2go/backends/settings/file.py | 14 ++--
x2go/backends/settings/winreg.py | 16 ++--
x2go/backends/terminal/plain.py | 28 +++----
x2go/cache.py | 30 ++++----
x2go/checkhosts.py | 4 +-
x2go/client.py | 138 +++++++++++++++++------------------
x2go/defaults.py | 2 +-
x2go/forward.py | 20 ++---
x2go/guardian.py | 20 ++---
x2go/inifiles.py | 8 +-
x2go/mimebox.py | 36 ++++-----
x2go/mimeboxactions.py | 40 +++++-----
x2go/printactions.py | 62 ++++++++--------
x2go/printqueue.py | 32 ++++----
x2go/pulseaudio.py | 8 +-
x2go/registry.py | 86 +++++++++++-----------
x2go/rforward.py | 54 +++++++-------
x2go/session.py | 90 +++++++++++------------
x2go/sftpserver.py | 36 ++++-----
x2go/sshproxy.py | 14 ++--
x2go/telekinesis.py | 12 +--
x2go/xserver.py | 16 ++--
34 files changed, 478 insertions(+), 466 deletions(-)
diff --git a/x2go/__init__.py b/x2go/__init__.py
index 8a233a2..fec2432 100644
--- a/x2go/__init__.py
+++ b/x2go/__init__.py
@@ -18,8 +18,8 @@
# 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
"""\
-Python X2Go is a python module that implements X2Go client support for
-the free X2Go server project (U{http://wiki.x2go.org}) in Python.
+Python X2Go is a Python module that implements X2Go client support for
+the free X2Go Server project (http://wiki.x2go.org) in Python.
Introduction
============
@@ -48,20 +48,20 @@ API Concept
The five public API classes are:
- - L{X2GoClient} --- a whole X2Go client API
- - L{X2GoSession} --- management of an individual X2Go
- session--either started standalone or from within an L{X2GoClient} instance
- - L{X2GoClientSettings} --- provide access to X2Go (global and
+ - :class:`x2go.client.X2GoClient` --- a whole X2Go client API
+ - :class:`x2go.session.X2GoSession` --- management of an individual X2Go
+ session--either started standalone or from within an :class:`x2go.client.X2GoClient` instance
+ - :class:`x2go.backends.settings.base.X2GoClientSettings` --- provide access to X2Go (global and
user) configuration node »settings«
- - L{X2GoClientPrinting} --- provide access to X2Go (global and
+ - :class:`x2go.backends.printing.base.X2GoClientPrinting` --- provide access to X2Go (global and
user) configuration node »printing«
- - L{X2GoSessionProfiles} --- provide access to X2Go (global and
+ - :class:`x2go.backends.profiles.base.X2GoSessionProfiles` --- provide access to X2Go (global and
user) configuration node »sessions«
Plus two extra classes on MS Windows platforms:
- - L{X2GoClientXConfig} and L{X2GoXServer} --- these classes will be initialized
- during L{X2GoClient} instantiation on MS Windows platforms and start an installed XServer
+ - :class:`x2go.xserver.X2GoClientXConfig` and :class:`x2go.xserver.X2GoXServer` --- these classes will be initialized
+ during :class:`x2go.client.X2GoClient` instantiation on MS Windows platforms and start an installed XServer
Any other of the Python X2Go classes may be subject to internal changes
and the way of addressing these classes in code may vary between different
@@ -82,15 +82,15 @@ API Structure
Python X2Go is capable of handling multiple running/suspended sessions within the
same client instance, so for your application, there should not be any need of
- instantiating more than one L{X2GoClient} object in parallel.
+ instantiating more than one :class:`x2go.client.X2GoClient` object in parallel.
NOTE: Doing so is--herewith--fully disrecommended.
- The L{X2GoClient} class flattens the complex structure of Python X2Go into
- many L{X2GoClient} methods that you can use in your own ``MyX2GoClient`` instance.
+ The :class:`x2go.client.X2GoClient` class flattens the complex structure of Python X2Go into
+ many :class:`x2go.client.X2GoClient` methods that you can use in your own ``MyX2GoClient`` instance.
However, it might be handy to retrieve a whole X2Go session instance
- from the L{X2GoClient} instance. This can be achieved by the
+ from the :class:`x2go.client.X2GoClient` instance. This can be achieved by the
L{X2GoClient.register_session()} method::
import x2go
@@ -101,12 +101,12 @@ API Structure
»profile_name=<PROFILE_NAME_IN_SESSIONS_FILE>«
- or contain a whole set of L{X2GoSession} parameters that can be used to start a
+ or contain a whole set of :class:`x2go.session.X2GoSession` parameters that can be used to start a
session manually (i.e. a session that is based on a pre-configured session profile
in either of the »sessions« config files).
The L{X2GoClient.register_session()} method---in object-retrieval-mode---returns
- an L{X2GoSession} instance. With this instance you can then manage
+ an :class:`x2go.session.X2GoSession` instance. With this instance you can then manage
your X2Go session::
import gevent, getpass
@@ -131,8 +131,8 @@ API Structure
How to access---especially how to modify---the X2Go client configuration
files »settings«, »printing«, »sessions« and »xconfig« (Windows only)
is explained in detail with each class declaration in this API documentation.
- Please refer to the class docs of L{X2GoClientSettings}, L{X2GoClientPrinting},
- L{X2GoSessionProfiles} and L{X2GoXServer}.
+ Please refer to the class docs of :class:`x2go.backends.settings.base.X2GoClientSettings`, :class:`x2go.backends.printing.base.X2GoClientPrinting`,
+ :class:`x2go.backends.profiles.base.X2GoSessionProfiles` and :class:`x2go.xserver.X2GoXServer`.
Configuration and Session Management
@@ -152,17 +152,17 @@ Configuration and Session Management
Conclusively, any change to either of the configuration nodes
will be reflected as a change in your X2Go client behaviour:
- - L{X2GoSessionProfiles}: changes to a session profile in
+ - :class:`x2go.backends.profiles.base.X2GoSessionProfiles`: changes to a session profile in
the »sessions« node will be available for the next registered
- L{X2GoSession} instance
- - L{X2GoClientPrinting}: on each incoming X2Go print job the
+ :class:`x2go.session.X2GoSession` instance
+ - :class:`x2go.backends.printing.base.X2GoClientPrinting`: on each incoming X2Go print job the
»printing« configuration node will be re-read, thus you can
change your X2Go client's print setup during a running session
- - L{X2GoClientSettings}: also the configuration node »settings«
+ - :class:`x2go.backends.settings.base.X2GoClientSettings`: also the configuration node »settings«
is re-read whenever needed in the course of X2Go session management
- - L{X2GoClientXConfig} and L{X2GoXServer} (Windows only): these classes will only be initialized
+ - :class:`x2go.xserver.X2GoClientXConfig` and :class:`x2go.xserver.X2GoXServer` (Windows only): these classes will only be initialized
once (starting the XServer on Windows platforms) on construction
- of an L{X2GoClient} instance
+ of an :class:`x2go.client.X2GoClient` instance
Dependencies
============
@@ -170,9 +170,9 @@ Dependencies
gevent (http://www.gevent.org). The least needed version of Python gevent
is 0.13.0. On MS Windows Python gevent 1.0 is highly recommended.
- Python X2Go (because of gevent) requires at least Python 2.6. Further recent
- information on Python X2Go is available at:
- U{http://wiki.x2go.org/python-x2go}
+ Python X2Go (because of gevent) requires at least Python 2.6 or
+ Python 3.4. Further recent information on Python X2Go is available
+ at: https://wiki.x2go.org/doku.php/wiki:libs:python-x2go
Contact
=======
diff --git a/x2go/backends/control/plain.py b/x2go/backends/control/plain.py
index cb58e9b..de56286 100644
--- a/x2go/backends/control/plain.py
+++ b/x2go/backends/control/plain.py
@@ -18,7 +18,7 @@
# 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
"""\
-L{X2GoControlSession} class - core functions for handling your individual X2Go sessions.
+:class:`x2go.backends.control.plain.X2GoControlSession` class - core functions for handling your individual X2Go sessions.
This backend handles X2Go server implementations that respond via server-side PLAIN text output.
@@ -139,7 +139,7 @@ class X2GoControlSession(paramiko.SSHClient):
control session and one to many terminal sessions that all server-client-communicate via this one common control
session.
- A control session normally gets set up by an L{X2GoSession} instance. Do not use it directly!!!
+ A control session normally gets set up by an :class:`x2go.session.X2GoSession` instance. Do not use it directly!!!
:param profile_name: the profile name of the session profile this control session works for
:type profile_name: ``str``
@@ -169,10 +169,10 @@ class X2GoControlSession(paramiko.SSHClient):
:param published_applications_no_submenus: published applications menus with less items than ``published_applications_no_submenus``
are rendered without submenus
:type published_applications_no_submenus: ``int``
- :param logger: you can pass an L{X2GoLogger} object to the
- L{X2GoControlSession} constructor
- :type logger: L{X2GoLogger} instance
- :param loglevel: if no L{X2GoLogger} object has been supplied a new one will be
+ :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the
+ :class:`x2go.backends.control.plain.X2GoControlSession` 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``
:param low_latency: set this boolean switch for weak connections, it will double all timeout values.
@@ -850,7 +850,7 @@ class X2GoControlSession(paramiko.SSHClient):
:param force_password_auth: non-paramiko option, disable pub/priv key authentication
completely, even if the ``pkey`` or the ``key_filename`` parameter is given (Default value = False)
:type force_password_auth: ``bool``
- :param session_instance: an instance L{X2GoSession} using this L{X2GoControlSession}
+ :param session_instance: an instance :class:`x2go.session.X2GoSession` using this :class:`x2go.backends.control.plain.X2GoControlSession`
instance. (Default value = None)
:type session_instance: ``obj``
:param use_sshproxy: connect through an SSH proxy (Default value = False)
@@ -1528,7 +1528,7 @@ class X2GoControlSession(paramiko.SSHClient):
:param session_name: the X2Go session name (Default value = None)
:type session_name: ``str``
:param session_instance: a Python X2Go session instance (Default value = None)
- :type session_instance: L{X2GoSession}
+ :type session_instance: :class:`x2go.session.X2GoSession`
:param session_list: Default value = None)
:param kwargs: catch any non-defined param in kwargs
:type kwargs: ``dict``
diff --git a/x2go/backends/info/plain.py b/x2go/backends/info/plain.py
index 2671e30..ac9890d 100644
--- a/x2go/backends/info/plain.py
+++ b/x2go/backends/info/plain.py
@@ -40,7 +40,7 @@ import re
class X2GoServerSessionInfo(object):
"""\
- L{X2GoServerSessionInfo} is used to store all information
+ :class:`x2go.backends.info.plain.X2GoServerSessionInfo` is used to store all information
that is retrieved from the connected X2Go server on
``X2GoTerminalSession.start()`` resp. ``X2GoTerminalSession.resume()``.
@@ -284,7 +284,7 @@ class X2GoServerSessionInfo(object):
def clear(self):
"""\
- Clear all properties of a L{X2GoServerSessionInfo} object.
+ Clear all properties of a :class:`x2go.backends.info.plain.X2GoServerSessionInfo` object.
"""
@@ -308,7 +308,7 @@ class X2GoServerSessionInfo(object):
def update(self, session_info):
"""\
- Update all properties of a L{X2GoServerSessionInfo} object.
+ Update all properties of a :class:`x2go.backends.info.plain.X2GoServerSessionInfo` object.
:param session_info: a provided session info data structure
:type session_info: ``X2GoServerSessionInfo*``
@@ -332,7 +332,7 @@ class X2GoServerSessionInfo(object):
class X2GoServerSessionList(object):
"""\
- L{X2GoServerSessionList} is used to store all information
+ :class:`x2go.backends.info.plain.X2GoServerSessionList` is used to store all information
that is retrieved from a connected X2Go server on a
``X2GoControlSession.list_sessions()`` call.
diff --git a/x2go/backends/printing/file.py b/x2go/backends/printing/file.py
index b0c1bf4..9f8da1c 100644
--- a/x2go/backends/printing/file.py
+++ b/x2go/backends/printing/file.py
@@ -18,9 +18,10 @@
# 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
"""\
-L{X2GoClientPrinting} class is one of Python X2Go's public API classes.
+:class:`x2go.backends.printing.file.X2GoClientPrinting` class is one of Python X2Go's public API classes.
+
+Retrieve an instance of this class from your :class:`x2go.client.X2GoClient` instance.
-Retrieve an instance of this class from your L{X2GoClient} instance.
Use this class in your Python X2Go based applications to access the »printing«
configuration of your X2Go client application.
@@ -88,10 +89,10 @@ class X2GoClientPrinting(inifiles.X2GoIniFile):
@param defaults: a cascaded Python dicitionary structure with ini file defaults (to override
Python X2Go's hard coded defaults in L{defaults}
@type defaults: ``dict``
- @param logger: you can pass an L{X2GoLogger} object to the
- L{X2GoPrintAction} constructor
+ @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 L{X2GoLogger} object has been supplied a new one will be
+ @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``
diff --git a/x2go/backends/printing/winreg.py b/x2go/backends/printing/winreg.py
index 34024c6..ea9ade3 100644
--- a/x2go/backends/printing/winreg.py
+++ b/x2go/backends/printing/winreg.py
@@ -18,11 +18,14 @@
# 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
"""\
-L{X2GoClientPrinting} class is one of Python X2Go's public API classes.
+:class:`x2go.backends.printing.winreg.X2GoClientPrinting` class is one of Python X2Go's public API classes.
+
+Retrieve an instance of this class from your :class:`x2go.client.X2GoClient` instance.
-Retrieve an instance of this class from your L{X2GoClient} instance.
Use this class in your Python X2Go based applications to access the »printing«
-configuration of your X2Go client application.
+configuration of your X2Go client application. The configuration is read from the MS Windows Registry.
+
+NOTE: This class is a stub class for now, as noone has been interested in working on this, so far.
"""
from builtins import object
@@ -63,10 +66,10 @@ class X2GoClientPrinting(object):
@param defaults: a cascaded Python dicitionary structure with ini file defaults (to override
Python X2Go's hard coded defaults in L{defaults}
@type defaults: ``dict``
- @param logger: you can pass an L{X2GoLogger} object to the
- L{X2GoPrintAction} constructor
+ @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 L{X2GoLogger} object has been supplied a new one will be
+ @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``
diff --git a/x2go/backends/profiles/base.py b/x2go/backends/profiles/base.py
index 396df70..b41f31c 100644
--- a/x2go/backends/profiles/base.py
+++ b/x2go/backends/profiles/base.py
@@ -18,9 +18,9 @@
# 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
"""\
-L{X2GoSessionProfiles} class - managing x2goclient session profiles.
+:class:`x2go.backends.profiles.base.X2GoSessionProfiles` class - managing X2Go Client session profiles, base API.
-L{X2GoSessionProfiles} is a public API class. Use this class in your Python X2Go based
+:class:`x2go.backends.profiles.base.X2GoSessionProfiles` is a public API class. Use this class in your Python X2Go based
applications.
"""
@@ -56,10 +56,10 @@ class X2GoSessionProfiles(object):
@param session_profile_defaults: a default session profile
@type session_profile_defaults: ``dict``
- @param logger: you can pass an L{X2GoLogger} object to the
+ @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the
L{x2go.backends.profiles.httpbroker.X2GoSessionProfiles} constructor
- @type logger: L{X2GoLogger} instance
- @param loglevel: if no L{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``
@@ -667,13 +667,13 @@ class X2GoSessionProfiles(object):
def to_session_params(self, profile_id_or_name=None, profile_id=None):
"""\
- Convert session profile options to L{X2GoSession} constructor method parameters.
+ Convert session profile options to :class:`x2go.session.X2GoSession` constructor method parameters.
:param profile_id_or_name: either profile ID or profile name is accepted (Default value = None)
:type profile_id_or_name: ``str``
:param profile_id: profile ID (fast than specifying ``profile_id_or_name``) (Default value = None)
:type profile_id: ``str``
- :returns: a dictionary of L{X2GoSession} constructor method parameters
+ :returns: a dictionary of :class:`x2go.session.X2GoSession` constructor method parameters
:rtype: ``dict``
"""
@@ -682,11 +682,11 @@ class X2GoSessionProfiles(object):
def get_session_param(self, profile_id_or_name, param):
"""\
- Get a single L{X2GoSession} parameter from a specific session profile.
+ Get a single :class:`x2go.session.X2GoSession` parameter from a specific session profile.
:param profile_id_or_name: either profile ID or profile name is accepted
:type profile_id_or_name: ``str``
- :param param: the parameter name in the L{X2GoSession} constructor method
+ :param param: the parameter name in the :class:`x2go.session.X2GoSession` constructor method
:type param: ``str``
:returns: the value of the session profile option represented by ``param``
:rtype: depends on the session profile option requested
diff --git a/x2go/backends/profiles/file.py b/x2go/backends/profiles/file.py
index 4e3f5de..73087a0 100644
--- a/x2go/backends/profiles/file.py
+++ b/x2go/backends/profiles/file.py
@@ -18,9 +18,9 @@
# 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
"""\
-L{X2GoSessionProfiles} class - managing x2goclient session profiles.
+:class:`x2go.backends.profiles.file.X2GoSessionProfiles` class - managing X2Go Client session profiles read from a file (``~/.x2goclient/sessions``).
-L{X2GoSessionProfiles} is a public API class. Use this class in your Python X2Go based
+:class:`x2go.backends.profiles.base.X2GoSessionProfiles` is a public API class. Use this class in your Python X2Go based
applications.
"""
@@ -47,10 +47,10 @@ class X2GoSessionProfiles(base.X2GoSessionProfiles, inifiles.X2GoIniFile):
:type config_files: ``list``
:param session_profile_defaults: a default session profile
:type session_profile_defaults: ``dict``
- :param logger: you can pass an L{X2GoLogger} object to the
+ :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the
L{x2go.backends.profiles.file.X2GoSessionProfiles} constructor
- :type logger: L{X2GoLogger} instance
- :param loglevel: if no L{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``
diff --git a/x2go/backends/profiles/httpbroker.py b/x2go/backends/profiles/httpbroker.py
index 3b0fb76..147e102 100644
--- a/x2go/backends/profiles/httpbroker.py
+++ b/x2go/backends/profiles/httpbroker.py
@@ -18,9 +18,9 @@
# 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
"""\
-L{X2GoSessionProfiles} class - managing x2goclient session profiles.
+:class:`x2go.backends.profiles.httpbroker.X2GoSessionProfiles` class - managing X2Go Client session profiles obtain from an HTTP based X2Go Session Broker.
-L{X2GoSessionProfiles} is a public API class. Use this class in your Python X2Go based
+:class:`x2go.backends.profiles.httpbroker.X2GoSessionProfiles` is a public API class. Use this class in your Python X2Go based
applications.
"""
@@ -68,10 +68,10 @@ class X2GoSessionProfiles(base.X2GoSessionProfiles):
@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 L{X2GoLogger} object to the
+ @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the
L{x2go.backends.profiles.httpbroker.X2GoSessionProfiles} constructor
- @type logger: L{X2GoLogger} instance
- @param loglevel: if no L{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``
diff --git a/x2go/backends/profiles/sshbroker.py b/x2go/backends/profiles/sshbroker.py
index 99e68da..5974677 100644
--- a/x2go/backends/profiles/sshbroker.py
+++ b/x2go/backends/profiles/sshbroker.py
@@ -18,9 +18,9 @@
# 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
"""\
-L{X2GoSessionProfiles} class - managing x2goclient session profiles.
+:class:`x2go.backends.profiles.sshbroker.X2GoSessionProfiles` class - managing X2Go Client session profiles obtained from an SSH based X2Go Session Broker.
-L{X2GoSessionProfiles} is a public API class. Use this class in your Python X2Go based
+:class:`x2go.backends.profiles.sshbroker.X2GoSessionProfiles` is a public API class. Use this class in your Python X2Go based
applications.
"""
@@ -51,10 +51,10 @@ class X2GoSessionProfiles(base.X2GoSessionProfiles):
@param session_profile_defaults: a default session profile
@type session_profile_defaults: ``dict``
- @param logger: you can pass an L{X2GoLogger} object to the
+ @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the
L{x2go.backends.profiles.httpbroker.X2GoSessionProfiles} constructor
- @type logger: L{X2GoLogger} instance
- @param loglevel: if no L{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``
diff --git a/x2go/backends/profiles/winreg.py b/x2go/backends/profiles/winreg.py
index 4b34172..df9101c 100644
--- a/x2go/backends/profiles/winreg.py
+++ b/x2go/backends/profiles/winreg.py
@@ -18,11 +18,13 @@
# 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
"""\
-L{X2GoSessionProfiles} class - managing x2goclient session profiles.
+:class:`x2go.backends.profiles.winreg.X2GoSessionProfiles` class - managing X2Go Client session profiles stored in MS Windows Registry.
-L{X2GoSessionProfiles} is a public API class. Use this class in your Python X2Go based
+:class:`x2go.backends.profiles.winreg.X2GoSessionProfiles` is a public API class. Use this class in your Python X2Go based
applications.
+NOTE: This class is a stub class for now, as noone has been interested in working on this, so far.
+
"""
__NAME__ = 'x2gosessionprofiles-pylib'
@@ -50,10 +52,10 @@ class X2GoSessionProfilesWINREG(base.X2GoSessionProfiles):
@param session_profile_defaults: a default session profile
@type session_profile_defaults: ``dict``
- @param logger: you can pass an L{X2GoLogger} object to the
- L{X2GoSessionProfilesWINREG} constructor
- @type logger: L{X2GoLogger} instance
- @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be
+ @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
constructed with the given loglevel
@type loglevel: ``int``
diff --git a/x2go/backends/proxy/base.py b/x2go/backends/proxy/base.py
index e11f272..1545594 100644
--- a/x2go/backends/proxy/base.py
+++ b/x2go/backends/proxy/base.py
@@ -91,12 +91,12 @@ class X2GoProxy(threading.Thread):
@param proxy_options: a set of very L{base.X2GoProxy} backend specific options; any option that is not known
to the L{base.X2GoProxy} backend will simply be ignored
@type proxy_options: ``dict``
- @param logger: you can pass an L{X2GoLogger} object to the
+ @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the
L{base.X2GoProxy} constructor
- @param session_instance: the L{X2GoSession} instance this L{base.X2GoProxy} instance belongs to
- @type session_instance: L{X2GoSession} instance
- @type logger: L{X2GoLogger} instance
- @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be
+ @param session_instance: the :class:`x2go.session.X2GoSession` instance this L{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
diff --git a/x2go/backends/proxy/nx3.py b/x2go/backends/proxy/nx3.py
index 0daedc5..0162880 100644
--- a/x2go/backends/proxy/nx3.py
+++ b/x2go/backends/proxy/nx3.py
@@ -37,7 +37,7 @@ from x2go.defaults import X2GOCLIENT_OS as _X2GOCLIENT_OS
class X2GoProxy(base.X2GoProxy):
"""\
- This L{X2GoProxy} class is a NX version 3 based X2Go proxy connection class.
+ This :class:`x2go.backends.proxy.nx3.X2GoProxy` class is a NX version 3 based X2Go proxy connection class.
It basically fills L{x2go.backends.proxy.base.X2GoProxy} variables with sensible content. Its
methods mostly wrap around the corresponding methods of the parent class.
diff --git a/x2go/backends/settings/file.py b/x2go/backends/settings/file.py
index ed34316..6709b6a 100644
--- a/x2go/backends/settings/file.py
+++ b/x2go/backends/settings/file.py
@@ -20,11 +20,13 @@
"""\
X2GoClientSettings class - managing x2goclient settings file.
-The L{X2GoClientSettings} class one of Python X2Go's a public API classes.
-Use this class (indirectly by retrieving it from an L{X2GoClient} instance)
+The :class:`x2go.backends.settings.file.X2GoClientSettings` class one of Python X2Go's a public API classes.
+Use this class (indirectly by retrieving it from an :class:`x2go.client.X2GoClient` instance)
in your Python X2Go based applications to access the
»settings« configuration file of your X2Go client application.
+This class supports reading the »settings« configuration from a file (``~/.x2goclient/settings``).
+
"""
__NAME__ = 'x2gosettings-pylib'
@@ -40,17 +42,17 @@ import x2go.inifiles as inifiles
class X2GoClientSettings(inifiles.X2GoIniFile):
"""\
- Configuration file based settings for L{X2GoClient} instances.
+ Configuration file based settings for :class:`x2go.client.X2GoClient` instances.
"""
def __init__(self, config_files=_X2GO_SETTINGS_CONFIGFILES, defaults=_X2GO_CLIENTSETTINGS_DEFAULTS, logger=None, loglevel=log.loglevel_DEFAULT):
"""\
- Constructs an L{X2GoClientSettings} instance. This is normally done from within an L{X2GoClient} instance.
- You can retrieve this L{X2GoClientSettings} instance with the L{X2GoClient.get_client_settings()}
+ Constructs an :class:`x2go.backends.settings.base.X2GoClientSettings` instance. This is normally done from within an :class:`x2go.client.X2GoClient` instance.
+ You can retrieve this :class:`x2go.backends.settings.base.X2GoClientSettings` instance with the L{X2GoClient.get_client_settings()}
method.
- On construction the L{X2GoClientSettings} object is filled with values from the configuration files::
+ On construction the :class:`x2go.backends.settings.base.X2GoClientSettings` object is filled with values from the configuration files::
/etc/x2goclient/settings
~/.x2goclient/settings
diff --git a/x2go/backends/settings/winreg.py b/x2go/backends/settings/winreg.py
index 3eb6b77..6ff079b 100644
--- a/x2go/backends/settings/winreg.py
+++ b/x2go/backends/settings/winreg.py
@@ -20,11 +20,15 @@
"""\
X2GoClientSettings class - managing x2goclient settings file (incl. LDAP-Support).
-The L{X2GoClientSettings} class one of Python X2Go's a public API classes.
-Use this class (indirectly by retrieving it from an L{X2GoClient} instance)
+The :class:`x2go.backends.settings.base.X2GoClientSettings` class one of Python X2Go's a public API classes.
+Use this class (indirectly by retrieving it from an :class:`x2go.client.X2GoClient` instance)
in your Python X2Go based applications to access the
»settings« configuration file of your X2Go client application.
+This class supports reading the »settings« configuration from the MS Windows Registry.
+
+NOTE: This class is a stub class for now, as noone has been interested in working on this, so far.
+
"""
__NAME__ = 'x2gosettings-pylib'
@@ -43,7 +47,7 @@ from x2go.x2go_exceptions import X2GoNotImplementedYetException
class X2GoClientSettings(inifiles.X2GoIniFile):
"""\
- Windows registry based settings for L{X2GoClient} instances.
+ Windows registry based settings for :class:`x2go.client.X2GoClient` instances.
"""
@@ -51,11 +55,11 @@ class X2GoClientSettings(inifiles.X2GoIniFile):
def __init__(self, defaults=_X2GO_CLIENTSETTINGS_DEFAULTS, logger=None, loglevel=log.loglevel_DEFAULT):
"""\
- Constructs an L{X2GoClientSettings} instance. This is normally done from within an L{X2GoClient} instance.
- You can retrieve this L{X2GoClientSettings} instance with the L{X2GoClient.get_client_settings()}
+ Constructs an :class:`x2go.backends.settings.base.X2GoClientSettings` instance. This is normally done from within an :class:`x2go.client.X2GoClient` instance.
+ You can retrieve this :class:`x2go.backends.settings.base.X2GoClientSettings` instance with the L{X2GoClient.get_client_settings()}
method.
- On construction the L{X2GoClientSettings} object is filled with values from the Windows registry::
+ On construction the :class:`x2go.backends.settings.base.X2GoClientSettings` object is filled with values from the Windows registry::
<HKLM path, FIXME: give proper locations here>
<HKCU path, FIXME: give proper locations here>
diff --git a/x2go/backends/terminal/plain.py b/x2go/backends/terminal/plain.py
index 0b6802d..986b0e4 100644
--- a/x2go/backends/terminal/plain.py
+++ b/x2go/backends/terminal/plain.py
@@ -73,7 +73,7 @@ def _rewrite_cmd(cmd, params=None):
:param cmd: the current command for execution (as found in the session profile parameter ``cmd``)
:type cmd: ``str``
:param params: an session paramter object (Default value = None)
- :type params: L{X2GoSessionParams}
+ :type params: :class:`x2go.backends.terminal.plain.X2GoSessionParams`
:returns: the rewritten command for server-side execution
:rtype: ``str``
@@ -122,7 +122,7 @@ def _rewrite_blanks(cmd):
class X2GoSessionParams(object):
"""\
- The L{X2GoSessionParams} class is used to store all parameters that
+ The :class:`x2go.backends.terminal.plain.X2GoSessionParams` class is used to store all parameters that
``X2GoTerminalSession`` backend objects are constructed with.
@@ -173,12 +173,12 @@ class X2GoSessionParams(object):
def update(self, **properties_to_be_updated):
"""\
- Update all properties in the object L{X2GoSessionParams} object from
+ Update all properties in the object :class:`x2go.backends.terminal.plain.X2GoSessionParams` object from
the passed on dictionary.
- :param properties_to_be_updated: a dictionary with L{X2GoSessionParams}
+ :param properties_to_be_updated: a dictionary with :class:`x2go.backends.terminal.plain.X2GoSessionParams`
property names as keys und their values to be update in
- L{X2GoSessionParams} object.
+ :class:`x2go.backends.terminal.plain.X2GoSessionParams` object.
:type properties_to_be_updated: ``dict``
"""
@@ -197,7 +197,7 @@ class X2GoTerminalSession(object):
An L{x2go.backends.terminal.plain.X2GoTerminalSession} object uses two main data structure classes:
- - L{X2GoSessionParams}: stores all parameters that have been passed to the
+ - :class:`x2go.backends.terminal.plain.X2GoSessionParams`: stores all parameters that have been passed to the
constructor method.
- ``X2GoServerSessionInfo*`` backend class: when starting or resuming a session, an object of this class
@@ -205,7 +205,7 @@ class X2GoTerminalSession(object):
The terminal session instance works closely together (i.e. depends on) a connected control
session instance (e.g. L{x2go.backends.control.plain.X2GoControlSession}). You never should use either of them as a standalone
- instance. Both, control session and terminal session(s) get managed/controlled via L{X2GoSession} instances.
+ instance. Both, control session and terminal session(s) get managed/controlled via :class:`x2go.session.X2GoSession` instances.
"""
@@ -300,7 +300,7 @@ class X2GoTerminalSession(object):
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
- L{X2GoPrintActionPDFVIEW}, L{X2GoPrintActionPDFSAVE}, L{X2GoPrintActionPRINT} and L{X2GoPrintActionPRINTCMD})
+ :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
@@ -315,12 +315,12 @@ class X2GoTerminalSession(object):
@type client_rootdir: ``str``
@param sessions_rootdir: sessions base dir (default: ~/.x2go)
@type sessions_rootdir: ``str``
- @param session_instance: the L{X2GoSession} instance that is parent to this terminal session
+ @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 L{X2GoLogger} object to the
+ @param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the
L{x2go.backends.terminal.plain.X2GoTerminalSession} constructor
- @type logger: L{X2GoLogger} instance
- @param loglevel: if no L{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``
@@ -707,7 +707,7 @@ class X2GoTerminalSession(object):
"""\
Set a print action for the next incoming print jobs.
- This method is a wrapper for L{X2GoPrintQueue}``.set_print_action()``.
+ This method is a wrapper for :class:`x2go.printing.X2GoPrintQueue`.set_print_action()``.
:param print_action: print action name or object (i.e. an instance of ``X2GoPrintAction*`` classes)
:type print_action: ``str`` or ``X2GoPrintAction*``
@@ -771,7 +771,7 @@ class X2GoTerminalSession(object):
"""\
Set a MIME box action for the next incoming MIME jobs.
- This method is a wrapper for L{X2GoMIMEboxQueue}``set_mimebox_action()``.
+ This method is a wrapper for :class:`x2go.mimebox.X2GoMIMEboxQueue```set_mimebox_action()``.
:param mimebox_action: MIME box action name or object (i.e. an instance of ``X2GoMIMEboxAction*`` classes)
:type mimebox_action: ``str`` or ``X2GoMIMEboxAction*``
diff --git a/x2go/cache.py b/x2go/cache.py
index 0e81d39..18f0249 100644
--- a/x2go/cache.py
+++ b/x2go/cache.py
@@ -39,11 +39,11 @@ from . import x2go_exceptions
class X2GoListSessionsCache(object):
"""\
For non-blocking operations in client applications using Python X2Go, it is
- recommended to enable the L{X2GoListSessionsCache}. This can be done by calling
- the constructor of the L{X2GoClient} class.
+ recommended to enable the :class:`x2go.cache.X2GoListSessionsCache`. This can be done by calling
+ the constructor of the :class:`x2go.client.X2GoClient` class.
The session list and desktop cache gets updated in regular intervals by a threaded
- L{X2GoSessionGuardian} instance. For the session list and desktop list update, the
+ :class:`x2go.guardian.X2GoSessionGuardian` instance. For the session list and desktop list update, the
X2Go server commands ``x2golistsessions`` and ``x2godesktopsessions`` are called and
the command's stdout is cached in the session list cache.
@@ -58,11 +58,11 @@ class X2GoListSessionsCache(object):
def __init__(self, client_instance, logger=None, loglevel=log.loglevel_DEFAULT):
"""\
- @param client_instance: the L{X2GoClient} instance that uses this L{X2GoListSessionsCache}
+ @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 L{X2GoLogger} object to the L{X2GoListSessionsCache} constructor
+ @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 L{X2GoLogger} object has been supplied a new one will be
+ @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``
@@ -106,7 +106,7 @@ class X2GoListSessionsCache(object):
def update_all(self, update_sessions=True, update_desktops=False):
"""\
- Update L{X2GoListSessionsCache} for all connected session profiles.
+ Update :class:`x2go.cache.X2GoListSessionsCache` for all connected session profiles.
:param update_sessions: cache recent session lists from all connected servers (Default value = True)
:type update_sessions: ``bool``
@@ -121,7 +121,7 @@ class X2GoListSessionsCache(object):
def update(self, profile_name, update_sessions=True, update_desktops=False, update_mounts=False):
"""\
- Update L{X2GoListSessionsCache} (i.e. session/desktops) for session profile ``profile_name``.
+ Update :class:`x2go.cache.X2GoListSessionsCache` (i.e. session/desktops) for session profile ``profile_name``.
:param profile_name: name of profile to update
:type profile_name: ``str``
@@ -148,7 +148,7 @@ class X2GoListSessionsCache(object):
def _update_mounts(self, profile_name, control_session):
"""\
- Update mounts list of L{X2GoListSessionsCache} for session profile ``profile_name``.
+ Update mounts list of :class:`x2go.cache.X2GoListSessionsCache` for session profile ``profile_name``.
:param profile_name: name of profile to update
:type profile_name: ``str``
@@ -176,7 +176,7 @@ class X2GoListSessionsCache(object):
def _update_desktops(self, profile_name, control_session):
"""\
- Update session lists of L{X2GoListSessionsCache} for session profile ``profile_name``.
+ Update session lists of :class:`x2go.cache.X2GoListSessionsCache` for session profile ``profile_name``.
:param profile_name: name of profile to update
:type profile_name: ``str``
@@ -200,7 +200,7 @@ class X2GoListSessionsCache(object):
def _update_sessions(self, profile_name, control_session):
"""\
- Update desktop list of L{X2GoListSessionsCache} for session profile ``profile_name``.
+ Update desktop list of :class:`x2go.cache.X2GoListSessionsCache` for session profile ``profile_name``.
:param profile_name: name of profile to update
:type profile_name: ``str``
@@ -222,8 +222,8 @@ class X2GoListSessionsCache(object):
def list_sessions(self, session_uuid):
"""\
- Retrieve a session list from the current cache content of L{X2GoListSessionsCache}
- for a given L{X2GoSession} instance (specified by its unique session UUID).
+ Retrieve a session list from the current cache content of :class:`x2go.cache.X2GoListSessionsCache`
+ for a given :class:`x2go.session.X2GoSession` instance (specified by its unique session UUID).
:param session_uuid: unique identifier of session to query cache for
:type session_uuid: ``str``
@@ -240,7 +240,7 @@ class X2GoListSessionsCache(object):
def list_desktops(self, session_uuid):
"""\
Retrieve a list of available desktop sessions from the current cache content of
- L{X2GoListSessionsCache} for a given L{X2GoSession} instance (specified by its
+ :class:`x2go.cache.X2GoListSessionsCache` for a given :class:`x2go.session.X2GoSession` instance (specified by its
unique session UUID).
:param session_uuid: unique identifier of session to query cache for
@@ -258,7 +258,7 @@ class X2GoListSessionsCache(object):
def list_mounts(self, session_uuid):
"""\
Retrieve a list of mounted client shares from the current cache content of
- L{X2GoListSessionsCache} for a given L{X2GoSession} instance (specified by its
+ :class:`x2go.cache.X2GoListSessionsCache` for a given :class:`x2go.session.X2GoSession` instance (specified by its
unique session UUID).
:param session_uuid: unique identifier of session to query cache for
diff --git a/x2go/checkhosts.py b/x2go/checkhosts.py
index d017511..6fce772 100644
--- a/x2go/checkhosts.py
+++ b/x2go/checkhosts.py
@@ -49,7 +49,7 @@ class X2GoMissingHostKeyPolicy(paramiko.MissingHostKeyPolicy):
@param caller: calling instance
@type caller: ``class``
@param session_instance: an X2Go session instance
- @type session_instance: L{X2GoSession} instance
+ @type session_instance: :class:`x2go.session.X2GoSession` instance
"""
self.caller = caller
@@ -188,7 +188,7 @@ class X2GoInteractiveAddPolicy(X2GoMissingHostKeyPolicy):
"""\
Policy for making host key information available to Python X2Go after a
Paramiko/SSH connect has been attempted. This class needs information
- about the associated L{X2GoSession} instance.
+ about the associated :class:`x2go.session.X2GoSession` instance.
Once called, the L{missing_host_key} method of this class will try to call
L{X2GoSession.HOOK_check_host_dialog()}. This hook method---if not re-defined
diff --git a/x2go/client.py b/x2go/client.py
index 43d0c0b..3d58604 100644
--- a/x2go/client.py
+++ b/x2go/client.py
@@ -19,8 +19,8 @@
# 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
"""\
-L{X2GoClient} is a public API class. Use this class in your Python X2Go based
-applications. Use it as a parent class for your own object oriented L{X2GoClient}'ish
+:class:`x2go.client.X2GoClient` is a public API class. Use this class in your Python X2Go based
+applications. Use it as a parent class for your own object oriented :class:`x2go.client.X2GoClient`'ish
class implementation.
Supported Features
@@ -43,7 +43,7 @@ Supported Features
Non-Profile Sessions
====================
- A new non-profile based X2Go session within an L{X2GoClient} instance is setup in the
+ A new non-profile based X2Go session within an :class:`x2go.client.X2GoClient` instance is setup in the
following way:
- import the Python X2Go module and call the session constructor::
@@ -51,7 +51,7 @@ Non-Profile Sessions
import x2go
x2go_client = x2go.X2GoClient()
- - register a new L{X2GoClient} session; this creates an L{X2GoSession} instance
+ - register a new :class:`x2go.client.X2GoClient` session; this creates an :class:`x2go.session.X2GoSession` instance
and calls its constructor method::
x2go_sess_uuid = x2go_client.register_session(<many-options>)
@@ -77,7 +77,7 @@ Non-Profile Sessions
Profiled Sessions
=================
A new profile based X2Go session (i.e. using pre-defined session profiles) within an
- L{X2GoClient} instance is setup in a much easier way:
+ :class:`x2go.client.X2GoClient` instance is setup in a much easier way:
- import the Python X2Go module and call the session constructor::
@@ -228,19 +228,19 @@ class X2GoClient(object):
@type sessions_rootdir: ``str``
@param ssh_rootdir: ssh base dir (default: ~/.ssh)
@type ssh_rootdir: ``str``
- @param start_xserver: start XServer when registering an L{X2GoClient} instance
+ @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 L{X2GoClient} instance
+ @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 (L{X2GoListSessionsCache})
+ @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 (L{X2GoListSessionsCache})
+ @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 (L{X2GoListSessionsCache})
+ @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 (L{X2GoListSessionsCache})
+ @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``
@@ -252,9 +252,9 @@ class X2GoClient(object):
@type refresh_interval: ``int``
@param pulseaudio_installdir: install path of Pulseaudio binary
@type pulseaudio_installdir: ``str``
- @param logger: you can pass an L{X2GoLogger} object to the
- L{X2GoClient} constructor
- @type logger: L{X2GoLogger} instance
+ @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
constructed with the given loglevel
@type loglevel: ``int``
@@ -469,7 +469,7 @@ class X2GoClient(object):
def HOOK_open_print_dialog(self, profile_name='UNKNOWN', session_name='UNKNOWN'):
"""\
- HOOK method: called if an incoming print job has been detected by L{X2GoPrintQueue} and a print dialog box is
+ HOOK method: called if an incoming print job has been detected by :class:`x2go.printing.X2GoPrintQueue` and a print dialog box is
requested.
:param profile_name: profile name of session that called this hook method (Default value = 'UNKNOWN')
@@ -636,7 +636,7 @@ class X2GoClient(object):
def HOOK_on_session_has_started_by_me(self, session_uuid='UNKNOWN', profile_name='UNKNOWN', session_name='UNKNOWN'):
"""\
- HOOK method: called if a session has been started by this instance of L{X2GoClient}.
+ HOOK method: called if a session has been started by this instance of :class:`x2go.client.X2GoClient`.
:param session_uuid: unique session identifier of the calling session (Default value = 'UNKNOWN')
:type session_uuid: ``str``
@@ -664,7 +664,7 @@ class X2GoClient(object):
def HOOK_on_session_has_resumed_by_me(self, session_uuid='UNKNOWN', profile_name='UNKNOWN', session_name='UNKNOWN'):
"""\
- HOOK method: called if a session has been resumed by this instance of L{X2GoClient}.
+ HOOK method: called if a session has been resumed by this instance of :class:`x2go.client.X2GoClient`.
:param session_uuid: unique session identifier of the calling session (Default value = 'UNKNOWN')
:type session_uuid: ``str``
@@ -706,7 +706,7 @@ class X2GoClient(object):
def HOOK_on_session_has_been_suspended(self, session_uuid='UNKNOWN', profile_name='UNKNOWN', session_name='UNKNOWN'):
"""\
- HOOK method: called if a session has been suspended by this instance of L{X2GoClient}.
+ HOOK method: called if a session has been suspended by this instance of :class:`x2go.client.X2GoClient`.
:param session_uuid: unique session identifier of the calling session (Default value = 'UNKNOWN')
:type session_uuid: ``str``
@@ -782,7 +782,7 @@ class X2GoClient(object):
def get_client_rootdir(self):
"""\
- Retrieve the settings root directory of this L{X2GoClient} instance.
+ Retrieve the settings root directory of this :class:`x2go.client.X2GoClient` instance.
:returns: X2Go client root directory
@@ -796,7 +796,7 @@ class X2GoClient(object):
@property
def has_custom_client_rootdir(self):
"""\
- Does this L{X2GoClient} instance have a customized root dir path?
+ Does this :class:`x2go.client.X2GoClient` instance have a customized root dir path?
Equals ``True`` in case it has.
@@ -806,7 +806,7 @@ class X2GoClient(object):
def get_sessions_rootdir(self):
"""\
- Retrieve the sessions root directory of this L{X2GoClient} instance.
+ Retrieve the sessions root directory of this :class:`x2go.client.X2GoClient` instance.
:returns: X2Go sessions root directory
@@ -819,7 +819,7 @@ class X2GoClient(object):
def get_ssh_rootdir(self):
"""\
- Retrieve the SSH client root dir used with this L{X2GoClient} instance.
+ Retrieve the SSH client root dir used with this :class:`x2go.client.X2GoClient` instance.
:returns: SSH client root directory
@@ -835,7 +835,7 @@ class X2GoClient(object):
Query the local user's username (i.e. the user running the X2Go client).
- :returns: the local username this L{X2GoClient} instance runs as
+ :returns: the local username this :class:`x2go.client.X2GoClient` instance runs as
:rtype: ``str``
@@ -848,12 +848,12 @@ class X2GoClient(object):
Register all session profiles found in the ``sessions`` configuration node
as potential X2Go sessions.
- :param return_objects: if set to ``True`` this methods returns a list of L{X2GoSession}
+ :param return_objects: if set to ``True`` this methods returns a list of :class:`x2go.session.X2GoSession`
instances, otherwise a list of session UUIDs representing the corresponding
registered sessions is returned (Default value = False)
:type return_objects: ``bool``
:returns: a Python dictionary containing one registered session for each available session profile
- configuration, whereas the profile names are used as dictionary keys and L{X2GoSession}
+ configuration, whereas the profile names are used as dictionary keys and :class:`x2go.session.X2GoSession`
instances as their values
:rtype: ``list``
@@ -873,13 +873,13 @@ class X2GoClient(object):
proxy_options={},
return_object=False, **kwargs):
"""\
- Register a new L{X2GoSession}. Within one L{X2GoClient}
- instance you can manage several L{X2GoSession} instances on serveral
+ Register a new :class:`x2go.session.X2GoSession`. Within one :class:`x2go.client.X2GoClient`
+ instance you can manage several :class:`x2go.session.X2GoSession` instances on serveral
remote X2Go servers under different user names.
- These sessions can be instantiated by passing direct L{X2GoSession}
+ These sessions can be instantiated by passing direct :class:`x2go.session.X2GoSession`
parameters to this method or by specifying the name of an existing session profile
- (as found in the L{X2GoClient}'s ``sessions`` configuration node.
+ (as found in the :class:`x2go.client.X2GoClient`'s ``sessions`` configuration node.
A session profile is a pre-defined set of session options stored in a sessions
profile node (e.g. a configuration file). With the FILE backend such session
@@ -890,13 +890,13 @@ class X2GoClient(object):
session profile simultaneously.
This method (L{X2GoClient.register_session()}) accepts a similar set of parameters
- as the L{X2GoSession} constructor itself. For a complete set of session options refer
+ as the :class:`x2go.session.X2GoSession` constructor itself. For a complete set of session options refer
there.
Alternatively, you can also pass a profile name or a profile id
to this method. If you do this, Python X2Go tries to find the specified session
in the ``sessions`` configuration node and then derives the necessary session parameters
- from the session profile configuration. Additional L{X2GoSession} parameters can
+ from the session profile configuration. Additional :class:`x2go.session.X2GoSession` parameters can
also be passed to this method---they will override the option values retrieved from
the session profile.
@@ -937,7 +937,7 @@ class X2GoClient(object):
``return_object`` is set to ``True`` an X2GoSession object will be returned
instead (Default value = False)
:type return_object: ``bool``
- :param kwargs: any option that is also valid for the L{X2GoSession} constructor
+ :param kwargs: any option that is also valid for the :class:`x2go.session.X2GoSession` constructor
:type kwargs: ``dict``
:returns: a unique identifier (UUID) for the newly registered X2Go session (or an
X2GoSession object if ``return_object`` is set to True
@@ -1074,7 +1074,7 @@ class X2GoClient(object):
def get_session_username(self, session_uuid):
"""\
- After an L{X2GoSession} has been set up you can query the
+ After an :class:`x2go.session.X2GoSession` has been set up you can query the
username that the remote sessions runs as.
:param session_uuid: the X2Go session's UUID registry hash
@@ -1120,12 +1120,12 @@ class X2GoClient(object):
def get_session(self, session_uuid):
"""\
- Retrieve the complete L{X2GoSession} object that has been
+ Retrieve the complete :class:`x2go.session.X2GoSession` object that has been
registered under the given session registry hash.
:param session_uuid: the X2Go session's UUID registry hash
:type session_uuid: ``str``
- :returns: the L{X2GoSession} instance
+ :returns: the :class:`x2go.session.X2GoSession` instance
:rtype: obj
"""
@@ -1136,17 +1136,17 @@ class X2GoClient(object):
def get_session_of_session_name(self, session_name, return_object=False, match_profile_name=None):
"""\
- Retrieve session UUID or L{X2GoSession} for session name
+ Retrieve session UUID or :class:`x2go.session.X2GoSession` for session name
<session_name> from the session registry.
:param session_name: the X2Go session's UUID registry hash
:type session_name: ``str``
- :param return_object: session UUID hash or L{X2GoSession} instance wanted? (Default value = False)
+ :param return_object: session UUID hash or :class:`x2go.session.X2GoSession` instance wanted? (Default value = False)
:type return_object: ``bool``
:param match_profile_name: only return sessions that match this profile name (Default value = None)
:type match_profile_name: ``str``
- :returns: the X2Go session's UUID registry hash or L{X2GoSession} instance
- :rtype: ``str`` or L{X2GoSession} instance
+ :returns: the X2Go session's UUID registry hash or :class:`x2go.session.X2GoSession` instance
+ :rtype: ``str`` or :class:`x2go.session.X2GoSession` instance
"""
try:
@@ -1225,7 +1225,7 @@ class X2GoClient(object):
def set_session_username(self, session_uuid, username):
"""\
- Set the session username for the L{X2GoSession} that has been registered under ``session_uuid``.
+ Set the session username for the :class:`x2go.session.X2GoSession` that has been registered under ``session_uuid``.
This can be helpful for modifying user credentials during an authentication phase.
:param session_uuid: the X2Go session's UUID registry hash
@@ -1394,7 +1394,7 @@ class X2GoClient(object):
def disconnect_session(self, session_uuid):
"""\
- Disconnect an L{X2GoSession} by closing down its Paramiko/SSH Transport thread.
+ Disconnect an :class:`x2go.session.X2GoSession` by closing down its Paramiko/SSH Transport thread.
:param session_uuid: the X2Go session's UUID registry hash
:type session_uuid: ``str``
@@ -1413,15 +1413,15 @@ class X2GoClient(object):
Currently, there are five different print actions available, each defined as an individual
print action class:
- - B{PDFVIEW} (L{X2GoPrintActionPDFVIEW}): view an incoming spool job (a PDF file)
+ - B{PDFVIEW} (:class:`x2go.printactions.X2GoPrintActionPDFVIEW`): view an incoming spool job (a PDF file)
locally in a PDF viewer
- - B{PDFSAVE} (L{X2GoPrintActionPDFSAVE}): save an incoming spool job (a PDF file)
+ - B{PDFSAVE} (:class:`x2go.printactions.X2GoPrintActionPDFSAVE`): save an incoming spool job (a PDF file)
under a nice name in a designated folder
- - B{PRINT} (L{X2GoPrintActionPRINT}): really print the incoming spool job on a real printing device
- - B{PRINTCMD} L{X2GoPrintActionPRINTCMD}: on each incoming spool job execute an
+ - B{PRINT} (:class:`x2go.printactions.X2GoPrintActionPRINT`): really print the incoming spool job on a real printing device
+ - B{PRINTCMD} :class:`x2go.printactions.X2GoPrintActionPRINTCMD`: on each incoming spool job execute an
external command that lets the client user handle the further processing of the
print job (PDF) file
- - B{DIALOG} (L{X2GoPrintActionDIALOG}): on each incoming spool job this print action
+ - B{DIALOG} (:class:`x2go.printactions.X2GoPrintActionDIALOG`): on each incoming spool job this print action
will call L{X2GoClient.HOOK_open_print_dialog()}
Each of the print action classes accepts different print action arguments. For detail
@@ -1526,7 +1526,7 @@ class X2GoClient(object):
"""\
Share another already running desktop session. Desktop sharing can be run
in two different modes: view-only and full-access mode. Like new sessions
- a to-be-shared session has be registered first with the L{X2GoClient}
+ a to-be-shared session has be registered first with the :class:`x2go.client.X2GoClient`
instance.
:param session_uuid: the X2Go session's UUID registry hash (Default value = None)
@@ -1606,7 +1606,7 @@ class X2GoClient(object):
Normally, you will use this method to suspend a registered session that you
have formerly started/resumed from within your recent
- L{X2GoClient} instance. For this you simply call this method
+ :class:`x2go.client.X2GoClient` instance. For this you simply call this method
using the session's ``session_uuid``, leave the ``session_name``
empty.
@@ -1658,7 +1658,7 @@ class X2GoClient(object):
Normally you will use this method to terminate a registered session that you
have formerly started/resumed from within your recent
- L{X2GoClient} instance. For this you simply call this method
+ :class:`x2go.client.X2GoClient` instance. For this you simply call this method
using the session's ``session_uuid``, leave the ``session_name``
empty.
@@ -1713,7 +1713,7 @@ class X2GoClient(object):
For non-profile based session this will either be a ``profile_name`` that
was passed to L{register_session} or it will be the application that
- instantiated this L{X2GoClient} instance.
+ instantiated this :class:`x2go.client.X2GoClient` instance.
:param session_uuid: the X2Go session's UUID registry hash
:type session_uuid: ``str``
@@ -2030,7 +2030,7 @@ class X2GoClient(object):
:param profile_name: the profile name that we query the master session of
:type profile_name: ``str``
- :param return_object: return L{X2GoSession} instance (Default value = True)
+ :param return_object: return :class:`x2go.session.X2GoSession` instance (Default value = True)
:type return_object: ``bool``
:param return_session_name: return X2Go session name (Default value = False)
:type return_session_name: ``bool``
@@ -2049,7 +2049,7 @@ class X2GoClient(object):
def client_connected_sessions(self, return_objects=False, return_profile_names=False, return_profile_ids=False, return_session_names=False):
"""\
- Retrieve a list of X2Go sessions that this L{X2GoClient} instance is connected to.
+ Retrieve a list of X2Go sessions that this :class:`x2go.client.X2GoClient` instance is connected to.
:param return_objects: return as list of X2Go session objects (Default value = False)
:type return_objects: ``bool``
@@ -2069,7 +2069,7 @@ class X2GoClient(object):
@property
def client_has_connected_sessions(self):
"""\
- Equals ``True`` if there are any connected sessions with this L{X2GoClient} instance.
+ Equals ``True`` if there are any connected sessions with this :class:`x2go.client.X2GoClient` instance.
"""
@@ -2078,7 +2078,7 @@ class X2GoClient(object):
def client_associated_sessions(self, return_objects=False, return_profile_names=False, return_profile_ids=False, return_session_names=False):
"""\
- Retrieve a list of X2Go sessions associated to this L{X2GoClient} instance.
+ Retrieve a list of X2Go sessions associated to this :class:`x2go.client.X2GoClient` instance.
:param return_objects: return as list of X2Go session objects (Default value = False)
:type return_objects: ``bool``
@@ -2098,7 +2098,7 @@ class X2GoClient(object):
@property
def client_has_associated_sessions(self):
"""\
- Equals ``True`` if there are any associated sessions with this L{X2GoClient} instance.
+ Equals ``True`` if there are any associated sessions with this :class:`x2go.client.X2GoClient` instance.
"""
@@ -2127,7 +2127,7 @@ class X2GoClient(object):
@property
def client_has_running_sessions(self):
"""\
- Equals ``True`` if there are any running sessions with this L{X2GoClient} instance.
+ Equals ``True`` if there are any running sessions with this :class:`x2go.client.X2GoClient` instance.
"""
@@ -2156,7 +2156,7 @@ class X2GoClient(object):
@property
def client_has_suspended_sessions(self):
"""\
- Equals ``True`` if there are any suspended sessions with this L{X2GoClient} instance.
+ Equals ``True`` if there are any suspended sessions with this :class:`x2go.client.X2GoClient` instance.
"""
@@ -2410,7 +2410,7 @@ class X2GoClient(object):
:param session_uuid: the X2Go session's UUID registry hash
:type session_uuid: ``str``
- :returns: ``True`` if X2Go server connection for L{X2GoSession} instance with <session_uuid> is alive.
+ :returns: ``True`` if X2Go server connection for :class:`x2go.session.X2GoSession` instance with <session_uuid> is alive.
:rtype: ``bool``
:raises X2GoControlSessionException: if the session is not connected anymore; in that case the L{HOOK_on_control_session_death} gets called.
@@ -2458,7 +2458,7 @@ class X2GoClient(object):
def server_running_sessions(self, session_uuid):
"""\
Retrieve a list of session names of all server-side running sessions (including those not
- instantiated by our L{X2GoClient} instance).
+ instantiated by our :class:`x2go.client.X2GoClient` instance).
:param session_uuid: the X2Go session's UUID registry hash
:type session_uuid: ``str``
@@ -2503,7 +2503,7 @@ class X2GoClient(object):
def server_suspended_sessions(self, session_uuid):
"""\
Retrieve a list of session names of all server-side suspended sessions (including those not
- instantiated by our L{X2GoClient} instance).
+ instantiated by our :class:`x2go.client.X2GoClient` instance).
:param session_uuid: the X2Go session's UUID registry hash
:type session_uuid: ``str``
@@ -2606,7 +2606,7 @@ class X2GoClient(object):
session registry according to the obtained information (Default value = True)
:type update_sessionregistry: ``bool``
:param register_sessions: query the X2Go server directly and register newly found X2Go session
- as L{X2GoSession} instances associated to this L{X2GoClient} instance (Default value = False)
+ as :class:`x2go.session.X2GoSession` instances associated to this :class:`x2go.client.X2GoClient` instance (Default value = False)
:type register_sessions: ``bool``
:param raw: output the session list in X2Go's raw ``x2golistsessions`` format (Default value = False)
:type raw: ``bool``
@@ -2811,7 +2811,7 @@ class X2GoClient(object):
def get_profiles(self):
"""\
- Returns the L{X2GoClient} instance's ``X2GoSessionProfiles*`` object.
+ Returns the :class:`x2go.client.X2GoClient` instance's ``X2GoSessionProfiles*`` object.
Use this method for object retrieval if you want to modify the »sessions«
configuration node (e.g. in ~/.x2goclient with the FILE backend) from within your
@@ -2831,7 +2831,7 @@ class X2GoClient(object):
@property
def profile_names(self):
"""\
- Equals a list of all profile names that are known to this L{X2GoClient} instance.
+ Equals a list of all profile names that are known to this :class:`x2go.client.X2GoClient` instance.
"""
@@ -2840,7 +2840,7 @@ class X2GoClient(object):
def get_client_settings(self):
"""\
- Returns the L{X2GoClient} instance's ``X2GoClientSettings*`` object.
+ Returns the :class:`x2go.client.X2GoClient` instance's ``X2GoClientSettings*`` object.
Use this method for object retrieval if you want to modify the »settings«
configuration node (e.g. in ~/.x2goclient with the FILE backend) from within your
@@ -2857,7 +2857,7 @@ class X2GoClient(object):
def get_client_printing(self):
"""\
- Returns the L{X2GoClient} instance's ``X2GoClientPrinting*`` object.
+ Returns the :class:`x2go.client.X2GoClient` instance's ``X2GoClientPrinting*`` object.
Use this method for object retrieval if you want to modify the printing
configuration node (e.g. in ~/.x2goclient with the FILE backend) from within your
@@ -2974,7 +2974,7 @@ class X2GoClient(object):
def disconnect_profile(self, profile_name):
"""\
- Disconnect all L{X2GoSession} instances that relate to ``profile_name`` by closing down their
+ Disconnect all :class:`x2go.session.X2GoSession` instances that relate to ``profile_name`` by closing down their
Paramiko/SSH Transport thread.
:param profile_name: the X2Go session profile name
@@ -3026,7 +3026,7 @@ class X2GoClient(object):
def update_sessionregistry_status_by_session_uuid(self, session_uuid):
"""\
- Update the session registry status of a specific L{X2GoSession} instance with
+ Update the session registry status of a specific :class:`x2go.session.X2GoSession` instance with
session identifier <session_uuid>.
:param session_uuid: the X2Go session's UUID registry hash
@@ -3082,7 +3082,7 @@ class X2GoClient(object):
def update_cache_by_session_uuid(self, session_uuid, cache_types=('sessions'), update_sessions=None, update_desktops=None, update_mounts=None):
"""\
- Update the session list cache of a specific L{X2GoSession} instance with
+ Update the session list cache of a specific :class:`x2go.session.X2GoSession` instance with
session identifier <session_uuid>.
:param session_uuid: the X2Go session's UUID registry hash
@@ -3170,7 +3170,7 @@ class X2GoClient(object):
def register_available_server_sessions_by_session_uuid(self, session_uuid, skip_pubapp_sessions=False):
"""\
- Register available sessions that are found on the X2Go server that the L{X2GoSession} instance
+ Register available sessions that are found on the X2Go server that the :class:`x2go.session.X2GoSession` instance
with session identifier <session_uuid> is connected to.
:param session_uuid: the X2Go session's UUID registry hash
diff --git a/x2go/defaults.py b/x2go/defaults.py
index 1c5efd0..9a9a95f 100644
--- a/x2go/defaults.py
+++ b/x2go/defaults.py
@@ -311,7 +311,7 @@ X2GO_SESSIONPROFILE_DEFAULTS = {
'print': False,
'xdmcpserver': 'localhost',
}
-"""L{X2GoSessionProfiles} default values to fill a new session profile with."""
+""":class:`x2go.backends.profiles.base.X2GoSessionProfiles` default values to fill a new session profile with."""
##
## X2Go Proxy defaults
##
diff --git a/x2go/forward.py b/x2go/forward.py
index 964a9db..2ad0f7e 100644
--- a/x2go/forward.py
+++ b/x2go/forward.py
@@ -39,10 +39,10 @@ from .defaults import X2GOCLIENT_OS as _X2GOCLIENT_OS
class X2GoFwServer(StreamServer):
"""\
- L{X2GoFwServer} implements a gevent's StreamServer based Paramiko/SSH port
+ :class:`x2go.forward.X2GoFwServer` implements a gevent's StreamServer based Paramiko/SSH port
forwarding server.
- An L{X2GoFwServer} class object is used to tunnel graphical trafic
+ An :class:`x2go.forward.X2GoFwServer` class object is used to tunnel graphical trafic
through an external proxy command launched by a ``X2GoProxy*`` backend.
@@ -60,15 +60,15 @@ class X2GoFwServer(StreamServer):
@type remote_port: ``int``
@param ssh_transport: a valid Paramiko/SSH transport object
@type ssh_transport: ``obj``
- @param session_instance: the complete L{X2GoSession} instance of the X2Go session this port forwarding server belongs to.
- Note: for new L{X2GoSession} instances the object has the session name not yet set(!!!)
+ @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 L{X2GoLogger} object to the
- L{X2GoFwServer} constructor
+ @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 L{X2GoLogger} object has been supplied a new one will be
+ @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``
@@ -250,7 +250,7 @@ def start_forward_tunnel(local_host='127.0.0.1', local_port=22022,
:type remote_port: ``int``
:param ssh_transport: the Paramiko/SSH transport (i.e. the X2Go session's Paramiko/SSH transport object) (Default value = None)
:type ssh_transport: ``obj``
- :param session_instance: the L{X2GoSession} instance that initiates this tunnel (Default value = None)
+ :param session_instance: the :class:`x2go.session.X2GoSession` instance that initiates this tunnel (Default value = None)
:type session_instance: ``obj``
:param session_name: the session name of the X2Go session this port forwarding server belongs to (Default value = None)
:type session_name: ``str``
@@ -258,7 +258,7 @@ def start_forward_tunnel(local_host='127.0.0.1', local_port=22022,
:type subsystem: ``str``
:param logger: an X2GoLogger object (Default value = None)
:type logger: ``obj``
- :returns: returns an L{X2GoFwServer} instance
+ :returns: returns an :class:`x2go.forward.X2GoFwServer` instance
:rtype: ``obj``
"""
@@ -281,7 +281,7 @@ def stop_forward_tunnel(fw_server):
"""\
Tear down a given Paramiko/SSH port forwarding tunnel.
- :param fw_server: an L{X2GoFwServer} instance as returned by the L{start_forward_tunnel()} function
+ :param fw_server: an :class:`x2go.forward.X2GoFwServer` instance as returned by the L{start_forward_tunnel()} function
:type fw_server: ``obj``
"""
diff --git a/x2go/guardian.py b/x2go/guardian.py
index 884f299..909f526 100644
--- a/x2go/guardian.py
+++ b/x2go/guardian.py
@@ -39,12 +39,12 @@ from . import log
class X2GoSessionGuardian(threading.Thread):
"""\
- L{X2GoSessionGuardian} thread controls X2Go session threads and their sub-threads (like
+ :class:`x2go.guardian.X2GoSessionGuardian` thread controls X2Go session threads and their sub-threads (like
reverse forwarding tunnels, Paramiko transport threads, etc.). Its main function is
to tidy up once a session gets interrupted (SIGTERM, SIGINT).
- There is one L{X2GoSessionGuardian} for each L{X2GoClient} instance (thus: for normal
- setups there should be _one_ L{X2GoClient} and _one_ L{X2GoSessionGuardian} in use).
+ There is one :class:`x2go.guardian.X2GoSessionGuardian` for each :class:`x2go.client.X2GoClient` instance (thus: for normal
+ setups there should be _one_ :class:`x2go.client.X2GoClient` and _one_ :class:`x2go.guardian.X2GoSessionGuardian` in use).
"""
@@ -58,11 +58,11 @@ class X2GoSessionGuardian(threading.Thread):
refresh_interval=5,
logger=None, loglevel=log.loglevel_DEFAULT):
"""\
- @param auto_update_listsessions_cache: let L{X2GoSessionGuardian} refresh the session list cache for all L{X2GoSession} objects
+ @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 L{X2GoSessionGuardian} refresh desktop lists in the session list cache for all L{X2GoSession} objects
+ @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 L{X2GoSessionGuardian} refresh mount lists in the session list cache for all L{X2GoSession} objects
+ @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``
@@ -73,9 +73,9 @@ class X2GoSessionGuardian(threading.Thread):
@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 L{X2GoLogger} object to the L{X2GoSessionGuardian} constructor
+ @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 L{X2GoLogger} object has been supplied a new one will be
+ @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``
@@ -101,7 +101,7 @@ class X2GoSessionGuardian(threading.Thread):
def guardian(self):
"""\
- The handler of this L{X2GoSessionGuardian} thread.
+ The handler of this :class:`x2go.guardian.X2GoSessionGuardian` thread.
"""
@@ -137,7 +137,7 @@ class X2GoSessionGuardian(threading.Thread):
def stop_thread(self):
"""\
- Stop this L{X2GoSessionGuardian} thread.
+ Stop this :class:`x2go.guardian.X2GoSessionGuardian` thread.
"""
diff --git a/x2go/inifiles.py b/x2go/inifiles.py
index 45833f9..d74700d 100644
--- a/x2go/inifiles.py
+++ b/x2go/inifiles.py
@@ -68,10 +68,10 @@ class X2GoIniFile(object):
@param defaults: a cascaded Python dicitionary structure with ini file defaults (to override
Python X2Go's hard coded defaults in L{defaults}
@type defaults: ``dict``
- @param logger: you can pass an L{X2GoLogger} object to the
- L{X2GoIniFile} constructor
- @type logger: L{X2GoLogger} instance
- @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be
+ @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``
diff --git a/x2go/mimebox.py b/x2go/mimebox.py
index ce2f9c3..18f6b6f 100644
--- a/x2go/mimebox.py
+++ b/x2go/mimebox.py
@@ -18,11 +18,11 @@
# 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
"""\
-L{X2GoMIMEboxQueue} sets up a thread that listens for incoming files that
+:class:`x2go.mimebox.X2GoMIMEboxQueue` sets up a thread that listens for incoming files that
shall be opened locally on the client.
For each file that gets dropped in the MIME box an individual
-thread is started (L{X2GoMIMEboxJob}) that handles the processing
+thread is started (:class:`x2go.mimebox.X2GoMIMEboxJob`) that handles the processing
of the incoming file.
"""
@@ -47,10 +47,10 @@ from . import mimeboxactions
class X2GoMIMEboxQueue(threading.Thread):
"""\
- If the X2Go MIME box is supported in a particaluar L{X2GoSession} instance
+ If the X2Go MIME box is supported in a particaluar :class:`x2go.session.X2GoSession` instance
this class provides a sub-thread for handling incoming files in the MIME box
directory. The actual handling of a dropped file is handled by the classes
- L{X2GoMIMEboxActionOPEN}, L{X2GoMIMEboxActionOPENWITH} and L{X2GoMIMEboxActionSAVEAS}.
+ :class:`x2go.mimeboxactions.X2GoMIMEboxActionOPEN`, :class:`x2go.mimeboxactions.X2GoMIMEboxActionOPENWITH` and :class:`x2go.mimeboxactions.X2GoMIMEboxActionSAVEAS`.
"""
@@ -64,18 +64,18 @@ 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 print queue belongs to
+ @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 print action classes
+ @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 L{X2GoClient} instance
+ @param client_instance: the underlying :class:`x2go.client.X2GoClient` instance
@type client_instance: ``obj``
- @param logger: you can pass an L{X2GoLogger} object to the
- L{X2GoPrintQueue} constructor
+ @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 L{X2GoLogger} object has been supplied a new one will be
+ @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``
@@ -141,7 +141,7 @@ class X2GoMIMEboxQueue(threading.Thread):
def stop_thread(self):
"""\
- Stops this L{X2GoMIMEboxQueue} thread completely.
+ Stops this :class:`x2go.mimebox.X2GoMIMEboxQueue` thread completely.
"""
@@ -164,7 +164,7 @@ class X2GoMIMEboxQueue(threading.Thread):
def set_mimebox_action(self, mimebox_action, **kwargs):
"""\
- Modify the MIME box action of this L{X2GoMIMEboxQueue} thread during runtime. The
+ Modify the MIME box action of this :class:`x2go.mimebox.X2GoMIMEboxQueue` thread during runtime. The
change of the MIME box action will be valid for the next incoming file in the MIME box
directory.
@@ -182,7 +182,7 @@ class X2GoMIMEboxQueue(threading.Thread):
def run(self):
"""\
- This method gets called once the L{X2GoMIMEboxQueue} thread is started by the ``X2GoMIMEboxQueue.start()`` method.
+ This method gets called once the :class:`x2go.mimebox.X2GoMIMEboxQueue` thread is started by the ``X2GoMIMEboxQueue.start()`` method.
"""
@@ -220,7 +220,7 @@ def x2go_mimeboxjob_handler(mimebox_file=None,
parent_thread=None, logger=None, ):
"""\
This function is called as a handler function for each incoming X2Go MIME box file
- represented by the class L{X2GoMIMEboxJob}.
+ represented by the class :class:`x2go.mimebox.X2GoMIMEboxJob`.
:param mimebox_file: MIME box file name as placed in to the X2Go MIME box spool directory (Default value = None)
:type mimebox_file: ``str``
@@ -228,16 +228,16 @@ def x2go_mimeboxjob_handler(mimebox_file=None,
:type mimebox_action: ``X2GoMIMEboxActionXXX`` nstance
:param mimebox_extensions: filter out files whose file extension is not in this list (Default value = [], means: no filtering)
:type mimebox_extensions: ``list``
- :param parent_thread: the L{X2GoMIMEboxQueue} thread that actually created this handler's L{X2GoMIMEboxJob} instance (Default value = None)
+ :param parent_thread: the :class:`x2go.mimebox.X2GoMIMEboxQueue` thread that actually created this handler's :class:`x2go.mimebox.X2GoMIMEboxJob` instance (Default value = None)
:type parent_thread: ``obj``
- :param logger: the L{X2GoMIMEboxQueue}'s logging instance (Default value = None)
+ :param logger: the :class:`x2go.mimebox.X2GoMIMEboxQueue`'s logging instance (Default value = None)
:type logger: ``obj``
"""
mimebox_action.profile_name = parent_thread.profile_name
mimebox_action.session_name = parent_thread.session_name
- logger('action for printing is: %s' % mimebox_action, loglevel=log.loglevel_DEBUG)
+ logger('action for MIME box is: %s' % mimebox_action, loglevel=log.loglevel_DEBUG)
_dotfile = mimebox_file.startswith('.')
_blacklisted = mimebox_file.upper().split('.')[-1] in defaults.X2GO_MIMEBOX_EXTENSIONS_BLACKLIST
@@ -256,7 +256,7 @@ def x2go_mimeboxjob_handler(mimebox_file=None,
logger('removing MIME box file %s' % mimebox_file, loglevel=log.loglevel_DEBUG)
utils.patiently_remove_file(parent_thread.mimebox_dir, mimebox_file)
- logger('removed print job file %s' % mimebox_file, loglevel=log.loglevel_DEBUG)
+ logger('removed MIME box job file %s' % mimebox_file, loglevel=log.loglevel_DEBUG)
del parent_thread.active_jobs['%s' % mimebox_file]
parent_thread.mimebox_history.append(mimebox_file)
diff --git a/x2go/mimeboxactions.py b/x2go/mimeboxactions.py
index 722f172..f8dc293 100644
--- a/x2go/mimeboxactions.py
+++ b/x2go/mimeboxactions.py
@@ -19,7 +19,7 @@
"""\
For MIME box jobs there are currently three handling actions available:
-L{X2GoMIMEboxActionOPEN}, L{X2GoMIMEboxActionOPENWITH} and L{X2GoMIMEboxActionSAVEAS}.
+:class:`x2go.mimeboxactions.X2GoMIMEboxActionOPEN`, :class:`x2go.mimeboxactions.X2GoMIMEboxActionOPENWITH` and :class:`x2go.mimeboxactions.X2GoMIMEboxActionSAVEAS`.
"""
from builtins import str
@@ -60,12 +60,12 @@ 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 L{X2GoClient} instance
+ @param client_instance: the underlying :class:`x2go.client.X2GoClient` instance
@type client_instance: ``obj``
- @param logger: you can pass an L{X2GoLogger} object to the
- L{X2GoMIMEboxAction} constructor
+ @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 L{X2GoLogger} object has been supplied a new one will be
+ @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``
@@ -110,7 +110,7 @@ class X2GoMIMEboxAction(object):
def _do_process(self, mimebox_file, mimebox_dir, ):
"""\
- Perform the defined MIME box action (doing nothing in L{X2GoMIMEboxAction} parent class).
+ Perform the defined MIME box action (doing nothing in :class:`x2go.mimeboxactions.X2GoMIMEboxAction` parent class).
:param mimebox_file: file name as placed in to the X2Go MIME box directory
:type mimebox_file: ``str``
@@ -148,12 +148,12 @@ class X2GoMIMEboxActionOPEN(X2GoMIMEboxAction):
def __init__(self, client_instance=None, logger=None, loglevel=log.loglevel_DEFAULT):
"""\
- @param client_instance: the underlying L{X2GoClient} instance
+ @param client_instance: the underlying :class:`x2go.client.X2GoClient` instance
@type client_instance: ``obj``
- @param logger: you can pass an L{X2GoLogger} object to the
- L{X2GoMIMEboxActionOPEN} constructor
+ @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 L{X2GoLogger} object has been supplied a new one will be
+ @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``
@@ -207,12 +207,12 @@ class X2GoMIMEboxActionOPENWITH(X2GoMIMEboxAction):
def __init__(self, client_instance=None, logger=None, loglevel=log.loglevel_DEFAULT):
"""\
- @param client_instance: the underlying L{X2GoClient} instance
+ @param client_instance: the underlying :class:`x2go.client.X2GoClient` instance
@type client_instance: ``obj``
- @param logger: you can pass an L{X2GoLogger} object to the
- L{X2GoMIMEboxActionOPENWITH} constructor
+ @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 L{X2GoLogger} object has been supplied a new one will be
+ @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``
@@ -255,7 +255,7 @@ class X2GoMIMEboxActionOPENWITH(X2GoMIMEboxAction):
class X2GoMIMEboxActionSAVEAS(X2GoMIMEboxAction):
"""\
MIME box action that allows saving incoming MIME box files to a local folder. What this
- MIME box actually does is calling a hook method in the L{X2GoClient} instance that
+ MIME box actually does is calling a hook method in the :class:`x2go.client.X2GoClient` instance that
can be hi-jacked by one of your application's methods which then can handle the ,,Save as...''
request.
@@ -266,14 +266,14 @@ class X2GoMIMEboxActionSAVEAS(X2GoMIMEboxAction):
def __init__(self, client_instance=None, logger=None, loglevel=log.loglevel_DEFAULT):
"""\
- @param client_instance: an L{X2GoClient} instance, within your customized L{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 L{X2GoLogger} object to the
- L{X2GoMIMEboxActionSAVEAS} constructor
+ @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 L{X2GoLogger} object has been supplied a new one will be
+ @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``
@@ -286,7 +286,7 @@ class X2GoMIMEboxActionSAVEAS(X2GoMIMEboxAction):
def _do_process(self, mimebox_file, mimebox_dir):
"""\
- Call an L{X2GoClient} hook method (``HOOK_open_mimebox_saveas_dialog``) that
+ Call an :class:`x2go.client.X2GoClient` hook method (``HOOK_open_mimebox_saveas_dialog``) that
can handle the MIME box's SAVEAS action.
:param mimebox_file: file name as placed in to the MIME box directory
diff --git a/x2go/printactions.py b/x2go/printactions.py
index 722eee9..4da200f 100644
--- a/x2go/printactions.py
+++ b/x2go/printactions.py
@@ -21,8 +21,8 @@
Print jobs can either be sent to any of the local print queues (CUPS, Win32API),
be opened in an external PDF viewer, be saved to a local folder or be handed
over to a custom (print) command. This is defined by four print action classes
-(L{X2GoPrintActionDIALOG}, L{X2GoPrintActionPDFVIEW}, L{X2GoPrintActionPDFSAVE}, L{X2GoPrintActionPRINT} and
-L{X2GoPrintActionPRINTCMD}).
+(:class:`x2go.printactions.X2GoPrintActionDIALOG`, :class:`x2go.printactions.X2GoPrintActionPDFVIEW`, :class:`x2go.printactions.X2GoPrintActionPDFSAVE`, :class:`x2go.printactions.X2GoPrintActionPRINT` and
+:class:`x2go.printactions.X2GoPrintActionPRINTCMD`).
"""
from builtins import str
@@ -69,12 +69,12 @@ 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 L{X2GoClient} instance
+ @param client_instance: the underlying :class:`x2go.client.X2GoClient` instance
@type client_instance: ``obj``
- @param logger: you can pass an L{X2GoLogger} object to the
- L{X2GoPrintAction} constructor
+ @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 L{X2GoLogger} object has been supplied a new one will be
+ @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``
@@ -119,7 +119,7 @@ class X2GoPrintAction(object):
def _do_print(self, pdf_file, job_title, spool_dir, ):
"""\
- Perform the defined print action (doing nothing in L{X2GoPrintAction} parent class).
+ Perform the defined print action (doing nothing in :class:`x2go.printactions.X2GoPrintAction` parent class).
:param pdf_file: PDF file name as placed in to the X2Go spool directory
:type pdf_file: ``str``
@@ -186,14 +186,14 @@ class X2GoPrintActionPDFVIEW(X2GoPrintAction):
def __init__(self, client_instance=None, pdfview_cmd=None, logger=None, loglevel=log.loglevel_DEFAULT):
"""\
- @param client_instance: the underlying L{X2GoClient} instance
+ @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 L{X2GoLogger} object to the
- L{X2GoPrintActionPDFVIEW} constructor
+ @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 L{X2GoLogger} object has been supplied a new one will be
+ @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``
@@ -264,14 +264,14 @@ class X2GoPrintActionPDFSAVE(X2GoPrintAction):
def __init__(self, client_instance=None, save_to_folder=None, logger=None, loglevel=log.loglevel_DEFAULT):
"""\
- @param client_instance: the underlying L{X2GoClient} instance
+ @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 L{X2GoLogger} object to the
- L{X2GoPrintActionPDFSAVE} constructor
+ @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 L{X2GoLogger} object has been supplied a new one will be
+ @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``
@@ -320,14 +320,14 @@ class X2GoPrintActionPRINT(X2GoPrintAction):
def __init__(self, client_instance=None, printer=None, logger=None, loglevel=log.loglevel_DEFAULT):
"""\
- @param client_instance: the underlying L{X2GoClient} instance
+ @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 L{X2GoLogger} object to the
- L{X2GoPrintActionPRINT} constructor
+ @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 L{X2GoLogger} object has been supplied a new one will be
+ @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``
@@ -441,7 +441,7 @@ class X2GoPrintActionPRINTCMD(X2GoPrintAction):
Print action that calls an external command for further processing of incoming print jobs.
The print job's PDF filename will be prepended as last argument to the print command
- used in L{X2GoPrintActionPRINTCMD} instances.
+ used in :class:`x2go.printactions.X2GoPrintActionPRINTCMD` instances.
"""
@@ -450,14 +450,14 @@ class X2GoPrintActionPRINTCMD(X2GoPrintAction):
def __init__(self, client_instance=None, print_cmd=None, logger=None, loglevel=log.loglevel_DEFAULT):
"""\
- @param client_instance: the underlying L{X2GoClient} instance
+ @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 L{X2GoLogger} object to the
- L{X2GoPrintActionPRINTCMD} constructor
+ @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 L{X2GoLogger} object has been supplied a new one will be
+ @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``
@@ -470,7 +470,7 @@ class X2GoPrintActionPRINTCMD(X2GoPrintAction):
def _do_print(self, pdf_file, job_title, spool_dir):
"""\
Execute an external command that has been defined on construction
- of this L{X2GoPrintActionPRINTCMD} instance.
+ of this :class:`x2go.printactions.X2GoPrintActionPRINTCMD` instance.
:param pdf_file: PDF file name as placed in to the X2Go spool directory
:type pdf_file: ``str``
@@ -502,7 +502,7 @@ class X2GoPrintActionDIALOG(X2GoPrintAction):
"""\
Print action that mediates opening a print dialog window. This class is rather empty,
the actual print dialog box must be implemented in our GUI application (with the application's
- L{X2GoClient} instance.
+ :class:`x2go.client.X2GoClient` instance.
"""
@@ -511,14 +511,14 @@ class X2GoPrintActionDIALOG(X2GoPrintAction):
def __init__(self, client_instance=None, logger=None, loglevel=log.loglevel_DEFAULT):
"""\
- @param client_instance: an L{X2GoClient} instance, within your customized L{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 L{X2GoLogger} object to the
- L{X2GoPrintActionDIALOG} constructor
+ @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 L{X2GoLogger} object has been supplied a new one will be
+ @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``
@@ -532,7 +532,7 @@ class X2GoPrintActionDIALOG(X2GoPrintAction):
def _do_print(self, pdf_file, job_title, spool_dir):
"""\
Execute an external command that has been defined on construction
- of this L{X2GoPrintActionPRINTCMD} instance.
+ of this :class:`x2go.printactions.X2GoPrintActionPRINTCMD` instance.
:param pdf_file: PDF file name as placed in to the X2Go spool directory
:type pdf_file: ``str``
diff --git a/x2go/printqueue.py b/x2go/printqueue.py
index dbbbdae..a5771a3 100644
--- a/x2go/printqueue.py
+++ b/x2go/printqueue.py
@@ -18,10 +18,10 @@
# 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
"""\
-L{X2GoPrintQueue} sets up a thread that listens for incoming print jobs.
+:class:`x2go.printing.X2GoPrintQueue` sets up a thread that listens for incoming print jobs.
For each incoming print job in an X2Go session's spool directory an
-individual thread is started (L{X2GoPrintJob}) that handles the processing
+individual thread is started (:class:`x2go.printqueue.X2GoPrintJob`) that handles the processing
of the incoming print job.
"""
@@ -46,7 +46,7 @@ from .defaults import BACKENDS as _BACKENDS
class X2GoPrintQueue(threading.Thread):
"""\
- If X2Go printing is supported in a particular L{X2GoSession} instance
+ If X2Go printing is supported in a particular :class:`x2go.session.X2GoSession` instance
this class provides a sub-thread for handling incoming X2Go print jobs.
@@ -76,15 +76,15 @@ class X2GoPrintQueue(threading.Thread):
@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: L{X2GoPrintActionPDFVIEW}, L{X2GoPrintActionPRINT} et al.
- @param client_instance: the underlying L{X2GoClient} instance
+ 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 L{X2GoLogger} object to the
- L{X2GoPrintQueue} constructor
+ @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 L{X2GoLogger} object has been supplied a new one will be
+ @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``
@@ -139,7 +139,7 @@ class X2GoPrintQueue(threading.Thread):
def stop_thread(self):
"""\
- Stops this L{X2GoPrintQueue} thread completely.
+ Stops this :class:`x2go.printing.X2GoPrintQueue` thread completely.
"""
@@ -170,12 +170,12 @@ class X2GoPrintQueue(threading.Thread):
def set_print_action(self, print_action, **kwargs):
"""\
- Modify the print action of this L{X2GoPrintQueue} thread during runtime. The
+ Modify the print action of this :class:`x2go.printing.X2GoPrintQueue` thread during runtime. The
change of print action will be valid for the next incoming print job.
As kwargs you can pass arguments for the print action class to be set. Refer
- to the class descriptions of L{X2GoPrintActionDIALOG}, L{X2GoPrintActionPDFVIEW},
- L{X2GoPrintActionPRINT}, etc.
+ to the class descriptions of :class:`x2go.printactions.X2GoPrintActionDIALOG`, :class:`x2go.printactions.X2GoPrintActionPDFVIEW`,
+ :class:`x2go.printactions.X2GoPrintActionPRINT`, etc.
:param print_action: new print action to be valid for incoming print jobs
:type print_action: ``str`` or ``class``
@@ -191,7 +191,7 @@ class X2GoPrintQueue(threading.Thread):
def run(self):
"""\
- Start this L{X2GoPrintQueue} thread...
+ Start this :class:`x2go.printing.X2GoPrintQueue` thread...
"""
@@ -227,7 +227,7 @@ class X2GoPrintQueue(threading.Thread):
def x2go_printjob_handler(job_file=None, pdf_file=None, job_title=None, print_action=None, parent_thread=None, logger=None, ):
"""\
This function is called as a handler function for each incoming X2Go print job
- represented by the class L{X2GoPrintJob}.
+ represented by the class :class:`x2go.printqueue.X2GoPrintJob`.
The handler function will (re-)read the »printing« configuration file (if no
explicit ``print_action`` is passed to this function...). It then will
@@ -241,9 +241,9 @@ def x2go_printjob_handler(job_file=None, pdf_file=None, job_title=None, print_ac
:type job_title: ``str``
:param print_action: an instance of either of the possible ``X2GoPrintActionXXX`` classes (Default value = None)
:type print_action: ``X2GoPrintActionXXX`` nstance
- :param parent_thread: the L{X2GoPrintQueue} thread that actually created this handler's L{X2GoPrintJob} instance (Default value = None)
+ :param parent_thread: the :class:`x2go.printing.X2GoPrintQueue` thread that actually created this handler's :class:`x2go.printqueue.X2GoPrintJob` instance (Default value = None)
:type parent_thread: ``obj``
- :param logger: the L{X2GoPrintQueue}'s logging instance (Default value = None)
+ :param logger: the :class:`x2go.printing.X2GoPrintQueue`'s logging instance (Default value = None)
:type logger: ``obj``
"""
diff --git a/x2go/pulseaudio.py b/x2go/pulseaudio.py
index 82748fe..d405294 100644
--- a/x2go/pulseaudio.py
+++ b/x2go/pulseaudio.py
@@ -61,11 +61,11 @@ class X2GoPulseAudio(threading.Thread):
@param path: full path to pulseaudio.exe
@type path: ``str``
- @param client_instance: the calling L{X2GoClient} instance
- @type client_instance: L{X2GoClient} instance
- @param logger: you can pass an L{X2GoLogger} object to the L{X2GoClientXConfig} constructor
+ @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 L{X2GoLogger} object has been supplied a new one will be
+ @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``
diff --git a/x2go/registry.py b/x2go/registry.py
index 7ca2988..00ee797 100644
--- a/x2go/registry.py
+++ b/x2go/registry.py
@@ -52,19 +52,19 @@ from .defaults import BACKENDS as _BACKENDS
class X2GoSessionRegistry(object):
"""\
- This class is utilized by L{X2GoClient} instances to maintain a good overview on
- session status of all associated L{X2GoSession} instances.
+ This class is utilized by :class:`x2go.client.X2GoClient` instances to maintain a good overview on
+ session status of all associated :class:`x2go.session.X2GoSession` instances.
"""
def __init__(self, client_instance,
logger=None, loglevel=log.loglevel_DEFAULT):
"""\
- @param client_instance: the L{X2GoClient} instance that instantiated this L{X2GoSessionRegistry} instance.
- @type client_instance: L{X2GoClient} instance
- @param logger: you can pass an L{X2GoLogger} object to the L{X2GoClientXConfig} constructor
+ @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 L{X2GoLogger} object has been supplied a new one will be
+ @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``
@@ -107,13 +107,13 @@ class X2GoSessionRegistry(object):
def __call__(self, session_uuid):
"""\
- Returns the L{X2GoSession} instance for a given session UUID hash.
+ 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``
- @return: the corresponding L{X2GoSession} instance
- @rtype: L{X2GoSession} instance
+ @return: the corresponding :class:`x2go.session.X2GoSession` instance
+ @rtype: :class:`x2go.session.X2GoSession` instance
@raise X2GoSessionRegistryException: if the given session UUID could not be found
@@ -232,7 +232,7 @@ class X2GoSessionRegistry(object):
def update_status(self, session_uuid=None, profile_name=None, profile_id=None, session_list=None, force_update=False, newly_connected=False):
"""\
- Update the session status for L{X2GoSession} that is represented by a given session UUID hash,
+ Update the session status for :class:`x2go.session.X2GoSession` that is represented by a given session UUID hash,
profile name or profile ID.
:param session_uuid: the X2Go session's UUID registry hash (Default value = None)
@@ -386,7 +386,7 @@ class X2GoSessionRegistry(object):
def register_available_server_sessions(self, profile_name, session_list=None, newly_connected=False, re_register=False, skip_pubapp_sessions=False):
"""\
- Register server-side available X2Go sessions with this L{X2GoSessionRegistry} instance for a given profile name.
+ Register server-side available X2Go sessions with this :class:`x2go.registry.X2GoSessionRegistry` instance for a given profile name.
:param profile_name: session profile name to register available X2Go sessions for
:type profile_name: ``str``
@@ -480,7 +480,7 @@ class X2GoSessionRegistry(object):
known_hosts=None,
**kwargs):
"""\
- Register a new L{X2GoSession} instance with this L{X2GoSessionRegistry}.
+ Register a new :class:`x2go.session.X2GoSession` instance with this :class:`x2go.registry.X2GoSessionRegistry`.
:param server: hostname of X2Go server
:type server: ``str``
@@ -516,7 +516,7 @@ class X2GoSessionRegistry(object):
:type add_to_known_hosts: ``bool``
:param known_hosts: the underlying Paramiko/SSH systems ``known_hosts`` file
:type known_hosts: ``str``
- :param kwargs: all other options will be passed on to the constructor of the to-be-instantiated L{X2GoSession} instance
+ :param kwargs: all other options will be passed on to the constructor of the to-be-instantiated :class:`x2go.session.X2GoSession` instance
:type kwargs: ``dict``
:param _X2GO_CLIENT_ROOTDIR:
:returns: the session UUID of the newly registered (or re-registered) session
@@ -612,7 +612,7 @@ class X2GoSessionRegistry(object):
def has_session_of_session_name(self, session_name, match_profile_name=None):
"""\
- Detect if we know about an L{X2GoSession} of name ``<session_name>``.
+ Detect if we know about an :class:`x2go.session.X2GoSession` of name ``<session_name>``.
:param session_name: name of session to be searched for
:type session_name: ``str``
@@ -626,18 +626,18 @@ class X2GoSessionRegistry(object):
def get_session_of_session_name(self, session_name, return_object=False, match_profile_name=None):
"""\
- Retrieve the L{X2GoSession} instance with session name ``<session_name>``.
+ Retrieve the :class:`x2go.session.X2GoSession` instance with session name ``<session_name>``.
:param session_name: name of session to be retrieved
:type session_name: ``str``
- :param return_object: if ``False`` the session UUID hash will be returned, if ``True`` the L{X2GoSession} instance will be returned (Default value = False)
+ :param return_object: if ``False`` the session UUID hash will be returned, if ``True`` the :class:`x2go.session.X2GoSession` instance will be returned (Default value = False)
:type return_object: ``bool``
:param match_profile_name: returned sessions must match this profile name (Default value = None)
:type match_profile_name: ``str``
- :returns: L{X2GoSession} object or its representing session UUID hash
- :rtype: L{X2GoSession} instance or ``str``
- :raises X2GoSessionRegistryException: if there is more than one L{X2GoSession} registered for ``<session_name>`` within
- the same L{X2GoClient} instance. This should never happen!
+ :returns: :class:`x2go.session.X2GoSession` object or its representing session UUID hash
+ :rtype: :class:`x2go.session.X2GoSession` instance or ``str``
+ :raises X2GoSessionRegistryException: if there is more than one :class:`x2go.session.X2GoSession` registered for ``<session_name>`` within
+ the same :class:`x2go.client.X2GoClient` instance. This should never happen!
"""
if match_profile_name is None:
@@ -688,10 +688,10 @@ class X2GoSessionRegistry(object):
def connected_sessions(self, return_objects=True, return_profile_names=False, return_profile_ids=False, return_session_names=False):
"""\
- Retrieve a list of sessions that the underlying L{X2GoClient} instances is currently connected to.
+ Retrieve a list of sessions that the underlying :class:`x2go.client.X2GoClient` instances is currently connected to.
If none of the ``return_*`` options is specified a list of session UUID hashes will be returned.
- :param return_objects: return as list of L{X2GoSession} instances (Default value = True)
+ :param return_objects: return as list of :class:`x2go.session.X2GoSession` instances (Default value = True)
:type return_objects: ``bool``
:param return_profile_names: return as list of profile names (Default value = False)
:type return_profile_names: ``bool``
@@ -707,10 +707,10 @@ class X2GoSessionRegistry(object):
def associated_sessions(self, return_objects=True, return_profile_names=False, return_profile_ids=False, return_session_names=False):
"""\
- Retrieve a list of sessions that are currently associated by an ``X2GoTerminalSession*`` to the underlying L{X2GoClient} instance.
+ Retrieve a list of sessions that are currently associated by an ``X2GoTerminalSession*`` to the underlying :class:`x2go.client.X2GoClient` instance.
If none of the ``return_*`` options is specified a list of session UUID hashes will be returned.
- :param return_objects: return as list of L{X2GoSession} instances (Default value = True)
+ :param return_objects: return as list of :class:`x2go.session.X2GoSession` instances (Default value = True)
:type return_objects: ``bool``
:param return_profile_names: return as list of profile names (Default value = False)
:type return_profile_names: ``bool``
@@ -729,7 +729,7 @@ class X2GoSessionRegistry(object):
Retrieve a list of sessions that are currently still in virgin state (not yet connected, associated etc.).
If none of the ``return_*`` options is specified a list of session UUID hashes will be returned.
- :param return_objects: return as list of L{X2GoSession} instances (Default value = True)
+ :param return_objects: return as list of :class:`x2go.session.X2GoSession` instances (Default value = True)
:type return_objects: ``bool``
:param return_profile_names: return as list of profile names (Default value = False)
:type return_profile_names: ``bool``
@@ -748,7 +748,7 @@ class X2GoSessionRegistry(object):
Retrieve a list of sessions that are currently in running state.
If none of the ``return_*`` options is specified a list of session UUID hashes will be returned.
- :param return_objects: return as list of L{X2GoSession} instances (Default value = True)
+ :param return_objects: return as list of :class:`x2go.session.X2GoSession` instances (Default value = True)
:type return_objects: ``bool``
:param return_profile_names: return as list of profile names (Default value = False)
:type return_profile_names: ``bool``
@@ -767,7 +767,7 @@ class X2GoSessionRegistry(object):
Retrieve a list of sessions that are currently in suspended state.
If none of the ``return_*`` options is specified a list of session UUID hashes will be returned.
- :param return_objects: return as list of L{X2GoSession} instances (Default value = True)
+ :param return_objects: return as list of :class:`x2go.session.X2GoSession` instances (Default value = True)
:type return_objects: ``bool``
:param return_profile_names: return as list of profile names (Default value = False)
:type return_profile_names: ``bool``
@@ -786,7 +786,7 @@ class X2GoSessionRegistry(object):
Retrieve a list of sessions that have terminated recently.
If none of the ``return_*`` options is specified a list of session UUID hashes will be returned.
- :param return_objects: return as list of L{X2GoSession} instances (Default value = True)
+ :param return_objects: return as list of :class:`x2go.session.X2GoSession` instances (Default value = True)
:type return_objects: ``bool``
:param return_profile_names: return as list of profile names (Default value = False)
:type return_profile_names: ``bool``
@@ -803,7 +803,7 @@ class X2GoSessionRegistry(object):
@property
def has_running_sessions(self):
"""\
- Equals ``True`` if the underlying L{X2GoClient} instance has any running sessions at hand.
+ Equals ``True`` if the underlying :class:`x2go.client.X2GoClient` instance has any running sessions at hand.
"""
@@ -812,7 +812,7 @@ class X2GoSessionRegistry(object):
@property
def has_suspended_sessions(self):
"""\
- Equals ``True`` if the underlying L{X2GoClient} instance has any suspended sessions at hand.
+ Equals ``True`` if the underlying :class:`x2go.client.X2GoClient` instance has any suspended sessions at hand.
"""
@@ -823,7 +823,7 @@ class X2GoSessionRegistry(object):
Retrieve a list of all registered sessions.
If none of the ``return_*`` options is specified a list of session UUID hashes will be returned.
- :param return_objects: return as list of L{X2GoSession} instances (Default value = True)
+ :param return_objects: return as list of :class:`x2go.session.X2GoSession` instances (Default value = True)
:type return_objects: ``bool``
:param return_profile_names: return as list of profile names (Default value = False)
:type return_profile_names: ``bool``
@@ -842,7 +842,7 @@ class X2GoSessionRegistry(object):
Retrieve a list of sessions that are currently _NOT_ in running state.
If none of the ``return_*`` options is specified a list of session UUID hashes will be returned.
- :param return_objects: return as list of L{X2GoSession} instances (Default value = True)
+ :param return_objects: return as list of :class:`x2go.session.X2GoSession` instances (Default value = True)
:type return_objects: ``bool``
:param return_profile_names: return as list of profile names (Default value = False)
:type return_profile_names: ``bool``
@@ -863,7 +863,7 @@ class X2GoSessionRegistry(object):
:param profile_name: session profile name
:type profile_name: ``str``
- :param return_objects: return as list of L{X2GoSession} instances (Default value = True)
+ :param return_objects: return as list of :class:`x2go.session.X2GoSession` instances (Default value = True)
:type return_objects: ``bool``
:param return_session_names: return as list of X2Go session names (Default value = False)
:type return_session_names: ``bool``
@@ -880,12 +880,12 @@ class X2GoSessionRegistry(object):
def associated_sessions_of_profile_name(self, profile_name, return_objects=True, return_session_names=False):
"""\
- For a given session profile name retrieve a list of sessions that are currently associated by an ``X2GoTerminalSession*`` to this L{X2GoClient} instance.
+ For a given session profile name retrieve a list of sessions that are currently associated by an ``X2GoTerminalSession*`` to this :class:`x2go.client.X2GoClient` instance.
If none of the ``return_*`` options is specified a list of session UUID hashes will be returned.
:param profile_name: session profile name
:type profile_name: ``str``
- :param return_objects: return as list of L{X2GoSession} instances (Default value = True)
+ :param return_objects: return as list of :class:`x2go.session.X2GoSession` instances (Default value = True)
:type return_objects: ``bool``
:param return_session_names: return as list of X2Go session names (Default value = False)
:type return_session_names: ``bool``
@@ -907,7 +907,7 @@ class X2GoSessionRegistry(object):
:param profile_name: session profile name
:type profile_name: ``str``
- :param return_objects: return as list of L{X2GoSession} instances (Default value = True)
+ :param return_objects: return as list of :class:`x2go.session.X2GoSession` instances (Default value = True)
:type return_objects: ``bool``
:param return_session_names: return as list of X2Go session names (Default value = False)
:type return_session_names: ``bool``
@@ -924,12 +924,12 @@ class X2GoSessionRegistry(object):
def registered_sessions_of_profile_name(self, profile_name, return_objects=True, return_session_names=False):
"""\
- For a given session profile name retrieve a list of sessions that are currently registered with this L{X2GoClient} instance.
+ For a given session profile name retrieve a list of sessions that are currently registered with this :class:`x2go.client.X2GoClient` instance.
If none of the ``return_*`` options is specified a list of session UUID hashes will be returned.
:param profile_name: session profile name
:type profile_name: ``str``
- :param return_objects: return as list of L{X2GoSession} instances (Default value = True)
+ :param return_objects: return as list of :class:`x2go.session.X2GoSession` instances (Default value = True)
:type return_objects: ``bool``
:param return_session_names: return as list of X2Go session names (Default value = False)
:type return_session_names: ``bool``
@@ -946,13 +946,13 @@ class X2GoSessionRegistry(object):
def virgin_sessions_of_profile_name(self, profile_name, return_objects=True, return_session_names=False):
"""\
- For a given session profile name retrieve a list of sessions that are registered with this L{X2GoClient} instance but have not
+ For a given session profile name retrieve a list of sessions that are registered with this :class:`x2go.client.X2GoClient` instance but have not
yet been started (i.e. sessions that are in virgin state). If none of the ``return_*`` options is specified a list of
session UUID hashes will be returned.
:param profile_name: session profile name
:type profile_name: ``str``
- :param return_objects: return as list of L{X2GoSession} instances (Default value = True)
+ :param return_objects: return as list of :class:`x2go.session.X2GoSession` instances (Default value = True)
:type return_objects: ``bool``
:param return_session_names: return as list of X2Go session names (Default value = False)
:type return_session_names: ``bool``
@@ -974,7 +974,7 @@ class X2GoSessionRegistry(object):
:param profile_name: session profile name
:type profile_name: ``str``
- :param return_objects: return as list of L{X2GoSession} instances (Default value = True)
+ :param return_objects: return as list of :class:`x2go.session.X2GoSession` instances (Default value = True)
:type return_objects: ``bool``
:param return_session_names: return as list of X2Go session names (Default value = False)
:type return_session_names: ``bool``
@@ -996,7 +996,7 @@ class X2GoSessionRegistry(object):
:param profile_name: session profile name
:type profile_name: ``str``
- :param return_objects: return as list of L{X2GoSession} instances (Default value = True)
+ :param return_objects: return as list of :class:`x2go.session.X2GoSession` instances (Default value = True)
:type return_objects: ``bool``
:param return_session_names: return as list of X2Go session names (Default value = False)
:type return_session_names: ``bool``
@@ -1061,7 +1061,7 @@ class X2GoSessionRegistry(object):
:param profile_name: the profile name that we query the master session of
:type profile_name: ``str``
- :param return_object: return L{X2GoSession} instance (Default value = True)
+ :param return_object: return :class:`x2go.session.X2GoSession` instance (Default value = True)
:type return_object: ``bool``
:param return_session_name: return X2Go session name (Default value = False)
:type return_session_name: ``bool``
diff --git a/x2go/rforward.py b/x2go/rforward.py
index 60bcaf5..3d118e4 100644
--- a/x2go/rforward.py
+++ b/x2go/rforward.py
@@ -49,12 +49,12 @@ def x2go_transport_tcp_handler(chan, origin, server):
However, additionally this handler function checks the server port of the incoming channel
and detects if there are Paramiko/SSH reverse forwarding tunnels waiting for the incoming
- channels. The Paramiko/SSH reverse forwarding tunnels are initiated by an L{X2GoSession} instance
+ channels. The Paramiko/SSH reverse forwarding tunnels are initiated by an :class:`x2go.session.X2GoSession` instance
(currently supported: reverse tunneling auf audio data, reverse tunneling of SSH requests).
- If the server port of an incoming Paramiko/SSH channel matches the configured port of an L{X2GoRevFwTunnel}
- instance, this instance gets notified of the incoming channel and a new L{X2GoRevFwChannelThread} is
- started. This L{X2GoRevFwChannelThread} then takes care of the new channel's incoming data stream.
+ If the server port of an incoming Paramiko/SSH channel matches the configured port of an :class:`x2go.rforward.X2GoRevFwTunnel`
+ instance, this instance gets notified of the incoming channel and a new :class:`x2go.rforward.X2GoRevFwChannelThread` is
+ started. This :class:`x2go.rforward.X2GoRevFwChannelThread` then takes care of the new channel's incoming data stream.
:param chan: a Paramiko channel object
:type chan: ``paramiko.Channel`` object
@@ -83,7 +83,7 @@ def x2go_transport_tcp_handler(chan, origin, server):
class X2GoRevFwTunnel(threading.Thread):
"""\
- L{X2GoRevFwTunnel} class objects are used to reversely tunnel
+ :class:`x2go.rforward.X2GoRevFwTunnel` class objects are used to reversely tunnel
X2Go audio, X2Go printing and X2Go folder sharing / device mounting
through Paramiko/SSH.
@@ -96,7 +96,7 @@ class X2GoRevFwTunnel(threading.Thread):
After the reverse tunnel has been setup up with L{X2GoRevFwTunnel.start()} it waits
for notification from L{X2GoRevFwTunnel.notify()} to accept incoming channels. This
notification (L{X2GoRevFwTunnel.notify()} gets called from within the transport's
- TCP handler function L{x2go_transport_tcp_handler} of the L{X2GoSession} instance.
+ TCP handler function L{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),
normally some number above 30000
@@ -107,12 +107,12 @@ class X2GoRevFwTunnel(threading.Thread):
@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 L{X2GoSession}'s Paramiko/SSH transport instance
+ @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 L{X2GoLogger} object to the
- L{X2GoRevFwTunnel} constructor
- @type logger: L{X2GoLogger} instance
- @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be
+ @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
constructed with the given loglevel
@type loglevel: int
@@ -167,7 +167,7 @@ class X2GoRevFwTunnel(threading.Thread):
def pause(self):
"""\
Prevent acceptance of new incoming connections through the Paramiko/SSH
- reverse forwarding tunnel. Also, any active connection on this L{X2GoRevFwTunnel}
+ reverse forwarding tunnel. Also, any active connection on this :class:`x2go.rforward.X2GoRevFwTunnel`
instance will be closed immediately, if this method is called.
@@ -191,10 +191,10 @@ class X2GoRevFwTunnel(threading.Thread):
def notify(self):
"""\
- Notify an L{X2GoRevFwTunnel} instance of an incoming Paramiko/SSH channel.
+ Notify an :class:`x2go.rforward.X2GoRevFwTunnel` instance of an incoming Paramiko/SSH channel.
If an incoming reverse tunnel channel appropriate for this instance has
- been detected, this method gets called from the L{X2GoSession}'s transport
+ been detected, this method gets called from the :class:`x2go.session.X2GoSession`'s transport
TCP handler.
The sent notification will trigger a ``thread.Condition()`` waiting for notification
@@ -209,7 +209,7 @@ class X2GoRevFwTunnel(threading.Thread):
def stop_thread(self):
"""\
- Stops this L{X2GoRevFwTunnel} thread completely.
+ Stops this :class:`x2go.rforward.X2GoRevFwTunnel` thread completely.
"""
@@ -236,8 +236,8 @@ class X2GoRevFwTunnel(threading.Thread):
def run(self):
"""\
- This method gets run once an L{X2GoRevFwTunnel} has been started with its
- L{start()} method. Use L{X2GoRevFwTunnel}.stop_thread() to stop the
+ This method gets run once an :class:`x2go.rforward.X2GoRevFwTunnel` has been started with its
+ L{start()} method. Use :class:`x2go.rforward.X2GoRevFwTunnel`.stop_thread() to stop the
reverse forwarding tunnel again. You can also temporarily lock the tunnel
down with L{X2GoRevFwTunnel.pause()} and L{X2GoRevFwTunnel.resume()}).
@@ -247,7 +247,7 @@ class X2GoRevFwTunnel(threading.Thread):
property ``server_port``.
Once a new incoming channel gets announced by the L{notify()} method, a new
- L{X2GoRevFwChannelThread} instance will be initialized. As a data stream handler,
+ :class:`x2go.rforward.X2GoRevFwChannelThread` instance will be initialized. As a data stream handler,
the function L{x2go_rev_forward_channel_handler()} will be used.
The channel will last till the connection gets dropped on the X2Go server side or
@@ -290,16 +290,16 @@ class X2GoRevFwTunnel(threading.Thread):
def x2go_rev_forward_channel_handler(chan=None, addr='', port=0, parent_thread=None, logger=None, ):
"""\
- Handle the data stream of a requested channel that got set up by a L{X2GoRevFwTunnel} (Paramiko/SSH
+ Handle the data stream of a requested channel that got set up by a :class:`x2go.rforward.X2GoRevFwTunnel` (Paramiko/SSH
reverse forwarding tunnel).
The channel (and the corresponding connections) close either ...
- ... if the connecting application closes the connection and thus, drops
the channel, or
- - ... if the L{X2GoRevFwTunnel} parent thread gets paused. The call
+ - ... if the :class:`x2go.rforward.X2GoRevFwTunnel` parent thread gets paused. The call
of L{X2GoRevFwTunnel.pause()} on the instance can be used to shut down all incoming
- tunneled SSH connections associated to this L{X2GoRevFwTunnel} instance
+ tunneled SSH connections associated to this :class:`x2go.rforward.X2GoRevFwTunnel` instance
from within a Python X2Go application.
:param chan: channel (Default value = None)
@@ -308,11 +308,11 @@ def x2go_rev_forward_channel_handler(chan=None, addr='', port=0, parent_thread=N
:type addr: ``str``
:param port: bind port (Default value = 0)
:type port: ``int``
- :param parent_thread: the calling L{X2GoRevFwTunnel} instance (Default value = None)
- :type parent_thread: L{X2GoRevFwTunnel} instance
- :param logger: you can pass an L{X2GoLogger} object to the
- L{X2GoRevFwTunnel} constructor (Default value = None)
- :type logger: L{X2GoLogger} instance
+ :param parent_thread: the calling :class:`x2go.rforward.X2GoRevFwTunnel` instance (Default value = None)
+ :type parent_thread: :class:`x2go.rforward.X2GoRevFwTunnel` instance
+ :param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the
+ :class:`x2go.rforward.X2GoRevFwTunnel` constructor (Default value = None)
+ :type logger: :class:`x2go.logger.X2GoLogger` instance
"""
fw_socket = socket.socket()
@@ -363,7 +363,7 @@ class X2GoRevFwChannelThread(threading.Thread):
"""\
Initializes a reverse forwarding channel thread.
- @param channel: incoming Paramiko/SSH channel from the L{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
diff --git a/x2go/session.py b/x2go/session.py
index 4b81684..edb8725 100644
--- a/x2go/session.py
+++ b/x2go/session.py
@@ -21,8 +21,8 @@
X2GoSession class - a public API of Python X2Go, handling standalone X2Go
sessions.
-This class is normally embedded into the context of an L{X2GoClient}
-instance, but it is also possible to address L{X2GoSession}s directly via this
+This class is normally embedded into the context of an :class:`x2go.client.X2GoClient`
+instance, but it is also possible to address an :class:`x2go.session.X2GoSession` directly via this
class.
To launch a session manually from the Python interactive shell, perform these
@@ -125,11 +125,11 @@ _X2GO_SSHPROXY_PARAMS = ('sshproxy_host', 'sshproxy_port', 'sshproxy_user', 'ssh
class X2GoSession(object):
"""\
Public API class for launching X2Go sessions. Recommended is to manage X2Go sessions from
- within an L{X2GoClient} instance. However, Python X2Go is designed in a way that it also
- allows the management of singel L{X2GoSession} instance.
+ within an :class:`x2go.client.X2GoClient` instance. However, Python X2Go is designed in a way that it also
+ allows the management of singel :class:`x2go.session.X2GoSession` instance.
- Thus, you can use the L{X2GoSession} class to manually set up X2Go sessions without
- L{X2GoClient} context (session registry, session list cache, auto-registration of new
+ Thus, you can use the :class:`x2go.session.X2GoSession` class to manually set up X2Go sessions without
+ :class:`x2go.client.X2GoClient` context (session registry, session list cache, auto-registration of new
sessions etc.).
@@ -241,7 +241,7 @@ class X2GoSession(object):
@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 L{X2GoClient} instance
+ @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``
@@ -428,10 +428,10 @@ class X2GoSession(object):
def get_client_instance(self):
"""\
- Return parent L{X2GoClient} instance if avaiable.
+ Return parent :class:`x2go.client.X2GoClient` instance if avaiable.
- :returns: L{X2GoClient} instance this session is associated with
+ :returns: :class:`x2go.client.X2GoClient` instance this session is associated with
:rtype: ``obj``
@@ -656,7 +656,7 @@ class X2GoSession(object):
The master session is the session has been launched first for a specific connection,
it also is _the_ session that controls the client-side shared folders.
- If this L{X2GoSession} instance is a standalone instance (without parent L{X2GoClient})
+ If this :class:`x2go.session.X2GoSession` instance is a standalone instance (without parent :class:`x2go.client.X2GoClient`)
this method will always return ``True``.
@@ -674,7 +674,7 @@ class X2GoSession(object):
"""\
Declare this as a master session of a connection channel.
- This method gets called by the L{X2GoSessionRegistry} while sessions are starting or resuming and it relies on
+ This method gets called by the :class:`x2go.registry.X2GoSessionRegistry` while sessions are starting or resuming and it relies on
an already set-up terminal session.
:param wait: wait for <wait> seconds before sharing local folders via the new master session
@@ -719,7 +719,7 @@ class X2GoSession(object):
def set_server(self, server):
"""\
- Modify server name after L{X2GoSession} has already been initialized.
+ Modify server name after :class:`x2go.session.X2GoSession` has already been initialized.
:param server: new server name
:type server: ``str``
@@ -730,7 +730,7 @@ class X2GoSession(object):
def set_port(self, port):
"""\
- Modify server port after L{X2GoSession} has already been initialized.
+ Modify server port after :class:`x2go.session.X2GoSession` has already been initialized.
:param port: socket port of server to connect to
:type port: ``int``
@@ -741,7 +741,7 @@ class X2GoSession(object):
def set_profile_name(self, profile_name):
"""\
- Modify session profile name after L{X2GoSession} has already been initialized.
+ Modify session profile name after :class:`x2go.session.X2GoSession` has already been initialized.
:param profile_name: new session profile name
:type profile_name: ``str``
@@ -770,10 +770,10 @@ class X2GoSession(object):
def update_params(self, params):
"""\
- This method can be used to modify L{X2GoSession} parameters after the
- L{X2GoSession} instance has already been initialized.
+ This method can be used to modify :class:`x2go.session.X2GoSession` parameters after the
+ :class:`x2go.session.X2GoSession` instance has already been initialized.
- :param params: a Python dictionary with L{X2GoSession} parameters
+ :param params: a Python dictionary with :class:`x2go.session.X2GoSession` parameters
:type params: ``dict``
"""
@@ -860,7 +860,7 @@ class X2GoSession(object):
def get_uuid(self):
"""\
- Retrieve session UUID hash for this L{X2GoSession}.
+ Retrieve session UUID hash for this :class:`x2go.session.X2GoSession`.
:returns: the session's UUID hash
@@ -1001,7 +1001,7 @@ class X2GoSession(object):
def set_session_name(self, session_name):
"""\
- Manipulate the L{X2GoSession}'s session name.
+ Manipulate the :class:`x2go.session.X2GoSession`'s session name.
:param session_name: the new session name to be set
:type session_name: ``str``
@@ -1082,10 +1082,10 @@ class X2GoSession(object):
def get_control_session(self):
"""\
- Retrieve the control session (``X2GoControlSession*`` backend) of this L{X2GoSession}.
+ Retrieve the control session (``X2GoControlSession*`` backend) of this :class:`x2go.session.X2GoSession`.
- :returns: the L{X2GoSession}'s control session
+ :returns: the :class:`x2go.session.X2GoSession`'s control session
:rtype: ``X2GoControlSession*`` instance
@@ -1095,10 +1095,10 @@ class X2GoSession(object):
def has_control_session(self):
"""\
- Check if this L{X2GoSession} instance has an associated control session.
+ Check if this :class:`x2go.session.X2GoSession` instance has an associated control session.
- :returns: returns ``True`` if this L{X2GoSession} has a control session associated to itself
+ :returns: returns ``True`` if this :class:`x2go.session.X2GoSession` has a control session associated to itself
:rtype: ``bool``
@@ -1108,10 +1108,10 @@ class X2GoSession(object):
def get_terminal_session(self):
"""\
- Retrieve the terminal session (``X2GoTerminalSession*`` backend) of this L{X2GoSession}.
+ Retrieve the terminal session (``X2GoTerminalSession*`` backend) of this :class:`x2go.session.X2GoSession`.
- :returns: the L{X2GoSession}'s terminal session
+ :returns: the :class:`x2go.session.X2GoSession`'s terminal session
:rtype: ``X2GoControlTerminal*`` instance
@@ -1123,10 +1123,10 @@ class X2GoSession(object):
def has_terminal_session(self):
"""\
- Check if this L{X2GoSession} instance has an associated terminal session.
+ Check if this :class:`x2go.session.X2GoSession` instance has an associated terminal session.
- :returns: returns ``True`` if this L{X2GoSession} has a terminal session associated to itself
+ :returns: returns ``True`` if this :class:`x2go.session.X2GoSession` has a terminal session associated to itself
:rtype: ``bool``
@@ -1255,7 +1255,7 @@ class X2GoSession(object):
"""\
Automatically connect this session.
- :param redirect_to_client: Pass this request through to the L{X2GoClient} instance, if given (Default value = True)
+ :param redirect_to_client: Pass this request through to the :class:`x2go.client.X2GoClient` instance, if given (Default value = True)
:type redirect_to_client: ``True``
:returns: Return success (or failure) of connecting this sessions
:rtype: ``bool``
@@ -1276,7 +1276,7 @@ class X2GoSession(object):
use_sshproxy=None, sshproxy_user=None, sshproxy_password=None, sshproxy_passphrase=None,
sshproxy_force_password_auth=None, sshproxy_reuse_authinfo=None, ):
"""\
- Connects to the L{X2GoSession}'s server host. This method basically wraps around
+ Connects to the :class:`x2go.session.X2GoSession`'s server host. This method basically wraps around
the ``X2GoControlSession*.connect()`` method.
:param username: the username for the X2Go server that is going to be
@@ -1423,7 +1423,7 @@ class X2GoSession(object):
def disconnect(self):
"""\
- Disconnect this L{X2GoSession} instance.
+ Disconnect this :class:`x2go.session.X2GoSession` instance.
:returns: returns ``True`` if the disconnect operation has been successful
@@ -1632,16 +1632,16 @@ class X2GoSession(object):
def update_status(self, session_list=None, force_update=False):
"""\
- Update the current session status. The L{X2GoSession} instance uses an internal
+ Update the current session status. The :class:`x2go.session.X2GoSession` instance uses an internal
session status cache that allows to query the session status without the need
of retrieving data from the remote X2Go server for each query.
- The session status (if initialized properly with the L{X2GoClient} constructor gets
+ The session status (if initialized properly with the :class:`x2go.client.X2GoClient` constructor gets
updated in regularly intervals.
- In case you use the L{X2GoSession} class in standalone instances (that is: without
- being embedded into an L{X2GoSession} context) then run this method in regular
- intervals to make sure the L{X2GoSession}'s internal status cache information
+ In case you use the :class:`x2go.session.X2GoSession` class in standalone instances (that is: without
+ being embedded into an :class:`x2go.session.X2GoSession` context) then run this method in regular
+ intervals to make sure the :class:`x2go.session.X2GoSession`'s internal status cache information
is always up-to-date.
:param session_list: provide an ``X2GoServerSessionList*`` that refers to X2Go sessions we want to update.
@@ -1783,7 +1783,7 @@ class X2GoSession(object):
:type all_suspended: ``bool``
:param start: is no session is to be resumed, start a new session (Default value = True)
:type start: ``bool``
- :param redirect_to_client: redirect this call to the L{X2GoClient} instance (if available) to allow frontend interaction (Default value = True)
+ :param redirect_to_client: redirect this call to the :class:`x2go.client.X2GoClient` instance (if available) to allow frontend interaction (Default value = True)
:type redirect_to_client: ``bool``
:returns: returns success (or failure) of starting/resuming this sessions
:rtype: ``bool``
@@ -2513,7 +2513,7 @@ class X2GoSession(object):
def get_profile_name(self):
"""\
- Retrieve the profile name of this L{X2GoSession} instance.
+ Retrieve the profile name of this :class:`x2go.session.X2GoSession` instance.
:returns: X2Go client profile name of the session
@@ -2526,7 +2526,7 @@ class X2GoSession(object):
def get_profile_id(self):
"""\
- Retrieve the profile ID of this L{X2GoSession} instance.
+ Retrieve the profile ID of this :class:`x2go.session.X2GoSession` instance.
:returns: the session profile's id
@@ -2596,7 +2596,7 @@ class X2GoSession(object):
def is_connected(self):
"""\
- Test if the L{X2GoSession}'s control session is connected to the
+ Test if the :class:`x2go.session.X2GoSession`'s control session is connected to the
remote X2Go server.
@@ -2616,7 +2616,7 @@ class X2GoSession(object):
def is_running(self, update_status=False):
"""\
- Test if the L{X2GoSession}'s terminal session is up and running.
+ Test if the :class:`x2go.session.X2GoSession`'s terminal session is up and running.
:param update_status: if ``True``, the status is updated by a server call (Default value = False)
:type update_status: ``bool``
@@ -2640,7 +2640,7 @@ class X2GoSession(object):
def is_suspended(self, update_status=False):
"""\
- Test if the L{X2GoSession}'s terminal session is in suspended state.
+ Test if the :class:`x2go.session.X2GoSession`'s terminal session is in suspended state.
:param update_status: if ``True``, the status is updated by a server call (Default value = False)
:type update_status: ``bool``
@@ -2664,7 +2664,7 @@ class X2GoSession(object):
def has_terminated(self, update_status=False):
"""\
- Test if the L{X2GoSession}'s terminal session has terminated.
+ Test if the :class:`x2go.session.X2GoSession`'s terminal session has terminated.
:param update_status: if ``True``, the status is updated by a server call (Default value = False)
:type update_status: ``bool``
@@ -2732,7 +2732,7 @@ class X2GoSession(object):
:returns: returns ``True`` if the local folder has been successfully mounted within
this X2Go session
:rtype: ``bool``
- :raises X2GoSessionException: if this L{X2GoSession} does not have an associated terminal session
+ :raises X2GoSessionException: if this :class:`x2go.session.X2GoSession` does not have an associated terminal session
"""
# compat for Python-X2Go (<=0.1.1.6)
@@ -2832,7 +2832,7 @@ class X2GoSession(object):
:returns: returns ``True`` if all local folders could be successfully unmounted
inside this X2Go session
:rtype: ``bool``
- :raises X2GoSessionException: if this L{X2GoSession} does not have an associated terminal session
+ :raises X2GoSessionException: if this :class:`x2go.session.X2GoSession` does not have an associated terminal session
"""
retval = False
@@ -2873,7 +2873,7 @@ class X2GoSession(object):
:returns: returns ``True`` if all local folders could be successfully unmounted
inside this X2Go session
:rtype: ``bool``
- :raises X2GoSessionException: if this L{X2GoSession} does not have an associated terminal session
+ :raises X2GoSessionException: if this :class:`x2go.session.X2GoSession` does not have an associated terminal session
"""
if self.has_terminal_session():
diff --git a/x2go/sftpserver.py b/x2go/sftpserver.py
index 22c2213..a47ad54 100644
--- a/x2go/sftpserver.py
+++ b/x2go/sftpserver.py
@@ -60,11 +60,11 @@ class _SSHServer(paramiko.ServerInterface):
@param auth_key: Server key that the client has to authenticate against
@type auth_key: ``paramiko.RSAKey`` instance
- @param session_instance: the calling L{X2GoSession} instance
- @type session_instance: L{X2GoSession} instance
- @param logger: you can pass an L{X2GoLogger} object to the L{X2GoClientXConfig} constructor
+ @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 L{X2GoLogger} object has been supplied a new one will be
+ @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``
@@ -168,9 +168,9 @@ class _SFTPServerInterface(paramiko.SFTPServerInterface):
@type server: ``paramiko.ServerInterface`` instance
@param chroot: chroot environment for this SFTP interface
@type chroot: ``str``
- @param logger: you can pass an L{X2GoLogger} object to the L{X2GoClientXConfig} constructor
+ @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 L{X2GoLogger} object has been supplied a new one will be
+ @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
@@ -501,15 +501,15 @@ class X2GoRevFwTunnelToSFTP(rforward.X2GoRevFwTunnel):
@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 L{X2GoSession}'s Paramiko/SSH transport instance
+ @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 L{X2GoLogger} object to the
- L{X2GoRevFwTunnelToSFTP} constructor
- @type logger: L{X2GoLogger} instance
- @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be
+ @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
constructed with the given loglevel
@type loglevel: ``int``
@@ -537,8 +537,8 @@ class X2GoRevFwTunnelToSFTP(rforward.X2GoRevFwTunnel):
def run(self):
"""\
- This method gets run once an L{X2GoRevFwTunnelToSFTP} has been started with its
- L{start()} method. Use L{X2GoRevFwTunnelToSFTP}.stop_thread() to stop the
+ This method gets run once an :class:`x2go.sftpserver.X2GoRevFwTunnelToSFTP` has been started with its
+ L{start()} method. Use :class:`x2go.sftpserver.X2GoRevFwTunnelToSFTP`.stop_thread() to stop the
reverse forwarding tunnel again (refer also to its pause() and resume() method).
L{X2GoRevFwTunnelToSFTP.run()} waits for notifications of an appropriate incoming
@@ -547,7 +547,7 @@ class X2GoRevFwTunnelToSFTP(rforward.X2GoRevFwTunnel):
property ``server_port``.
Once a new incoming channel gets announced by the L{notify()} method, a new
- L{X2GoRevFwSFTPChannelThread} instance will be initialized. As a data stream handler,
+ :class:`x2go.sftpserver.X2GoRevFwSFTPChannelThread` instance will be initialized. As a data stream handler,
the function L{x2go_rev_forward_sftpchannel_handler()} will be used.
The channel will last till the connection gets dropped on the X2Go server side or
@@ -589,15 +589,15 @@ class X2GoRevFwTunnelToSFTP(rforward.X2GoRevFwTunnel):
def x2go_rev_forward_sftpchannel_handler(chan=None, auth_key=None, logger=None):
"""\
- Handle incoming sFTP channels that got setup by an L{X2GoRevFwTunnelToSFTP} instance.
+ Handle incoming sFTP channels that got setup by an :class:`x2go.sftpserver.X2GoRevFwTunnelToSFTP` instance.
The channel (and the corresponding connections) close either ...
- ... if the connecting application closes the connection and thus, drops
the sFTP channel, or
- - ... if the L{X2GoRevFwTunnelToSFTP} parent thread gets paused. The call
+ - ... if the :class:`x2go.sftpserver.X2GoRevFwTunnelToSFTP` parent thread gets paused. The call
of L{X2GoRevFwTunnelToSFTP.pause()} on the instance can be used to shut down all incoming
- tunneled SSH connections associated to this L{X2GoRevFwTunnelToSFTP} instance
+ tunneled SSH connections associated to this :class:`x2go.sftpserver.X2GoRevFwTunnelToSFTP` instance
from within a Python X2Go application.
:param chan: an incoming sFTP channel (Default value = None)
@@ -605,7 +605,7 @@ def x2go_rev_forward_sftpchannel_handler(chan=None, auth_key=None, logger=None):
:param auth_key: Paramiko/SSH RSAkey object that has to be authenticated against by
the remote sFTP client (Default value = None)
:type auth_key: ``paramiko.RSAKey`` instance
- :param logger: you must pass an L{X2GoLogger} object to this handler method (Default value = None)
+ :param logger: you must pass an :class:`x2go.logger.X2GoLogger` object to this handler method (Default value = None)
:type logger: ``X2GoLogger`` instance
"""
diff --git a/x2go/sshproxy.py b/x2go/sshproxy.py
index c36ca0a..1bdd17c 100644
--- a/x2go/sshproxy.py
+++ b/x2go/sshproxy.py
@@ -18,7 +18,7 @@
# 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
"""\
-L{X2GoSSHProxy} class - providing a forwarding tunnel for connecting to servers behind firewalls.
+:class:`x2go.sshproxy.X2GoSSHProxy` class - providing a forwarding tunnel for connecting to servers behind firewalls.
"""
from __future__ import print_function
@@ -139,12 +139,12 @@ class X2GoSSHProxy(paramiko.SSHClient, threading.Thread):
@param ssh_rootdir: local user's SSH base directory (default: ~/.ssh)
@type ssh_rootdir: ``str``
- @param session_instance: the L{X2GoSession} instance that builds up this SSH proxying tunnel
- @type session_instance: L{X2GoSession} instance
- @param logger: you can pass an L{X2GoLogger} object to the
- L{X2GoSSHProxy} constructor
- @type logger: L{X2GoLogger} instance
- @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be
+ @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
constructed with the given loglevel
@type loglevel: int
diff --git a/x2go/telekinesis.py b/x2go/telekinesis.py
index d042f28..97ef4c1 100644
--- a/x2go/telekinesis.py
+++ b/x2go/telekinesis.py
@@ -80,12 +80,12 @@ class X2GoTelekinesisClient(threading.Thread):
@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 L{X2GoLogger} object to the
- L{X2GoTelekinesisClient} constructor
- @param session_instance: the L{X2GoSession} instance this ``X2GoProxy*`` instance belongs to
- @type session_instance: L{X2GoSession} instance
- @type logger: L{X2GoLogger} instance
- @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be
+ @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
constructed with the given loglevel
@type loglevel: int
diff --git a/x2go/xserver.py b/x2go/xserver.py
index 6a63733..b4e7ce9 100644
--- a/x2go/xserver.py
+++ b/x2go/xserver.py
@@ -58,11 +58,11 @@ class X2GoClientXConfig(inifiles.X2GoIniFile):
def __init__(self, config_files=_X2GO_XCONFIG_CONFIGFILES, defaults=_X2GO_CLIENTXCONFIG_DEFAULTS, logger=None, loglevel=log.loglevel_DEFAULT):
"""\
- Constructs an L{X2GoClientXConfig} instance. This is normally done by an L{X2GoClient} instance.
- You can retrieve this L{X2GoClientXConfig} instance with the ``X2GoClient.get_client_xconfig()``
+ Constructs an :class:`x2go.xserver.X2GoClientXConfig` instance. This is normally done by an :class:`x2go.client.X2GoClient` instance.
+ You can retrieve this :class:`x2go.xserver.X2GoClientXConfig` instance with the ``X2GoClient.get_client_xconfig()``
method.
- On construction the L{X2GoClientXConfig} instance is filled with values from the configuration files::
+ On construction the :class:`x2go.xserver.X2GoClientXConfig` instance is filled with values from the configuration files::
/etc/x2goclient/xconfig
~/.x2goclient/xconfig
@@ -75,9 +75,9 @@ class X2GoClientXConfig(inifiles.X2GoIniFile):
@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 L{X2GoLogger} object to the L{X2GoClientXConfig} constructor
+ @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 L{X2GoLogger} object has been supplied a new one will be
+ @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``
@@ -288,9 +288,9 @@ class X2GoXServer(threading.Thread):
@type xserver_name: ``str``
@param xserver_config: XServer configuration node (as derived from L{X2GoClientXConfig.get_xserver_config()}
@type xserver_config: ``dict``
- @param logger: you can pass an L{X2GoLogger} object to the L{X2GoClientXConfig} constructor
+ @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 L{X2GoLogger} object has been supplied a new one will be
+ @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``
@@ -329,7 +329,7 @@ class X2GoXServer(threading.Thread):
def run(self):
"""\
- Start this L{X2GoXServer} thread. This will launch the configured XServer application.
+ Start this :class:`x2go.xserver.X2GoXServer` thread. This will launch the configured XServer application.
"""
--
Alioth's /home/x2go-admin/maintenancescripts/git/hooks/post-receive-email on /srv/git/code.x2go.org/python-x2go.git
More information about the x2go-commits
mailing list