test_util.py 20.1 KB
Newer Older
1
""" Test suite for the code in fixer_util """
2 3 4 5 6 7 8 9

# Testing imports
from . import support

# Python imports
import os.path

# Local imports
10 11 12 13
from lib2to3.pytree import Node, Leaf
from lib2to3 import fixer_util
from lib2to3.fixer_util import Attr, Name, Call, Comma
from lib2to3.pgen2 import token
14 15 16 17 18 19 20 21 22 23 24 25 26

def parse(code, strip_levels=0):
    # The topmost node is file_input, which we don't care about.
    # The next-topmost node is a *_stmt node, which we also don't care about
    tree = support.parse_string(code)
    for i in range(strip_levels):
        tree = tree.children[0]
    tree.parent = None
    return tree

class MacroTestCase(support.TestCase):
    def assertStr(self, node, string):
        if isinstance(node, (tuple, list)):
27
            node = Node(fixer_util.syms.simple_stmt, node)
28 29 30 31 32
        self.assertEqual(str(node), string)


class Test_is_tuple(support.TestCase):
    def is_tuple(self, string):
33
        return fixer_util.is_tuple(parse(string, strip_levels=2))
34 35

    def test_valid(self):
36 37 38 39 40
        self.assertTrue(self.is_tuple("(a, b)"))
        self.assertTrue(self.is_tuple("(a, (b, c))"))
        self.assertTrue(self.is_tuple("((a, (b, c)),)"))
        self.assertTrue(self.is_tuple("(a,)"))
        self.assertTrue(self.is_tuple("()"))
41 42

    def test_invalid(self):
43 44
        self.assertFalse(self.is_tuple("(a)"))
        self.assertFalse(self.is_tuple("('foo') % (b, c)"))
45 46 47 48


class Test_is_list(support.TestCase):
    def is_list(self, string):
49
        return fixer_util.is_list(parse(string, strip_levels=2))
50 51

    def test_valid(self):
52 53 54 55 56
        self.assertTrue(self.is_list("[]"))
        self.assertTrue(self.is_list("[a]"))
        self.assertTrue(self.is_list("[a, b]"))
        self.assertTrue(self.is_list("[a, [b, c]]"))
        self.assertTrue(self.is_list("[[a, [b, c]],]"))
57 58

    def test_invalid(self):
59
        self.assertFalse(self.is_list("[]+[]"))
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80


class Test_Attr(MacroTestCase):
    def test(self):
        call = parse("foo()", strip_levels=2)

        self.assertStr(Attr(Name("a"), Name("b")), "a.b")
        self.assertStr(Attr(call, Name("b")), "foo().b")

    def test_returns(self):
        attr = Attr(Name("a"), Name("b"))
        self.assertEqual(type(attr), list)


class Test_Name(MacroTestCase):
    def test(self):
        self.assertStr(Name("a"), "a")
        self.assertStr(Name("foo.foo().bar"), "foo.foo().bar")
        self.assertStr(Name("a", prefix="b"), "ba")


81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
class Test_Call(MacroTestCase):
    def _Call(self, name, args=None, prefix=None):
        """Help the next test"""
        children = []
        if isinstance(args, list):
            for arg in args:
                children.append(arg)
                children.append(Comma())
            children.pop()
        return Call(Name(name), children, prefix)

    def test(self):
        kids = [None,
                [Leaf(token.NUMBER, 1), Leaf(token.NUMBER, 2),
                 Leaf(token.NUMBER, 3)],
                [Leaf(token.NUMBER, 1), Leaf(token.NUMBER, 3),
                 Leaf(token.NUMBER, 2), Leaf(token.NUMBER, 4)],
                [Leaf(token.STRING, "b"), Leaf(token.STRING, "j", prefix=" ")]
                ]
        self.assertStr(self._Call("A"), "A()")
        self.assertStr(self._Call("b", kids[1]), "b(1,2,3)")
        self.assertStr(self._Call("a.b().c", kids[2]), "a.b().c(1,3,2,4)")
        self.assertStr(self._Call("d", kids[3], prefix=" "), " d(b, j)")


106 107 108 109
class Test_does_tree_import(support.TestCase):
    def _find_bind_rec(self, name, node):
        # Search a tree for a binding -- used to find the starting
        # point for these tests.
110
        c = fixer_util.find_binding(name, node)
