← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/add.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-03-16 16:58:03 UTC
  • mfrom: (3224.3.1 news-typo)
  • Revision ID: pqm@pqm.ubuntu.com-20080316165803-tisoc9mpob9z544o
(Matt Nordhoff) Trivial NEWS typo fix

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/add.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Helper functions for adding files to working trees."""
18
18
 
 
19
import errno
 
20
import os
19
21
import sys
20
 
import os
21
 
 
22
 
from bzrlib import (
23
 
    osutils,
24
 
    ui, 
25
 
    )
26
 
from bzrlib.i18n import gettext
 
22
 
 
23
import bzrlib.bzrdir
 
24
import bzrlib.errors as errors
 
25
import bzrlib.osutils
 
26
from bzrlib.symbol_versioning import *
 
27
from bzrlib.workingtree import WorkingTree
 
28
 
27
29
 
28
30
class AddAction(object):
29
31
    """A class which defines what action to take when adding a file."""
33
35
 
34
36
        :param to_file: The stream to write into. This is expected to take
35
37
            Unicode paths. If not supplied, it will default to ``sys.stdout``.
36
 
        :param should_print: If False, printing will be suppressed.
 
38
        :param should_print: If False, printing will be supressed.
37
39
        """
38
40
        self._to_file = to_file
39
41
        if to_file is None:
42
44
        if should_print is not None:
43
45
            self.should_print = should_print
44
46
 
45
 
    def __call__(self, inv, parent_ie, path, kind, _quote=osutils.quotefn):
 
47
    def __call__(self, inv, parent_ie, path, kind, _quote=bzrlib.osutils.quotefn):
46
48
        """Add path to inventory.
47
49
 
48
50
        The default action does nothing.
52
54
        :param kind: The kind of the object being added.
53
55
        """
54
56
        if self.should_print:
55
 
            self._to_file.write('adding %s\n' % _quote(path))
 
57
            self._to_file.write('added %s\n' % _quote(path.raw_path))
56
58
        return None
57
59
 
58
 
    def skip_file(self, tree, path, kind, stat_value = None):
59
 
        """Test whether the given file should be skipped or not.
60
 
        
61
 
        The default action never skips. Note this is only called during
62
 
        recursive adds
63
 
        
64
 
        :param tree: The tree we are working in
65
 
        :param path: The path being added
66
 
        :param kind: The kind of object being added.
67
 
        :param stat: Stat result for this file, if available already
68
 
        :return bool. True if the file should be skipped (not added)
69
 
        """
70
 
        return False
71
 
 
72
 
 
73
 
class AddWithSkipLargeAction(AddAction):
74
 
    """A class that can decide to skip a file if it's considered too large"""
75
 
 
76
 
    # default 20 MB
77
 
    _DEFAULT_MAX_FILE_SIZE = 20000000
78
 
    _optionName = 'add.maximum_file_size'
79
 
    _maxSize = None
80
 
 
81
 
    def skip_file(self, tree, path, kind, stat_value = None):
82
 
        if kind != 'file':
83
 
            return False            
84
 
        if self._maxSize is None:
85
 
            config = tree.branch.get_config()
86
 
            self._maxSize = config.get_user_option_as_int_from_SI(
87
 
                self._optionName,  
88
 
                self._DEFAULT_MAX_FILE_SIZE)
89
 
        if stat_value is None:
90
 
            file_size = os.path.getsize(path);
91
 
        else:
92
 
            file_size = stat_value.st_size;
93
 
        if self._maxSize > 0 and file_size > self._maxSize:
94
 
            ui.ui_factory.show_warning(gettext(
95
 
                "skipping {0} (larger than {1} of {2} bytes)").format(
96
 
                path, self._optionName,  self._maxSize))
97
 
            return True
98
 
        return False
99
 
 
100
60
 
101
61
class AddFromBaseAction(AddAction):
102
62
    """This class will try to extract file ids from another tree."""
113
73
        file_id, base_path = self._get_base_file_id(path, parent_ie)
114
74
        if file_id is not None:
115
75
            if self.should_print:
116
 
                self._to_file.write('adding %s w/ file id from %s\n'
117
 
                                    % (path, base_path))
 
76
                self._to_file.write('added %s w/ file id from %s\n'
 
77
                                    % (path.raw_path, base_path))
118
78
        else:
119
79
            # we aren't doing anything special, so let the default
120
80
            # reporter happen
130
90
        Else, we look for an entry in the base tree with the same path.
131
91
        """
132
92
 
133
 
        if self.base_tree.has_id(parent_ie.file_id):
 
93
        if (parent_ie.file_id in self.base_tree):
134
94
            base_parent_ie = self.base_tree.inventory[parent_ie.file_id]
135
 
            base_child_ie = base_parent_ie.children.get(
136
 
                osutils.basename(path))
 
95
            base_child_ie = base_parent_ie.children.get(path.base_path)
137
96
            if base_child_ie is not None:
138
97
                return (base_child_ie.file_id,
139
98
                        self.base_tree.id2path(base_child_ie.file_id))
140
 
        full_base_path = osutils.pathjoin(self.base_path, path)
 
99
        full_base_path = bzrlib.osutils.pathjoin(self.base_path, path.raw_path)
141
100
        # This may return None, but it is our last attempt
142
101
        return self.base_tree.path2id(full_base_path), full_base_path
 
102
 
 
103
 
 
104
# TODO: jam 20050105 These could be used for compatibility
 
105
#       however, they bind against the current stdout, not the
 
106
#       one which exists at the time they are called, so they
 
107
#       don't work for the test suite.
 
108
# deprecated
 
109
add_action_add = AddAction()
 
110
add_action_null = add_action_add
 
111
add_action_add_and_print = AddAction(should_print=True)
 
112
add_action_print = add_action_add_and_print
 
113
 
 
114
 
 
115
@deprecated_function(zero_eighteen)
 
116
def smart_add(file_list, recurse=True, action=None, save=True):
 
117
    """Add files to version, optionally recursing into directories.
 
118
 
 
119
    This is designed more towards DWIM for humans than API simplicity.
 
120
    For the specific behaviour see the help for cmd_add().
 
121
 
 
122
    Returns the number of files added.
 
123
    Deprecated in 0.18. Please use MutableTree.smart_add.
 
124
    """
 
125
    tree = WorkingTree.open_containing(file_list[0])[0]
 
126
    return smart_add_tree(tree, file_list, recurse, action=action, save=save)
 
127
 
 
128
 
 
129
@deprecated_function(zero_eighteen)
 
130
def smart_add_tree(tree, file_list, recurse=True, action=None, save=True):
 
131
    """Deprecated in 0.18. Please use MutableTree.smart_add."""
 
132
    return tree.smart_add(file_list, recurse, action, save)
 
133