← 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: 2007-07-17 13:27:14 UTC
  • mfrom: (2624 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2631.
  • Revision ID: abentley@panoramicfeedback.com-20070717132714-tmzx9khmg9501k51
Merge from bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/rio.py
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
# \subsection{\emph{rio} - simple text metaformat}
18
 
#
 
18
# 
19
19
# \emph{r} stands for `restricted', `reproducible', or `rfc822-like'.
20
 
#
 
20
# 
21
21
# The stored data consists of a series of \emph{stanzas}, each of which contains
22
22
# \emph{fields} identified by an ascii name, with Unicode or string contents.
23
 
# The field tag is constrained to alphanumeric characters.
 
23
# The field tag is constrained to alphanumeric characters.  
24
24
# There may be more than one field in a stanza with the same name.
25
 
#
 
25
# 
26
26
# The format itself does not deal with character encoding issues, though
27
27
# the result will normally be written in Unicode.
28
 
#
 
28
# 
29
29
# The format is intended to be simple enough that there is exactly one character
30
30
# stream representation of an object and vice versa, and that this relation
31
31
# will continue to hold for future versions of bzr.
32
32
 
33
33
import re
34
34
 
35
 
from bzrlib import osutils
36
35
from bzrlib.iterablefile import IterableFile
37
36
 
38
37
# XXX: some redundancy is allowing to write stanzas in isolation as well as
39
 
# through a writer object.
 
38
# through a writer object.  
40
39
 
41
40
class RioWriter(object):
42
41
    def __init__(self, to_file):
45
44
 
46
45
    def write_stanza(self, stanza):
47
46
        if self._soft_nl:
48
 
            self._to_file.write('\n')
 
47
            print >>self._to_file
49
48
        stanza.write(self._to_file)
50
49
        self._soft_nl = True
51
50
 
52
51
 
53
52
class RioReader(object):
54
53
    """Read stanzas from a file as a sequence
55
 
 
56
 
    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 
57
56
    lines (with newlines.)
58
57
    """
59
58
    def __init__(self, from_file):
94
93
class Stanza(object):
95
94
    """One stanza for rio.
96
95
 
97
 
    Each stanza contains a set of named fields.
98
 
 
 
96
    Each stanza contains a set of named fields.  
 
97
    
99
98
    Names must be non-empty ascii alphanumeric plus _.  Names can be repeated
100
99
    within a stanza.  Names are case-sensitive.  The ordering of fields is
101
100
    preserved.
117
116
 
118
117
    def add(self, tag, value):
119
118
        """Append a name and value to the stanza."""
120
 
        if not valid_tag(tag):
121
 
            raise ValueError("invalid tag %r" % (tag,))
 
119
        assert valid_tag(tag), \
 
120
            ("invalid tag %r" % tag)
122
121
        if isinstance(value, str):
123
122
            value = unicode(value)
124
123
        elif isinstance(value, unicode):
129
128
            raise TypeError("invalid type for rio value: %r of type %s"
130
129
                            % (value, type(value)))
131
130
        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
 
 
 
131
        
139
132
    def __contains__(self, find_tag):
140
133
        """True if there is any field in this stanza with the given tag."""
141
134
        for tag, value in self.items:
164
157
 
165
158
    def to_lines(self):
166
159
        """Generate sequence of lines for external version of this file.
167
 
 
 
160
        
168
161
        The lines are always utf-8 encoded strings.
169
162
        """
170
163
        if not self.items:
172
165
            return []
173
166
        result = []
174
167
        for tag, value in self.items:
 
168
            assert isinstance(tag, str), type(tag)
 
169
            assert isinstance(value, unicode)
175
170
            if value == '':
176
171
                result.append(tag + ': \n')
177
172
            elif '\n' in value:
198
193
 
199
194
        result = []
200
195
        for tag, value in self.items:
201
 
            if value == u'':
202
 
                result.append(tag + u': \n')
203
 
            elif u'\n' in value:
 
196
            if value == '':
 
197
                result.append(tag + ': \n')
 
198
            elif '\n' in value:
204
199
                # 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')
 
200
                val_lines = value.split('\n')
 
201
                result.append(tag + ': ' + val_lines[0] + '\n')
207
202
                for line in val_lines[1:]:
208
 
                    result.append(u'\t' + line + u'\n')
 
203
                    result.append('\t' + line + '\n')
209
204
            else:
210
 
                result.append(tag + u': ' + value + u'\n')
 
205
                result.append(tag + ': ' + value + '\n')
211
206
        return u''.join(result)
212
207
 
213
208
    def write(self, to_file):
240
235
        """
241
236
        d = {}
242
237
        for tag, value in self.items:
 
238
            assert tag not in d
243
239
            d[tag] = value
244
240
        return d
245
 
 
246
 
 
 
241
         
 
242
_tag_re = re.compile(r'^[-a-zA-Z0-9_]+$')
247
243
def valid_tag(tag):
248
 
    return _valid_tag(tag)
 
244
    return bool(_tag_re.match(tag))
249
245
 
250
246
 
251
247
def read_stanza(line_iter):
252
248
    """Return new Stanza read from list of lines or a file
253
 
 
 
249
    
254
250
    Returns one Stanza that was read, or returns None at end of file.  If a
255
251
    blank line follows the stanza, it is consumed.  It's not an error for
256
252
    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.
 
253
    start of the input this is really an empty stanza and that is returned. 
258
254
 
259
255
    Only the stanza lines and the trailing blank (if any) are consumed
260
256
    from the line_iter.
261
257
 
262
258
    The raw lines must be in utf-8 encoding.
263
259
    """
264
 
    return _read_stanza_utf8(line_iter)
 
260
    unicode_iter = (line.decode('utf-8') for line in line_iter)
 
261
    return read_stanza_unicode(unicode_iter)
265
262
 
266
263
 
267
264
def read_stanza_unicode(unicode_iter):
281
278
    :return: A Stanza object if there are any lines in the file.
282
279
        None otherwise
283
280
    """
284
 
    return _read_stanza_unicode(unicode_iter)
 
281
    stanza = Stanza()
 
282
    tag = None
 
283
    accum_value = None
 
284
    
 
285
    # TODO: jam 20060922 This code should raise real errors rather than
 
286
    #       using 'assert' to process user input, or raising ValueError
 
287
    #       rather than a more specific error.
 
288
 
 
289
    for line in unicode_iter:
 
290
        if line is None or line == '':
 
291
            break       # end of file
 
292
        if line == '\n':
 
293
            break       # end of stanza
 
294
        assert line.endswith('\n')
 
295
        real_l = line
 
296
        if line[0] == '\t': # continues previous value
 
297
            if tag is None:
 
298
                raise ValueError('invalid continuation line %r' % real_l)
 
299
            accum_value += '\n' + line[1:-1]
 
300
        else: # new tag:value line
 
301
            if tag is not None:
 
302
                stanza.add(tag, accum_value)
 
303
            try:
 
304
                colon_index = line.index(': ')
 
305
            except ValueError:
 
306
                raise ValueError('tag/value separator not found in line %r'
 
307
                                 % real_l)
 
308
            tag = str(line[:colon_index])
 
309
            assert valid_tag(tag), \
 
310
                    "invalid rio tag %r" % tag
 
311
            accum_value = line[colon_index+2:-1]
 
312
 
 
313
    if tag is not None: # add last tag-value
 
314
        stanza.add(tag, accum_value)
 
315
        return stanza
 
316
    else:     # didn't see any content
 
317
        return None    
285
318
 
286
319
 
287
320
def to_patch_lines(stanza, max_width=72):
294
327
    :param max_width: The maximum number of characters per physical line.
295
328
    :return: a list of lines
296
329
    """
297
 
    if max_width <= 6:
298
 
        raise ValueError(max_width)
 
330
    assert max_width > 6
299
331
    max_rio_width = max_width - 4
300
332
    lines = []
301
333
    for pline in stanza.to_lines():
341
373
    for line in line_iter:
342
374
        if line.startswith('# '):
343
375
            line = line[2:]
344
 
        elif line.startswith('#'):
 
376
        else:
 
377
            assert line.startswith('#')
345
378
            line = line[1:]
346
 
        else:
347
 
            raise ValueError("bad line %r" % (line,))
348
379
        if last_line is not None and len(line) > 2:
349
380
            line = line[2:]
350
381
        line = re.sub('\r', '', line)
370
401
    :return: a Stanza
371
402
    """
372
403
    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
 
       )