added a test to check how exception handling works with Win32 SEH; corrected copyright

[wxWidgets.git] / wxPython / wxversion / wxversion.py

diff --git a/wxPython/wxversion/wxversion.py b/wxPython/wxversion/wxversion.py
index ca7f2c505521f707c6d56193c6294557273d50bf..b024966706d244e548399de6d548cf1faae1a822 100644 (file)
--- a/wxPython/wxversion/wxversion.py
+++ b/wxPython/wxversion/wxversion.py
@@ -34,13 +34,13 @@ selection itself rather than depend on the user to setup the
 environment correctly.
 
 It works by searching the sys.path for directories matching wx-* and
 environment correctly.
 
 It works by searching the sys.path for directories matching wx-* and

-then comparing them to what was passed to the require function.  If a
+then comparing them to what was passed to the select function.  If a

 match is found then that path is inserted into sys.path.
 
 NOTE: If you are making a 'bundle' of your application with a tool
 like py2exe then you should *not* use the wxversion module since it
 match is found then that path is inserted into sys.path.
 
 NOTE: If you are making a 'bundle' of your application with a tool
 like py2exe then you should *not* use the wxversion module since it

-looks at filesystem for the directories on sys.path, it will fail in a
-bundled environment.  Instead you should simply ensure that the
+looks at the filesystem for the directories on sys.path, it will fail
+in a bundled environment.  Instead you should simply ensure that the

 version of wxPython that you want is found by default on the sys.path
 when making the bundled version by setting PYTHONPATH.  Then that
 version will be included in your bundle and your app will work as
 version of wxPython that you want is found by default on the sys.path
 when making the bundled version by setting PYTHONPATH.  Then that
 version will be included in your bundle and your app will work as


@@ -53,6 +53,9 @@ that and only use wxversion if needed.  For example, for py2exe::
         wxversion.select('2.5')
     import wx
 
         wxversion.select('2.5')
     import wx
 

+More documentation on wxversion and multi-version installs can be
+found at: http://wiki.wxpython.org/index.cgi/MultiVersionInstalls
+

 """
 
 import sys, os, glob, fnmatch
 """
 
 import sys, os, glob, fnmatch


@@ -103,15 +106,15 @@ def select(versions):
         # otherwise, raise an exception
         raise VersionError("A previously selected wx version does not match the new request.")
 
         # otherwise, raise an exception
         raise VersionError("A previously selected wx version does not match the new request.")
 

-    # If we get here then this is the first time wxversion is used.
-    # Ensure that wxPython hasn't been imported yet.
+    # If we get here then this is the first time wxversion is used, 
+    # ensure that wxPython hasn't been imported yet.

     if sys.modules.has_key('wx') or sys.modules.has_key('wxPython'):
     if sys.modules.has_key('wx') or sys.modules.has_key('wxPython'):

-        raise VersionError("wxversion.require() must be called before wxPython is imported")
-
+        raise VersionError("wxversion.select() must be called before wxPython is imported")
+    

     # Look for a matching version and manipulate the sys.path as
     # needed to allow it to be imported.
     # Look for a matching version and manipulate the sys.path as
     # needed to allow it to be imported.

-    packages = _find_installed(True)
-    bestMatch = _get_best_match(packages, versions)
+    installed = _find_installed(True)
+    bestMatch = _get_best_match(installed, versions)

     
     if bestMatch is None:
         raise VersionError("Requested version of wxPython not found")
     
     if bestMatch is None:
         raise VersionError("Requested version of wxPython not found")


@@ -121,6 +124,63 @@ def select(versions):
         
 #----------------------------------------------------------------------
 
         
 #----------------------------------------------------------------------
 

