← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/rio.py

(vila) Calling super() instead of mentioning the base class in setUp avoid
 mistakes. (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/rio.py
1
 
# Copyright (C) 2005 by Canonical Ltd
2
 
#
3
 
# Distributed under the GNU General Public Licence v2
 
1
# Copyright (C) 2005 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
from __future__ import absolute_import
4
18
 
5
19
# \subsection{\emph{rio} - simple text metaformat}
6
 
# 
 
20
#
7
21
# \emph{r} stands for `restricted', `reproducible', or `rfc822-like'.
8
 
# 
 
22
#
9
23
# The stored data consists of a series of \emph{stanzas}, each of which contains
10
24
# \emph{fields} identified by an ascii name, with Unicode or string contents.
11
 
# The field tag is constrained to alphanumeric characters.  
 
25
# The field tag is constrained to alphanumeric characters.
12
26
# There may be more than one field in a stanza with the same name.
13
 
# 
 
27
#
14
28
# The format itself does not deal with character encoding issues, though
15
29
# the result will normally be written in Unicode.
16
 
# 
 
30
#
17
31
# The format is intended to be simple enough that there is exactly one character
18
32
# stream representation of an object and vice versa, and that this relation
19
33
# will continue to hold for future versions of bzr.
20
34
 
21
35
import re
22
36
 
 
37
from bzrlib import osutils
 
38
from bzrlib.iterablefile import IterableFile
 
39
 
23
40
# XXX: some redundancy is allowing to write stanzas in isolation as well as
24
 
# through a writer object.  
 
41
# through a writer object.
25
42
 
26
43
class RioWriter(object):
27
44
    def __init__(self, to_file):
30
47
 
31
48
    def write_stanza(self, stanza):
32
49
        if self._soft_nl:
33
 
            print >>self._to_file
 
50
            self._to_file.write('\n')
34
51
        stanza.write(self._to_file)
35
52
        self._soft_nl = True
36
53
 
37
54
 
38
55
class RioReader(object):
39
56
    """Read stanzas from a file as a sequence
40
 
    
41
 
    to_file can be anything that can be enumerated as a sequence of 
 
57
 
 
58
    to_file can be anything that can be enumerated as a sequence of
42
59
    lines (with newlines.)
43
60
    """
44
61
    def __init__(self, from_file):
52
69
            else:
53
70
                yield s
54
71
 
 
72
 
 
73
def rio_file(stanzas, header=None):
 
74
    """Produce a rio IterableFile from an iterable of stanzas"""
 
75
    def str_iter():
 
76
        if header is not None:
 
77
            yield header + '\n'
 
78
        first_stanza = True
 
79
        for s in stanzas:
 
80
            if first_stanza is not True:
 
81
                yield '\n'
 
82
            for line in s.to_lines():
 
83
                yield line
 
84
            first_stanza = False
 
85
    return IterableFile(str_iter())
 
86
 
 
87
 
55
88
def read_stanzas(from_file):
56
89
    while True:
57
90
        s = read_stanza(from_file)
63
96
class Stanza(object):
64
97
    """One stanza for rio.
65
98
 
66
 
    Each stanza contains a set of named fields.  
67
 
    
 
99
    Each stanza contains a set of named fields.
 
100
 
68
101
    Names must be non-empty ascii alphanumeric plus _.  Names can be repeated
69
102
    within a stanza.  Names are case-sensitive.  The ordering of fields is
70
103
    preserved.
86
119
 
87
120
    def add(self, tag, value):
88
121
        """Append a name and value to the stanza."""
89
 
        assert valid_tag(tag), \
90
 
            ("invalid tag %r" % tag)
 
122
        if not valid_tag(tag):
 
123
            raise ValueError("invalid tag %r" % (tag,))
91
124
        if isinstance(value, str):
92
125
            value = unicode(value)
93
126
        elif isinstance(value, unicode):
98
131
            raise TypeError("invalid type for rio value: %r of type %s"
99
132
                            % (value, type(value)))
100
133
        self.items.append((tag, value))
101
 
        
 
134
 
 
135
    @classmethod
 
136
    def from_pairs(cls, pairs):
 
137
        ret = cls()
 
138
        ret.items = pairs
 
139
        return ret
 
140
 
102
141
    def __contains__(self, find_tag):
103
142
        """True if there is any field in this stanza with the given tag."""
104
143
        for tag, value in self.items:
127
166
 
128
167
    def to_lines(self):
129
168
        """Generate sequence of lines for external version of this file.
130
 
        
 
169
 
131
170
        The lines are always utf-8 encoded strings.
132
171
        """
133
172
        if not self.items:
135
174
            return []
136
175
        result = []
137
176
        for tag, value in self.items:
138
 
            assert isinstance(tag, str)
139
 
            assert isinstance(value, unicode)
140
177
            if value == '':
141
178
                result.append(tag + ': \n')
142
179
            elif '\n' in value:
153
190
        """Return stanza as a single string"""
154
191
        return ''.join(self.to_lines())
155
192
 
 
193
    def to_unicode(self):
 
194
        """Return stanza as a single Unicode string.
 
195
 
 
196
        This is most useful when adding a Stanza to a parent Stanza
 
197
        """
 
198
        if not self.items:
 
199
            return u''
 
200
 
 
201
        result = []
 
202
        for tag, value in self.items:
 
203
            if value == u'':
 
204
                result.append(tag + u': \n')
 
205
            elif u'\n' in value:
 
206
                # don't want splitlines behaviour on empty lines
 
207
                val_lines = value.split(u'\n')
 
208
                result.append(tag + u': ' + val_lines[0] + u'\n')
 
209
                for line in val_lines[1:]:
 
210
                    result.append(u'\t' + line + u'\n')
 
211
            else:
 
212
                result.append(tag + u': ' + value + u'\n')
 
213
        return u''.join(result)
 
214
 
156
215
    def write(self, to_file):
157
216
        """Write stanza to a file"""
158
217
        to_file.writelines(self.to_lines())
183
242
        """
184
243
        d = {}
185
244
        for tag, value in self.items:
186
 
            assert tag not in d
187
245
            d[tag] = value
188
246
        return d
189
 
         
190
 
_tag_re = re.compile(r'^[-a-zA-Z0-9_]+$')
 
247
 
 
248
 
191
249
def valid_tag(tag):
192
 
    return bool(_tag_re.match(tag))
 
250
    return _valid_tag(tag)
193
251
 
194
252
 
195
253
def read_stanza(line_iter):
196
254
    """Return new Stanza read from list of lines or a file
197
 
    
 
255
 
198
256
    Returns one Stanza that was read, or returns None at end of file.  If a
199
257
    blank line follows the stanza, it is consumed.  It's not an error for
200
258
    there to be no blank at end of file.  If there is a blank file at the
201
 
    start of the input this is really an empty stanza and that is returned. 
 
259
    start of the input this is really an empty stanza and that is returned.
202
260
 
203
261
    Only the stanza lines and the trailing blank (if any) are consumed
204
262
    from the line_iter.
205
263
 
206
264
    The raw lines must be in utf-8 encoding.
207
265
    """
208
 
    items = []
209
 
    stanza = Stanza()
210
 
    tag = None
211
 
    accum_value = None
 
266
    return _read_stanza_utf8(line_iter)
 
267
 
 
268
 
 
269
def read_stanza_unicode(unicode_iter):
 
270
    """Read a Stanza from a list of lines or a file.
 
271
 
 
272
    The lines should already be in unicode form. This returns a single
 
273
    stanza that was read. If there is a blank line at the end of the Stanza,
 
274
    it is consumed. It is not an error for there to be no blank line at
 
275
    the end of the iterable. If there is a blank line at the beginning,
 
276
    this is treated as an empty Stanza and None is returned.
 
277
 
 
278
    Only the stanza lines and the trailing blank (if any) are consumed
 
279
    from the unicode_iter
 
280
 
 
281
    :param unicode_iter: A iterable, yeilding Unicode strings. See read_stanza
 
282
        if you have a utf-8 encoded string.
 
283
    :return: A Stanza object if there are any lines in the file.
 
284
        None otherwise
 
285
    """
 
286
    return _read_stanza_unicode(unicode_iter)
 
287
 
 
288
 
 
289
def to_patch_lines(stanza, max_width=72):
 
290
    """Convert a stanza into RIO-Patch format lines.
 
291
 
 
292
    RIO-Patch is a RIO variant designed to be e-mailed as part of a patch.
 
293
    It resists common forms of damage such as newline conversion or the removal
 
294
    of trailing whitespace, yet is also reasonably easy to read.
 
295
 
 
296
    :param max_width: The maximum number of characters per physical line.
 
297
    :return: a list of lines
 
298
    """
 
299
    if max_width <= 6:
 
300
        raise ValueError(max_width)
 
301
    max_rio_width = max_width - 4
 
302
    lines = []
 
303
    for pline in stanza.to_lines():
 
304
        for line in pline.split('\n')[:-1]:
 
305
            line = re.sub('\\\\', '\\\\\\\\', line)
 
306
            while len(line) > 0:
 
307
                partline = line[:max_rio_width]
 
308
                line = line[max_rio_width:]
 
309
                if len(line) > 0 and line[0] != [' ']:
 
310
                    break_index = -1
 
311
                    break_index = partline.rfind(' ', -20)
 
312
                    if break_index < 3:
 
313
                        break_index = partline.rfind('-', -20)
 
314
                        break_index += 1
 
315
                    if break_index < 3:
 
316
                        break_index = partline.rfind('/', -20)
 
317
                    if break_index >= 3:
 
318
                        line = partline[break_index:] + line
 
319
                        partline = partline[:break_index]
 
320
                if len(line) > 0:
 
321
                    line = '  ' + line
 
322
                partline = re.sub('\r', '\\\\r', partline)
 
323
                blank_line = False
 
324
                if len(line) > 0:
 
325
                    partline += '\\'
 
326
                elif re.search(' $', partline):
 
327
                    partline += '\\'
 
328
                    blank_line = True
 
329
                lines.append('# ' + partline + '\n')
 
330
                if blank_line:
 
331
                    lines.append('#   \n')
 
332
    return lines
 
333
 
 
334
 
 
335
def _patch_stanza_iter(line_iter):
 
336
    map = {'\\\\': '\\',
 
337
           '\\r' : '\r',
 
338
           '\\\n': ''}
 
339
    def mapget(match):
 
340
        return map[match.group(0)]
 
341
 
 
342
    last_line = None
212
343
    for line in line_iter:
213
 
        if line == None or line == '':
214
 
            break       # end of file
215
 
        if line == '\n':
216
 
            break       # end of stanza
217
 
        line = line.decode('utf-8')
218
 
        assert line[-1] == '\n'
219
 
        real_l = line
220
 
        if line[0] == '\t': # continues previous value
221
 
            if tag is None:
222
 
                raise ValueError('invalid continuation line %r' % real_l)
223
 
            accum_value += '\n' + line[1:-1]
224
 
        else: # new tag:value line
225
 
            if tag is not None:
226
 
                stanza.add(tag, accum_value)
227
 
            try:
228
 
                colon_index = line.index(': ')
229
 
            except ValueError:
230
 
                raise ValueError('tag/value separator not found in line %r' % real_l)
231
 
            tag = line[:colon_index]
232
 
            assert valid_tag(tag), \
233
 
                    "invalid rio tag %r" % tag
234
 
            accum_value = line[colon_index+2:-1]
235
 
    if tag is not None: # add last tag-value
236
 
        stanza.add(tag, accum_value)
237
 
        return stanza
238
 
    else:     # didn't see any content
239
 
        return None    
 
344
        if line.startswith('# '):
 
345
            line = line[2:]
 
346
        elif line.startswith('#'):
 
347
            line = line[1:]
 
348
        else:
 
349
            raise ValueError("bad line %r" % (line,))
 
350
        if last_line is not None and len(line) > 2:
 
351
            line = line[2:]
 
352
        line = re.sub('\r', '', line)
 
353
        line = re.sub('\\\\(.|\n)', mapget, line)
 
354
        if last_line is None:
 
355
            last_line = line
 
356
        else:
 
357
            last_line += line
 
358
        if last_line[-1] == '\n':
 
359
            yield last_line
 
360
            last_line = None
 
361
    if last_line is not None:
 
362
        yield last_line
 
363
 
 
364
 
 
365
def read_patch_stanza(line_iter):
 
366
    """Convert an iterable of RIO-Patch format lines into a Stanza.
 
367
 
 
368
    RIO-Patch is a RIO variant designed to be e-mailed as part of a patch.
 
369
    It resists common forms of damage such as newline conversion or the removal
 
370
    of trailing whitespace, yet is also reasonably easy to read.
 
371
 
 
372
    :return: a Stanza
 
373
    """
 
374
    return read_stanza(_patch_stanza_iter(line_iter))
 
375
 
 
376
 
 
377
try:
 
378
    from bzrlib._rio_pyx import (
 
379
        _read_stanza_utf8,
 
380
        _read_stanza_unicode,
 
381
        _valid_tag,
 
382
        )
 
383
except ImportError, e:
 
384
    osutils.failed_to_load_extension(e)
 
385
    from bzrlib._rio_py import (
 
386
       _read_stanza_utf8,
 
387
       _read_stanza_unicode,
 
388
       _valid_tag,
 
389
       )