← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/ignores.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 05:06:57 UTC
  • mfrom: (6603.4.1 bzr)
  • Revision ID: pqm@pqm.ubuntu.com-20160421050657-ygnzfybewvudf1j9
(richard-wilbur) Use initial_comment as commit_message for lp_propose.(Shawn
 Wang) (Shawn Wang)

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