Package x2go :: Package backends :: Package settings :: Module _file
[frames] | no frames]

Source Code for Module x2go.backends.settings._file

 1  # -*- coding: utf-8 -*- 
 2   
 3  # Copyright (C) 2010-2014 by Mike Gabriel <mike.gabriel@das-netzwerkteam.de> 
 4  # 
 5  # Python X2Go is free software; you can redistribute it and/or modify 
 6  # it under the terms of the GNU Affero General Public License as published by 
 7  # the Free Software Foundation; either version 3 of the License, or 
 8  # (at your option) any later version. 
 9  # 
10  # Python X2Go is distributed in the hope that it will be useful, 
11  # but WITHOUT ANY WARRANTY; without even the implied warranty of 
12  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
13  # GNU Affero General Public License for more details. 
14  # 
15  # You should have received a copy of the GNU Affero General Public License 
16  # along with this program; if not, write to the 
17  # Free Software Foundation, Inc., 
18  # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. 
19   
20  """\ 
21  X2GoClientSettings class - managing x2goclient settings file (incl. LDAP-Support). 
22   
23  The L{X2GoClientSettings} class one of Python X2Go's a public API classes. 
24  Use this class (indirectly by retrieving it from an L{X2GoClient} instance) 
25  in your Python X2Go based applications to access the 
26  »settings« configuration file of your X2Go client application. 
27   
28  """ 
29  __NAME__ = 'x2gosettings-pylib' 
30   
31  # Python X2Go modules 
32  import x2go.log as log 
33  from x2go.defaults import X2GO_SETTINGS_CONFIGFILES as _X2GO_SETTINGS_CONFIGFILES 
34  from x2go.defaults import X2GO_CLIENTSETTINGS_DEFAULTS as _X2GO_CLIENTSETTINGS_DEFAULTS 
35  import x2go.inifiles as inifiles 
36   
37   
38 -class X2GoClientSettingsFILE(inifiles.X2GoIniFile):
39 """\ 40 Configuration file based settings for L{X2GoClient} instances. 41 42 """ 43 defaultValues = _X2GO_CLIENTSETTINGS_DEFAULTS 44
45 - def __init__(self, config_files=_X2GO_SETTINGS_CONFIGFILES, defaults=None, logger=None, loglevel=log.loglevel_DEFAULT):
46 """\ 47 Constructs an L{X2GoClientSettingsFILE} instance. This is normally done from within an L{X2GoClient} instance. 48 You can retrieve this L{X2GoClientSettingsFILE} instance with the L{X2GoClient.get_client_settings()} 49 method. 50 51 On construction the L{X2GoClientSettingsFILE} object is filled with values from the configuration files:: 52 53 /etc/x2goclient/settings 54 ~/.x2goclient/settings 55 56 The files are read in the specified order and config options of both files are merged. Options 57 set in the user configuration file (C{~/.x2goclient/settings}) override global options set in 58 C{/etc/x2goclient/settings}. 59 60 """ 61 inifiles.X2GoIniFile.__init__(self, config_files, defaults=defaults, logger=logger, loglevel=loglevel)
62