← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/clean_tree.py

  • Committer: Max Bowsher
  • Date: 2010-10-31 14:31:17 UTC
  • mto: This revision was merged to the branch mainline in revision 5521.
  • Revision ID: maxb@f2s.com-20101031143117-57vrfu630yq8a3k2
Fix a slightly odd style of ConfigObj construction to match the prevailing style in bzrlib.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/clean_tree.py
 
1
# Copyright (C) 2009, 2010 Canonical Ltd
 
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
 
 
18
import errno
 
19
import os
 
20
import shutil
 
21
 
 
22
from bzrlib import (
 
23
    bzrdir,
 
24
    errors,
 
25
    ui,
 
26
    )
 
27
from bzrlib.osutils import isdir
 
28
from bzrlib.trace import note
 
29
from bzrlib.workingtree import WorkingTree
 
30
 
 
31
 
 
32
def is_detritus(subp):
 
33
    """Return True if the supplied path is detritus, False otherwise"""
 
34
    return subp.endswith('.THIS') or subp.endswith('.BASE') or\
 
35
        subp.endswith('.OTHER') or subp.endswith('~') or subp.endswith('.tmp')
 
36
 
 
37
 
 
38
def iter_deletables(tree, unknown=False, ignored=False, detritus=False):
 
39
    """Iterate through files that may be deleted"""
 
40
    for subp in tree.extras():
 
41
        if detritus and is_detritus(subp):
 
42
            yield tree.abspath(subp), subp
 
43
            continue
 
44
        if tree.is_ignored(subp):
 
45
            if ignored:
 
46
                yield tree.abspath(subp), subp
 
47
        else:
 
48
            if unknown:
 
49
                yield tree.abspath(subp), subp
 
50
 
 
51
 
 
52
def clean_tree(directory, unknown=False, ignored=False, detritus=False,
 
53
               dry_run=False, no_prompt=False):
 
54
    """Remove files in the specified classes from the tree"""
 
55
    tree = WorkingTree.open_containing(directory)[0]
 
56
    tree.lock_read()
 
57
    try:
 
58
        deletables = list(iter_deletables(tree, unknown=unknown,
 
59
            ignored=ignored, detritus=detritus))
 
60
        deletables = _filter_out_nested_bzrdirs(deletables)
 
61
        if len(deletables) == 0:
 
62
            note('Nothing to delete.')
 
63
            return 0
 
64
        if not no_prompt:
 
65
            for path, subp in deletables:
 
66
                # FIXME using print is very bad idea
 
67
                # clean_tree should accept to_file argument to write the output
 
68
                print subp
 
69
            val = raw_input('Are you sure you wish to delete these [y/N]?')
 
70
            if val.lower() not in ('y', 'yes'):
 
71
                print 'Canceled'
 
72
                return 0
 
73
        delete_items(deletables, dry_run=dry_run)
 
74
    finally:
 
75
        tree.unlock()
 
76
 
 
77
 
 
78
def _filter_out_nested_bzrdirs(deletables):
 
79
    result = []
 
80
    for path, subp in deletables:
 
81
        # bzr won't recurse into unknowns/ignored directories by default
 
82
        # so we don't pay a penalty for checking subdirs of path for nested
 
83
        # bzrdir.
 
84
        # That said we won't detect the branch in the subdir of non-branch
 
85
        # directory and therefore delete it. (worth to FIXME?)
 
86
        if isdir(path):
 
87
            try:
 
88
                bzrdir.BzrDir.open(path)
 
89
            except errors.NotBranchError:
 
90
                result.append((path,subp))
 
91
            else:
 
92
                # TODO may be we need to notify user about skipped directories?
 
93
                pass
 
94
        else:
 
95
            result.append((path,subp))
 
96
    return result
 
97
 
 
98
 
 
99
def delete_items(deletables, dry_run=False):
 
100
    """Delete files in the deletables iterable"""
 
101
    def onerror(function, path, excinfo):
 
102
        """Show warning for errors seen by rmtree.
 
103
        """
 
104
        # Handle only permission error while removing files.
 
105
        # Other errors are re-raised.
 
106
        if function is not os.remove or excinfo[1].errno != errno.EACCES:
 
107
            raise
 
108
        ui.ui_factory.show_warning('unable to remove %s' % path)
 
109
    has_deleted = False
 
110
    for path, subp in deletables:
 
111
        if not has_deleted:
 
112
            note("deleting paths:")
 
113
            has_deleted = True
 
114
        if not dry_run:
 
115
            if isdir(path):
 
116
                shutil.rmtree(path, onerror=onerror)
 
117
            else:
 
118
                try:
 
119
                    os.unlink(path)
 
120
                    note('  ' + subp)
 
121
                except OSError, e:
 
122
                    # We handle only permission error here
 
123
                    if e.errno != errno.EACCES:
 
124
                        raise e
 
125
                    ui.ui_factory.show_warning(
 
126
                        'unable to remove "%s": %s.' % (path, e.strerror))
 
127
        else:
 
128
            note('  ' + subp)
 
129
    if not has_deleted:
 
130
        note("No files deleted.")