← 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: 2005-05-16 02:19:13 UTC
  • Revision ID: mbp@sourcefrog.net-20050516021913-3a933f871079e3fe
- patch from ddaa to create api/ directory 
  before building API docs

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/ignores.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
2
 
#
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
#
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
#
13
 
# You should have received a copy of the GNU General Public License
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
16
 
 
17
 
"""Lists of ignore files, etc."""
18
 
 
19
 
import errno
20
 
 
21
 
import bzrlib
22
 
from bzrlib import (
23
 
    atomicfile,
24
 
    config,
25
 
    globbing,
26
 
    )
27
 
 
28
 
from trace import warning
29
 
 
30
 
# ~/.bazaar/ignore will be filled out using
31
 
# this ignore list, if it does not exist
32
 
# please keep these sorted (in C locale order) to aid merging
33
 
USER_DEFAULTS = [
34
 
    '*.a',
35
 
    '*.o',
36
 
    '*.py[co]',
37
 
    '*.so',
38
 
    '*.sw[nop]',
39
 
    '*~',
40
 
    '.#*',
41
 
    '[#]*#',
42
 
]
43
 
 
44
 
 
45
 
 
46
 
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:
73
 
        line = line.rstrip('\r\n')
74
 
        if not line or line.startswith('#'):
75
 
            continue
76
 
        ignored.add(globbing.normalize_pattern(line))
77
 
    return ignored
78
 
 
79
 
 
80
 
def get_user_ignores():
81
 
    """Get the list of user ignored files, possibly creating it."""
82
 
    path = config.user_ignore_config_filename()
83
 
    patterns = set(USER_DEFAULTS)
84
 
    try:
85
 
        f = open(path, 'rb')
86
 
    except (IOError, OSError), e:
87
 
        # open() shouldn't return an IOError without errno, but just in case
88
 
        err = getattr(e, 'errno', None)
89
 
        if err not in (errno.ENOENT,):
90
 
            raise
91
 
        # Create the ignore file, and just return the default
92
 
        # We want to ignore if we can't write to the file
93
 
        # since get_* should be a safe operation
94
 
        try:
95
 
            _set_user_ignores(USER_DEFAULTS)
96
 
        except (IOError, OSError), e:
97
 
            if e.errno not in (errno.EPERM,):
98
 
                raise
99
 
        return patterns
100
 
 
101
 
    try:
102
 
        return parse_ignore_file(f)
103
 
    finally:
104
 
        f.close()
105
 
 
106
 
 
107
 
def _set_user_ignores(patterns):
108
 
    """Fill out the user ignore file with the given patterns
109
 
 
110
 
    This may raise an error if it doesn't have permission to
111
 
    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
 
    """
116
 
    ignore_path = config.user_ignore_config_filename()
117
 
    config.ensure_config_dir_exists()
118
 
 
119
 
    # Create an empty file
120
 
    f = open(ignore_path, 'wb')
121
 
    try:
122
 
        for pattern in patterns:
123
 
            f.write(pattern.encode('utf8') + '\n')
124
 
    finally:
125
 
        f.close()
126
 
 
127
 
 
128
 
def add_unique_user_ignores(new_ignores):
129
 
    """Add entries to the user's ignore list if not present.
130
 
 
131
 
    :param new_ignores: A list of ignore patterns
132
 
    :return: The list of ignores that were added
133
 
    """
134
 
    ignored = get_user_ignores()
135
 
    to_add = []
136
 
    for ignore in new_ignores:
137
 
        ignore = globbing.normalize_pattern(ignore)
138
 
        if ignore not in ignored:
139
 
            ignored.add(ignore)
140
 
            to_add.append(ignore)
141
 
 
142
 
    if not to_add:
143
 
        return []
144
 
 
145
 
    f = open(config.user_ignore_config_filename(), 'ab')
146
 
    try:
147
 
        for pattern in to_add:
148
 
            f.write(pattern.encode('utf8') + '\n')
149
 
    finally:
150
 
        f.close()
151
 
 
152
 
    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])