111 112 113 114 115 116 117 118 119
        if c: return c
        for child in node.children:
            c = self._find_bind_rec(name, child)
            if c: return c

    def does_tree_import(self, package, name, string):
        node = parse(string)
        # Find the binding of start -- that's what we'll go from
        node = self._find_bind_rec('start', node)
120
        return fixer_util.does_tree_import(package, name, node)
121 122 123 124 125 126 127 128 129

    def try_with(self, string):
        failing_tests = (("a", "a", "from a import b"),
                         ("a.d", "a", "from a.d import b"),
                         ("d.a", "a", "from d.a import b"),
                         (None, "a", "import b"),
                         (None, "a", "import b, c, d"))
        for package, name, import_ in failing_tests:
            n = self.does_tree_import(package, name, import_ + "\n" + string)
130
            self.assertFalse(n)
131
            n = self.does_tree_import(package, name, string + "\n" + import_)
132
            self.assertFalse(n)
133 134 135 136 137 138 139 140 141 142

        passing_tests = (("a", "a", "from a import a"),
                         ("x", "a", "from x import a"),
                         ("x", "a", "from x import b, c, a, d"),
                         ("x.b", "a", "from x.b import a"),
                         ("x.b", "a", "from x.b import b, c, a, d"),
                         (None, "a", "import a"),
                         (None, "a", "import b, c, a, d"))
        for package, name, import_ in passing_tests:
            n = self.does_tree_import(package, name, import_ + "\n" + string)
143
            self.assertTrue(n)
144
            n = self.does_tree_import(package, name, string + "\n" + import_)
145
            self.assertTrue(n)
146 147 148 149 150 151

    def test_in_function(self):
        self.try_with("def foo():\n\tbar.baz()\n\tstart=3")

class Test_find_binding(support.TestCase):
    def find_binding(self, name, string, package=None):
152
        return fixer_util.find_binding(name, parse(string), package)
153 154

    def test_simple_assignment(self):
155 156 157 158 159 160
        self.assertTrue(self.find_binding("a", "a = b"))
        self.assertTrue(self.find_binding("a", "a = [b, c, d]"))
        self.assertTrue(self.find_binding("a", "a = foo()"))
        self.assertTrue(self.find_binding("a", "a = foo().foo.foo[6][foo]"))
        self.assertFalse(self.find_binding("a", "foo = a"))
        self.assertFalse(self.find_binding("a", "foo = (a, b, c)"))
161 162

    def test_tuple_assignment(self):
163 164 165 166 167 168
        self.assertTrue(self.find_binding("a", "(a,) = b"))
        self.assertTrue(self.find_binding("a", "(a, b, c) = [b, c, d]"))
        self.assertTrue(self.find_binding("a", "(c, (d, a), b) = foo()"))
        self.assertTrue(self.find_binding("a", "(a, b) = foo().foo[6][foo]"))
        self.assertFalse(self.find_binding("a", "(foo, b) = (b, a)"))
        self.assertFalse(self.find_binding("a", "(foo, (b, c)) = (a, b, c)"))
169 170

    def test_list_assignment(self):
171 172 173 174 175 176
        self.assertTrue(self.find_binding("a", "[a] = b"))
        self.assertTrue(self.find_binding("a", "[a, b, c] = [b, c, d]"))
        self.assertTrue(self.find_binding("a", "[c, [d, a], b] = foo()"))
        self.assertTrue(self.find_binding("a", "[a, b] = foo().foo[a][foo]"))
        self.assertFalse(self.find_binding("a", "[foo, b] = (b, a)"))
        self.assertFalse(self.find_binding("a", "[foo, [b, c]] = (a, b, c)"))
177 178

    def test_invalid_assignments(self):
179 180 181 182
        self.assertFalse(self.find_binding("a", "foo.a = 5"))
        self.assertFalse(self.find_binding("a", "foo[a] = 5"))
        self.assertFalse(self.find_binding("a", "foo(a) = 5"))
        self.assertFalse(self.find_binding("a", "foo(a, b) = 5"))
183 184

    def test_simple_import(self):
185 186 187 188
        self.assertTrue(self.find_binding("a", "import a"))
        self.assertTrue(self.find_binding("a", "import b, c, a, d"))
        self.assertFalse(self.find_binding("a", "import b"))
        self.assertFalse(self.find_binding("a", "import b, c, d"))
189 190

    def test_from_import(self):
