← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/add.py

  • Committer: Jelmer Vernooij
  • Date: 2011-12-19 13:23:58 UTC
  • mto: This revision was merged to the branch mainline in revision 6386.
  • Revision ID: jelmer@canonical.com-20111219132358-uvs5a6y92gomzacd
Move importing from future until after doc string, otherwise the doc string will disappear.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/add.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
16
16
 
17
17
"""Helper functions for adding files to working trees."""
18
18
 
 
19
from __future__ import absolute_import
 
20
 
19
21
import sys
20
 
 
21
 
import bzrlib.bzrdir
22
 
import bzrlib.osutils
23
 
from bzrlib.symbol_versioning import *
24
 
 
 
22
import os
 
23
 
 
24
from bzrlib import (
 
25
    osutils,
 
26
    ui, 
 
27
    )
 
28
from bzrlib.i18n import gettext
25
29
 
26
30
class AddAction(object):
27
31
    """A class which defines what action to take when adding a file."""
40
44
        if should_print is not None:
41
45
            self.should_print = should_print
42
46
 
43
 
    def __call__(self, inv, parent_ie, path, kind, _quote=bzrlib.osutils.quotefn):
 
47
    def __call__(self, inv, parent_ie, path, kind, _quote=osutils.quotefn):
44
48
        """Add path to inventory.
45
49
 
46
50
        The default action does nothing.
50
54
        :param kind: The kind of the object being added.
51
55
        """
52
56
        if self.should_print:
53
 
            self._to_file.write('adding %s\n' % _quote(path.raw_path))
 
57
            self._to_file.write('adding %s\n' % _quote(path))
54
58
        return None
55
59
 
 
60
    def skip_file(self, tree, path, kind, stat_value = None):
 
61
        """Test whether the given file should be skipped or not.
 
62
        
 
63
        The default action never skips. Note this is only called during
 
64
        recursive adds
 
65
        
 
66
        :param tree: The tree we are working in
 
67
        :param path: The path being added
 
68
        :param kind: The kind of object being added.
 
69
        :param stat: Stat result for this file, if available already
 
70
        :return bool. True if the file should be skipped (not added)
 
71
        """
 
72
        return False
 
73
 
 
74
 
 
75
class AddWithSkipLargeAction(AddAction):
 
76
    """A class that can decide to skip a file if it's considered too large"""
 
77
 
 
78
    # default 20 MB
 
79
    _DEFAULT_MAX_FILE_SIZE = 20000000
 
80
    _optionName = 'add.maximum_file_size'
 
81
    _maxSize = None
 
82
 
 
83
    def skip_file(self, tree, path, kind, stat_value = None):
 
84
        if kind != 'file':
 
85
            return False            
 
86
        if self._maxSize is None:
 
87
            config = tree.branch.get_config()
 
88
            self._maxSize = config.get_user_option_as_int_from_SI(
 
89
                self._optionName,  
 
90
                self._DEFAULT_MAX_FILE_SIZE)
 
91
        if stat_value is None:
 
92
            file_size = os.path.getsize(path);
 
93
        else:
 
94
            file_size = stat_value.st_size;
 
95
        if self._maxSize > 0 and file_size > self._maxSize:
 
96
            ui.ui_factory.show_warning(gettext(
 
97
                "skipping {0} (larger than {1} of {2} bytes)").format(
 
98
                path, self._optionName,  self._maxSize))
 
99
            return True
 
100
        return False
 
101
 
56
102
 
57
103
class AddFromBaseAction(AddAction):
58
104
    """This class will try to extract file ids from another tree."""
70
116
        if file_id is not None:
71
117
            if self.should_print:
72
118
                self._to_file.write('adding %s w/ file id from %s\n'
73
 
                                    % (path.raw_path, base_path))
 
119
                                    % (path, base_path))
74
120
        else:
75
121
            # we aren't doing anything special, so let the default
76
122
            # reporter happen
86
132
        Else, we look for an entry in the base tree with the same path.
87
133
        """
88
134
 
89
 
        if (parent_ie.file_id in self.base_tree):
 
135
        if self.base_tree.has_id(parent_ie.file_id):
90
136
            base_parent_ie = self.base_tree.inventory[parent_ie.file_id]
91
 
            base_child_ie = base_parent_ie.children.get(path.base_path)
 
137
            base_child_ie = base_parent_ie.children.get(
 
138
                osutils.basename(path))
92
139
            if base_child_ie is not None:
93
140
                return (base_child_ie.file_id,
94
141
                        self.base_tree.id2path(base_child_ie.file_id))
95
 
        full_base_path = bzrlib.osutils.pathjoin(self.base_path, path.raw_path)
 
142
        full_base_path = osutils.pathjoin(self.base_path, path)
96
143
        # This may return None, but it is our last attempt
97
144
        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