+UPDATE_URL = "http://wxPython.org/"
+#UPDATE_URL = "http://sourceforge.net/project/showfiles.php?group_id=10718"
+
+
+def ensureMinimal(minVersion):
+    """
+    Checks to see if the default version of wxPython is greater-than
+    or equal to `minVersion`.  If not then it will try to find an
+    installed version that is >= minVersion.  If none are available
+    then a message is displayed that will inform the user and will
+    offer to open their web browser to the wxPython downloads page,
+    and will then exit the application.
+    """
+    assert type(minVersion) == str
+
+    # ensure that wxPython hasn't been imported yet.
+    if sys.modules.has_key('wx') or sys.modules.has_key('wxPython'):
+        raise VersionError("wxversion.ensureMinimal() must be called before wxPython is imported")
+
+    bestMatch = None
+    minv = _wxPackageInfo(minVersion)
+    defaultPath = _find_default()
+    if defaultPath:
+        defv = _wxPackageInfo(defaultPath, True)
+        if defv >= minv:
+            bestMatch = defv
+
+    if bestMatch is None:
+        installed = _find_installed()
+        if installed:
+            # The list is in reverse sorted order, so if the first one is
+            # big enough then choose it
+            if installed[0] >= minv:
+                bestMatch = installed[0]
+
+    if bestMatch is None:
+        import wx, webbrowser
+        versions = "\n".join(["      "+ver for ver in getInstalled()])
+        app = wx.PySimpleApp()
+        result = wx.MessageBox("This application requires a version of wxPython "
+                               "greater than or equal to %s, but a matching version "
+                               "was not found.\n\n"
+                               "You currently have these version(s) installed:\n%s\n\n"
+                               "Would you like to download a new version of wxPython?\n"
+                               % (minVersion, versions),
+                      "wxPython Upgrade Needed", style=wx.YES_NO)
+        if result == wx.YES:
+            webbrowser.open(UPDATE_URL)
+        app.MainLoop()
+        sys.exit()
+
+    sys.path.insert(0, bestMatch.pathname)
+    _selected = bestMatch
+        
+
+#----------------------------------------------------------------------
+

 def checkInstalled(versions):
     """
     Check if there is a version of wxPython installed that matches one
 def checkInstalled(versions):
     """
     Check if there is a version of wxPython installed that matches one


@@ -134,8 +194,8 @@ def checkInstalled(versions):
     
     if type(versions) == str:
         versions = [versions]
     
     if type(versions) == str:
         versions = [versions]

-    packages = _find_installed()
-    bestMatch = _get_best_match(packages, versions)
+    installed = _find_installed()
+    bestMatch = _get_best_match(installed, versions)

     return bestMatch is not None
 
 #----------------------------------------------------------------------
     return bestMatch is not None
 
 #----------------------------------------------------------------------


@@ -145,18 +205,18 @@ def getInstalled():
     Returns a list of strings representing the installed wxPython
     versions that are found on the system.
     """
     Returns a list of strings representing the installed wxPython
     versions that are found on the system.
     """

-    packages = _find_installed()
-    return [os.path.basename(p.pathname)[3:] for p in packages]
+    installed = _find_installed()
+    return [os.path.basename(p.pathname)[3:] for p in installed]

 
 
 
 #----------------------------------------------------------------------
 # private helpers...
 
 
 
 
 #----------------------------------------------------------------------
 # private helpers...
 

-def _get_best_match(packages, versions):
+def _get_best_match(installed, versions):

     bestMatch = None
     bestScore = 0
     bestMatch = None
     bestScore = 0

-    for pkg in packages:
+    for pkg in installed:

         for ver in versions:
             score = pkg.Score(_wxPackageInfo(ver))
             if score > bestScore:
         for ver in versions:
             score = pkg.Score(_wxPackageInfo(ver))
             if score > bestScore:


@@ -206,6 +266,35 @@ def _find_installed(removeExisting=False):
     return installed
 
 
     return installed
 
 

