← 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-12-12 16:50:31 UTC
  • Revision ID: abentley@panoramicfeedback.com-20061212165031-51w8gjy1eps1vnw0
update NEWS

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.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"""
 
28
    return subp.endswith('.THIS') or subp.endswith('.BASE') or\
 
29
        subp.endswith('.OTHER') or subp.endswith('~') or subp.endswith('.tmp')
 
30
 
 
31
 
 
32
def iter_deletables(tree, unknown=False, ignored=False, detritus=False):
 
33
    """Iterate through files that may be deleted"""
 
34
    for subp in tree.extras():
 
35
        if detritus and is_detritus(subp):
 
36
            yield tree.abspath(subp), subp
 
37
            continue
 
38
        if tree.is_ignored(subp):
 
39
            if ignored:
 
40
                yield tree.abspath(subp), subp
 
41
        else:
 
42
            if unknown:
 
43
                yield tree.abspath(subp), subp
 
44
 
 
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):
 
56
    """Delete files in the deletables iterable"""
 
57
    has_deleted = False
 
58
    for path, subp in deletables:
 
59
        if not has_deleted:
 
60
            note("deleting paths:")
 
61
            has_deleted = True
 
62
        note('  ' + subp)
 
63
        if not dry_run:
 
64
            if isdir(path):
 
65
                shutil.rmtree(path)
 
66
            else:
 
67
                os.unlink(path)
 
68
    if not has_deleted:
 
69
        note("No files deleted.")