← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/add.py

  • Committer: Martin
  • Date: 2010-05-03 20:57:39 UTC
  • mto: This revision was merged to the branch mainline in revision 5204.
  • Revision ID: gzlist@googlemail.com-20100503205739-n326zdvevv0rmruh
Retain original stack and error message when translating to ValueError in bencode

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/add.py
 
1
# Copyright (C) 2005, 2006 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
"""Helper functions for adding files to working trees."""
 
18
 
 
19
import sys
 
20
 
 
21
import bzrlib.bzrdir
 
22
import bzrlib.osutils
 
23
from bzrlib.symbol_versioning import *
 
24
 
 
25
 
 
26
class AddAction(object):
 
27
    """A class which defines what action to take when adding a file."""
 
28
 
 
29
    def __init__(self, to_file=None, should_print=None):
 
30
        """Initialize an action which prints added files to an output stream.
 
31
 
 
32
        :param to_file: The stream to write into. This is expected to take
 
33
            Unicode paths. If not supplied, it will default to ``sys.stdout``.
 
34
        :param should_print: If False, printing will be suppressed.
 
35
        """
 
36
        self._to_file = to_file
 
37
        if to_file is None:
 
38
            self._to_file = sys.stdout
 
39
        self.should_print = False
 
40
        if should_print is not None:
 
41
            self.should_print = should_print
 
42
 
 
43
    def __call__(self, inv, parent_ie, path, kind, _quote=bzrlib.osutils.quotefn):
 
44
        """Add path to inventory.
 
45
 
 
46
        The default action does nothing.
 
47
 
 
48
        :param inv: The inventory we are working with.
 
49
        :param path: The FastPath being added
 
50
        :param kind: The kind of the object being added.
 
51
        """
 
52
        if self.should_print:
 
53
            self._to_file.write('adding %s\n' % _quote(path.raw_path))
 
54
        return None
 
55
 
 
56
 
 
57
class AddFromBaseAction(AddAction):
 
58
    """This class will try to extract file ids from another tree."""
 
59
 
 
60
    def __init__(self, base_tree, base_path, to_file=None, should_print=None):
 
61
        super(AddFromBaseAction, self).__init__(to_file=to_file,
 
62
                                                should_print=should_print)
 
63
        self.base_tree = base_tree
 
64
        self.base_path = base_path
 
65
 
 
66
    def __call__(self, inv, parent_ie, path, kind):
 
67
        # Place the parent call
 
68
        # Now check to see if we can extract an id for this file
 
69
        file_id, base_path = self._get_base_file_id(path, parent_ie)
 
70
        if file_id is not None:
 
71
            if self.should_print:
 
72
                self._to_file.write('adding %s w/ file id from %s\n'
 
73
                                    % (path.raw_path, base_path))
 
74
        else:
 
75
            # we aren't doing anything special, so let the default
 
76
            # reporter happen
 
77
            file_id = super(AddFromBaseAction, self).__call__(
 
78
                        inv, parent_ie, path, kind)
 
79
        return file_id
 
80
 
 
81
    def _get_base_file_id(self, path, parent_ie):
 
82
        """Look for a file id in the base branch.
 
83
 
 
84
        First, if the base tree has the parent directory,
 
85
        we look for a file with the same name in that directory.
 
86
        Else, we look for an entry in the base tree with the same path.
 
87
        """
 
88
 
 
89
        if (parent_ie.file_id in self.base_tree):
 
90
            base_parent_ie = self.base_tree.inventory[parent_ie.file_id]
 
91
            base_child_ie = base_parent_ie.children.get(path.base_path)
 
92
            if base_child_ie is not None:
 
93
                return (base_child_ie.file_id,
 
94
                        self.base_tree.id2path(base_child_ie.file_id))
 
95
        full_base_path = bzrlib.osutils.pathjoin(self.base_path, path.raw_path)
 
96
        # This may return None, but it is our last attempt
 
97
        return self.base_tree.path2id(full_base_path), full_base_path
 
98
 
 
99
 
 
100
# TODO: jam 20050105 These could be used for compatibility
 
101
#       however, they bind against the current stdout, not the
 
102
#       one which exists at the time they are called, so they
 
103
#       don't work for the test suite.
 
104
# deprecated
 
105
add_action_add = AddAction()
 
106
add_action_null = add_action_add
 
107
add_action_add_and_print = AddAction(should_print=True)
 
108
add_action_print = add_action_add_and_print