~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/rio.py

  • Committer: John Arbash Meinel
  • Date: 2009-02-23 15:29:35 UTC
  • mfrom: (3943.7.7 bzr.code_style_cleanup)
  • mto: This revision was merged to the branch mainline in revision 4033.
  • Revision ID: john@arbash-meinel.com-20090223152935-oel9m92mwcc6nb4h
Merge the removal of all trailing whitespace, and resolve conflicts.

Show diffs side-by-side

added added

removed removed

Lines of Context:
15
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.
35
35
from bzrlib.iterablefile import IterableFile
36
36
 
37
37
# XXX: some redundancy is allowing to write stanzas in isolation as well as
38
 
# through a writer object.  
 
38
# through a writer object.
39
39
 
40
40
class RioWriter(object):
41
41
    def __init__(self, to_file):
51
51
 
52
52
class RioReader(object):
53
53
    """Read stanzas from a file as a sequence
54
 
    
55
 
    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
56
56
    lines (with newlines.)
57
57
    """
58
58
    def __init__(self, from_file):
93
93
class Stanza(object):
94
94
    """One stanza for rio.
95
95
 
96
 
    Each stanza contains a set of named fields.  
97
 
    
 
96
    Each stanza contains a set of named fields.
 
97
 
98
98
    Names must be non-empty ascii alphanumeric plus _.  Names can be repeated
99
99
    within a stanza.  Names are case-sensitive.  The ordering of fields is
100
100
    preserved.
128
128
            raise TypeError("invalid type for rio value: %r of type %s"
129
129
                            % (value, type(value)))
130
130
        self.items.append((tag, value))
131
 
        
 
131
 
132
132
    def __contains__(self, find_tag):
133
133
        """True if there is any field in this stanza with the given tag."""
134
134
        for tag, value in self.items:
157
157
 
158
158
    def to_lines(self):
159
159
        """Generate sequence of lines for external version of this file.
160
 
        
 
160
 
161
161
        The lines are always utf-8 encoded strings.
162
162
        """
163
163
        if not self.items:
235
235
        for tag, value in self.items:
236
236
            d[tag] = value
237
237
        return d
238
 
         
 
238
 
239
239
_tag_re = re.compile(r'^[-a-zA-Z0-9_]+$')
240
240
def valid_tag(tag):
241
241
    return bool(_tag_re.match(tag))
243
243
 
244
244
def read_stanza(line_iter):
245
245
    """Return new Stanza read from list of lines or a file
246
 
    
 
246
 
247
247
    Returns one Stanza that was read, or returns None at end of file.  If a
248
248
    blank line follows the stanza, it is consumed.  It's not an error for
249
249
    there to be no blank at end of file.  If there is a blank file at the
250
 
    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.
251
251
 
252
252
    Only the stanza lines and the trailing blank (if any) are consumed
253
253
    from the line_iter.
278
278
    stanza = Stanza()
279
279
    tag = None
280
280
    accum_value = None
281
 
    
 
281
 
282
282
    # TODO: jam 20060922 This code should raise real errors rather than
283
283
    #       using 'assert' to process user input, or raising ValueError
284
284
    #       rather than a more specific error.
310
310
        stanza.add(tag, accum_value)
311
311
        return stanza
312
312
    else:     # didn't see any content
313
 
        return None    
 
313
        return None
314
314
 
315
315
 
316
316
def to_patch_lines(stanza, max_width=72):