source: orange/Orange/OrangeCanvas/orngRegistry.py @ 10827:8527a7511c4f

Revision 10827:8527a7511c4f, 12.0 KB checked in by mitar, 2 years ago (diff)

Support for widgets loading from modules, registered through entry point.

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.__name__))
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
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, imp
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    for filename in glob.iglob(os.path.join(directory, "*.py")):
152        if os.path.isdir(filename):
153            continue
154       
155        datetime = str(os.stat(filename)[stat.ST_MTIME])
156        cachedDescription = cachedWidgetDescriptions.get(filename, None)
157        if cachedDescription and cachedDescription.time == datetime and hasattr(cachedDescription, "inputClasses"):
158            widgets.append((cachedDescription.name, cachedDescription))
159            continue
160       
161        data = file(filename).read()
162        try:
163            meta = widgetParser.WidgetMetaData(data, defaultCategory, enforceDefaultCategory=prototype)
164        except:   # Probably not an Orange widget module.
165            continue
166
167        widgetPrototype = meta.prototype == "1" or meta.prototype.lower().strip() == "true" or prototype
168        if widgetPrototype:
169            meta.category = "Prototypes"
170
171        dirname, fname = os.path.split(filename)
172        widgname = os.path.splitext(fname)[0]
173        try:
174            if not splashWindow:
175                import orngEnviron
176                logo = QPixmap(os.path.join(orngEnviron.directoryNames["canvasDir"], "icons", "splash.png"))
177                splashWindow = QSplashScreen(logo, Qt.WindowStaysOnTopHint)
178                splashWindow.setMask(logo.mask())
179                splashWindow.show()
180               
181            splashWindow.showMessage("Registering widget %s" % meta.name, Qt.AlignHCenter + Qt.AlignBottom)
182            qApp.processEvents()
183           
184            # We import modules using imp.load_source to avoid storing them in sys.modules,
185            # but we need to append the path to sys.path in case the module would want to load
186            # something
187            dirnameInPath = dirname in sys.path
188            if not dirnameInPath:
189                sys.path.append(dirname)
190            if module:
191                wmod = imp.load_source("%s.%s" % (module, widgname), filename)
192            else:
193                wmod = imp.load_source(widgname, filename)
194            if not dirnameInPath and dirname in sys.path: # I have no idea, why we need this, but it seems to disappear sometimes?!
195                sys.path.remove(dirname)
196            widgClass = wmod.__dict__[widgname]
197
198            # Evaluate the input/output list (all tuple items are strings)
199            inputs = eval(meta.inputList)
200            outputs = eval(meta.outputList)
201
202            inputs = [InputSignal(*input) for input in inputs]
203            outputs = [OutputSignal(*output) for output in outputs]
204
205            # Resolve signal type names into concrete type instances
206            inputs = [resolveSignal(input, globals=wmod.__dict__)
207                      for input in inputs]
208            outputs = [resolveSignal(output, globals=wmod.__dict__)
209                      for output in outputs]
210
211            inputClasses = set([s.type.__name__ for s in inputs])
212            outputClasses = set([klass.__name__ for s in outputs
213                                 for klass in s.type.mro()])
214
215            # Convert all signal types back into qualified names.
216            # This is to prevent any possible import problems when cached
217            # descriptions are unpickled (the relevant code using this lists
218            # should be able to handle missing types better).
219            for s in inputs + outputs:
220                s.type = "%s.%s" % (s.type.__module__, s.type.__name__)
221
222            widgetInfo = WidgetDescription(
223                             name =meta.name,
224                             time = datetime,
225                             fileName = widgname,
226                             module = module,
227                             fullName = filename,
228                             directory = directory,
229                             addOn = addOn,
230                             inputList = meta.inputList, outputList = meta.outputList,
231                             inputClasses = inputClasses, outputClasses = outputClasses,
232                             tags=meta.tags,
233                             inputs=inputs,
234                             outputs=outputs,
235                             )
236
237            for attr in ["contact", "icon", "priority", "description", "category"]:
238                setattr(widgetInfo, attr, getattr(meta, attr))
239
240            # build the tooltip
241            if len(widgetInfo.inputs) == 0:
242                formatedInList = "<b>Inputs:</b><br> &nbsp;&nbsp; None<br>"
243            else:
244                formatedInList = "<b>Inputs:</b><br>"
245                for signal in widgetInfo.inputs:
246                    formatedInList += " &nbsp;&nbsp; - " + signal.name + " (" + signal.type + ")<br>"
247
248            if len(widgetInfo.outputs) == 0:
249                formatedOutList = "<b>Outputs:</b><br> &nbsp; &nbsp; None<br>"
250            else:
251                formatedOutList = "<b>Outputs:</b><br>"
252                for signal in widgetInfo.outputs:
253                    formatedOutList += " &nbsp; &nbsp; - " + signal.name + " (" + signal.type + ")<br>"
254
255            addOnName = "" if not widgetInfo.addOn else " (from add-on %s)" % widgetInfo.addOn.name
256   
257            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]) 
258            widgets.append((meta.name, widgetInfo))
259        except Exception, msg:
260            if not hasErrors and not silent:
261                print "There were problems importing the following widgets:"
262                hasErrors = True
263            if not silent:
264                print "   %s: %s" % (widgname, msg)
265
266            if not widgetPrototype:
267                widgetsWithError.append(widgname)
268            else:
269                widgetsWithErrorPrototypes.append(widgname)
270       
271    return widgets
Note: See TracBrowser for help on using the repository browser.