← 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: 2012-01-20 02:00:40 UTC
  • Revision ID: aaron@aaronbentley.com-20120120020040-7y4c93fhnnahidxg
Remove rspush

Show diffs side-by-side

added added

removed removed

Lines of Context:
clean_tree.py
1
 
# Copyright (C) 2005 by Aaron Bentley
2
 
 
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
 
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
 
13
 
# You should have received a copy of the GNU General Public License
14
 
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
import errno
17
 
import os
18
 
import shutil
19
 
import sys
20
 
 
21
 
from bzrlib.bzrdir import BzrDir
22
 
from bzrlib.osutils import has_symlinks, isdir
23
 
from bzrlib.workingtree import WorkingTree
24
 
 
25
 
def is_detritus(subp):
26
 
    return subp.endswith('.THIS') or subp.endswith('.BASE') or\
27
 
        subp.endswith('.OTHER') or subp.endswith('~') or subp.endswith('.tmp')
28
 
 
29
 
def iter_deletables(tree, unknown=True, ignored=False, detritus=False):
30
 
    """Iterate through files that may be deleted"""
31
 
    for subp in tree.extras():
32
 
        if detritus and is_detritus(subp):
33
 
            yield tree.abspath(subp), subp
34
 
            continue
35
 
        if tree.is_ignored(subp):
36
 
            if ignored:
37
 
                yield tree.abspath(subp), subp
38
 
        else:
39
 
            if unknown:
40
 
                yield tree.abspath(subp), subp
41
 
 
42
 
def clean_tree(directory, ignored=False, detritus=False, dry_run=False,
43
 
               to_file=sys.stdout):
44
 
    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
 
    """Delete files in the deletables iterable"""
50
 
    has_deleted = False
51
 
    for path, subp in deletables:
52
 
        if not has_deleted:
53
 
            print >> to_file, "deleting paths:"
54
 
            has_deleted = True
55
 
        print >> to_file, ' ', subp
56
 
        if not dry_run:
57
 
            if isdir(path):
58
 
                shutil.rmtree(path)
59
 
            else:
60
 
                os.unlink(path)
61
 
    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)