~bzr-pqm/bzr/bzr.dev

70 by mbp at sourcefrog
Prepare for smart recursive add.
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
1128 by Martin Pool
- smart_add routine now doesn't print filenames directly, but rather
17
from bzrlib.trace import mutter, note, warning
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
18
from bzrlib.errors import NotBranchError
19
from bzrlib.branch import Branch
1139 by Martin Pool
- merge in merge improvements and additional tests
20
from bzrlib.osutils import quotefn
70 by mbp at sourcefrog
Prepare for smart recursive add.
21
686 by Martin Pool
- glob expand add arguments on win32
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
1128 by Martin Pool
- smart_add routine now doesn't print filenames directly, but rather
37
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
38
def add_reporter_null(path, kind, entry):
39
    """Absorb add reports and do nothing."""
1092.1.30 by Robert Collins
change smart_add reporting of added files to callback with the entry, and change the inventory.add signature to return the added entry
40
    pass
41
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
42
def add_reporter_print(path, kind, entry):
43
    """Print a line to stdout for each file that's added."""
1139 by Martin Pool
- merge in merge improvements and additional tests
44
    print "added", quotefn(path)
1092.1.30 by Robert Collins
change smart_add reporting of added files to callback with the entry, and change the inventory.add signature to return the added entry
45
    
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
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
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
57
58
def smart_add(file_list, recurse=True, reporter=add_reporter_null):
598 by Martin Pool
doc
59
    """Add files to version, optionally recursing into directories.
70 by mbp at sourcefrog
Prepare for smart recursive add.
60
61
    This is designed more towards DWIM for humans than API simplicity.
62
    For the specific behaviour see the help for cmd_add().
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
63
64
    Returns the number of files added.
70 by mbp at sourcefrog
Prepare for smart recursive add.
65
    """
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
66
    file_list = _prepare_file_list(file_list)
67
    b = Branch(file_list[0], find_root=True)
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
68
    return smart_add_branch(b, file_list, recurse, reporter)
69
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
70
        
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
71
def smart_add_branch(branch, file_list, recurse=True, reporter=add_reporter_null):
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
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().
1128 by Martin Pool
- smart_add routine now doesn't print filenames directly, but rather
76
77
    This yields a sequence of (path, kind, file_id) for added files.
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
78
79
    Returns the number of files added.
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
80
    """
974 by Martin Pool
- start adding tests for commit in subdir
81
    import os
82
    import sys
1103 by Martin Pool
- some pychecker cleanups
83
    from bzrlib.osutils import quotefn
599 by Martin Pool
- better error reporting from smart_add
84
    from bzrlib.errors import BadFileKindError, ForbiddenFileError
974 by Martin Pool
- start adding tests for commit in subdir
85
    import bzrlib.branch
86
    import bzrlib.osutils
599 by Martin Pool
- better error reporting from smart_add
87
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
88
    assert isinstance(recurse, bool)
89
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
90
    file_list = _prepare_file_list(file_list)
426 by Martin Pool
- Skip symlinks during recursive add (path from aaron)
91
    user_list = file_list[:]
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
92
    inv = branch.read_working_inventory()
93
    tree = branch.working_tree()
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
94
    count = 0
86 by mbp at sourcefrog
first cut at recursive add
95
70 by mbp at sourcefrog
Prepare for smart recursive add.
96
    for f in file_list:
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
97
        rf = branch.relpath(f)
98
        af = branch.abspath(rf)
510 by Martin Pool
- fix add of files when standing in subdirectory
99
100
        kind = bzrlib.osutils.file_kind(af)
426 by Martin Pool
- Skip symlinks during recursive add (path from aaron)
101
102
        if kind != 'file' and kind != 'directory':
599 by Martin Pool
- better error reporting from smart_add
103
            if f in user_list:
104
                raise BadFileKindError("cannot add %s of type %s" % (f, kind))
105
            else:
1128 by Martin Pool
- smart_add routine now doesn't print filenames directly, but rather
106
                warning("skipping %s (can't add file of kind '%s')", f, kind)
426 by Martin Pool
- Skip symlinks during recursive add (path from aaron)
107
                continue
108
800 by Martin Pool
Merge John's import-speedup branch:
109
        mutter("smart add of %r, abs=%r" % (f, af))
70 by mbp at sourcefrog
Prepare for smart recursive add.
110
        
111
        if bzrlib.branch.is_control_file(af):
599 by Martin Pool
- better error reporting from smart_add
112
            raise ForbiddenFileError('cannot add control file %s' % f)
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
113
            
86 by mbp at sourcefrog
first cut at recursive add
114
        versioned = (inv.path2id(rf) != None)
115
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
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
91 by mbp at sourcefrog
special handling of root directory for recursive add
125
        if rf == '':
126
            mutter("branch root doesn't need to be added")
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
127
            sub_tree = False
91 by mbp at sourcefrog
special handling of root directory for recursive add
128
        elif versioned:
88 by mbp at sourcefrog
smart_add: no warning for already-added files
129
            mutter("%r is already versioned" % f)
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
130
        elif sub_tree:
131
            mutter("%r is a bzr tree" %f)
70 by mbp at sourcefrog
Prepare for smart recursive add.
132
        else:
1092.1.30 by Robert Collins
change smart_add reporting of added files to callback with the entry, and change the inventory.add signature to return the added entry
133
            entry = inv.add_path(rf, kind=kind)
134
            mutter("added %r kind %r file_id={%s}" % (rf, kind, entry.file_id))
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
135
            count += 1 
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
136
            reporter(rf, kind, entry)
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
137
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
138
        if kind == 'directory' and recurse and not sub_tree:
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
139
            for subf in os.listdir(af):
597 by Martin Pool
- tidy up add code
140
                subp = os.path.join(rf, subf)
103 by mbp at sourcefrog
Skip control directories in recursive add
141
                if subf == bzrlib.BZRDIR:
142
                    mutter("skip control directory %r" % subp)
143
                elif tree.is_ignored(subp):
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
144
                    mutter("skip ignored sub-file %r" % subp)
145
                else:
510 by Martin Pool
- fix add of files when standing in subdirectory
146
                    mutter("queue to add sub-file %r" % subp)
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
147
                    file_list.append(branch.abspath(subp))
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
148
1128 by Martin Pool
- smart_add routine now doesn't print filenames directly, but rather
149
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
150
    mutter('added %d entries', count)
151
    
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
152
    if count > 0:
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
153
        branch._write_inventory(inv)
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
154
155
    return count