191 192 193 194 195 196 197 198
        self.assertTrue(self.find_binding("a", "from x import a"))
        self.assertTrue(self.find_binding("a", "from a import a"))
        self.assertTrue(self.find_binding("a", "from x import b, c, a, d"))
        self.assertTrue(self.find_binding("a", "from x.b import a"))
        self.assertTrue(self.find_binding("a", "from x.b import b, c, a, d"))
        self.assertFalse(self.find_binding("a", "from a import b"))
        self.assertFalse(self.find_binding("a", "from a.d import b"))
        self.assertFalse(self.find_binding("a", "from d.a import b"))
199 200

    def test_import_as(self):
201 202 203 204
        self.assertTrue(self.find_binding("a", "import b as a"))
        self.assertTrue(self.find_binding("a", "import b as a, c, a as f, d"))
        self.assertFalse(self.find_binding("a", "import a as f"))
        self.assertFalse(self.find_binding("a", "import b, c as f, d as e"))
205 206

    def test_from_import_as(self):
207 208 209 210 211 212 213
        self.assertTrue(self.find_binding("a", "from x import b as a"))
        self.assertTrue(self.find_binding("a", "from x import g as a, d as b"))
        self.assertTrue(self.find_binding("a", "from x.b import t as a"))
        self.assertTrue(self.find_binding("a", "from x.b import g as a, d"))
        self.assertFalse(self.find_binding("a", "from a import b as t"))
        self.assertFalse(self.find_binding("a", "from a.d import b as t"))
        self.assertFalse(self.find_binding("a", "from d.a import b as t"))
214 215

    def test_simple_import_with_package(self):
216 217 218 219
        self.assertTrue(self.find_binding("b", "import b"))
        self.assertTrue(self.find_binding("b", "import b, c, d"))
        self.assertFalse(self.find_binding("b", "import b", "b"))
        self.assertFalse(self.find_binding("b", "import b, c, d", "c"))
220 221

    def test_from_import_with_package(self):
222 223 224 225 226 227 228 229 230 231 232
        self.assertTrue(self.find_binding("a", "from x import a", "x"))
        self.assertTrue(self.find_binding("a", "from a import a", "a"))
        self.assertTrue(self.find_binding("a", "from x import *", "x"))
        self.assertTrue(self.find_binding("a", "from x import b, c, a, d", "x"))
        self.assertTrue(self.find_binding("a", "from x.b import a", "x.b"))
        self.assertTrue(self.find_binding("a", "from x.b import *", "x.b"))
        self.assertTrue(self.find_binding("a", "from x.b import b, c, a, d", "x.b"))
        self.assertFalse(self.find_binding("a", "from a import b", "a"))
        self.assertFalse(self.find_binding("a", "from a.d import b", "a.d"))
        self.assertFalse(self.find_binding("a", "from d.a import b", "a.d"))
        self.assertFalse(self.find_binding("a", "from x.y import *", "a.b"))
233 234

    def test_import_as_with_package(self):
235 236 237
        self.assertFalse(self.find_binding("a", "import b.c as a", "b.c"))
        self.assertFalse(self.find_binding("a", "import a as f", "f"))
        self.assertFalse(self.find_binding("a", "import a as f", "a"))
238 239 240 241 242

    def test_from_import_as_with_package(self):
        # Because it would take a lot of special-case code in the fixers
        # to deal with from foo import bar as baz, we'll simply always
        # fail if there is an "from ... import ... as ..."
243 244 245 246 247 248 249
        self.assertFalse(self.find_binding("a", "from x import b as a", "x"))
        self.assertFalse(self.find_binding("a", "from x import g as a, d as b", "x"))
        self.assertFalse(self.find_binding("a", "from x.b import t as a", "x.b"))
        self.assertFalse(self.find_binding("a", "from x.b import g as a, d", "x.b"))
        self.assertFalse(self.find_binding("a", "from a import b as t", "a"))
        self.assertFalse(self.find_binding("a", "from a import b as t", "b"))
        self.assertFalse(self.find_binding("a", "from a import b as t", "t"))
250 251

    def test_function_def(self):
252 253 254 255 256 257 258
        self.assertTrue(self.find_binding("a", "def a(): pass"))
        self.assertTrue(self.find_binding("a", "def a(b, c, d): pass"))
        self.assertTrue(self.find_binding("a", "def a(): b = 7"))
        self.assertFalse(self.find_binding("a", "def d(b, (c, a), e): pass"))
        self.assertFalse(self.find_binding("a", "def d(a=7): pass"))
        self.assertFalse(self.find_binding("a", "def d(a): pass"))
        self.assertFalse(self.find_binding("a", "def d(): a = 7"))
259 260 261 262 263

        s = """
            def d():
                def a():
                    pass"""
