← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/rio.py

  • Committer: Aaron Bentley
  • Date: 2009-03-24 15:47:32 UTC
  • mto: This revision was merged to the branch mainline in revision 4241.
  • Revision ID: aaron@aaronbentley.com-20090324154732-bwkvi4dx3o90a7dq
Add output, emit minimal inventory delta.

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