← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/ignores.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-07-21 03:37:53 UTC
  • mfrom: (1873.1.1 bzr.mbp.update)
  • Revision ID: pqm@pqm.ubuntu.com-20060721033753-193c788f37dd5004
(metze) add bzr up as synonym for update

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/ignores.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Development 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
"""Lists of ignore files, etc."""
18
18
 
19
19
import errno
20
20
 
21
 
import bzrlib
22
 
from bzrlib import (
23
 
    atomicfile,
24
 
    config,
25
 
    globbing,
26
 
    )
27
 
 
28
 
from trace import warning
 
21
from bzrlib import config
 
22
 
 
23
# This was the full ignore list for bzr 0.8
 
24
# please keep these sorted (in C locale order) to aid merging
 
25
OLD_DEFAULTS = [
 
26
    '#*#',
 
27
    '*$',
 
28
    '*,v',
 
29
    '*.BAK',
 
30
    '*.a',
 
31
    '*.bak',
 
32
    '*.elc',
 
33
    '*.exe',
 
34
    '*.la',
 
35
    '*.lo',
 
36
    '*.o',
 
37
    '*.obj',
 
38
    '*.orig',
 
39
    '*.py[oc]',
 
40
    '*.so',
 
41
    '*.tmp',
 
42
    '*~',
 
43
    '.#*',
 
44
    '.*.sw[nop]',
 
45
    '.*.tmp',
 
46
    # Our setup tests dump .python-eggs in the bzr source tree root
 
47
    './.python-eggs',
 
48
    '.DS_Store',
 
49
    '.arch-ids',
 
50
    '.arch-inventory',
 
51
    '.bzr.log',
 
52
    '.del-*',
 
53
    '.git',
 
54
    '.hg',
 
55
    '.jamdeps'
 
56
    '.libs',
 
57
    '.make.state',
 
58
    '.sconsign*',
 
59
    '.svn',
 
60
    '.sw[nop]',    # vim editing nameless file
 
61
    '.tmp*',
 
62
    'BitKeeper',
 
63
    'CVS',
 
64
    'CVS.adm',
 
65
    'RCS',
 
66
    'SCCS',
 
67
    'TAGS',
 
68
    '_darcs',
 
69
    'aclocal.m4',
 
70
    'autom4te*',
 
71
    'config.h',
 
72
    'config.h.in',
 
73
    'config.log',
 
74
    'config.status',
 
75
    'config.sub',
 
76
    'stamp-h',
 
77
    'stamp-h.in',
 
78
    'stamp-h1',
 
79
    '{arch}',
 
80
]
 
81
 
29
82
 
30
83
# ~/.bazaar/ignore will be filled out using
31
84
# this ignore list, if it does not exist
42
95
]
43
96
 
44
97
 
45
 
 
46
98
def parse_ignore_file(f):
47
 
    """Read in all of the lines in the file and turn it into an ignore list
48
 
    
49
 
    Continue in the case of utf8 decoding errors, and emit a warning when 
50
 
    such and error is found. Optimise for the common case -- no decoding 
51
 
    errors.
52
 
    """
53
 
    ignored = set()
54
 
    ignore_file = f.read()
55
 
    try:
56
 
        # Try and parse whole ignore file at once.
57
 
        unicode_lines = ignore_file.decode('utf8').split('\n')
58
 
    except UnicodeDecodeError:
59
 
        # Otherwise go though line by line and pick out the 'good'
60
 
        # decodable lines
61
 
        lines = ignore_file.split('\n')
62
 
        unicode_lines = []
63
 
        for line_number, line in enumerate(lines):
64
 
            try:
65
 
                unicode_lines.append(line.decode('utf-8'))
66
 
            except UnicodeDecodeError:
67
 
                # report error about line (idx+1)
68
 
                warning('.bzrignore: On Line #%d, malformed utf8 character. '
69
 
                        'Ignoring line.' % (line_number+1))
70
 
 
71
 
    # Append each line to ignore list if it's not a comment line
72
 
    for line in unicode_lines:
 
99
    """Read in all of the lines in the file and turn it into an ignore list"""
 
100
    ignored = []
 
101
    for line in f.read().decode('utf8').split('\n'):
73
102
        line = line.rstrip('\r\n')
74
103
        if not line or line.startswith('#'):
75
104
            continue
