← Back to branch summary

~abentley/bzrtools/bzrtools.dev

« back to all changes in this revision

Viewing changes to clean_tree.py

  • Committer: Aaron Bentley
  • Date: 2006-11-22 16:40:12 UTC
  • Revision ID: abentley@panoramicfeedback.com-20061122164012-vbz1tq8dwjplpnha
Update switch API use

Show diffs side-by-side

added added

removed removed

Lines of Context:
clean_tree.py
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
import errno
17
17
import os
18
 
from bzrlib.osutils import has_symlinks, isdir
19
18
import shutil
20
 
from bzrlib.branch import Branch
21
19
import sys
22
20
 
23
 
def is_detrius(subp):
 
21
from bzrlib.osutils import has_symlinks, isdir
 
22
from bzrlib.trace import note
 
23
from bzrlib.workingtree import WorkingTree
 
24
 
 
25
 
 
26
def is_detritus(subp):
 
27
    """Return True if the supplied path is detritus, False otherwise"""
24
28
    return subp.endswith('.THIS') or subp.endswith('.BASE') or\
25
29
        subp.endswith('.OTHER') or subp.endswith('~') or subp.endswith('.tmp')
26
30
 
27
 
def iter_deletables(tree, unknown=True, ignored=False, detrius=False):
 
31
 
 
32
def iter_deletables(tree, unknown=False, ignored=False, detritus=False):
28
33
    """Iterate through files that may be deleted"""
29
34
    for subp in tree.extras():
30
 
        if detrius and is_detrius(subp):
 
35
        if detritus and is_detritus(subp):
31
36
            yield tree.abspath(subp), subp
32
37
            continue
33
38
        if tree.is_ignored(subp):
37
42
            if unknown:
38
43
                yield tree.abspath(subp), subp
39
44
 
40
 
def clean_tree(directory, ignored=False, detrius=False, dry_run=False,
41
 
               to_file=sys.stdout):
42
 
    br = Branch.open_containing(directory)[0]
43
 
    tree = br.working_tree()
44
 
    deletables = iter_deletables(tree, ignored=ignored, detrius=detrius)
45
 
    delete_items(deletables, dry_run=dry_run, to_file=to_file)
46
 
 
47
 
def delete_items(deletables, dry_run=False, to_file=sys.stdout):
 
45
 
 
46
def clean_tree(directory, unknown=False, ignored=False, detritus=False, 
 
47
               dry_run=False):
 
48
    """Remove files in the specified classes from the tree"""
 
49
    tree = WorkingTree.open_containing(directory)[0]
 
50
    deletables = iter_deletables(tree, unknown=unknown, ignored=ignored, 
 
51
                                 detritus=detritus)
 
52
    delete_items(deletables, dry_run=dry_run)
 
53
 
 
54
 
 
55
def delete_items(deletables, dry_run=False):
48
56
    """Delete files in the deletables iterable"""
49
57
    has_deleted = False
50
58
    for path, subp in deletables:
51
59
        if not has_deleted:
52
 
            print >> to_file, "deleting paths:"
 
60
            note("deleting paths:")
53
61
            has_deleted = True
54
 
        print >> to_file, ' ', subp
 
62
        note('  ' + subp)
55
63
        if not dry_run:
56
64
            if isdir(path):
57
65
                shutil.rmtree(path)
58
66
            else:
59
67
                os.unlink(path)
60
68
    if not has_deleted:
61
 
        print >> to_file, "No files deleted."
62
 
def test_suite():
63
 
    from bzrlib.selftest import TestCaseInTempDir
64
 
    from unittest import makeSuite
65
 
    import os.path
66
 
    from StringIO import StringIO
67
 
    class TestCleanTree(TestCaseInTempDir):
68
 
        def test_symlinks(self):
69
 
            if has_symlinks() is False:
70
 
                return
71
 
            os.mkdir('branch')
72
 
            b = Branch.initialize('branch')
73
 
            os.symlink(os.path.realpath('no-die-please'), 'branch/die-please')
74
 
            os.mkdir('no-die-please')
75
 
            assert os.path.exists('branch/die-please')
76
 
            os.mkdir('no-die-please/child')
77
 
 
78
 
            clean_tree('branch', to_file=StringIO())
79
 
            assert os.path.exists('no-die-please')
80
 
            assert os.path.exists('no-die-please/child')
81
 
 
82
 
        def test_iter_deletable(self):
83
 
            """Files are selected for deletion appropriately"""
84
 
            os.mkdir('branch')
85
 
            b = Branch.initialize('branch')
86
 
            tree = b.working_tree()
87
 
            file('branch/file.BASE', 'wb').write('contents')
88
 
            self.assertEqual(len(list(iter_deletables(tree))), 1)
89
 
            file('branch/file~', 'wb').write('contents')
90
 
            file('branch/file.pyc', 'wb').write('contents')
91
 
            dels = [r for a,r in iter_deletables(tree)]
92
 
            assert 'file~' not in dels
93
 
            assert 'file.pyc' not in dels
94
 
            dels = [r for a,r in iter_deletables(tree, detrius=True)]
95
 
            assert 'file~' in dels
96
 
            assert 'file.pyc' not in dels
97
 
            dels = [r for a,r in iter_deletables(tree, ignored=True)]
98
 
            assert 'file~' in dels
99
 
            assert 'file.BASE' in dels
100
 
            assert 'file.pyc' in dels
101
 
            dels = [r for a,r in iter_deletables(tree, unknown=False)]
102
 
            assert 'file.BASE' not in dels
103
 
 
104
 
    return makeSuite(TestCleanTree)
 
69
        note("No files deleted.")