+# Scan the sys.path looking for either a directory matching _pattern,
+# or a wx.pth file
+def _find_default():
+    for pth in sys.path:
+        # empty means to look in the current dir
+        if not pth:
+            pth = '.'
+
+        # skip it if it's not a package dir
+        if not os.path.isdir(pth):
+            continue
+        
+        # does it match the pattern?
+        base = os.path.basename(pth)
+        if fnmatch.fnmatchcase(base, _pattern):
+            return pth
+
+    for pth in sys.path:
+        if not pth:
+            pth = '.'
+        if not os.path.isdir(pth):
+            continue
+        if os.path.exists(os.path.join(pth, 'wx.pth')):
+            base = open(os.path.join(pth, 'wx.pth')).read()
+            return os.path.join(pth, base)
+
+    return None
+
+

 class _wxPackageInfo(object):
     def __init__(self, pathname, stripFirst=False):
         self.pathname = pathname
 class _wxPackageInfo(object):
     def __init__(self, pathname, stripFirst=False):
         self.pathname = pathname


@@ -220,11 +309,12 @@ class _wxPackageInfo(object):
     def Score(self, other):
         score = 0
         
     def Score(self, other):
         score = 0
         

-        # whatever version components given in other must match exactly
+        # whatever number of version components given in other must
+        # match exactly

         minlen = min(len(self.version), len(other.version))
         if self.version[:minlen] != other.version[:minlen]:
             return 0        
         minlen = min(len(self.version), len(other.version))
         if self.version[:minlen] != other.version[:minlen]:
             return 0        

-        score += 1  # todo: should it be +=minlen to reward longer matches?
+        score += 1

         
         for opt in other.options:
             if opt in self.options:
         
         for opt in other.options:
             if opt in self.options:


@@ -232,13 +322,23 @@ class _wxPackageInfo(object):
         return score
     
 
         return score
     
 

-    # TODO: factor self.options into the sort order?
+   

     def __lt__(self, other):
     def __lt__(self, other):

-        return self.version < other.version
+        return self.version < other.version or \
+               (self.version == other.version and self.options < other.options)
+    def __le__(self, other):
+        return self.version <= other.version or \
+               (self.version == other.version and self.options <= other.options)
+    

     def __gt__(self, other):
     def __gt__(self, other):

-        return self.version > other.version
+        return self.version > other.version or \
+               (self.version == other.version and self.options > other.options)
+    def __ge__(self, other):
+        return self.version >= other.version or \
+               (self.version == other.version and self.options >= other.options)
+    

     def __eq__(self, other):
     def __eq__(self, other):

-        return self.version == other.version
+        return self.version == other.version and self.options == other.options

         
     
 
         
     
 


@@ -246,6 +346,12 @@ class _wxPackageInfo(object):
 
 if __name__ == '__main__':
     import pprint
 
 if __name__ == '__main__':
     import pprint

+
+    #ensureMinimal('2.5')
+    #pprint.pprint(sys.path)
+    #sys.exit()
+    
+    

     def test(version):
         # setup
         savepath = sys.path[:]
     def test(version):
         # setup
         savepath = sys.path[:]


@@ -253,8 +359,8 @@ if __name__ == '__main__':
         #test
         select(version)
         print "Asked for %s:\t got: %s" % (version, sys.path[0])
         #test
         select(version)
         print "Asked for %s:\t got: %s" % (version, sys.path[0])

-        #pprint.pprint(sys.path)
-        #print
+        pprint.pprint(sys.path)
+        print

 
         # reset
         sys.path = savepath[:]
 
         # reset
         sys.path = savepath[:]


@@ -284,6 +390,10 @@ if __name__ == '__main__':
     print checkInstalled("2.4")
     print checkInstalled("2.5-unicode")
     print checkInstalled("2.99-bogus")
     print checkInstalled("2.4")
     print checkInstalled("2.5-unicode")
     print checkInstalled("2.99-bogus")

+    print "Current sys.path:"
+    pprint.pprint(sys.path)
+    print
+    

     test("2.4")
     test("2.5")
     test("2.5-gtk2")
     test("2.4")
     test("2.5")
     test("2.5-gtk2")