← 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: 2011-05-04 12:10:51 UTC
  • mfrom: (5819.1.4 777007-developer-doc)
  • Revision ID: pqm@pqm.ubuntu.com-20110504121051-aovlsmqiivjmc4fc
(jelmer) Small fixes to developer documentation. (Jonathan Riddell)

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
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Lists of ignore files, etc."""
18
18
 
19
19
import errno
20
 
 
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
 
 
 
20
import os
 
21
from cStringIO import StringIO
 
22
 
 
23
import bzrlib
 
24
from bzrlib.lazy_import import lazy_import
 
25
lazy_import(globals(), """
 
26
from bzrlib import (
 
27
    atomicfile,
 
28
    config,
 
29
    globbing,
 
30
    )
 
31
 
 
32
from trace import warning
 
33
""")
82
34
 
83
35
# ~/.bazaar/ignore will be filled out using
84
36
# this ignore list, if it does not exist
92
44
    '*~',
93
45
    '.#*',
94
46
    '[#]*#',
 
47
    '__pycache__',
 
48
    'bzr-orphans',
95
49
]
96
50
 
97
51
 
 
52
 
98
53
def parse_ignore_file(f):
99
 
    """Read in all of the lines in the file and turn it into an ignore list"""
 
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
    """
100
60
    ignored = set()
101
 
    for line in f.read().decode('utf8').split('\n'):
102
 
        line = line.rstrip('/\r\n')
 
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:
 
80
        line = line.rstrip('\r\n')
103
81
        if not line or line.startswith('#'):
104
82
            continue
105
 
        ignored.add(line)
 
83
        ignored.add(globbing.normalize_pattern(line))
106
84
    return ignored
107
85
 
108
86
 
163
141
    ignored = get_user_ignores()
164
142
    to_add = []
165
143
    for ignore in new_ignores:
166
 
        ignore = ignore.rstrip('/')
 
144
        ignore = globbing.normalize_pattern(ignore)
167
145
        if ignore not in ignored:
168
146
            ignored.add(ignore)
169
147
            to_add.append(ignore)
202
180
def get_runtime_ignores():
203
181
    """Get the current set of runtime ignores."""
204
182
    return _runtime_ignores
 
183
 
 
184
 
 
185
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.
 
189
 
 
190
    :param tree: Working tree to update the ignore list.
 
191
    :param name_pattern_list: List of ignore patterns.
 
192
    :return: None
 
193
    """
 
194
    # read in the existing ignores set
 
195
    ifn = tree.abspath(bzrlib.IGNORE_FILENAME)
 
196
    if tree.has_filename(ifn):
 
197
        f = open(ifn, 'rU')
 
198
        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
 
206
        finally:
 
207
            f.close()
 
208
    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
 
219
    f = atomicfile.AtomicFile(ifn, 'wb')
 
220
    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)
 
229
        f.commit()
 
230
    finally:
 
231
        f.close()
 
232
 
 
233
    if not tree.path2id(bzrlib.IGNORE_FILENAME):
 
234
        tree.add([bzrlib.IGNORE_FILENAME])