source: orange/Orange/OrangeCanvas/orngRegistry.py @ 10879:1707c807d6f4

Revision 10879:1707c807d6f4, 12.7 KB checked in by Ales Erjavec <ales.erjavec@…>, 2 years ago (diff)

Handle all exceptions when entry_points loading fails.

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