source: orange/Orange/utils/addons.py @ 11597:2f4fbcb6396d

Revision 11597:2f4fbcb6396d, 10.9 KB checked in by Ales Erjavec <ales.erjavec@…>, 10 months ago (diff)

Delete global addons variable after use.

Line 
1from __future__ import absolute_import
2"""
3==============================
4Add-on Management (``addons``)
5==============================
6
7.. index:: add-ons
8
9Orange.utils.addons module provides a framework for Orange add-on management. As
10soon as it is imported, the following initialization takes place: the list of
11installed add-ons is loaded, their directories are added to python path
12(:obj:`sys.path`) the callback list is initialized, the stored repository list is
13loaded. The most important consequence of importing the module is thus the
14injection of add-ons into the namespace.
15
16"""
17
18#TODO Document this module.
19
20import socket
21import shelve
22import xmlrpclib
23import warnings
24import re
25import pkg_resources
26import tempfile
27import tarfile
28import shutil
29import os
30import sys
31import platform
32import subprocess
33
34from collections import namedtuple, defaultdict
35from contextlib import closing
36
37import Orange.utils.environ
38
39ADDONS_ENTRY_POINT="orange.addons"
40
41socket.setdefaulttimeout(120)  # In seconds.
42
43OrangeAddOn = namedtuple('OrangeAddOn', ['name', 'available_version', 'installed_version', 'summary', 'description',
44                                         'author', 'docs_url', 'keywords', 'homepage', 'package_url',
45                                         'release_url', 'release_size', 'python_version'])
46#It'd be great if we could somehow read a list and descriptions of widgets, show them in the dialog and enable
47#search of add-ons based on keywords in widget names and descriptions.
48
49INDEX_RE = "[^a-z0-9-']"  # RE for splitting entries in the search index
50
51AOLIST_FILE = os.path.join(Orange.utils.environ.orange_settings_dir, "addons.shelve")
52def open_addons():
53    try:
54        addons = shelve.open(AOLIST_FILE, 'c')
55        if any(name != name.lower() for name, record in addons.items()):  # Try to read the whole list and check for sanity.
56            raise Exception("Corrupted add-on list.")
57    except:
58        if os.path.isfile(AOLIST_FILE):
59            os.remove(AOLIST_FILE)
60        addons = shelve.open(AOLIST_FILE, 'n')
61    return addons
62
63global addons_corrupted
64with closing(open_addons()) as addons:
65    addons_corrupted = len(addons)==0
66
67del addons
68
69addon_refresh_callback = []
70
71global index
72index = defaultdict(list)
73def rebuild_index():
74    global index
75
76    index = defaultdict(list)
77    with closing(open_addons()) as addons:
78        for name, ao in addons.items():
79            for s in [name, ao.summary, ao.description, ao.author] + (ao.keywords if ao.keywords else []):
80                if not s:
81                    continue
82                words = [word for word in re.split(INDEX_RE, s.lower())
83                         if len(word)>1]
84                for word in words:
85                    for i in range(len(word)):
86                        index[word[:i+1]].append(name)
87
88def search_index(query):
89    global index
90    result = set()
91    words = [word for word in re.split(INDEX_RE, query.lower()) if len(word)>1]
92    if not words:
93        with closing(open_addons()) as addons:
94            return addons.keys()
95    for word in words:
96        result.update(index[word])
97    return result
98
99def refresh_available_addons(force=False, progress_callback=None):
100    pypi = xmlrpclib.ServerProxy('http://pypi.python.org/pypi')
101    if progress_callback:
102        progress_callback(1, 0)
103
104    pkg_dict = {}
105    for data in pypi.search({'keywords': 'orange'}):
106        name = data['name']
107        order = data['_pypi_ordering']
108        if name not in pkg_dict or pkg_dict[name][0] < order:
109            pkg_dict[name] = (order, data['version'])
110
111    try:
112        import slumber
113        readthedocs = slumber.API(base_url='http://readthedocs.org/api/v1/')
114    except:
115        readthedocs = None
116
117    global addons_corrupted
118    docs = {}
119    if progress_callback:
120        progress_callback(len(pkg_dict)+1, 1)
121    with closing(open_addons()) as addons:
122        for i, (name, (_, version)) in enumerate(pkg_dict.items()):
123            if force or name not in addons or addons[name.lower()].available_version != version:
124                try:
125                    data = pypi.release_data(name, version)
126                    rel = pypi.release_urls(name, version)[0]
127
128                    if readthedocs:
129                        try:
130                            docs = readthedocs.project.get(slug=name.lower())['objects'][0]
131                        except:
132                            docs = {}
133                    addons[name.lower()] = OrangeAddOn(name = name,
134                                               available_version = data['version'],
135                                               installed_version = addons[name.lower()].installed_version if name.lower() in addons else None,
136                                               summary = data['summary'],
137                                               description = data.get('description', ''),
138                                               author = str((data.get('author', '') or '') + ' ' + (data.get('author_email', '') or '')).strip(),
139                                               docs_url = data.get('docs_url', docs.get('subdomain', '')),
140                                               keywords = data.get('keywords', "").split(","),
141                                               homepage = data.get('home_page', ''),
142                                               package_url = data.get('package_url', ''),
143                                               release_url = rel.get('url', None),
144                                               release_size = rel.get('size', -1),
145                                               python_version = rel.get('python_version', None))
146                except Exception, e:
147                    import traceback
148                    traceback.print_exc()
149                    warnings.warn('Could not load data for the following add-on: %s'%name)
150            if progress_callback:
151                progress_callback(len(pkg_dict)+1, i+2)
152        addons_corrupted = False
153
154    rebuild_index()
155
156def load_installed_addons():
157    found = set()
158    with closing(open_addons()) as addons:
159        for entry_point in pkg_resources.iter_entry_points(ADDONS_ENTRY_POINT):
160            name, version = entry_point.dist.project_name, entry_point.dist.version
161            #TODO We could import setup.py from entry_point.location and load descriptions and such ...
162            if name.lower() in addons:
163                addons[name.lower()] = addons[name.lower()]._replace(installed_version = version)
164            else:
165                addons[name.lower()] = OrangeAddOn(name = name,
166                    available_version = None,
167                    installed_version = version,
168                    summary = "",
169                    description = "",
170                    author = "",
171                    docs_url = "",
172                    keywords = "",
173                    homepage = "",
174                    package_url = "",
175                    release_url = "",
176                    release_size = None,
177                    python_version = None)
178            found.add(name.lower())
179        for name in set(addons).difference(found):
180            addons[name.lower()] = addons[name.lower()]._replace(installed_version = None)
181    rebuild_index()
182
183
184def run_setup(setup_script, args):
185    """
186    Run `setup_script` with `args` in a subprocess, using
187    :ref:`subprocess.check_output`.
188
189    """
190    source_root = os.path.dirname(setup_script)
191    executable = sys.executable
192    extra_kwargs = {}
193    if os.name == "nt" and os.path.basename(executable) == "pythonw.exe":
194        dirname, _ = os.path.split(executable)
195        executable = os.path.join(dirname, "python.exe")
196        # by default a new console window would show up when executing the
197        # script
198        startupinfo = subprocess.STARTUPINFO()
199        startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW
200        extra_kwargs["startupinfo"] = startupinfo
201
202    subprocess.check_output([executable, setup_script] + args,
203                             cwd=source_root,
204                             stderr=subprocess.STDOUT,
205                             **extra_kwargs)
206
207
208def install(name, progress_callback=None):
209    if progress_callback:
210        progress_callback(1, 0)
211    import site
212    try:
213        import urllib
214        rh = (lambda done, bs, fs: progress_callback(fs/bs, done)) if progress_callback else None
215        with closing(open_addons()) as addons:
216            egg = urllib.urlretrieve(addons[name.lower()].release_url, reporthook=rh)[0]
217    except Exception, e:
218        raise Exception("Unable to download add-on from repository: %s" % e)
219
220    try:
221        try:
222            tmpdir = tempfile.mkdtemp()
223            egg_contents = tarfile.open(egg)
224            egg_contents.extractall(tmpdir)
225            with closing(open_addons()) as addons:
226                setup_py = os.path.join(tmpdir, name+'-'+addons[name.lower()].available_version, 'setup.py')
227        except Exception, e:
228            raise Exception("Unable to unpack add-on: %s" % e)
229
230        if not os.path.isfile(setup_py):
231            raise Exception("Unable to install add-on - it is not properly packed.")
232
233        switches = []
234        if site.USER_SITE in sys.path:   # we're not in a virtualenv
235            switches.append('--user')
236        run_setup(setup_py, ['install'] + switches)
237    finally:
238        shutil.rmtree(tmpdir, ignore_errors=True)
239
240    for p in list(sys.path):
241        site.addsitedir(p)
242    reload(pkg_resources)
243    for p in list(sys.path):
244        pkg_resources.find_distributions(p)
245    from orngRegistry import load_new_addons
246    load_new_addons()
247    load_installed_addons()
248    for func in addon_refresh_callback:
249        func()
250
251def uninstall(name, progress_callback=None):
252    try:
253        import pip.req
254        ao = pip.req.InstallRequirement(name, None)
255        ao.uninstall(True)
256    except ImportError:
257        raise Exception("Pip is required for add-on uninstallation. Install pip and try again.")
258
259def upgrade(name, progress_callback=None):
260    install(name, progress_callback)
261
262load_installed_addons()
263
264
265
266# Support for loading legacy "registered" add-ons
267def __read_addons_list(addons_file, systemwide):
268    if os.path.isfile(addons_file):
269        return [tuple([x.strip() for x in lne.split("\t")])
270                for lne in file(addons_file, "rt")]
271    else:
272        return []
273
274registered = __read_addons_list(os.path.join(Orange.utils.environ.orange_settings_dir, "add-ons.txt"), False) + \
275             __read_addons_list(os.path.join(Orange.utils.environ.install_dir, "add-ons.txt"), True)
276
277for name, path in registered:
278    for p in [os.path.join(path, "widgets", "prototypes"),
279          os.path.join(path, "widgets"),
280          path,
281          os.path.join(path, "lib-%s" % "-".join(( sys.platform, "x86" if (platform.machine()=="")
282          else platform.machine(), ".".join(map(str, sys.version_info[:2])) )) )]:
283        if os.path.isdir(p) and not any([Orange.utils.environ.samepath(p, x)
284                                         for x in sys.path]):
285            if p not in sys.path:
286                sys.path.insert(0, p)
287
288#TODO Show some progress to the user at least during the installation procedure.
Note: See TracBrowser for help on using the repository browser.