~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/add.py

  • Committer: Robert Collins
  • Date: 2005-12-24 02:20:45 UTC
  • mto: (1185.50.57 bzr-jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1550.
  • Revision ID: robertc@robertcollins.net-20051224022045-14efc8dfa0e1a4e9
Start tests for api usage.

Show diffs side-by-side

added added

removed removed

Lines of Context:
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
import os, sys
18
 
import bzrlib
19
 
 
20
 
from osutils import quotefn, appendpath
21
 
from errors import bailout
22
 
from trace import mutter, note
23
 
 
24
 
def smart_add(file_list, verbose=False, recurse=True):
25
 
    """Add files to version, optionall recursing into directories.
26
 
 
27
 
    This is designed more towards DWIM for humans than API simplicity.
28
 
    For the specific behaviour see the help for cmd_add().
29
 
    """
30
 
    assert file_list
31
 
    assert not isinstance(file_list, basestring)
32
 
    b = bzrlib.branch.Branch(file_list[0], find_root=True)
33
 
    inv = b.read_working_inventory()
34
 
    tree = b.working_tree()
35
 
    count = 0
 
17
from os.path import dirname
 
18
 
 
19
import bzrlib.errors as errors
 
20
from bzrlib.inventory import InventoryEntry
 
21
from bzrlib.trace import mutter, note, warning
 
22
from bzrlib.errors import NotBranchError
 
23
from bzrlib.branch import is_control_file
 
24
import bzrlib.osutils
 
25
from bzrlib.workingtree import WorkingTree
 
26
 
 
27
def glob_expand_for_win32(file_list):
 
28
    if not file_list:
 
29
        return
 
30
    import glob
 
31
    expanded_file_list = []
 
32
    for possible_glob in file_list:
 
33
        glob_files = glob.glob(possible_glob)
 
34
       
 
35
        if glob_files == []:
 
36
            # special case to let the normal code path handle
 
37
            # files that do not exists
 
38
            expanded_file_list.append(possible_glob)
 
39
        else:
 
40
            expanded_file_list += glob_files
 
41
    return expanded_file_list
 
42
 
 
43
 
 
44
def _prepare_file_list(file_list):
 
45
    """Prepare a file list for use by smart_add_*."""
 
46
    import sys
 
47
    if sys.platform == 'win32':
 
48
        file_list = glob_expand_for_win32(file_list)
 
49
    if not file_list:
 
50
        file_list = [u'.']
 
51
    file_list = list(file_list)
 
52
    return file_list
 
53
 
 
54
 
 
55
def add_action_null(inv, path, kind):
 
56
    """Absorb add actions and do nothing."""
 
57
    pass
 
58
 
 
59
def add_action_print(inv, path, kind):
 
60
    """Print a line to stdout for each file that would be added."""
 
61
    print "added", bzrlib.osutils.quotefn(path)
 
62
 
 
63
def add_action_add(inv, path, kind):
 
64
    """Add each file to the given inventory. Produce no output."""
 
65
    entry = inv.add_path(path, kind=kind)
 
66
    mutter("added %r kind %r file_id={%s}" % (path, kind, entry.file_id))
 
67
 
 
68
def add_action_add_and_print(inv, path, kind):
 
69
    """Add each file to the given inventory, and print a line to stdout."""
 
70
    add_action_add(inv, path, kind)
 
71
    add_action_print(inv, path, kind)
 
72
 
 
73
 
 
74
def smart_add(file_list, recurse=True, action=add_action_add):
 
75
    """Add files to version, optionally recursing into directories.
 
76
 
 
77
    This is designed more towards DWIM for humans than API simplicity.
 
78
    For the specific behaviour see the help for cmd_add().
 
79
 
 
80
    Returns the number of files added.
 
81
    """
 
82
    file_list = _prepare_file_list(file_list)
 
83
    tree = WorkingTree.open_containing(file_list[0])[0]
 
84
    return smart_add_tree(tree, file_list, recurse, action)
 
85
 
 
86
def smart_add_tree(tree, file_list, recurse=True, action=add_action_add):
 
87
    """Add files to version, optionally recursing into directories.
 
88
 
 
89
    This is designed more towards DWIM for humans than API simplicity.
 
90
    For the specific behaviour see the help for cmd_add().
 
91
 
 
92
    This calls reporter with each (path, kind, file_id) of added files.
 
93
 
 
94
    Returns the number of files added.
 
95
    """
 
96
    import os, errno
 
97
    from bzrlib.errors import BadFileKindError, ForbiddenFileError
 
98
    assert isinstance(recurse, bool)
 
99
 
 
100
    file_list = _prepare_file_list(file_list)
 
101
    user_list = file_list[:]
 
102
    inv = tree.read_working_inventory()
 
103
    added = []
 
104
    ignored = {}
36
105
 
37
106
    for f in file_list:
38
 
        rf = b.relpath(f)
39
 
        af = b.abspath(rf)
40
 
 
41
 
        ## TODO: It's OK to add root but only in recursive mode
42
 
 
43
 
        bzrlib.mutter("smart add of %r" % f)
 
107
        rf = tree.relpath(f)
 
108
        af = tree.abspath(rf)
 
109
 
 
110
        try:
 
111
            kind = bzrlib.osutils.file_kind(af)
 
112
        except OSError, e:
 
113
            if hasattr(e, 'errno') and e.errno == errno.ENOENT:
 
114
                raise errors.NoSuchFile(rf)
 
115
            raise
 
116
 
 
117
        if not InventoryEntry.versionable_kind(kind):
 
118
            if f in user_list:
 
119
                raise BadFileKindError("cannot add %s of type %s" % (f, kind))
 
120
            else:
 
121
                warning("skipping %s (can't add file of kind '%s')", f, kind)
 
122
                continue
 
123
 
 
124
        mutter("smart add of %r, abs=%r", f, af)
44
125
        
45
 
        if bzrlib.branch.is_control_file(af):
46
 
            bailout("cannot add control file %r" % af)
47
 
 
48
 
        kind = bzrlib.osutils.file_kind(f)
49
 
 
50
 
        if kind != 'file' and kind != 'directory':
51
 
            bailout("can't add file of kind %r" % kind)
 
126
        if is_control_file(af):
 
127
            raise ForbiddenFileError('cannot add control file %s' % f)
52
128
            
53
129
        versioned = (inv.path2id(rf) != None)
54
130
 
 
131
        if kind == 'directory':
 
132
            try:
 
133
                sub_branch = WorkingTree(af)
 
134
                sub_tree = True
 
135
            except NotBranchError:
 
136
                sub_tree = False
 
137
            except errors.UnsupportedFormatError:
 
138
                sub_tree = True
 
139
        else:
 
140
            sub_tree = False
 
141
 
55
142
        if rf == '':
56
 
            mutter("branch root doesn't need to be added")
 
143
            mutter("tree root doesn't need to be added")
 
144
            sub_tree = False
57
145
        elif versioned:
58
 
            mutter("%r is already versioned" % f)
 
146
            mutter("%r is already versioned", f)
 
147
        elif sub_tree:
 
148
            mutter("%r is a bzr tree", f)
59
149
        else:
60
 
            file_id = bzrlib.branch.gen_file_id(rf)
61
 
            inv.add_path(rf, kind=kind, file_id=file_id)
62
 
            bzrlib.mutter("added %r kind %r file_id={%s}" % (rf, kind, file_id))
63
 
            count += 1 
64
 
            if verbose:
65
 
                bzrlib.textui.show_status('A', kind, quotefn(f))
 
150
            added.extend(__add_one(tree, inv, rf, kind, action))
66
151
 
67
 
        if kind == 'directory' and recurse:
 
152
        if kind == 'directory' and recurse and not sub_tree:
68
153
            for subf in os.listdir(af):
69
 
                subp = appendpath(rf, subf)
 
154
                subp = os.path.join(rf, subf)
70
155
                if subf == bzrlib.BZRDIR:
71
 
                    mutter("skip control directory %r" % subp)
72
 
                elif tree.is_ignored(subp):
73
 
                    mutter("skip ignored sub-file %r" % subp)
 
156
                    mutter("skip control directory %r", subp)
74
157
                else:
75
 
                    mutter("queue to add sub-file %r" % (subp))
76
 
                    file_list.append(subp)
77
 
 
78
 
    if count > 0:
79
 
        if verbose:
80
 
            note('added %d' % count)
81
 
        b._write_inventory(inv)
 
158
                    ignore_glob = tree.is_ignored(subp)
 
159
                    if ignore_glob is not None:
 
160
                        mutter("skip ignored sub-file %r", subp)
 
161
                        if ignore_glob not in ignored:
 
162
                            ignored[ignore_glob] = []
 
163
                        ignored[ignore_glob].append(subp)
 
164
                    else:
 
165
                        mutter("queue to add sub-file %r", subp)
 
166
                        file_list.append(tree.abspath(subp))
 
167
 
 
168
 
 
169
    mutter('added %d entries', len(added))
 
170
    
 
171
    if len(added) > 0:
 
172
        tree._write_inventory(inv)
 
173
 
 
174
    return added, ignored
 
175
 
 
176
def __add_one(tree, inv, path, kind, action):
 
177
    """Add a file or directory, automatically add unversioned parents."""
 
178
 
 
179
    # Nothing to do if path is already versioned.
 
180
    # This is safe from infinite recursion because the tree root is
 
181
    # always versioned.
 
182
    if inv.path2id(path) != None:
 
183
        return []
 
184
 
 
185
    # add parent
 
186
    added = __add_one(tree, inv, dirname(path), 'directory', action)
 
187
    action(inv, path, kind)
 
188
 
 
189
    return added + [path]