264
        self.assertFalse(self.find_binding("a", s))
265 266

    def test_class_def(self):
267 268 269 270 271 272 273 274 275 276
        self.assertTrue(self.find_binding("a", "class a: pass"))
        self.assertTrue(self.find_binding("a", "class a(): pass"))
        self.assertTrue(self.find_binding("a", "class a(b): pass"))
        self.assertTrue(self.find_binding("a", "class a(b, c=8): pass"))
        self.assertFalse(self.find_binding("a", "class d: pass"))
        self.assertFalse(self.find_binding("a", "class d(a): pass"))
        self.assertFalse(self.find_binding("a", "class d(b, a=7): pass"))
        self.assertFalse(self.find_binding("a", "class d(b, *a): pass"))
        self.assertFalse(self.find_binding("a", "class d(b, **a): pass"))
        self.assertFalse(self.find_binding("a", "class d: a = 7"))
277 278 279 280 281

        s = """
            class d():
                class a():
                    pass"""
282
        self.assertFalse(self.find_binding("a", s))
283 284

    def test_for(self):
285 286 287 288 289 290 291
        self.assertTrue(self.find_binding("a", "for a in r: pass"))
        self.assertTrue(self.find_binding("a", "for a, b in r: pass"))
        self.assertTrue(self.find_binding("a", "for (a, b) in r: pass"))
        self.assertTrue(self.find_binding("a", "for c, (a,) in r: pass"))
        self.assertTrue(self.find_binding("a", "for c, (a, b) in r: pass"))
        self.assertTrue(self.find_binding("a", "for c in r: a = c"))
        self.assertFalse(self.find_binding("a", "for c in a: pass"))
292 293 294 295 296 297

    def test_for_nested(self):
        s = """
            for b in r:
                for a in b:
                    pass"""
298
        self.assertTrue(self.find_binding("a", s))
299 300 301 302 303

        s = """
            for b in r:
                for a, c in b:
                    pass"""
304
        self.assertTrue(self.find_binding("a", s))
305 306 307 308 309

        s = """
            for b in r:
                for (a, c) in b:
                    pass"""
310
        self.assertTrue(self.find_binding("a", s))
311 312 313 314 315

        s = """
            for b in r:
                for (a,) in b:
                    pass"""
316
        self.assertTrue(self.find_binding("a", s))
317 318 319 320 321

        s = """
            for b in r:
                for c, (a, d) in b:
                    pass"""
322
        self.assertTrue(self.find_binding("a", s))
323 324 325 326 327

        s = """
            for b in r:
                for c in b:
                    a = 7"""
328
        self.assertTrue(self.find_binding("a", s))
329 330 331 332 333

        s = """
            for b in r:
                for c in b:
                    d = a"""
334
        self.assertFalse(self.find_binding("a", s))
335 336 337 338 339

        s = """
            for b in r:
                for c in a:
                    d = 7"""
340
        self.assertFalse(self.find_binding("a", s))
341 342

    def test_if(self):
343 344
        self.assertTrue(self.find_binding("a", "if b in r: a = c"))
        self.assertFalse(self.find_binding("a", "if a in r: d = e"))
345 346 347 348 349 350

    def test_if_nested(self):
        s = """
            if b in r:
                if c in d:
                    a = c"""
351
        self.assertTrue(self.find_binding("a", s))
352 353 354 355 356

        s = """
            if b in r:
                if c in d:
                    c = a"""
357
        self.assertFalse(self.find_binding("a", s))
358 359

    def test_while(self):
360 361
        self.assertTrue(self.find_binding("a", "while b in r: a = c"))
        self.assertFalse(self.find_binding("a", "while a in r: d = e"))
362 363 364 365 366 367

    def test_while_nested(self):
        s = """
            while b in r:
                while c in d:
                    a = c"""
368
        self.assertTrue(self.find_binding("a", s))
369 370 371 372 373

        s = """
            while b in r:
                while c in d:
                    c = a"""
374
        self.assertFalse(self.find_binding("a", s))
375 376 377 378 379 380 381

    def test_try_except(self):
        s = """
            try:
                a = 6
            except:
                b = 8"""
382
        self.assertTrue(self.find_binding("a", s))
383 384 385 386 387 388

        s = """
            try:
                b = 8
            except:
                a = 6"""
389
        self.assertTrue(self.find_binding("a", s))
390 391 392 393 394 395 396 397

        s = """
            try:
                b = 8
            except KeyError:
                pass
            except:
                a = 6"""
