/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/add.py

  • Committer: Martin Pool
  • Date: 2005-09-01 06:33:48 UTC
  • Revision ID: mbp@sourcefrog.net-20050901063348-e71d651642ab18ba
- clean up parameters to smart_add and smart_add_branch

- the two add callbacks aren't private to the module, so shouldn't
  have underscore-prefixed names.  call them 'add reporters' as a 
  less generic name aren't private to the module, so shouldn't
  have underscore-prefixed names.  call them 'add reporters' as a 
  less generic name

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/add.py
 
1
# Copyright (C) 2005 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
from bzrlib.trace import mutter, note, warning
 
18
from bzrlib.errors import NotBranchError
 
19
from bzrlib.branch import Branch
 
20
from bzrlib.osutils import quotefn
 
21
 
 
22
def glob_expand_for_win32(file_list):
 
23
    import glob
 
24
    
 
25
    expanded_file_list = []
 
26
    for possible_glob in file_list:
 
27
        glob_files = glob.glob(possible_glob)
 
28
       
 
29
        if glob_files == []:
 
30
            # special case to let the normal code path handle
 
31
            # files that do not exists
 
32
            expanded_file_list.append(possible_glob)
 
33
        else:
 
34
            expanded_file_list += glob_files
 
35
    return expanded_file_list
 
36
 
 
37
 
 
38
def add_reporter_null(path, kind, entry):
 
39
    """Absorb add reports and do nothing."""
 
40
    pass
 
41
 
 
42
def add_reporter_print(path, kind, entry):
 
43
    """Print a line to stdout for each file that's added."""
 
44
    print "added", quotefn(path)
 
45
    
 
46
def _prepare_file_list(file_list):
 
47
    """Prepare a file list for use by smart_add_*."""
 
48
    import sys
 
49
    if sys.platform == 'win32':
 
50
        file_list = glob_expand_for_win32(file_list)
 
51
    if not file_list:
 
52
        file_list = ['.']
 
53
    file_list = list(file_list)
 
54
    assert not isinstance(file_list, basestring)
 
55
    return file_list
 
56
 
 
57
 
 
58
def smart_add(file_list, recurse=True, reporter=add_reporter_null):
 
59
    """Add files to version, optionally recursing into directories.
 
60
 
 
61
    This is designed more towards DWIM for humans than API simplicity.
 
62
    For the specific behaviour see the help for cmd_add().
 
63
 
 
64
    Returns the number of files added.
 
65
    """
 
66
    file_list = _prepare_file_list(file_list)
 
67
    b = Branch(file_list[0], find_root=True)
 
68
    return smart_add_branch(b, file_list, recurse, reporter)
 
69
 
 
70
        
 
71
def smart_add_branch(branch, file_list, recurse=True, reporter=add_reporter_null):
 
72
    """Add files to version, optionally recursing into directories.
 
73
 
 
74
    This is designed more towards DWIM for humans than API simplicity.
 
75
    For the specific behaviour see the help for cmd_add().
 
76
 
 
77
    This yields a sequence of (path, kind, file_id) for added files.
 
78
 
 
79
    Returns the number of files added.
 
80
    """
 
81
    import os
 
82
    import sys
 
83
    from bzrlib.osutils import quotefn
 
84
    from bzrlib.errors import BadFileKindError, ForbiddenFileError
 
85
    import bzrlib.branch
 
86
    import bzrlib.osutils
 
87
 
 
88
    assert isinstance(recurse, bool)
 
89
 
 
90
    file_list = _prepare_file_list(file_list)
 
91
    user_list = file_list[:]
 
92
    inv = branch.read_working_inventory()
 
93
    tree = branch.working_tree()
 
94
    count = 0
 
95
 
 
96
    for f in file_list:
 
97
        rf = branch.relpath(f)
 
98
        af = branch.abspath(rf)
 
99
 
 
100
        kind = bzrlib.osutils.file_kind(af)
 
101
 
 
102
        if kind != 'file' and kind != 'directory':
 
103
            if f in user_list:
 
104
                raise BadFileKindError("cannot add %s of type %s" % (f, kind))
 
105
            else:
 
106
                warning("skipping %s (can't add file of kind '%s')", f, kind)
 
107
                continue
 
108
 
 
109
        mutter("smart add of %r, abs=%r" % (f, af))
 
110
        
 
111
        if bzrlib.branch.is_control_file(af):
 
112
            raise ForbiddenFileError('cannot add control file %s' % f)
 
113
            
 
114
        versioned = (inv.path2id(rf) != None)
 
115
 
 
116
        if kind == 'directory':
 
117
            try:
 
118
                sub_branch = Branch(af, find_root=False)
 
119
                sub_tree = True
 
120
            except NotBranchError:
 
121
                sub_tree = False
 
122
        else:
 
123
            sub_tree = False
 
124
 
 
125
        if rf == '':
 
126
            mutter("branch root doesn't need to be added")
 
127
            sub_tree = False
 
128
        elif versioned:
 
129
            mutter("%r is already versioned" % f)
 
130
        elif sub_tree:
 
131
            mutter("%r is a bzr tree" %f)
 
132
        else:
 
133
            entry = inv.add_path(rf, kind=kind)
 
134
            mutter("added %r kind %r file_id={%s}" % (rf, kind, entry.file_id))
 
135
            count += 1 
 
136
            reporter(rf, kind, entry)
 
137
 
 
138
        if kind == 'directory' and recurse and not sub_tree:
 
139
            for subf in os.listdir(af):
 
140
                subp = os.path.join(rf, subf)
 
141
                if subf == bzrlib.BZRDIR:
 
142
                    mutter("skip control directory %r" % subp)
 
143
                elif tree.is_ignored(subp):
 
144
                    mutter("skip ignored sub-file %r" % subp)
 
145
                else:
 
146
                    mutter("queue to add sub-file %r" % subp)
 
147
                    file_list.append(branch.abspath(subp))
 
148
 
 
149
 
 
150
    mutter('added %d entries', count)
 
151
    
 
152
    if count > 0:
 
153
        branch._write_inventory(inv)
 
154
 
 
155
    return count