← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/rio.py

  • Committer: Robert Collins
  • Date: 2005-10-11 07:52:29 UTC
  • mto: This revision was merged to the branch mainline in revision 1444.
  • Revision ID: robertc@lifelesslap.robertcollins.net-20051011075229-e1a1429e0b59f80f
nuke --pattern to selftest, replace with regexp.search calls.

Show diffs side-by-side

added added

removed removed

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