/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/ignores.py

  • Committer: Robert Collins
  • Date: 2007-04-19 02:27:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2426.
  • Revision ID: robertc@robertcollins.net-20070419022744-pfdqz42kp1wizh43
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
(Robert Collins)

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
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Lists of ignore files, etc."""
18
18
 
19
19
import errno
20
 
from io import BytesIO
21
 
import os
22
20
 
23
 
import breezy
24
 
from .lazy_import import lazy_import
25
 
lazy_import(globals(), """
26
 
from breezy import (
27
 
    atomicfile,
 
21
from bzrlib import (
 
22
    config,
28
23
    globbing,
29
 
    trace,
30
 
    )
31
 
""")
32
 
from . import (
33
 
    bedding,
34
 
    )
35
 
 
36
 
# ~/.config/breezy/ignore will be filled out using
 
24
    )
 
25
 
 
26
# This was the full ignore list for bzr 0.8
 
27
# please keep these sorted (in C locale order) to aid merging
 
28
OLD_DEFAULTS = [
 
29
    '#*#',
 
30
    '*$',
 
31
    '*,v',
 
32
    '*.BAK',
 
33
    '*.a',
 
34
    '*.bak',
 
35
    '*.elc',
 
36
    '*.exe',
 
37
    '*.la',
 
38
    '*.lo',
 
39
    '*.o',
 
40
    '*.obj',
 
41
    '*.orig',
 
42
    '*.py[oc]',
 
43
    '*.so',
 
44
    '*.tmp',
 
45
    '*~',
 
46
    '.#*',
 
47
    '.*.sw[nop]',
 
48
    '.*.tmp',
 
49
    # Our setup tests dump .python-eggs in the bzr source tree root
 
50
    './.python-eggs',
 
51
    '.DS_Store',
 
52
    '.arch-ids',
 
53
    '.arch-inventory',
 
54
    '.bzr.log',
 
55
    '.del-*',
 
56
    '.git',
 
57
    '.hg',
 
58
    '.jamdeps'
 
59
    '.libs',
 
60
    '.make.state',
 
61
    '.sconsign*',
 
62
    '.svn',
 
63
    '.sw[nop]',    # vim editing nameless file
 
64
    '.tmp*',
 
65
    'BitKeeper',
 
66
    'CVS',
 
67
    'CVS.adm',
 
68
    'RCS',
 
69
    'SCCS',
 
70
    'TAGS',
 
71
    '_darcs',
 
72
    'aclocal.m4',
 
73
    'autom4te*',
 
74
    'config.h',
 
75
    'config.h.in',
 
76
    'config.log',
 
77
    'config.status',
 
78
    'config.sub',
 
79
    'stamp-h',
 
80
    'stamp-h.in',
 
81
    'stamp-h1',
 
82
    '{arch}',
 
83
]
 
84
 
 
85
 
 
86
# ~/.bazaar/ignore will be filled out using
37
87
# this ignore list, if it does not exist
38
88
# please keep these sorted (in C locale order) to aid merging
39
89
USER_DEFAULTS = [
45
95
    '*~',
46
96
    '.#*',
47
97
    '[#]*#',
48
 
    '__pycache__',
49
 
    'bzr-orphans',
50
98
]
51
99
 
52
100
 
53
101
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
 
    """
 
102
    """Read in all of the lines in the file and turn it into an ignore list"""
60
103
    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(b'\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
 
                trace.warning(
76
 
                    '.bzrignore: On Line #%d, malformed utf8 character. '
77
 
                    'Ignoring line.' % (line_number + 1))
78
 
 
79
 
    # Append each line to ignore list if it's not a comment line
80
 
    for line in unicode_lines:
 
104
    for line in f.read().decode('utf8').split('\n'):
81
105
        line = line.rstrip('\r\n')
82
106
        if not line or line.startswith('#'):
83
107
            continue
87
111
 
88
112
def get_user_ignores():
89
113
    """Get the list of user ignored files, possibly creating it."""
90
 
    path = bedding.user_ignore_config_path()
 
114
    path = config.user_ignore_config_filename()
91
115
    patterns = set(USER_DEFAULTS)
92
116
    try:
93
117
        f = open(path, 'rb')
94
 
    except (IOError, OSError) as e:
 
118
    except (IOError, OSError), e:
95
119
        # open() shouldn't return an IOError without errno, but just in case
96
120
        err = getattr(e, 'errno', None)
97
121
        if err not in (errno.ENOENT,):
101
125
        # since get_* should be a safe operation
102
126
        try:
103
127
            _set_user_ignores(USER_DEFAULTS)
104
 
        except EnvironmentError as e:
105
 
            if e.errno not in (errno.EPERM, errno.ENOENT):
 
128
        except (IOError, OSError), e:
 
129
            if e.errno not in (errno.EPERM,):
106
130
                raise
107
131
        return patterns
108
132
 
119
143
    write to the user ignore file.
120
144
    This is mostly used for testing, since it would be
121
145
    bad form to rewrite a user's ignore list.
122
 
    breezy only writes this file if it does not exist.
 
146
    bzrlib only writes this file if it does not exist.
123
147
    """
124
 
    ignore_path = bedding.user_ignore_config_path()
125
 
    bedding.ensure_config_dir_exists()
 
148
    ignore_path = config.user_ignore_config_filename()
 
149
    config.ensure_config_dir_exists()
126
150
 
127
151
    # Create an empty file
128
 
    with open(ignore_path, 'wb') as f:
 
152
    f = open(ignore_path, 'wb')
 
153
    try:
129
154
        for pattern in patterns:
130
 
            f.write(pattern.encode('utf8') + b'\n')
 
155
            f.write(pattern.encode('utf8') + '\n')
 
156
    finally:
 
157
        f.close()
131
158
 
132
159
 
133
160
def add_unique_user_ignores(new_ignores):
147
174
    if not to_add:
148
175
        return []
149
176
 
150
 
    with open(bedding.user_ignore_config_path(), 'ab') as f:
 
177
    f = open(config.user_ignore_config_filename(), 'ab')
 
178
    try:
151
179
        for pattern in to_add:
152
 
            f.write(pattern.encode('utf8') + b'\n')
 
180
            f.write(pattern.encode('utf8') + '\n')
 
181
    finally:
 
182
        f.close()
153
183
 
154
184
    return to_add
155
185
 
175
205
def get_runtime_ignores():
176
206
    """Get the current set of runtime ignores."""
177
207
    return _runtime_ignores
178
 
 
179
 
 
180
 
def tree_ignores_add_patterns(tree, name_pattern_list):
181
 
    """Add more ignore patterns to the ignore file in a tree.
182
 
    If ignore file does not exist then it will be created.
183
 
    The ignore file will be automatically added under version control.
184
 
 
185
 
    :param tree: Working tree to update the ignore list.
186
 
    :param name_pattern_list: List of ignore patterns.
187
 
    :return: None
188
 
    """
189
 
    # read in the existing ignores set
190
 
    ifn = tree.abspath(tree._format.ignore_filename)
191
 
    if tree.has_filename(ifn):
192
 
        with open(ifn, 'rb') as f:
193
 
            file_contents = f.read()
194
 
            if file_contents.find(b'\r\n') != -1:
195
 
                newline = b'\r\n'
196
 
            else:
197
 
                newline = b'\n'
198
 
    else:
199
 
        file_contents = b""
200
 
        newline = os.linesep.encode()
201
 
 
202
 
    with BytesIO(file_contents) as sio:
203
 
        ignores = parse_ignore_file(sio)
204
 
 
205
 
    # write out the updated ignores set
206
 
    with atomicfile.AtomicFile(ifn, 'wb') as f:
207
 
        # write the original contents, preserving original line endings
208
 
        f.write(file_contents)
209
 
        if len(file_contents) > 0 and not file_contents.endswith(b'\n'):
210
 
            f.write(newline)
211
 
        for pattern in name_pattern_list:
212
 
            if pattern not in ignores:
213
 
                f.write(pattern.encode('utf-8'))
214
 
                f.write(newline)
215
 
 
216
 
    if not tree.is_versioned(tree._format.ignore_filename):
217
 
        tree.add([tree._format.ignore_filename])