[Python-checkins] r65002 - in sandbox/trunk/2to3/lib2to3: fixer_util.py fixes/fix_urllib.py tests/test_fixers.py

brett.cannon python-checkins at python.org
Wed Jul 16 07:12:05 CEST 2008


Author: brett.cannon
Date: Wed Jul 16 07:12:04 2008
New Revision: 65002

Log:
Implement a fixer for urllib(2).

Thanks Nick Edds for the patch.


Added:
   sandbox/trunk/2to3/lib2to3/fixes/fix_urllib.py
Modified:
   sandbox/trunk/2to3/lib2to3/fixer_util.py
   sandbox/trunk/2to3/lib2to3/tests/test_fixers.py

Modified: sandbox/trunk/2to3/lib2to3/fixer_util.py
==============================================================================
--- sandbox/trunk/2to3/lib2to3/fixer_util.py	(original)
+++ sandbox/trunk/2to3/lib2to3/fixer_util.py	Wed Jul 16 07:12:04 2008
@@ -112,9 +112,9 @@
     """ Return an import statement in the form:
         from package import name_leafs"""
     # XXX: May not handle dotted imports properly (eg, package_name='foo.bar')
-    assert package_name == '.' or '.' not in package.name, "FromImport has "\
-           "not been tested with dotted package names -- use at your own "\
-           "peril!"
+    #assert package_name == '.' or '.' not in package_name, "FromImport has "\
+    #       "not been tested with dotted package names -- use at your own "\
+    #       "peril!"
 
     for leaf in name_leafs:
         # Pull the leaves out of their old tree

