13 |
14 | A demo of Psydiff's output (Psydiff diffing itself over a recent big change) can
15 | be found here:
16 |
17 | http://www.yinwang.org/resources/pydiff1-pydiff2.html
18 |
19 |
20 |
21 | ### Installation
22 |
23 | 1. Copy the whole directory to somewhere in your file system
24 | 2. Add the path to the system's "PATH variable"
25 |
26 |
27 |
28 | ### Usage
29 |
30 | Just run psydiff.py from the command line:
31 |
32 | ./psydiff.py demos/list1.py demos/list2.py
33 |
34 | This will generate a HTML file named list1-list2.html in the current directory.
35 | You can then use your browser to open this file and browse around the code.
36 |
37 | The HTML is a standalone entity (CSS styles and JavaScript embedded). You can
38 | put it anywhere you like and still be able to view it.
39 |
40 |
41 |
42 | ### Contact
43 |
44 | Yin Wang (yinwang0@gmail.com)
45 |
46 |
47 |
48 | #### License (GPLv3)
49 |
50 | psydiff - a structural comparison tool for Python
51 |
52 | Copyright (c) 2011-2014 Yin Wang
53 |
54 | This program is free software: you can redistribute it and/or modify
55 | it under the terms of the GNU General Public License as published by
56 | the Free Software Foundation, either version 3 of the License, or
57 | (at your option) any later version.
58 |
59 | This program is distributed in the hope that it will be useful,
60 | but WITHOUT ANY WARRANTY; without even the implied warranty of
61 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
62 | GNU General Public License for more details.
63 |
64 | You should have received a copy of the GNU General Public License
65 | along with this program. If not, see \n')
1441 | out.append(body)
1442 | out.append('\n')
1443 |
1444 | # out.append('\n')
1445 | # out.append('\n')
1446 |
1447 | return ''.join(out)
1448 |
1449 |
1450 |
1451 | # put the tags generated by changeTags into the text and create HTML
1452 | def applyTags(s, tags, side):
1453 | tags = sorted(tags, key = lambda t: (t.idx, -t.start))
1454 | curr = 0
1455 | out = []
1456 | for t in tags:
1457 | while curr < t.idx and curr < len(s):
1458 | out.append(escape(s[curr]))
1459 | curr += 1
1460 | out.append(t.tag)
1461 |
1462 | while curr < len(s):
1463 | out.append(escape(s[curr]))
1464 | curr += 1
1465 | return ''.join(out)
1466 |
1467 |
1468 |
1469 |
1470 | #--------------------- tag generation functions ----------------------
1471 |
1472 | def changeTags(s, changes, side):
1473 | tags = []
1474 | for r in changes:
1475 | key = r.orig if side == 'left' else r.cur
1476 | if hasattr(key, 'lineno'):
1477 | start = nodeStart(key)
1478 | if IS(key, FunctionDef):
1479 | end = start + len('def')
1480 | elif IS(key, ClassDef):
1481 | end = start + len('class')
1482 | else:
1483 | end = nodeEnd(key)
1484 |
1485 | if r.orig <> None and r.cur <> None:
1486 | # for change and move
1487 | tags.append(Tag(linkTagStart(r, side), start))
1488 | tags.append(Tag("", end, start))
1489 | else:
1490 | # for deletion and insertion
1491 | tags.append(Tag(spanStart(r), start))
1492 | tags.append(Tag('', end, start))
1493 |
1494 | return tags
1495 |
1496 |
1497 |
1498 | def lineTags(s):
1499 | out = []
1500 | lineno = 1;
1501 | curr = 0
1502 | while curr < len(s):
1503 | if curr == 0 or s[curr-1] == '\n':
1504 | out.append(Tag('', curr))
1505 | out.append(Tag('' + str(lineno) + ' ', curr))
1506 | if s[curr] == '\n':
1507 | out.append(Tag('
', curr))
1508 | lineno += 1
1509 | curr += 1
1510 | out.append(Tag('', curr))
1511 | return out
1512 |
1513 |
1514 |
1515 | def keywordTags(side):
1516 | tags = []
1517 | allNodes = allNodes1 if side == 'left' else allNodes2
1518 | for node in allNodes:
1519 | if type(node) in keywordMap:
1520 | kw = keywordMap[type(node)]
1521 | start = nodeStart(node)
1522 | if src(node)[:len(kw)] == kw:
1523 | startTag = (Tag('', start))
1524 | tags.append(startTag)
1525 | endTag = Tag('', start + len(kw), start)
1526 | tags.append(endTag)
1527 | return tags
1528 |
1529 |
1530 | def spanStart(diff):
1531 | if diff.cur == None:
1532 | cls = "deletion"
1533 | else:
1534 | cls = "insertion"
1535 | text = escape(describeChange(diff))
1536 | return ''
1537 |
1538 |
1539 |
1540 | def linkTagStart(diff, side):
1541 | if side == 'left':
1542 | me, other = diff.orig, diff.cur
1543 | else:
1544 | me, other = diff.cur, diff.orig
1545 |
1546 | text = escape(describeChange(diff))
1547 | if diff.cost > 0:
1548 | cls = "change"
1549 | else:
1550 | cls = "move"
1551 |
1552 | return ('')
1560 |
1561 |
1562 | keywordMap = {
1563 | FunctionDef : 'def',
1564 | ClassDef : 'class',
1565 | For : 'for',
1566 | While : 'while',
1567 | If : 'if',
1568 | With : 'with',
1569 | Return : 'return',
1570 | Yield : 'yield',
1571 | Global : 'global',
1572 | Raise : 'raise',
1573 | Pass : 'pass',
1574 | TryExcept : 'try',
1575 | TryFinally : 'try',
1576 | }
1577 |
1578 |
1579 |
1580 |
1581 | # human readable description of node
1582 |
1583 | def describeNode(node):
1584 |
1585 | def code(s):
1586 | return "'" + s + "'"
1587 |
1588 | def short(node):
1589 | if IS(node, Module):
1590 | ret = "module"
1591 | elif IS(node, Import):
1592 | ret = "import statement"
1593 | elif IS(node, Name):
1594 | ret = code(node.id)
1595 | elif IS(node, Attribute):
1596 | ret = code(short(node.value) + "." + short(node.attrName))
1597 | elif IS(node, FunctionDef):
1598 | ret = "function " + code(node.name)
1599 | elif IS(node, ClassDef):
1600 | ret = "class " + code(node.name)
1601 | elif IS(node, Call):
1602 | ret = "call to " + code(short(node.func))
1603 | elif IS(node, Assign):
1604 | ret = "assignment"
1605 | elif IS(node, If):
1606 | ret = "if statement"
1607 | elif IS(node, While):
1608 | ret = "while loop"
1609 | elif IS(node, For):
1610 | ret = "for loop"
1611 | elif IS(node, Yield):
1612 | ret = "yield"
1613 | elif IS(node, TryExcept) or IS(node, TryFinally):
1614 | ret = "try statement"
1615 | elif IS(node, Compare):
1616 | ret = "comparison " + src(node)
1617 | elif IS(node, Return):
1618 | ret = "return " + short(node.value)
1619 | elif IS(node, Print):
1620 | ret = ("print " + short(node.dest) +
1621 | ", " if (node.dest!=None) else "" + printList(node.values))
1622 | elif IS(node, Expr):
1623 | ret = "expression " + short(node.value)
1624 | elif IS(node, Num):
1625 | ret = str(node.n)
1626 | elif IS(node, Str):
1627 | if len(node.s) > 20:
1628 | ret = "string " + code(node.s[:20]) + "..."
1629 | else:
1630 | ret = "string " + code(node.s)
1631 | elif IS(node, Tuple):
1632 | ret = "tuple (" + src(node) + ")"
1633 | elif IS(node, BinOp):
1634 | ret = (short(node.left) + " " +
1635 | node.opName.id + " " + short(node.right))
1636 | elif IS(node, BoolOp):
1637 | ret = src(node)
1638 | elif IS(node, UnaryOp):
1639 | ret = node.opName.id + " " + short(node.operand)
1640 | elif IS(node, Pass):
1641 | ret = "pass"
1642 | elif IS(node, list):
1643 | ret = map(short, node)
1644 | else:
1645 | ret = str(type(node))
1646 | return ret
1647 |
1648 | ret = short(node)
1649 | if hasattr(node, 'lineno'):
1650 | ret = re.sub(" *(line [0-9]+)", '', ret)
1651 | return ret + " (line " + str(node.lineno) + ")"
1652 | else:
1653 | return ret
1654 |
1655 |
1656 |
1657 |
1658 | # describe a change in a human readable fashion
1659 | def describeChange(diff):
1660 |
1661 | ratio = diff.similarity()
1662 | sim = str(ratio)
1663 |
1664 | if ratio == 1.0:
1665 | sim = " (unchanged)"
1666 | else:
1667 | sim = " (similarity %.1f%%)" % (ratio * 100)
1668 |
1669 | if diff.isFrame:
1670 | wrap = "wrap "
1671 | else:
1672 | wrap = ""
1673 |
1674 | if diff.cur == None:
1675 | ret = wrap + describeNode(diff.orig) + " deleted"
1676 | elif diff.orig == None:
1677 | ret = wrap + describeNode(diff.cur) + " inserted"
1678 | elif nodeName(diff.orig) <> nodeName(diff.cur):
1679 | ret = (describeNode(diff.orig) +
1680 | " renamed to " + describeNode(diff.cur) + sim)
1681 | elif diff.cost == 0 and diff.orig.lineno <> diff.cur.lineno:
1682 | ret = (describeNode(diff.orig) +
1683 | " moved to " + describeNode(diff.cur) + sim)
1684 | elif diff.cost == 0:
1685 | ret = describeNode(diff.orig) + " unchanged"
1686 | else:
1687 | ret = (describeNode(diff.orig) +
1688 | " changed to " + describeNode(diff.cur) + sim)
1689 |
1690 | return ret
1691 |
1692 |
1693 |
1694 |
1695 |
1696 | #-------------------------------------------------------------
1697 | # main HTML based command
1698 | #-------------------------------------------------------------
1699 |
1700 | def diff(file1, file2, move=True):
1701 |
1702 | import time
1703 | print("\nJob started at %s, %s\n" % (time.ctime(), time.tzname[0]))
1704 | startTime = time.time()
1705 | checkpoint(startTime)
1706 |
1707 | cleanUp()
1708 |
1709 | # base files names
1710 | baseName1 = pyFileName(file1)
1711 | baseName2 = pyFileName(file2)
1712 |
1713 | # get AST of file1
1714 | f1 = open(file1, 'r');
1715 | lines1 = f1.read()
1716 | f1.close()
1717 | node1 = parse(lines1)
1718 | improveAST(node1, lines1, file1, 'left')
1719 |
1720 | # get AST of file2
1721 | f2 = open(file2, 'r');
1722 | lines2 = f2.read()
1723 | f2.close()
1724 | node2 = parse(lines2)
1725 | improveAST(node2, lines2, file2, 'right')
1726 |
1727 |
1728 | print("[parse] finished in %s. Now start to diff." % sec2min(checkpoint()))
1729 |
1730 | # get the changes
1731 |
1732 | (changes, cost) = diffNode(node1, node2, nil, nil, 0, False)
1733 |
1734 | print ("\n[diff] processed %d nodes in %s."
1735 | % (stat.diffCount, sec2min(checkpoint())))
1736 |
1737 | if move:
1738 | # print "changes:", changes
1739 | (changes, cost) = closure((changes, cost))
1740 |
1741 | print("\n[closure] finished in %s." % sec2min(checkpoint()))
1742 |
1743 |
1744 |
1745 | #---------------------- print final stats ---------------------
1746 | size1 = nodeSize(node1)
1747 | size2 = nodeSize(node2)
1748 | total = size1 + size2
1749 |
1750 | report = ""
1751 | report += ("\n--------------------- summary -----------------------") + "\n"
1752 | report += ("- total changes (chars): %d" % cost) + "\n"
1753 | report += ("- total code size: %d (left: %d right: %d)"
1754 | % (total, size1, size2)) + "\n"
1755 | report += ("- total moved pieces: %d" % stat.moveCount) + "\n"
1756 | report += ("- percentage of change: %.1f%%"
1757 | % (div(cost, total) * 100)) + "\n"
1758 | report += ("-----------------------------------------------------") + "\n"
1759 |
1760 | print report
1761 |
1762 |
1763 | #---------------------- generation HTML ---------------------
1764 | # write left file
1765 | leftChanges = filterlist(lambda p: p.orig <> None, changes)
1766 | html1 = genHTML(lines1, leftChanges, 'left')
1767 |
1768 | outname1 = baseName1 + '.html'
1769 | outfile1 = open(outname1, 'w')
1770 | outfile1.write(html1)
1771 | outfile1.write('')
1772 | outfile1.write(report)
1773 | outfile1.write('