← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/ignores.py

  • Committer: Martin Pool
  • Date: 2010-02-25 06:17:27 UTC
  • mfrom: (5055 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5057.
  • Revision ID: mbp@sourcefrog.net-20100225061727-4sd9lt0qmdc6087t
merge news

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/ignores.py
1
 
# Copyright (C) 2006-2011 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
17
17
"""Lists of ignore files, etc."""
18
18
 
19
19
import errno
20
 
import os
21
 
from cStringIO import StringIO
22
20
 
23
21
import bzrlib
24
 
from bzrlib.lazy_import import lazy_import
25
 
lazy_import(globals(), """
26
22
from bzrlib import (
27
23
    atomicfile,
28
24
    config,
29
25
    globbing,
30
26
    )
31
27
 
32
 
from trace import warning
33
 
""")
 
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
 
34
87
 
35
88
# ~/.bazaar/ignore will be filled out using
36
89
# this ignore list, if it does not exist
44
97
    '*~',
45
98
    '.#*',
46
99
    '[#]*#',
47
 
    '__pycache__',
48
 
    'bzr-orphans',
49
100
]
50
101
 
51
102
 
52
 
 
53
103
def parse_ignore_file(f):
54
 
    """Read in all of the lines in the file and turn it into an ignore list
55
 
    
56
 
    Continue in the case of utf8 decoding errors, and emit a warning when 
57
 
    such and error is found. Optimise for the common case -- no decoding 
58
 
    errors.
59
 
    """
 
104
    """Read in all of the lines in the file and turn it into an ignore list"""
60
105
    ignored = set()
61
 
    ignore_file = f.read()
62
 
    try:
63
 
        # Try and parse whole ignore file at once.
64
 
        unicode_lines = ignore_file.decode('utf8').split('\n')
65
 
    except UnicodeDecodeError:
66
 
        # Otherwise go though line by line and pick out the 'good'
67
 
        # decodable lines
68
 
        lines = ignore_file.split('\n')
69
 
        unicode_lines = []
70
 
        for line_number, line in enumerate(lines):
71
 
            try:
72
 
                unicode_lines.append(line.decode('utf-8'))
73
 
            except UnicodeDecodeError:
74
 
                # report error about line (idx+1)
75
 
                warning('.bzrignore: On Line #%d, malformed utf8 character. '
76
 
                        'Ignoring line.' % (line_number+1))
77
 
 
78
 
    # Append each line to ignore list if it's not a comment line
79
 
    for line in unicode_lines:
 
106
    for line in f.read().decode('utf8').split('\n'):
80
107
        line = line.rstrip('\r\n')
81
108
        if not line or line.startswith('#'):
82
109
            continue
183
210
 
184
211
 
185
212
def tree_ignores_add_patterns(tree, name_pattern_list):
186
 
    """Add more ignore patterns to the ignore file in a tree.
187
 
    If ignore file does not exist then it will be created.
188
 
    The ignore file will be automatically added under version control.
 
213
    """Retrieve a list of ignores from the ignore file in a tree.
189
214
 
190
 
    :param tree: Working tree to update the ignore list.
191
 
    :param name_pattern_list: List of ignore patterns.
192
 
    :return: None
 
215
    :param tree: Tree to retrieve the ignore list from.
 
216
    :return:
193
217
    """
194
 
    # read in the existing ignores set
195
218
    ifn = tree.abspath(bzrlib.IGNORE_FILENAME)
196
219
    if tree.has_filename(ifn):
197
 
        f = open(ifn, 'rU')
 
220
        f = open(ifn, 'rt')
198
221
        try:
199
 
            file_contents = f.read()
200
 
            # figure out what kind of line endings are used
201
 
            newline = getattr(f, 'newlines', None)
202
 
            if type(newline) is tuple:
203
 
                newline = newline[0]
204
 
            elif newline is None:
205
 
                newline = os.linesep
 
222
            igns = f.read().decode('utf-8')
206
223
        finally:
207
224
            f.close()
208
225
    else:
209
 
        file_contents = ""
210
 
        newline = os.linesep
211
 
    
212
 
    sio = StringIO(file_contents)
213
 
    try:
214
 
        ignores = parse_ignore_file(sio)
215
 
    finally:
216
 
        sio.close()
217
 
    
218
 
    # write out the updated ignores set
 
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
 
219
236
    f = atomicfile.AtomicFile(ifn, 'wb')
220
237
    try:
221
 
        # write the original contents, preserving original line endings
222
 
        f.write(newline.join(file_contents.split('\n')))
223
 
        if len(file_contents) > 0 and not file_contents.endswith('\n'):
224
 
            f.write(newline)
225
 
        for pattern in name_pattern_list:
226
 
            if not pattern in ignores:
227
 
                f.write(pattern.encode('utf-8'))
228
 
                f.write(newline)
 
238
        f.write(igns.encode('utf-8'))
229
239
        f.commit()
230
240
    finally:
231
241
        f.close()
232
242
 
233
 
    if not tree.path2id(bzrlib.IGNORE_FILENAME):
234
 
        tree.add([bzrlib.IGNORE_FILENAME])
 
243
    if not tree.path2id('.bzrignore'):
 
244
        tree.add(['.bzrignore'])