← 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: 2007-06-12 22:09:44 UTC
  • mfrom: (540.1.2 bzrtools-0.17)
  • Revision ID: aaron.bentley@utoronto.ca-20070612220944-5zw4hlzp1ctq6mkl
Merge fixes from 0.17

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
 
22
from bzrlib.trace import note
23
23
from bzrlib.workingtree import WorkingTree
24
24
 
 
25
 
25
26
def is_detritus(subp):
 
27
    """Return True if the supplied path is detritus, False otherwise"""
26
28
    return subp.endswith('.THIS') or subp.endswith('.BASE') or\
27
29
        subp.endswith('.OTHER') or subp.endswith('~') or subp.endswith('.tmp')
28
30
 
29
 
def iter_deletables(tree, unknown=True, ignored=False, detritus=False):
 
31
 
 
32
def iter_deletables(tree, unknown=False, ignored=False, detritus=False):
30
33
    """Iterate through files that may be deleted"""
31
34
    for subp in tree.extras():
32
35
        if detritus and is_detritus(subp):
39
42
            if unknown:
40
43
                yield tree.abspath(subp), subp
41
44
 
42
 
def clean_tree(directory, ignored=False, detritus=False, dry_run=False,
43
 
               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"""
44
49
    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):
 
50
    tree.lock_read()
 
51
    try:
 
52
        deletables = iter_deletables(tree, unknown=unknown, ignored=ignored,
 
53
                                     detritus=detritus)
 
54
        delete_items(deletables, dry_run=dry_run)
 
55
    finally:
 
56
        tree.unlock()
 
57
 
 
58
 
 
59
def delete_items(deletables, dry_run=False):
49
60
    """Delete files in the deletables iterable"""
50
61
    has_deleted = False
51
62
    for path, subp in deletables:
52
63
        if not has_deleted:
53
 
            print >> to_file, "deleting paths:"
 
64
            note("deleting paths:")
54
65
            has_deleted = True
55
 
        print >> to_file, ' ', subp
 
66
        note('  ' + subp)
56
67
        if not dry_run:
57
68
            if isdir(path):
58
69
                shutil.rmtree(path)
59
70
            else:
60
71
                os.unlink(path)
61
72
    if not has_deleted:
62
 
        print >> to_file, "No files deleted."
63
 
def test_suite():
64
 
    from bzrlib.tests import TestCaseInTempDir
65
 
    from unittest import makeSuite
66
 
    import os.path
67
 
    from StringIO import StringIO
68
 
    class TestCleanTree(TestCaseInTempDir):
69
 
        def test_symlinks(self):
70
 
            if has_symlinks() is False:
71
 
                return
72
 
            os.mkdir('branch')
73
 
            BzrDir.create_standalone_workingtree('branch')
74
 
            os.symlink(os.path.realpath('no-die-please'), 'branch/die-please')
75
 
            os.mkdir('no-die-please')
76
 
            assert os.path.exists('branch/die-please')
77
 
            os.mkdir('no-die-please/child')
78
 
 
79
 
            clean_tree('branch', to_file=StringIO())
80
 
            assert os.path.exists('no-die-please')
81
 
            assert os.path.exists('no-die-please/child')
82
 
 
83
 
        def test_iter_deletable(self):
84
 
            """Files are selected for deletion appropriately"""
85
 
            os.mkdir('branch')
86
 
            tree = BzrDir.create_standalone_workingtree('branch')
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, detritus=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)
 
73
        note("No files deleted.")