source: orange/Orange/OrangeCanvas/orngRegistry.py @ 11018:b7cbf2b86522

Revision 11018:b7cbf2b86522, 12.2 KB checked in by Matija Polajnar <matija.polajnar@…>, 18 months ago (diff)

Rewrite the add-on support modules and GUI to support the new properly packed add-ons, published on PyPI.

Line 
1# Author: Gregor Leban (gregor.leban@fri.uni-lj.si)
2#
3
4import os, sys, re, glob, stat
5import pkg_resources
6from orngSignalManager import OutputSignal, InputSignal, resolveSignal
7from PyQt4.QtCore import *
8from PyQt4.QtGui import *
9import widgetParser
10
11orangeDir = os.path.split(os.path.split(os.path.abspath(__file__))[0])[0]
12if not orangeDir in sys.path:
13    sys.path.append(orangeDir)
14
15import orngEnviron, Orange.utils.addons
16from Orange.utils import addons
17
18WIDGETS_ENTRY_POINT = 'orange.widgets'
19
20class WidgetDescription(object):
21    def __init__(self, **attrs):
22        self.__dict__.update(attrs)
23
24    def docDir(self):
25        if not self.addOn:  # A built-in widget
26            dir, widgetDir = os.path.realpath(self.directory), os.path.realpath(orngEnviron.widgetDir)
27            subDir = os.path.relpath(dir, widgetDir) if "relpath" in os.path.__dict__ else dir.replace(widgetDir, "")
28            return os.path.join(orngEnviron.orangeDocDir, "widgets", subDir)
29        else:  # An add-on widget
30            return None  # new style add-ons only have on-line documentation
31            #addOnDocDir = self.addOn.directory_documentation()
32            #return os.path.join(addOnDocDir, "widgets")
33
34
35class WidgetCategory(dict):
36    def __init__(self, name, widgets=None):
37        if widgets:
38            self.update(widgets)
39        self.name = name
40
41def load_new_addons(directories = []):
42    # New-type add-ons
43    for entry_point in pkg_resources.iter_entry_points(WIDGETS_ENTRY_POINT):
44        try:
45            module = entry_point.load()
46            if hasattr(module, '__path__'):
47                # It is a package
48                directories.append((entry_point.name, module.__path__[0], entry_point.name, False, module))
49            else:
50                # It is a module
51                # TODO: Implement loading of widget modules
52                # (This should be default way to load widgets, not parsing them as files, or traversing directories, just modules and packages (which load modules))
53                pass
54        except ImportError, err:
55            print "While loading, importing widgets '%s' failed: %s" % (entry_point.name, err)
56        except pkg_resources.DistributionNotFound, err:
57            print "Loading add-on '%s' failed because of a missing dependency: '%s'" % (entry_point.name, err)
58        except Exception, err:
59            print "An exception occurred during the loading of '%s':\n%r" %(entry_point.name, err)
60    return directories
61
62def readCategories(silent=False):
63    try:
64        from Orange.version import version as orange_version
65    except ImportError:
66        # Orange.version module is writen by setup.py, what if orange was build
67        # using make
68        orange_version = "???"
69    # Add orange version to the cache version (because cache contains names
70    # of types inside the Orange hierarchy, if that changes the cache should be
71    # invalidated)
72    currentCacheVersion = (3, orange_version)
73   
74    global widgetsWithError, widgetsWithErrorPrototypes
75    widgetDirName = os.path.realpath(orngEnviron.directoryNames["widgetDir"])
76    canvasSettingsDir = os.path.realpath(orngEnviron.directoryNames["canvasSettingsDir"])
77    cacheFilename = os.path.join(canvasSettingsDir, "cachedWidgetDescriptions.pickle")
78
79    try:
80        import cPickle
81        cacheFile = file(cacheFilename, "rb")
82        cats = cPickle.load(cacheFile)
83        try:
84            version = cPickle.load(cacheFile)
85        except EOFError:
86            version = 0
87        if version == currentCacheVersion:
88            cachedWidgetDescriptions = dict([(w.fullName, w) for cat in cats.values() for w in cat.values()])
89        else:
90            cachedWidgetDescriptions = {}
91    except Exception:
92        cachedWidgetDescriptions = {} 
93
94    directories = [] # tuples (defaultCategory, dirName, plugin, isPrototype)
95    for dirName in os.listdir(widgetDirName):
96        directory = os.path.join(widgetDirName, dirName)
97        if os.path.isdir(directory):
98            directories.append((None, directory, None, "prototypes" in dirName.lower(), None))
99           
100    # read list of add-ons
101    #TODO Load registered add-ons!
102
103    load_new_addons(directories)
104
105    categories = {}     
106    for defCat, dirName, addOn, isPrototype, module in directories:
107        widgets = readWidgets(dirName, cachedWidgetDescriptions, isPrototype, silent=silent, addOn=addOn, defaultCategory=defCat, module=module)
108        for (wName, wInfo) in widgets:
109            catName = wInfo.category
110            if not catName in categories:
111                categories[catName] = WidgetCategory(catName)
112            if wName in categories[catName]:
113                print "Warning! A widget with duplicated name '%s' in category '%s' has been found! It will _not_ be available in the Canvas." % (wName, catName)
114            else:
115                categories[catName][wName] = wInfo
116
117    cacheFile = file(cacheFilename, "wb")
118    cPickle.dump(categories, cacheFile)
119    cPickle.dump(currentCacheVersion, cacheFile)
120    if splashWindow:
121        splashWindow.hide()
122
123    if not silent:
124        if widgetsWithError != []:
125            print "The following widgets could not be imported and will not be available: " + ", ".join(set(widgetsWithError)) + "."
126        if widgetsWithErrorPrototypes != []:
127            print "The following prototype widgets could not be imported and will not be available: " + ", ".join(set(widgetsWithErrorPrototypes)) + "."
128
129    return categories
130
131
132hasErrors = False
133splashWindow = None
134widgetsWithError = []
135widgetsWithErrorPrototypes = []
136
137def readWidgets(directory, cachedWidgetDescriptions, prototype=False, silent=False, addOn=None, defaultCategory=None, module=None):
138    import sys
139    global hasErrors, splashWindow, widgetsWithError, widgetsWithErrorPrototypes
140   
141    widgets = []
142
143    if not defaultCategory:
144        predir, defaultCategory = os.path.split(directory.strip(os.path.sep).strip(os.path.altsep))
145        if defaultCategory == "widgets":
146            defaultCategory = os.path.split(predir.strip(os.path.sep).strip(os.path.altsep))[1]
147   
148    if defaultCategory.lower() == "prototypes" or prototype:
149        defaultCategory = "Prototypes"
150   
151    if module:
152        files = [f for f in pkg_resources.resource_listdir(module.__name__, '') if f.endswith('.py')]
153    else:
154        files = glob.iglob(os.path.join(directory, "*.py"))
155
156    for filename in files:
157        if module:
158            if pkg_resources.resource_isdir(module.__name__, filename):
159                continue
160        else:
161            if os.path.isdir(filename):
162                continue
163       
164        if module:
165            if getattr(module, '__loader__', None):
166                datetime = str(os.stat(module.__loader__.archive)[stat.ST_MTIME])
167            else:
168                datetime = str(os.stat(pkg_resources.resource_filename(module.__name__, filename))[stat.ST_MTIME])
169        else:
170            datetime = str(os.stat(filename)[stat.ST_MTIME])
171        cachedDescription = cachedWidgetDescriptions.get(filename, None)
172        if cachedDescription and cachedDescription.time == datetime and hasattr(cachedDescription, "inputClasses"):
173            widgets.append((cachedDescription.name, cachedDescription))
174            continue
175        if module:
176            data = pkg_resources.resource_string(module.__name__, filename)
177        else:
178            data = file(filename).read()
179        try:
180            meta = widgetParser.WidgetMetaData(data, defaultCategory, enforceDefaultCategory=prototype)
181        except:   # Probably not an Orange widget module.
182            continue
183
184        widgetPrototype = meta.prototype == "1" or meta.prototype.lower().strip() == "true" or prototype
185        if widgetPrototype:
186            meta.category = "Prototypes"
187
188        dirname, fname = os.path.split(filename)
189        widgname = os.path.splitext(fname)[0]
190        try:
191            if not splashWindow:
192                import orngEnviron
193                logo = QPixmap(os.path.join(orngEnviron.directoryNames["canvasDir"], "icons", "splash.png"))
194                splashWindow = QSplashScreen(logo, Qt.WindowStaysOnTopHint)
195                splashWindow.setMask(logo.mask())
196                splashWindow.show()
197
198            splashWindow.showMessage("Registering widget %s" % meta.name, Qt.AlignHCenter + Qt.AlignBottom)
199            qApp.processEvents()
200
201            if module:
202                import_name = "%s.%s" % (module.__name__, widgname)
203            else:
204                import_name = widgname
205            wmod = __import__(import_name, fromlist=[""])
206
207            wmodFilename = wmod.__file__
208            if os.path.splitext(wmodFilename)[1] != "py":
209                # Replace .pyc, .pyo with bare .py extension
210                # (used as key in cachedWidgetDescription)
211                wmodFilename = os.path.splitext(wmodFilename)[0] + ".py"
212
213            # Evaluate the input/output list (all tuple items are strings)
214            inputs = eval(meta.inputList)
215            outputs = eval(meta.outputList)
216
217            inputs = [InputSignal(*input) for input in inputs]
218            outputs = [OutputSignal(*output) for output in outputs]
219
220            # Resolve signal type names into concrete type instances
221            inputs = [resolveSignal(input, globals=wmod.__dict__)
222                      for input in inputs]
223            outputs = [resolveSignal(output, globals=wmod.__dict__)
224                      for output in outputs]
225
226            inputClasses = set([s.type.__name__ for s in inputs])
227            outputClasses = set([klass.__name__ for s in outputs
228                                 for klass in s.type.mro()])
229
230            # Convert all signal types back into qualified names.
231            # This is to prevent any possible import problems when cached
232            # descriptions are unpickled (the relevant code using this lists
233            # should be able to handle missing types better).
234            for s in inputs + outputs:
235                s.type = "%s.%s" % (s.type.__module__, s.type.__name__)
236
237            widgetInfo = WidgetDescription(
238                             name = meta.name,
239                             time = datetime,
240                             fileName = widgname,
241                             module = module.__name__ if module else None,
242                             fullName = wmodFilename,
243                             directory = directory,
244                             addOn = addOn,
245                             inputList = meta.inputList, outputList = meta.outputList,
246                             inputClasses = inputClasses, outputClasses = outputClasses,
247                             tags=meta.tags,
248                             inputs=inputs,
249                             outputs=outputs,
250                             )
251
252            for attr in ["contact", "icon", "priority", "description", "category"]:
253                setattr(widgetInfo, attr, getattr(meta, attr))
254
255            # build the tooltip
256            if len(widgetInfo.inputs) == 0:
257                formatedInList = "<b>Inputs:</b><br> &nbsp;&nbsp; None<br>"
258            else:
259                formatedInList = "<b>Inputs:</b><br>"
260                for signal in widgetInfo.inputs:
261                    formatedInList += " &nbsp;&nbsp; - " + signal.name + " (" + signal.type + ")<br>"
262
263            if len(widgetInfo.outputs) == 0:
264                formatedOutList = "<b>Outputs:</b><br> &nbsp; &nbsp; None<br>"
265            else:
266                formatedOutList = "<b>Outputs:</b><br>"
267                for signal in widgetInfo.outputs:
268                    formatedOutList += " &nbsp; &nbsp; - " + signal.name + " (" + signal.type + ")<br>"
269
270            addOnName = "" if not widgetInfo.addOn else " (from add-on %s)" % widgetInfo.addOn
271   
272            widgetInfo.tooltipText = "<b><b>&nbsp;%s</b></b>%s<hr><b>Description:</b><br>&nbsp;&nbsp;%s<hr>%s<hr>%s" % (meta.name, addOnName, widgetInfo.description, formatedInList[:-4], formatedOutList[:-4]) 
273            widgets.append((meta.name, widgetInfo))
274        except Exception, msg:
275            if not hasErrors and not silent:
276                print "There were problems importing the following widgets:"
277                hasErrors = True
278            if not silent:
279                print "   %s: %s" % (widgname, msg)
280
281            if not widgetPrototype:
282                widgetsWithError.append(widgname)
283            else:
284                widgetsWithErrorPrototypes.append(widgname)
285       
286    return widgets
Note: See TracBrowser for help on using the repository browser.