76
 
        ignored.add(globbing.normalize_pattern(line))
 
105
        ignored.append(line)
77
106
    return ignored
78
107
 
79
108
 
80
109
def get_user_ignores():
81
110
    """Get the list of user ignored files, possibly creating it."""
82
111
    path = config.user_ignore_config_filename()
83
 
    patterns = set(USER_DEFAULTS)
 
112
    patterns = USER_DEFAULTS[:]
84
113
    try:
85
114
        f = open(path, 'rb')
86
115
    except (IOError, OSError), e:
92
121
        # We want to ignore if we can't write to the file
93
122
        # since get_* should be a safe operation
94
123
        try:
95
 
            _set_user_ignores(USER_DEFAULTS)
 
124
            set_user_ignores(USER_DEFAULTS)
96
125
        except (IOError, OSError), e:
97
126
            if e.errno not in (errno.EPERM,):
98
127
                raise
104
133
        f.close()
105
134
 
106
135
 
107
 
def _set_user_ignores(patterns):
 
136
def set_user_ignores(patterns):
108
137
    """Fill out the user ignore file with the given patterns
109
138
 
110
139
    This may raise an error if it doesn't have permission to
111
140
    write to the user ignore file.
112
 
    This is mostly used for testing, since it would be
113
 
    bad form to rewrite a user's ignore list.
114
 
    bzrlib only writes this file if it does not exist.
115
141
    """
116
142
    ignore_path = config.user_ignore_config_filename()
117
143
    config.ensure_config_dir_exists()
131
157
    :param new_ignores: A list of ignore patterns
132
158
    :return: The list of ignores that were added
133
159
    """
134
 
    ignored = get_user_ignores()
 
160
    ignored = set(get_user_ignores())
135
161
    to_add = []
136
162
    for ignore in new_ignores:
137
 
        ignore = globbing.normalize_pattern(ignore)
138
163
        if ignore not in ignored:
139
164
            ignored.add(ignore)
140
165
            to_add.append(ignore)
150
175
        f.close()
151
176
 
152
177
    return to_add
153
 
 
154
 
 
155
 
_runtime_ignores = set()
156
 
 
157
 
 
158
 
def add_runtime_ignores(ignores):
159
 
    """Add some ignore patterns that only exists in memory.
160
 
 
161
 
    This is used by some plugins that want bzr to ignore files,
162
 
    but don't want to change a users ignore list.
163
 
    (Such as a conversion script that needs to ignore temporary files,
164
 
    but does not want to modify the project's ignore list.)
165
 
 
166
 
    :param ignores: A list or generator of ignore patterns.
167
 
    :return: None
168
 
    """
169
 
    global _runtime_ignores
170
 
    _runtime_ignores.update(set(ignores))
171
 
 
172
 
 
173
 
def get_runtime_ignores():
174
 
    """Get the current set of runtime ignores."""
175
 
    return _runtime_ignores
176
 
 
177
 
 
178
 
def tree_ignores_add_patterns(tree, name_pattern_list):
179
 
    """Add more ignore patterns to the ignore file in a tree.
180
 
    If ignore file does not exist then it will be created.
181
 
    The ignore file will be automatically added under version control.
182
 
 
183
 
    :param tree: Working tree to update the ignore list.
184
 
    """
185
 
    ifn = tree.abspath(bzrlib.IGNORE_FILENAME)
186
 
    if tree.has_filename(ifn):
187
 
        f = open(ifn, 'rt')
188
 
        try:
189
 
            igns = f.read().decode('utf-8')
190
 
        finally:
191
 
            f.close()
192
 
    else:
193
 
        igns = ""
194
 
 
195
 
    # TODO: If the file already uses crlf-style termination, maybe
196
 
    # we should use that for the newly added lines?
197
 
 
198
 
    if igns and igns[-1] != '\n':
199
 
        igns += '\n'
200
 
    for name_pattern in name_pattern_list:
201
 
        igns += name_pattern + '\n'
202
 
 
203
 
    f = atomicfile.AtomicFile(ifn, 'wb')
204
 
    try:
205
 
        f.write(igns.encode('utf-8'))
206
 
        f.commit()
207
 
    finally:
208
 
        f.close()
209
 
 
210
 
    if not tree.path2id(bzrlib.IGNORE_FILENAME):
211
 
        tree.add([bzrlib.IGNORE_FILENAME])