~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/rio.py

  • Committer: John Arbash Meinel
  • Date: 2006-09-23 06:39:46 UTC
  • mfrom: (2034 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2035.
  • Revision ID: john@arbash-meinel.com-20060923063946-e596c8a8eef928b4
[merge] bzr.dev 2034

Show diffs side-by-side

added added

removed removed

Lines of Context:
171
171
        """Return stanza as a single string"""
172
172
        return ''.join(self.to_lines())
173
173
 
 
174
    def to_unicode(self):
 
175
        """Return stanza as a single Unicode string.
 
176
 
 
177
        This is most useful when adding a Stanza to a parent Stanza
 
178
        """
 
179
        if not self.items:
 
180
            return u''
 
181
 
 
182
        result = []
 
183
        for tag, value in self.items:
 
184
            if value == '':
 
185
                result.append(tag + ': \n')
 
186
            elif '\n' in value:
 
187
                # don't want splitlines behaviour on empty lines
 
188
                val_lines = value.split('\n')
 
189
                result.append(tag + ': ' + val_lines[0] + '\n')
 
190
                for line in val_lines[1:]:
 
191
                    result.append('\t' + line + '\n')
 
192
            else:
 
193
                result.append(tag + ': ' + value + '\n')
 
194
        return u''.join(result)
 
195
 
174
196
    def write(self, to_file):
175
197
        """Write stanza to a file"""
176
198
        to_file.writelines(self.to_lines())
223
245
 
224
246
    The raw lines must be in utf-8 encoding.
225
247
    """
226
 
    items = []
 
248
    unicode_iter = (line.decode('utf-8') for line in line_iter)
 
249
    return read_stanza_unicode(unicode_iter)
 
250
 
 
251
 
 
252
def read_stanza_unicode(unicode_iter):
 
253
    """Read a Stanza from a list of lines or a file.
 
254
 
 
255
    The lines should already be in unicode form. This returns a single
 
256
    stanza that was read. If there is a blank line at the end of the Stanza,
 
257
    it is consumed. It is not an error for there to be no blank line at
 
258
    the end of the iterable. If there is a blank line at the beginning,
 
259
    this is treated as an empty Stanza and None is returned.
 
260
 
 
261
    Only the stanza lines and the trailing blank (if any) are consumed
 
262
    from the unicode_iter
 
263
 
 
264
    :param unicode_iter: A iterable, yeilding Unicode strings. See read_stanza
 
265
        if you have a utf-8 encoded string.
 
266
    :return: A Stanza object if there are any lines in the file.
 
267
        None otherwise
 
268
    """
227
269
    stanza = Stanza()
228
270
    tag = None
229
271
    accum_value = None
230
 
    for line in line_iter:
 
272
    
 
273
    # TODO: jam 20060922 This code should raise real errors rather than
 
274
    #       using 'assert' to process user input, or raising ValueError
 
275
    #       rather than a more specific error.
 
276
 
 
277
    for line in unicode_iter:
231
278
        if line is None or line == '':
232
279
            break       # end of file
233
280
        if line == '\n':
234
281
            break       # end of stanza
235
 
        line = line.decode('utf-8')
236
 
        assert line[-1] == '\n'
 
282
        assert line.endswith('\n')
237
283
        real_l = line
238
284
        if line[0] == '\t': # continues previous value
239
285
            if tag is None:
245
291
            try:
246
292
                colon_index = line.index(': ')
247
293
            except ValueError:
248
 
                raise ValueError('tag/value separator not found in line %r' % real_l)
 
294
                raise ValueError('tag/value separator not found in line %r'
 
295
                                 % real_l)
249
296
            tag = str(line[:colon_index])
250
297
            assert valid_tag(tag), \
251
298
                    "invalid rio tag %r" % tag
252
299
            accum_value = line[colon_index+2:-1]
 
300
 
253
301
    if tag is not None: # add last tag-value
254
302
        stanza.add(tag, accum_value)
255
303
        return stanza