/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: 2010-05-05 00:05:29 UTC
  • mto: This revision was merged to the branch mainline in revision 5206.
  • Revision ID: robertc@robertcollins.net-20100505000529-ltmllyms5watqj5u
Make 'pydoc bzrlib.tests.build_tree_shape' useful.

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) 2006-2010 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
 
 
21
19
import errno
22
 
from io import BytesIO
23
 
import os
24
20
 
25
 
import breezy
26
 
from .lazy_import import lazy_import
27
 
lazy_import(globals(), """
28
 
from breezy import (
 
21
import bzrlib
 
22
from bzrlib import (
29
23
    atomicfile,
 
24
    config,
30
25
    globbing,
31
 
    trace,
32
 
    )
33
 
""")
34
 
from . import (
35
 
    bedding,
36
 
    )
37
 
 
38
 
# ~/.config/breezy/ignore will be filled out using
 
26
    )
 
27
 
 
28
from trace import warning
 
29
 
 
30
# ~/.bazaar/ignore will be filled out using
39
31
# this ignore list, if it does not exist
40
32
# please keep these sorted (in C locale order) to aid merging
41
33
USER_DEFAULTS = [
47
39
    '*~',
48
40
    '.#*',
49
41
    '[#]*#',
50
 
    '__pycache__',
51
 
    'bzr-orphans',
52
42
]
53
43
 
54
44
 
 
45
 
55
46
def parse_ignore_file(f):
56
47
    """Read in all of the lines in the file and turn it into an ignore list
57
 
 
58
 
    Continue in the case of utf8 decoding errors, and emit a warning when
59
 
    such and error is found. Optimise for the common case -- no decoding
 
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 
60
51
    errors.
61
52
    """
62
53
    ignored = set()
67
58
    except UnicodeDecodeError:
68
59
        # Otherwise go though line by line and pick out the 'good'
69
60
        # decodable lines
70
 
        lines = ignore_file.split(b'\n')
 
61
        lines = ignore_file.split('\n')
71
62
        unicode_lines = []
72
63
        for line_number, line in enumerate(lines):
73
64
            try:
74
65
                unicode_lines.append(line.decode('utf-8'))
75
66
            except UnicodeDecodeError:
76
67
                # report error about line (idx+1)
77
 
                trace.warning(
78
 
                    '.bzrignore: On Line #%d, malformed utf8 character. '
79
 
                    'Ignoring line.' % (line_number + 1))
 
68
                warning('.bzrignore: On Line #%d, malformed utf8 character. '
 
69
                        'Ignoring line.' % (line_number+1))
80
70
 
81
71
    # Append each line to ignore list if it's not a comment line
82
72
    for line in unicode_lines:
89
79
 
90
80
def get_user_ignores():
91
81
    """Get the list of user ignored files, possibly creating it."""
92
 
    path = bedding.user_ignore_config_path()
 
82
    path = config.user_ignore_config_filename()
93
83
    patterns = set(USER_DEFAULTS)
94
84
    try:
95
85
        f = open(path, 'rb')
96
 
    except (IOError, OSError) as e:
 
86
    except (IOError, OSError), e:
97
87
        # open() shouldn't return an IOError without errno, but just in case
98
88
        err = getattr(e, 'errno', None)
99
89
        if err not in (errno.ENOENT,):
103
93
        # since get_* should be a safe operation
104
94
        try:
105
95
            _set_user_ignores(USER_DEFAULTS)
106
 
        except EnvironmentError as e:
107
 
            if e.errno not in (errno.EPERM, errno.ENOENT):
 
96
        except (IOError, OSError), e:
 
97
            if e.errno not in (errno.EPERM,):
108
98
                raise
109
99
        return patterns
110
100
 
121
111
    write to the user ignore file.
122
112
    This is mostly used for testing, since it would be
123
113
    bad form to rewrite a user's ignore list.
124
 
    breezy only writes this file if it does not exist.
 
114
    bzrlib only writes this file if it does not exist.
125
115
    """
126
 
    ignore_path = bedding.user_ignore_config_path()
127
 
    bedding.ensure_config_dir_exists()
 
116
    ignore_path = config.user_ignore_config_filename()
 
117
    config.ensure_config_dir_exists()
128
118
 
129
119
    # Create an empty file
130
 
    with open(ignore_path, 'wb') as f:
 
120
    f = open(ignore_path, 'wb')
 
121
    try:
131
122
        for pattern in patterns:
132
 
            f.write(pattern.encode('utf8') + b'\n')
 
123
            f.write(pattern.encode('utf8') + '\n')
 
124
    finally:
 
125
        f.close()
133
126
 
134
127
 
135
128
def add_unique_user_ignores(new_ignores):
149
142
    if not to_add:
150
143
        return []
151
144
 
152
 
    with open(bedding.user_ignore_config_path(), 'ab') as f:
 
145
    f = open(config.user_ignore_config_filename(), 'ab')
 
146
    try:
153
147
        for pattern in to_add:
154
 
            f.write(pattern.encode('utf8') + b'\n')
 
148
            f.write(pattern.encode('utf8') + '\n')
 
149
    finally:
 
150
        f.close()
155
151
 
156
152
    return to_add
157
153
 
185
181
    The ignore file will be automatically added under version control.
186
182
 
187
183
    :param tree: Working tree to update the ignore list.
188
 
    :param name_pattern_list: List of ignore patterns.
189
 
    :return: None
190
184
    """
191
 
    # read in the existing ignores set
192
 
    ifn = tree.abspath(tree._format.ignore_filename)
 
185
    ifn = tree.abspath(bzrlib.IGNORE_FILENAME)
193
186
    if tree.has_filename(ifn):
194
 
        with open(ifn, 'rb') as f:
195
 
            file_contents = f.read()
196
 
            if file_contents.find(b'\r\n') != -1:
197
 
                newline = b'\r\n'
198
 
            else:
199
 
                newline = b'\n'
 
187
        f = open(ifn, 'rt')
 
188
        try:
 
189
            igns = f.read().decode('utf-8')
 
190
        finally:
 
191
            f.close()
200
192
    else:
201
 
        file_contents = b""
202
 
        newline = os.linesep.encode()
203
 
 
204
 
    with BytesIO(file_contents) as sio:
205
 
        ignores = parse_ignore_file(sio)
206
 
 
207
 
    # write out the updated ignores set
208
 
    with atomicfile.AtomicFile(ifn, 'wb') as f:
209
 
        # write the original contents, preserving original line endings
210
 
        f.write(file_contents)
211
 
        if len(file_contents) > 0 and not file_contents.endswith(b'\n'):
212
 
            f.write(newline)
213
 
        for pattern in name_pattern_list:
214
 
            if pattern not in ignores:
215
 
                f.write(pattern.encode('utf-8'))
216
 
                f.write(newline)
217
 
 
218
 
    if not tree.is_versioned(tree._format.ignore_filename):
219
 
        tree.add([tree._format.ignore_filename])
 
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])