← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/ignores.py

(gz) Backslash escape selftest output when printing to non-unicode consoles
 (Martin [gz])

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/ignores.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2006-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
17
17
"""Lists of ignore files, etc."""
18
18
 
19
19
import errno
 
20
import os
 
21
from cStringIO import StringIO
20
22
 
21
23
import bzrlib
22
24
from bzrlib import (
25
27
    globbing,
26
28
    )
27
29
 
28
 
# This was the full ignore list for bzr 0.8
29
 
# please keep these sorted (in C locale order) to aid merging
30
 
OLD_DEFAULTS = [
31
 
    '#*#',
32
 
    '*$',
33
 
    '*,v',
34
 
    '*.BAK',
35
 
    '*.a',
36
 
    '*.bak',
37
 
    '*.elc',
38
 
    '*.exe',
39
 
    '*.la',
40
 
    '*.lo',
41
 
    '*.o',
42
 
    '*.obj',
43
 
    '*.orig',
44
 
    '*.py[oc]',
45
 
    '*.so',
46
 
    '*.tmp',
47
 
    '*~',
48
 
    '.#*',
49
 
    '.*.sw[nop]',
50
 
    '.*.tmp',
51
 
    # Our setup tests dump .python-eggs in the bzr source tree root
52
 
    './.python-eggs',
53
 
    '.DS_Store',
54
 
    '.arch-ids',
55
 
    '.arch-inventory',
56
 
    '.bzr.log',
57
 
    '.del-*',
58
 
    '.git',
59
 
    '.hg',
60
 
    '.jamdeps'
61
 
    '.libs',
62
 
    '.make.state',
63
 
    '.sconsign*',
64
 
    '.svn',
65
 
    '.sw[nop]',    # vim editing nameless file
66
 
    '.tmp*',
67
 
    'BitKeeper',
68
 
    'CVS',
69
 
    'CVS.adm',
70
 
    'RCS',
71
 
    'SCCS',
72
 
    'TAGS',
73
 
    '_darcs',
74
 
    'aclocal.m4',
75
 
    'autom4te*',
76
 
    'config.h',
77
 
    'config.h.in',
78
 
    'config.log',
79
 
    'config.status',
80
 
    'config.sub',
81
 
    'stamp-h',
82
 
    'stamp-h.in',
83
 
    'stamp-h1',
84
 
    '{arch}',
85
 
]
86
 
 
 
30
from trace import warning
87
31
 
88
32
# ~/.bazaar/ignore will be filled out using
89
33
# this ignore list, if it does not exist
97
41
    '*~',
98
42
    '.#*',
99
43
    '[#]*#',
 
44
    '__pycache__',
 
45
    'bzr-orphans',
100
46
]
101
47
 
102
48
 
 
49
 
103
50
def parse_ignore_file(f):
104
 
    """Read in all of the lines in the file and turn it into an ignore list"""
 
51
    """Read in all of the lines in the file and turn it into an ignore list
 
52
    
 
53
    Continue in the case of utf8 decoding errors, and emit a warning when 
 
54
    such and error is found. Optimise for the common case -- no decoding 
 
55
    errors.
 
56
    """
105
57
    ignored = set()
106
 
    for line in f.read().decode('utf8').split('\n'):
 
58
    ignore_file = f.read()
 
59
    try:
 
60
        # Try and parse whole ignore file at once.
 
61
        unicode_lines = ignore_file.decode('utf8').split('\n')
 
62
    except UnicodeDecodeError:
 
63
        # Otherwise go though line by line and pick out the 'good'
 
64
        # decodable lines
 
65
        lines = ignore_file.split('\n')
 
66
        unicode_lines = []
 
67
        for line_number, line in enumerate(lines):
 
68
            try:
 
69
                unicode_lines.append(line.decode('utf-8'))
 
70
            except UnicodeDecodeError:
 
71
                # report error about line (idx+1)
 
72
                warning('.bzrignore: On Line #%d, malformed utf8 character. '
 
73
                        'Ignoring line.' % (line_number+1))
 
74
 
 
75
    # Append each line to ignore list if it's not a comment line
 
76
    for line in unicode_lines:
107
77
        line = line.rstrip('\r\n')
108
78
        if not line or line.startswith('#'):
109
79
            continue
210
180
 
211
181
 
212
182
def tree_ignores_add_patterns(tree, name_pattern_list):
213
 
    """Retrieve a list of ignores from the ignore file in a tree.
 
183
    """Add more ignore patterns to the ignore file in a tree.
 
184
    If ignore file does not exist then it will be created.
 
185
    The ignore file will be automatically added under version control.
214
186
 
215
 
    :param tree: Tree to retrieve the ignore list from.
216
 
    :return:
 
187
    :param tree: Working tree to update the ignore list.
 
188
    :param name_pattern_list: List of ignore patterns.
 
189
    :return: None
217
190
    """
 
191
    # read in the existing ignores set
218
192
    ifn = tree.abspath(bzrlib.IGNORE_FILENAME)
219
193
    if tree.has_filename(ifn):
220
 
        f = open(ifn, 'rt')
 
194
        f = open(ifn, 'rU')
221
195
        try:
222
 
            igns = f.read().decode('utf-8')
 
196
            file_contents = f.read()
 
197
            # figure out what kind of line endings are used
 
198
            newline = getattr(f, 'newlines', None)
 
199
            if type(newline) is tuple:
 
200
                newline = newline[0]
 
201
            elif newline is None:
 
202
                newline = os.linesep
223
203
        finally:
224
204
            f.close()
225
205
    else:
226
 
        igns = ""
227
 
 
228
 
    # TODO: If the file already uses crlf-style termination, maybe
229
 
    # we should use that for the newly added lines?
230
 
 
231
 
    if igns and igns[-1] != '\n':
232
 
        igns += '\n'
233
 
    for name_pattern in name_pattern_list:
234
 
        igns += name_pattern + '\n'
235
 
 
 
206
        file_contents = ""
 
207
        newline = os.linesep
 
208
    
 
209
    sio = StringIO(file_contents)
 
210
    try:
 
211
        ignores = parse_ignore_file(sio)
 
212
    finally:
 
213
        sio.close()
 
214
    
 
215
    # write out the updated ignores set
236
216
    f = atomicfile.AtomicFile(ifn, 'wb')
237
217
    try:
238
 
        f.write(igns.encode('utf-8'))
 
218
        # write the original contents, preserving original line endings
 
219
        f.write(newline.join(file_contents.split('\n')))
 
220
        if len(file_contents) > 0 and not file_contents.endswith('\n'):
 
221
            f.write(newline)
 
222
        for pattern in name_pattern_list:
 
223
            if not pattern in ignores:
 
224
                f.write(pattern.encode('utf-8'))
 
225
                f.write(newline)
239
226
        f.commit()
240
227
    finally:
241
228
        f.close()
242
229
 
243
 
    if not tree.path2id('.bzrignore'):
244
 
        tree.add(['.bzrignore'])
 
230
    if not tree.path2id(bzrlib.IGNORE_FILENAME):
 
231
        tree.add([bzrlib.IGNORE_FILENAME])