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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
17
# \subsection{\emph{rio} - simple text metaformat}
19
19
# \emph{r} stands for `restricted', `reproducible', or `rfc822-like'.
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.
26
26
# The format itself does not deal with character encoding issues, though
27
27
# the result will normally be written in Unicode.
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
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.
40
40
class RioWriter(object):
41
41
def __init__(self, to_file):
52
52
class RioReader(object):
53
53
"""Read stanzas from a file as a sequence
55
to_file can be anything that can be enumerated as a sequence of
55
to_file can be anything that can be enumerated as a sequence of
56
56
lines (with newlines.)
58
58
def __init__(self, from_file):
93
93
class Stanza(object):
94
94
"""One stanza for rio.
96
Each stanza contains a set of named fields.
96
Each stanza contains a set of named fields.
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
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))
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:
244
244
def read_stanza(line_iter):
245
245
"""Return new Stanza read from list of lines or a file
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.
252
252
Only the stanza lines and the trailing blank (if any) are consumed
253
253
from the line_iter.
added
removed
bzrlib/rio.py
