1
# Copyright (C) 2005, 2006 Canonical Ltd
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.
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.
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Lists of ignore files, etc."""
21
from bzrlib import config
23
# This was the full ignore list for bzr 0.8
24
# please keep these sorted (in C locale order) to aid merging
46
# Our setup tests dump .python-eggs in the bzr source tree root
60
'.sw[nop]', # vim editing nameless file
83
# ~/.bazaar/ignore will be filled out using
84
# this ignore list, if it does not exist
85
# please keep these sorted (in C locale order) to aid merging
98
def parse_ignore_file(f):
99
"""Read in all of the lines in the file and turn it into an ignore list"""
101
for line in f.read().decode('utf8').split('\n'):
102
line = line.rstrip('/\r\n')
103
if not line or line.startswith('#'):
109
def get_user_ignores():
110
"""Get the list of user ignored files, possibly creating it."""
111
path = config.user_ignore_config_filename()
112
patterns = set(USER_DEFAULTS)
115
except (IOError, OSError), e:
116
# open() shouldn't return an IOError without errno, but just in case
117
err = getattr(e, 'errno', None)
118
if err not in (errno.ENOENT,):
120
# Create the ignore file, and just return the default
121
# We want to ignore if we can't write to the file
122
# since get_* should be a safe operation
124
_set_user_ignores(USER_DEFAULTS)
125
except (IOError, OSError), e:
126
if e.errno not in (errno.EPERM,):
131
return parse_ignore_file(f)
136
def _set_user_ignores(patterns):
137
"""Fill out the user ignore file with the given patterns
139
This may raise an error if it doesn't have permission to
140
write to the user ignore file.
141
This is mostly used for testing, since it would be
142
bad form to rewrite a user's ignore list.
143
bzrlib only writes this file if it does not exist.
145
ignore_path = config.user_ignore_config_filename()
146
config.ensure_config_dir_exists()
148
# Create an empty file
149
f = open(ignore_path, 'wb')
151
for pattern in patterns:
152
f.write(pattern.encode('utf8') + '\n')
157
def add_unique_user_ignores(new_ignores):
158
"""Add entries to the user's ignore list if not present.
160
:param new_ignores: A list of ignore patterns
161
:return: The list of ignores that were added
163
ignored = get_user_ignores()
165
for ignore in new_ignores:
166
ignore = ignore.rstrip('/')
167
if ignore not in ignored:
169
to_add.append(ignore)
174
f = open(config.user_ignore_config_filename(), 'ab')
176
for pattern in to_add:
177
f.write(pattern.encode('utf8') + '\n')
184
_runtime_ignores = set()
187
def add_runtime_ignores(ignores):
188
"""Add some ignore patterns that only exists in memory.
190
This is used by some plugins that want bzr to ignore files,
191
but don't want to change a users ignore list.
192
(Such as a conversion script that needs to ignore temporary files,
193
but does not want to modify the project's ignore list.)
195
:param ignores: A list or generator of ignore patterns.
198
global _runtime_ignores
199
_runtime_ignores.update(set(ignores))
202
def get_runtime_ignores():
203
"""Get the current set of runtime ignores."""
204
return _runtime_ignores
added
removed
bzrlib/ignores.py
