← Back to branch summary

~abentley/bzrtools/bzrtools.dev

« back to all changes in this revision

Viewing changes to clean_tree.py

  • Committer: Charlie Shepherd
  • Date: 2007-04-04 18:12:00 UTC
  • mto: This revision was merged to the branch mainline in revision 538.
  • Revision ID: masterdriverz@gentoo.org-20070404181200-wqiwytdor9srux2v
Remove all trailing whitespace

Show diffs side-by-side

added added

removed removed

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