source: orange/orange/Orange/misc/environ.py @ 9059:aec606a6bd44

Revision 9059:aec606a6bd44, 10.4 KB checked in by matija <matija.polajnar@…>, 3 years ago (diff)

Fixed typo.

Line 
1"""
2==============================================
3Orange environment configuration (``environ``)
4==============================================
5
6This module contains some basic customization options for Orange
7(for now mostly changing directories where orange settings are saved).
8
9How it works
10------------
11
12When this module is imported it will first load and parse a global
13configuration `orangerc.cfg` (located in the root directory of the orange
14installation). Further, it will look for and try to load a user specific
15configuration file located in $(HOME)/.orangerc.cfg or
16`application_dir`/orangerc.cfg where `application_dir` is a variable defined
17in the global configuration file.
18
19.. note:: in the configuration files all OS defined environment variables
20    (e.g $HOME, $USER, ...) are available.
21
22After all the parsing has taken place the select variables defined in the
23configuration will be made available as top level module variables.
24
25Example
26-------
27
28To change the location where settings are saved for Orange Canvas
29on Windows edit the global `orangerc.cfg` file and in the
30`[directories win32]` section change the `application_dir` variable:
31   
32    [directories win32]
33   
34    application_dir = D:/SharedAppData/orange/
35   
36In this way we can hard code the path instead of using the system default
37(defined in the the %APPDATA variable)
38
39Variables
40---------
41
42The following variables are exposed as top level module members
43
44`install_dir`:
45    Directory where Orange is installed.
46   
47`canvas_install_dir`:
48    Directory where Orange Canvas is installed.
49
50`widget_install_dir`:
51    Directory where Orange Widgets are installed.
52
53`icons_install_dir`:
54    Directory where icons for widgets are installed.
55
56`doc_install_dir`:
57    Directory with Orange documentation.
58 
59`dataset_install_dir`:
60    Directory with example data sets.
61
62`network_install_dir`:
63    Directory with example networks.
64
65`add_ons_dir`:
66    Directory where system-wide add-ons are installed
67   
68`add_ons_dir_user`:
69    Directory where user add-ons are installed
70   
71`application_dir`:
72    Directory where applications can save their data.
73     
74`output_dir`:
75    Directory where Orange saves settings/data.
76   
77`default_reports_dir`:
78    Directory where Orange Canvas saves the reports.
79   
80`orange_settings_dir`:
81    Directory where Orange settings are saved.
82   
83`canvas_settings_dir`:
84    Directory where Orange Canvas settings are saved.
85   
86`widget_settings_dir`:
87    Directory where Orange Widgets settings are saved.
88   
89`buffer_dir`:
90    Directory where :obj:`Orange.misc.serverfiles` downloads are stored. 
91
92`orange_no_deprecated_members`:
93    If True all deprecated members in Orange 2.5 will not be available.
94     
95"""
96
97import os, sys
98import ConfigParser
99
100def _path_fix():
101    """ Fix some common problems with $(PATH) and sys.path
102    """
103    if os.name == "nt":
104        ## Move any miktex paths containing Qt's dll to the end of the %PATH%
105        paths = os.environ["PATH"].split(";")
106        paths.sort(lambda x,y: -1 if "PyQt4" in x else (1 if "miktex" in y and \
107                        os.path.exists(os.path.join(y, "QtCore4.dll")) else 0))
108        os.environ["PATH"] = ";".join(paths)
109       
110    if sys.platform == "darwin":
111        ## PyQt4 installed from fink is installed in %{FINK_ROOT}lib/qt4-mac/lib/python${PYVERSION}/site-packages"
112        posible_fink_pyqt4_path = os.path.join(sys.prefix, 
113                "lib/qt4-mac/lib/python" + sys.version[:3] + "/site-packages")
114        if os.path.exists(posible_fink_pyqt4_path):
115            sys.path.append(posible_fink_pyqt4_path)
116           
117_path_fix()
118
119def _get_default_env():
120    """ Return a dictionary with default Orange environment."""
121
122    version = "orange"
123    version_display = "Orange 2.5"
124    orange_no_deprecated_members = "False"
125   
126    try:
127        install_dir = os.path.dirname(os.path.abspath(__file__)) # Orange/misc
128        install_dir = os.path.dirname(install_dir) # Orange/
129        install_dir = os.path.dirname(install_dir) #
130    except Exception: # Why should this happen??
131        raise
132        import orange
133        install_dir = os.path.dirname(os.path.abspath(orange.__file__))
134
135    doc_install_dir = os.path.join(install_dir, "doc") 
136    dataset_install_dir = os.path.join(install_dir, "doc", "datasets") 
137    network_install_dir = os.path.join(install_dir, "doc", "networks")
138
139    canvas_install_dir = os.path.join(install_dir, "OrangeCanvas")
140    widget_install_dir = os.path.join(install_dir, "OrangeWidgets")
141    icons_install_dir = os.path.join(widget_install_dir, "icons")
142    add_ons_dir = os.path.join(install_dir, "add-ons")
143
144    home = os.path.expanduser("~/")
145   
146    if sys.platform == "win32":
147        if home[-1] == ":":
148            home += "\\"
149        application_dir = os.environ["APPDATA"]
150        output_dir = os.path.join(application_dir, version)
151        default_reports_dir = os.path.join(home, "My Documents", "Orange Reports")
152    elif sys.platform == "darwin":
153        application_dir = os.path.join(home, "Library", "Application Support")
154        output_dir = os.path.join(application_dir, version)
155        default_reports_dir = os.path.join(home, "Library",
156                                           "Application Support",
157                                           version, "Reports")
158    else:
159        application_dir = home
160        output_dir = os.path.join(home, "." + version)
161        default_reports_dir = os.path.join(home, "orange-reports")
162
163    add_ons_dir_user = os.path.join(output_dir, "add-ons")
164
165    orange_settings_dir = output_dir
166    canvas_settings_dir = os.path.join(output_dir, "OrangeCanvasQt4")
167    widget_settings_dir = os.path.join(output_dir, "widgetSettingsQt4")
168   
169    if sys.platform == "darwin":
170        buffer_dir = os.path.join(home, "Library", "Caches", version)
171    else:
172        buffer_dir = os.path.join(output_dir, "buffer")
173
174    return locals()
175
176_ALL_ENV_OPTIONS = ["version", "version_display", "is_canvas_installed",
177                    "orange_no_deprecated_members"]
178
179_ALL_DIR_OPTIONS = ["install_dir", "canvas_install_dir",
180                    "widget_install_dir", "icons_install_dir",
181                    "doc_install_dir", "dataset_install_dir", 
182                    "network_install_dir", "add_ons_dir", "add_ons_dir_user",
183                    "application_dir", "output_dir", "default_reports_dir",
184                    "orange_settings_dir", "canvas_settings_dir",
185                    "widget_settings_dir", "buffer_dir"]
186
187def get_platform_option(section, option):
188    """ Return the platform specific configuration `option` from `section`.
189    """
190    try:
191        return parser.get(section + " " + sys.platform, option)
192    except Exception:
193        return parser.get(section, option)
194
195#options read from environment variables
196_ENVIRON_OPTIONS = [ "orange_no_deprecated_members" ]
197
198def _configure_env(defaults=None):
199    """ Apply the configuration files on the default environment
200    and return the instance of SafeConfigParser
201     
202    """
203    if defaults is None:
204        defaults = dict(os.environ)
205        defaults.update(_get_default_env())
206
207    for opt in _ENVIRON_OPTIONS:
208        if opt in os.environ:
209            defaults[opt] = os.environ[opt]
210   
211    parser = ConfigParser.SafeConfigParser(defaults)
212    global_cfg = os.path.join(defaults["install_dir"], "orangerc.cfg")
213    if not parser.read([global_cfg]):
214        pass
215#        import warnings
216#        warnings.warn("Could not read global orange configuration file.")
217
218    # In case the global_cfg does not exist or is empty
219    if not parser.has_section("directories"):
220        parser.add_section("directories")
221    if not parser.has_section("Orange"):
222        parser.add_section("Orange")
223       
224    platform = sys.platform
225    try:
226        application_dir = parser.get("directories " + platform, "application_dir")
227    except Exception:
228        application_dir = parser.get("directories", "application_dir")
229   
230    parser.read([os.path.join(application_dir, "orangerc.cfg"),
231                 os.path.expanduser("~/.orangerc.cfg")])
232   
233    return parser
234
235parser = _configure_env()
236
237for dirname in _ALL_DIR_OPTIONS:
238    globals()[dirname] = get_platform_option("directories", dirname)
239   
240
241if not os.path.isdir(widget_install_dir) or not os.path.isdir(widget_install_dir):
242    # Canvas and widgets are not installed
243    canvas_install_dir = None
244    widget_install_dir = None
245    canvas_settings_dir = None
246    widget_settings_dir = None
247    is_canvas_installed = False
248else:
249    is_canvas_installed = True
250   
251if not os.path.isdir(icons_install_dir):
252    icons_install_dir = ""
253   
254version = parser.get("Orange", "version")
255version_display = parser.get("Orange", "version_display")
256orange_no_deprecated_members = parser.getboolean("Orange", "orange_no_deprecated_members")
257version = get_platform_option("Orange", "version")
258   
259# Create the directories if missing
260_directories_to_create = ["application_dir", "orange_settings_dir",
261        "buffer_dir", "widget_settings_dir", "canvas_settings_dir",
262        "default_reports_dir"]
263
264for dname in _directories_to_create:
265    dname = globals()[dname]
266    if dname is not None and not os.path.isdir(dname):
267        try:
268            os.makedirs(dname)        # Vista has roaming profiles that will say that this folder does not exist and will then fail to create it, because it exists...
269        except Exception:
270            pass
271       
272def samepath(path1, path2):
273    """ Do the paths path1 and path2 point to the same location.
274    """
275    return os.path.normcase(os.path.realpath(os.path.normpath(path1))) == \
276           os.path.normcase(os.path.realpath(os.path.normpath(path2)))
277
278def add_orange_directories_to_path():
279    """Add orange directory paths to sys.path."""
280    paths_to_add = [install_dir]
281
282    if canvas_install_dir is not None:
283        paths_to_add.append(canvas_install_dir)
284
285    # Instead of doing this OrangeWidgets should be a package
286    if widget_install_dir is not None and os.path.isdir(widget_install_dir):
287        paths_to_add.append(widget_install_dir)
288        default_widgets_dirs = [os.path.join(widget_install_dir, x) \
289                                for x in os.listdir(widget_install_dir) \
290                                if os.path.isdir(os.path.join(widget_install_dir, x))]
291        paths_to_add.extend(default_widgets_dirs)
292
293    for path in paths_to_add:
294        if os.path.isdir(path) and not any([samepath(path, x) for x in sys.path]):
295            sys.path.insert(0, path)
296           
297add_orange_directories_to_path()
298directories = dict([(dname, globals()[dname]) for dname in _ALL_DIR_OPTIONS])
Note: See TracBrowser for help on using the repository browser.