398
        self.assertTrue(self.find_binding("a", s))
399 400 401 402 403 404

        s = """
            try:
                b = 8
            except:
                b = 6"""
405
        self.assertFalse(self.find_binding("a", s))
406 407 408 409 410 411 412 413 414 415

    def test_try_except_nested(self):
        s = """
            try:
                try:
                    a = 6
                except:
                    pass
            except:
                b = 8"""
416
        self.assertTrue(self.find_binding("a", s))
417 418 419 420 421 422 423 424 425

        s = """
            try:
                b = 8
            except:
                try:
                    a = 6
                except:
                    pass"""
426
        self.assertTrue(self.find_binding("a", s))
427 428 429 430 431 432 433 434 435

        s = """
            try:
                b = 8
            except:
                try:
                    pass
                except:
                    a = 6"""
436
        self.assertTrue(self.find_binding("a", s))
437 438 439 440 441 442 443 444 445 446 447

        s = """
            try:
                try:
                    b = 8
                except KeyError:
                    pass
                except:
                    a = 6
            except:
                pass"""
448
        self.assertTrue(self.find_binding("a", s))
449 450 451 452 453 454 455 456 457 458 459

        s = """
            try:
                pass
            except:
                try:
                    b = 8
                except KeyError:
                    pass
                except:
                    a = 6"""
460
        self.assertTrue(self.find_binding("a", s))
461 462 463 464 465 466

        s = """
            try:
                b = 8
            except:
                b = 6"""
467
        self.assertFalse(self.find_binding("a", s))
468 469 470 471 472 473 474 475 476 477 478 479 480 481

        s = """
            try:
                try:
                    b = 8
                except:
                    c = d
            except:
                try:
                    b = 6
                except:
                    t = 8
                except:
                    o = y"""
482
        self.assertFalse(self.find_binding("a", s))
483 484 485 486 487 488 489 490 491

    def test_try_except_finally(self):
        s = """
            try:
                c = 6
            except:
                b = 8
            finally:
                a = 9"""
492
        self.assertTrue(self.find_binding("a", s))
493 494 495 496 497 498

        s = """
            try:
                b = 8
            finally:
                a = 6"""
499
        self.assertTrue(self.find_binding("a", s))
500 501 502 503 504 505

        s = """
            try:
                b = 8
            finally:
                b = 6"""
506
        self.assertFalse(self.find_binding("a", s))
507 508 509 510 511 512 513 514

        s = """
            try:
                b = 8
            except:
                b = 9
            finally:
                b = 6"""
515
        self.assertFalse(self.find_binding("a", s))
516 517 518 519 520 521 522 523 524 525 526 527 528 529

    def test_try_except_finally_nested(self):
        s = """
            try:
                c = 6
            except:
                b = 8
            finally:
                try:
                    a = 9
                except:
                    b = 9
                finally:
                    c = 9"""
530
        self.assertTrue(self.find_binding("a", s))
531 532 533 534 535 536 537 538 539

        s = """
            try:
                b = 8
            finally:
                try:
                    pass
                finally:
                    a = 6"""
540
        self.assertTrue(self.find_binding("a", s))
541 542 543 544 545 546 547 548 549

        s = """
            try:
                b = 8
            finally:
                try:
                    b = 6
                finally:
                    b = 7"""
550
        self.assertFalse(self.find_binding("a", s))
551

552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
class Test_touch_import(support.TestCase):

    def test_after_docstring(self):
        node = parse('"""foo"""\nbar()')
        fixer_util.touch_import(None, "foo", node)
        self.assertEqual(str(node), '"""foo"""\nimport foo\nbar()\n\n')

    def test_after_imports(self):
        node = parse('"""foo"""\nimport bar\nbar()')
        fixer_util.touch_import(None, "foo", node)
        self.assertEqual(str(node), '"""foo"""\nimport bar\nimport foo\nbar()\n\n')

    def test_beginning(self):
        node = parse('bar()')
        fixer_util.touch_import(None, "foo", node)
        self.assertEqual(str(node), 'import foo\nbar()\n\n')

    def test_from_import(self):
        node = parse('bar()')
        fixer_util.touch_import("cgi", "escape", node)
        self.assertEqual(str(node), 'from cgi import escape\nbar()\n\n')

    def test_name_import(self):
        node = parse('bar()')
        fixer_util.touch_import(None, "cgi", node)
        self.assertEqual(str(node), 'import cgi\nbar()\n\n')