source: orange/Orange/misc/environ.py @ 10146:80e163c40e39

Revision 10146:80e163c40e39, 10.3 KB checked in by ales_erjavec, 2 years ago (diff)

Removed install_dir from the paths included to sys.path in Orange.misc.environ.

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    install_dir = os.path.dirname(os.path.abspath(__file__)) # Orange/misc
127    install_dir = os.path.dirname(install_dir) # Orange/
128
129    doc_install_dir = os.path.join(install_dir, "doc")
130    dataset_install_dir = os.path.join(install_dir, "doc", "datasets")
131    network_install_dir = os.path.join(install_dir, "doc", "networks")
132
133    canvas_install_dir = os.path.join(install_dir, "OrangeCanvas")
134    widget_install_dir = os.path.join(install_dir, "OrangeWidgets")
135    icons_install_dir = os.path.join(widget_install_dir, "icons")
136    add_ons_dir = os.path.join(install_dir, "add-ons")
137
138    home = os.path.expanduser("~/")
139   
140    if sys.platform == "win32":
141        if home[-1] == ":":
142            home += "\\"
143        application_dir = os.environ["APPDATA"]
144        output_dir = os.path.join(application_dir, version)
145        default_reports_dir = os.path.join(home, "My Documents")
146    elif sys.platform == "darwin":
147        application_dir = os.path.join(home, "Library", "Application Support")
148        output_dir = os.path.join(application_dir, version)
149        default_reports_dir = os.path.join(home, "Documents")
150    else:
151        application_dir = home
152        output_dir = os.path.join(home, "." + version)
153       
154        documents = os.path.join(home, "Documents")
155        # Need to make sure Documents folder actually exists
156        if os.path.exists(documents) and os.path.isdir(documents):
157            default_reports_dir = documents
158        else:
159            default_reports_dir = home
160
161    add_ons_dir_user = os.path.join(output_dir, "add-ons")
162
163    orange_settings_dir = output_dir
164    canvas_settings_dir = os.path.join(output_dir, "OrangeCanvasQt4")
165    widget_settings_dir = os.path.join(output_dir, "widgetSettingsQt4")
166   
167    if sys.platform == "darwin":
168        buffer_dir = os.path.join(home, "Library", "Caches", version)
169    else:
170        buffer_dir = os.path.join(output_dir, "buffer")
171
172    return locals()
173
174_ALL_ENV_OPTIONS = ["version", "version_display", "is_canvas_installed",
175                    "orange_no_deprecated_members"]
176
177_ALL_DIR_OPTIONS = ["install_dir", "canvas_install_dir",
178                    "widget_install_dir", "icons_install_dir",
179                    "doc_install_dir", "dataset_install_dir", 
180                    "network_install_dir", "add_ons_dir", "add_ons_dir_user",
181                    "application_dir", "output_dir", "default_reports_dir",
182                    "orange_settings_dir", "canvas_settings_dir",
183                    "widget_settings_dir", "buffer_dir"]
184
185def get_platform_option(section, option):
186    """ Return the platform specific configuration `option` from `section`.
187    """
188    try:
189        return parser.get(section + " " + sys.platform, option)
190    except Exception:
191        return parser.get(section, option)
192
193#options read from environment variables
194_ENVIRON_OPTIONS = [ "orange_no_deprecated_members" ]
195
196def _configure_env(defaults=None):
197    """ Apply the configuration files on the default environment
198    and return the instance of SafeConfigParser
199     
200    """
201    if defaults is None:
202        defaults = dict(os.environ)
203        defaults.update(_get_default_env())
204
205    for opt in _ENVIRON_OPTIONS:
206        if opt in os.environ:
207            defaults[opt] = os.environ[opt]
208   
209    parser = ConfigParser.SafeConfigParser(defaults)
210    global_cfg = os.path.join(defaults["install_dir"], "orangerc.cfg")
211    if not parser.read([global_cfg]):
212        pass
213#        import warnings
214#        warnings.warn("Could not read global orange configuration file.")
215
216    # In case the global_cfg does not exist or is empty
217    if not parser.has_section("directories"):
218        parser.add_section("directories")
219    if not parser.has_section("Orange"):
220        parser.add_section("Orange")
221       
222    platform = sys.platform
223    try:
224        application_dir = parser.get("directories " + platform, "application_dir")
225    except Exception:
226        application_dir = parser.get("directories", "application_dir")
227   
228    parser.read([os.path.join(application_dir, "orangerc.cfg"),
229                 os.path.expanduser("~/.orangerc.cfg")])
230   
231    return parser
232
233parser = _configure_env()
234
235for dirname in _ALL_DIR_OPTIONS:
236    globals()[dirname] = get_platform_option("directories", dirname)
237   
238
239if not os.path.isdir(widget_install_dir) or not os.path.isdir(widget_install_dir):
240    # Canvas and widgets are not installed
241    canvas_install_dir = None
242    widget_install_dir = None
243    canvas_settings_dir = None
244    widget_settings_dir = None
245    is_canvas_installed = False
246else:
247    is_canvas_installed = True
248   
249if not os.path.isdir(icons_install_dir):
250    icons_install_dir = ""
251   
252version = parser.get("Orange", "version")
253version_display = parser.get("Orange", "version_display")
254orange_no_deprecated_members = parser.getboolean("Orange", "orange_no_deprecated_members")
255version = get_platform_option("Orange", "version")
256   
257# Create the directories if missing
258# TODO: This are not needed if using orange without the GUI
259
260_directories_to_create = ["application_dir", "orange_settings_dir",
261        "buffer_dir", "widget_settings_dir", "canvas_settings_dir"]
262
263for dname in _directories_to_create:
264    dname = globals()[dname]
265    if dname is not None and not os.path.isdir(dname):
266        try:
267            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...
268        except Exception:
269            pass
270       
271def samepath(path1, path2):
272    """ Do the paths path1 and path2 point to the same location.
273    """
274    return os.path.normcase(os.path.realpath(os.path.normpath(path1))) == \
275           os.path.normcase(os.path.realpath(os.path.normpath(path2)))
276
277def add_orange_directories_to_path():
278    """Add orange directory paths to sys.path."""
279
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.