Added: sandbox/trunk/2to3/lib2to3/fixes/fix_urllib.py
==============================================================================
--- (empty file)
+++ sandbox/trunk/2to3/lib2to3/fixes/fix_urllib.py	Wed Jul 16 07:12:04 2008
@@ -0,0 +1,176 @@
+"""Fix changes imports of urllib which are now incompatible.
+   This is rather similar to fix_imports, but because of the more
+   complex nature of the fixing for urllib, it has its own fixer.
+"""
+# Author: Nick Edds
+
+# Local imports
+from .fix_imports import alternates, FixImports
+from .. import fixer_base
+from ..fixer_util import Name, Comma, FromImport, Newline, attr_chain, any, set
+
+MAPPING = {'urllib':  [
+                ('urllib.request',
+                    ['URLOpener', 'FancyURLOpener', 'urlretrieve',
+                     '_urlopener', 'urlcleanup']),
+                ('urllib.parse',
+                    ['quote', 'quote_plus', 'unquote', 'unquote_plus',
+                     'urlencode', 'pahtname2url', 'url2pathname']),
+                ('urllib.error',
+                    ['ContentTooShortError'])],
+           'urllib2' : [
+                ('urllib.request',
+                    ['urlopen', 'install_opener', 'build_opener',
+                     'Request', 'OpenerDirector', 'BaseHandler',
+                     'HTTPDefaultErrorHandler', 'HTTPRedirectHandler',
+                     'HTTPCookieProcessor', 'ProxyHandler',
+                     'HTTPPasswordMgr',
+                     'HTTPPasswordMgrWithDefaultRealm',
+                     'AbstractBasicAuthHandler',
+                     'HTTPBasicAuthHandler', 'ProxyBasicAuthHandler',
+                     'AbstractDigestAuthHandler',
+                     'HTTPDigestAuthHander', 'ProxyDigestAuthHandler',
+                     'HTTPHandler', 'HTTPSHandler', 'FileHandler',
+                     'FTPHandler', 'CacheFTPHandler',
+                     'UnknownHandler']),
+                ('urllib.error',
+                    ['URLError', 'HTTPError'])],
+}
+
+
+# def alternates(members):
+#     return "(" + "|".join(map(repr, members)) + ")"
+
+
+def build_pattern():
+    bare = set()
+    for old_module, changes in MAPPING.items():
+        for change in changes:
+            new_module, members = change
+            members = alternates(members)
+            yield """import_name< 'import' (module=%r
+                                  | dotted_as_names< any* module=%r any* >) >
+                  """ % (old_module, old_module)
+            yield """import_from< 'from' mod_member=%r 'import'
+                       ( member=%s | import_as_name< member=%s 'as' any > |
+                         import_as_names< members=any*  >) >
+                  """ % (old_module, members, members)
+            yield """import_from< 'from' module_star=%r 'import' star='*' >
+                  """ % old_module
+            yield """import_name< 'import'
+                                  dotted_as_name< module_as=%r 'as' any > >
+                  """ % old_module
+            yield """power< module_dot=%r trailer< '.' member=%s > any* >
+                  """ % (old_module, members)
+
+
+class FixUrllib(FixImports):
+    PATTERN = "|".join(build_pattern())
+
+    def transform_import(self, node, results):
+        """Transform for the basic import case. Replaces the old
+           import name with a comma separated list of its
+           replacements.
+        """
+        import_mod = results.get('module')
+        pref = import_mod.get_prefix()
+
+        names = []
+
+        # create a Node list of the replacement modules
+        for name in MAPPING[import_mod.value][:-1]:
+            names.extend([Name(name[0], prefix=pref), Comma()])
+        names.append(Name(MAPPING[import_mod.value][-1][0], prefix=pref))
+        import_mod.replace(names)
+
+    def transform_member(self, node, results):
+        """Transform for imports of specific module elements. Replaces
+           the module to be imported from with the appropriate new
+           module.
+        """
+        mod_member = results.get('mod_member')
+        pref = mod_member.get_prefix()
+        member = results.get('member')
+
+        # Simple case with only a single member being imported
+        if member:
+            # this may be a list of length one, or just a node
+            if isinstance(member, list):
+                member = member[0]
+            new_name = None
+            for change in MAPPING[mod_member.value]:
+                if member.value in change[1]:
+                    new_name = change[0]
+                    break
+            if new_name:
+                mod_member.replace(Name(new_name, prefix=pref))
+            else:
+                self.cannot_convert(node,
+                                    'This is an invalid module element')
+
+        # Multiple members being imported
+        else:
+            # a dictionary for replacements, order matters
+            modules = []
+            mod_dict = {}
+            members = results.get('members')
+            for member in members:
+                member = member.value
+                # we only care about the actual members
+                if member != ',':
+                    for change in MAPPING[mod_member.value]:
+                        if member in change[1]:
+                            if mod_dict.has_key(change[0]):
+                                mod_dict[change[0]].append(member)
+                            else:
+                                mod_dict[change[0]] = [member]
+                                modules.append(change[0])
+
+            new_nodes = []
+            for module in modules:
+                elts = mod_dict[module]
+                names = []
+                for elt in elts[:-1]:
+                    names.extend([Name(elt, prefix=pref), Comma()])
+                names.append(Name(elts[-1], prefix=pref))
+                new_nodes.append(FromImport(module, names))
+            if new_nodes:
+                nodes = []
+                for new_node in new_nodes[:-1]:
+                    nodes.extend([new_node, Newline()])
+                nodes.append(new_nodes[-1])
+                node.replace(nodes)
+            else:
+                self.cannot_convert(node, 'All module elements are invalid')
+
+    def transform_dot(self, node, results):
+        """Transform for calls to module members in code."""
+        module_dot = results.get('module_dot')
+        member = results.get('member')
+        # this may be a list of length one, or just a node
+        if isinstance(member, list):
+            member = member[0]
+        new_name = None
+        for change in MAPPING[module_dot.value]:
+            if member.value in change[1]:
+                new_name = change[0]
+                break
+        if new_name:
+            module_dot.replace(Name(new_name,
+                                    prefix=module_dot.get_prefix()))
+        else:
+            self.cannot_convert(node, 'This is an invalid module element')
+
+    def transform(self, node, results):
+        if results.get('module'):
+            self.transform_import(node, results)
+        elif results.get('mod_member'):
+            self.transform_member(node, results)
+        elif results.get('module_dot'):
+            self.transform_dot(node, results)
+        # Renaming and star imports are not supported for these modules.
+        elif results.get('module_star'):
+            self.cannot_convert(node, 'Cannot handle star imports.')
+        elif results.get('module_as'):
+            self.cannot_convert(node, 'This module is now multiple modules')
+

Modified: sandbox/trunk/2to3/lib2to3/tests/test_fixers.py
==============================================================================
--- sandbox/trunk/2to3/lib2to3/tests/test_fixers.py	(original)
+++ sandbox/trunk/2to3/lib2to3/tests/test_fixers.py	Wed Jul 16 07:12:04 2008
@@ -11,6 +11,7 @@
 # Python imports
 import unittest
 from itertools import chain
+from operator import itemgetter
 from os.path import dirname, pathsep
 
 # Local imports
@@ -1492,17 +1493,17 @@
                 foo(%s)
                 """ % (new, ", ".join(members), ", ".join(members))
             self.check(b, a)
-            
+
 
 class Test_imports2(Test_imports):
     fixer = "imports2"
     from ..fixes.fix_imports2 import MAPPING as modules
-    
-    
+
+
 class Test_imports_fixer_order(Test_imports):
-    
+
     fixer = None
-    
+
     def setUp(self):
         Test_imports.setUp(self, ['imports', 'imports2'])
         from ..fixes.fix_imports2 import MAPPING as mapping2
@@ -1512,6 +1513,77 @@
             self.modules[key] = mapping1[key]
 
 
+class Test_urllib(FixerTestCase):
+   fixer = "urllib"
+   from ..fixes.fix_urllib import MAPPING as modules
+
+   def test_import_module(self):
+       for old, changes in self.modules.items():
+           b = "import %s" % old
+           a = "import %s" % ", ".join(map(itemgetter(0), changes))
+           self.check(b, a)
+
+   def test_import_from(self):
+       for old, changes in self.modules.items():
+           all_members = []
+           for new, members in changes:
+               for member in members:
+                   all_members.append(member)
+                   b = "from %s import %s" % (old, member)
+                   a = "from %s import %s" % (new, member)
+                   self.check(b, a)
+
+                   s = "from foo import %s" % member
+                   self.unchanged(s)
+
+               b = "from %s import %s" % (old, ", ".join(members))
+               a = "from %s import %s" % (new, ", ".join(members))
+               self.check(b, a)
+
+               s = "from foo import %s" % ", ".join(members)
+               self.unchanged(s)
+
+           # test the breaking of a module into multiple replacements
+           b = "from %s import %s" % (old, ", ".join(all_members))
+           a = "\n".join(["from %s import %s" % (new, ", ".join(members))
+                           for (new, members) in changes])
+           self.check(b, a)
+
+   def test_import_module_as(self):
+       for old in self.modules:
+           s = "import %s as foo" % old
+           self.warns_unchanged(s, "This module is now multiple modules")
+
+   def test_import_from_as(self):
+       for old, changes in self.modules.items():
+           for new, members in changes:
+               for member in members:
+                   b = "from %s import %s as foo_bar" % (old, member)
+                   a = "from %s import %s as foo_bar" % (new, member)
+                   self.check(b, a)
+
+   def test_star(self):
+       for old in self.modules:
+           s = "from %s import *" % old
+           self.warns_unchanged(s, "Cannot handle star imports")
+
+   def test_import_module_usage(self):
+       for old, changes in self.modules.items():
+           for new, members in changes:
+               for member in members:
+                   b = """
+                       import %s
+                       foo(%s.%s)
+                       """ % (old, old, member)
+                   a = """
+                       import %s
+                       foo(%s.%s)
+                       """ % (", ".join([n for (n, mems)
+                                          in self.modules[old]]),
+                                        new, member)
+                   self.check(b, a)
+
+
 class Test_input(FixerTestCase):
     fixer = "input"
 


More information about the Python-checkins mailing list