source: pyyaml/trunk/lib/yaml/emitter.py @ 143

Revision 143, 43.1 KB checked in by xi, 8 years ago (diff)

Fix bugs in emitter and representer.

Line 
1
2# Emitter expects events obeying the following grammar:
3# stream ::= STREAM-START document* STREAM-END
4# document ::= DOCUMENT-START node DOCUMENT-END
5# node ::= SCALAR | sequence | mapping
6# sequence ::= SEQUENCE-START node* SEQUENCE-END
7# mapping ::= MAPPING-START (node node)* MAPPING-END
8
9__all__ = ['Emitter', 'EmitterError']
10
11from error import YAMLError
12from events import *
13
14import re
15
16class EmitterError(YAMLError):
17    pass
18
19class ScalarAnalysis:
20    def __init__(self, scalar, empty, multiline,
21            allow_flow_plain, allow_block_plain,
22            allow_single_quoted, allow_double_quoted,
23            allow_block):
24        self.scalar = scalar
25        self.empty = empty
26        self.multiline = multiline
27        self.allow_flow_plain = allow_flow_plain
28        self.allow_block_plain = allow_block_plain
29        self.allow_single_quoted = allow_single_quoted
30        self.allow_double_quoted = allow_double_quoted
31        self.allow_block = allow_block
32
33class Emitter:
34
35    DEFAULT_TAG_PREFIXES = {
36        u'!' : u'!',
37        u'tag:yaml.org,2002:' : u'!!',
38    }
39
40    def __init__(self, stream, canonical=None, indent=None, width=None,
41            allow_unicode=None, line_break=None):
42
43        # The stream should have the methods `write` and possibly `flush`.
44        self.stream = stream
45
46        # Encoding can be overriden by STREAM-START.
47        self.encoding = None
48
49        # Emitter is a state machine with a stack of states to handle nested
50        # structures.
51        self.states = []
52        self.state = self.expect_stream_start
53
54        # Current event and the event queue.
55        self.events = []
56        self.event = None
57
58        # The current indentation level and the stack of previous indents.
59        self.indents = []
60        self.indent = None
61
62        # Flow level.
63        self.flow_level = 0
64
65        # Contexts.
66        self.root_context = False
67        self.sequence_context = False
68        self.mapping_context = False
69        self.simple_key_context = False
70
71        # Characteristics of the last emitted character:
72        #  - current position.
73        #  - is it a whitespace?
74        #  - is it an indention character
75        #    (indentation space, '-', '?', or ':')?
76        self.line = 0
77        self.column = 0
78        self.whitespace = True
79        self.indention = True
80
81        # Formatting details.
82        self.canonical = canonical
83        self.allow_unicode = allow_unicode
84        self.best_indent = 2
85        if indent and 1 < indent < 10:
86            self.best_indent = indent
87        self.best_width = 80
88        if width and width > self.best_indent*2:
89            self.best_width = width
90        self.best_line_break = u'\n'
91        if line_break in [u'\r', u'\n', u'\r\n']:
92            self.best_line_break = line_break
93
94        # Tag prefixes.
95        self.tag_prefixes = None
96
97        # Prepared anchor and tag.
98        self.prepared_anchor = None
99        self.prepared_tag = None
100
101        # Scalar analysis and style.
102        self.analysis = None
103        self.style = None
104
105    def emit(self, event):
106        self.events.append(event)
107        while not self.need_more_events():
108            self.event = self.events.pop(0)
109            self.state()
110            self.event = None
111
112    # In some cases, we wait for a few next events before emitting.
113
114    def need_more_events(self):
115        if not self.events:
116            return True
117        event = self.events[0]
118        if isinstance(event, DocumentStartEvent):
119            return self.need_events(1)
120        elif isinstance(event, SequenceStartEvent):
121            return self.need_events(2)
122        elif isinstance(event, MappingStartEvent):
123            return self.need_events(3)
124        else:
125            return False
126
127    def need_events(self, count):
128        level = 0
129        for event in self.events[1:]:
130            if isinstance(event, (DocumentStartEvent, CollectionStartEvent)):
131                level += 1
132            elif isinstance(event, (DocumentEndEvent, CollectionEndEvent)):
133                level -= 1
134            elif isinstance(event, StreamEndEvent):
135                level = -1
136            if level < 0:
137                return False
138        return (len(self.events) < count+1)
139
140    def increase_indent(self, flow=False, indentless=False):
141        self.indents.append(self.indent)
142        if self.indent is None:
143            if flow:
144                self.indent = self.best_indent
145            else:
146                self.indent = 0
147        elif not indentless:
148            self.indent += self.best_indent
149
150    # States.
151
152    # Stream handlers.
153
154    def expect_stream_start(self):
155        if isinstance(self.event, StreamStartEvent):
156            if self.event.encoding:
157                self.encoding = self.event.encoding
158            self.write_stream_start()
159            self.state = self.expect_first_document_start
160        else:
161            raise EmitterError("expected StreamStartEvent, but got %s"
162                    % self.event)
163
164    def expect_nothing(self):
165        raise EmitterError("expected nothing, but got %s" % self.event)
166
167    # Document handlers.
168
169    def expect_first_document_start(self):
170        return self.expect_document_start(first=True)
171
172    def expect_document_start(self, first=False):
173        if isinstance(self.event, DocumentStartEvent):
174            if self.event.version:
175                version_text = self.prepare_version(self.event.version)
176                self.write_version_directive(version_text)
177            self.tag_prefixes = self.DEFAULT_TAG_PREFIXES.copy()
178            if self.event.tags:
179                handles = self.event.tags.keys()
180                handles.sort()
181                for handle in handles:
182                    prefix = self.event.tags[handle]
183                    self.tag_prefixes[prefix] = handle
184                    handle_text = self.prepare_tag_handle(handle)
185                    prefix_text = self.prepare_tag_prefix(prefix)
186                    self.write_tag_directive(handle_text, prefix_text)
187            implicit = (first and not self.event.explicit and not self.canonical
188                    and not self.event.version and not self.event.tags
189                    and not self.check_empty_document())
190            if not implicit:
191                self.write_indent()
192                self.write_indicator(u'---', True)
193                if self.canonical:
194                    self.write_indent()
195            self.state = self.expect_document_root
196        elif isinstance(self.event, StreamEndEvent):
197            self.write_stream_end()
198            self.state = self.expect_nothing
199        else:
200            raise EmitterError("expected DocumentStartEvent, but got %s"
201                    % self.event)
202
203    def expect_document_end(self):
204        if isinstance(self.event, DocumentEndEvent):
205            self.write_indent()
206            if self.event.explicit:
207                self.write_indicator(u'...', True)
208                self.write_indent()
209            self.flush_stream()
210            self.state = self.expect_document_start
211        else:
212            raise EmitterError("expected DocumentEndEvent, but got %s"
213                    % self.event)
214
215    def expect_document_root(self):
216        self.states.append(self.expect_document_end)
217        self.expect_node(root=True)
218
219    # Node handlers.
220
221    def expect_node(self, root=False, sequence=False, mapping=False,
222            simple_key=False):
223        self.root_context = root
224        self.sequence_context = sequence
225        self.mapping_context = mapping
226        self.simple_key_context = simple_key
227        if isinstance(self.event, AliasEvent):
228            self.expect_alias()
229        elif isinstance(self.event, (ScalarEvent, CollectionStartEvent)):
230            self.process_anchor(u'&')
231            self.process_tag()
232            if isinstance(self.event, ScalarEvent):
233                self.expect_scalar()
234            elif isinstance(self.event, SequenceStartEvent):
235                if self.flow_level or self.canonical or self.event.flow_style   \
236                        or self.check_empty_sequence():
237                    self.expect_flow_sequence()
238                else:
239                    self.expect_block_sequence()
240            elif isinstance(self.event, MappingStartEvent):
241                if self.flow_level or self.canonical or self.event.flow_style   \
242                        or self.check_empty_mapping():
243                    self.expect_flow_mapping()
244                else:
245                    self.expect_block_mapping()
246        else:
247            raise EmitterError("expected NodeEvent, but got %s" % self.event)
248
249    def expect_alias(self):
250        if self.event.anchor is None:
251            raise EmitterError("anchor is not specified for alias")
252        self.process_anchor(u'*')
253        self.state = self.states.pop()
254
255    def expect_scalar(self):
256        self.increase_indent(flow=True)
257        self.process_scalar()
258        self.indent = self.indents.pop()
259        self.state = self.states.pop()
260
261    # Flow sequence handlers.
262
263    def expect_flow_sequence(self):
264        self.write_indicator(u'[', True, whitespace=True)
265        self.flow_level += 1
266        self.increase_indent(flow=True)
267        self.state = self.expect_first_flow_sequence_item
268
269    def expect_first_flow_sequence_item(self):
270        if isinstance(self.event, SequenceEndEvent):
271            self.indent = self.indents.pop()
272            self.flow_level -= 1
273            self.write_indicator(u']', False)
274            self.state = self.states.pop()
275        else:
276            if self.canonical or self.column > self.best_width:
277                self.write_indent()
278            self.states.append(self.expect_flow_sequence_item)
279            self.expect_node(sequence=True)
280
281    def expect_flow_sequence_item(self):
282        if isinstance(self.event, SequenceEndEvent):
283            self.indent = self.indents.pop()
284            self.flow_level -= 1
285            if self.canonical:
286                self.write_indicator(u',', False)
287                self.write_indent()
288            self.write_indicator(u']', False)
289            self.state = self.states.pop()
290        else:
291            self.write_indicator(u',', False)
292            if self.canonical or self.column > self.best_width:
293                self.write_indent()
294            self.states.append(self.expect_flow_sequence_item)
295            self.expect_node(sequence=True)
296
297    # Flow mapping handlers.
298
299    def expect_flow_mapping(self):
300        self.write_indicator(u'{', True, whitespace=True)
301        self.flow_level += 1
302        self.increase_indent(flow=True)
303        self.state = self.expect_first_flow_mapping_key
304
305    def expect_first_flow_mapping_key(self):
306        if isinstance(self.event, MappingEndEvent):
307            self.indent = self.indents.pop()
308            self.flow_level -= 1
309            self.write_indicator(u'}', False)
310            self.state = self.states.pop()
311        else:
312            if self.canonical or self.column > self.best_width:
313                self.write_indent()
314            if not self.canonical and self.check_simple_key():
315                self.states.append(self.expect_flow_mapping_simple_value)
316                self.expect_node(mapping=True, simple_key=True)
317            else:
318                self.write_indicator(u'?', True)
319                self.states.append(self.expect_flow_mapping_value)
320                self.expect_node(mapping=True)
321
322    def expect_flow_mapping_key(self):
323        if isinstance(self.event, MappingEndEvent):
324            self.indent = self.indents.pop()
325            self.flow_level -= 1
326            if self.canonical:
327                self.write_indicator(u',', False)
328                self.write_indent()
329            self.write_indicator(u'}', False)
330            self.state = self.states.pop()
331        else:
332            self.write_indicator(u',', False)
333            if self.canonical or self.column > self.best_width:
334                self.write_indent()
335            if not self.canonical and self.check_simple_key():
336                self.states.append(self.expect_flow_mapping_simple_value)
337                self.expect_node(mapping=True, simple_key=True)
338            else:
339                self.write_indicator(u'?', True)
340                self.states.append(self.expect_flow_mapping_value)
341                self.expect_node(mapping=True)
342
343    def expect_flow_mapping_simple_value(self):
344        self.write_indicator(u':', False)
345        self.states.append(self.expect_flow_mapping_key)
346        self.expect_node(mapping=True)
347
348    def expect_flow_mapping_value(self):
349        if self.canonical or self.column > self.best_width:
350            self.write_indent()
351        self.write_indicator(u':', True)
352        self.states.append(self.expect_flow_mapping_key)
353        self.expect_node(mapping=True)
354
355    # Block sequence handlers.
356
357    def expect_block_sequence(self):
358        indentless = (self.mapping_context and not self.indention)
359        self.increase_indent(flow=False, indentless=indentless)
360        self.state = self.expect_first_block_sequence_item
361
362    def expect_first_block_sequence_item(self):
363        return self.expect_block_sequence_item(first=True)
364
365    def expect_block_sequence_item(self, first=False):
366        if not first and isinstance(self.event, SequenceEndEvent):
367            self.indent = self.indents.pop()
368            self.state = self.states.pop()
369        else:
370            self.write_indent()
371            self.write_indicator(u'-', True, indention=True)
372            self.states.append(self.expect_block_sequence_item)
373            self.expect_node(sequence=True)
374
375    # Block mapping handlers.
376
377    def expect_block_mapping(self):
378        self.increase_indent(flow=False)
379        self.state = self.expect_first_block_mapping_key
380
381    def expect_first_block_mapping_key(self):
382        return self.expect_block_mapping_key(first=True)
383
384    def expect_block_mapping_key(self, first=False):
385        if not first and isinstance(self.event, MappingEndEvent):
386            self.indent = self.indents.pop()
387            self.state = self.states.pop()
388        else:
389            self.write_indent()
390            if self.check_simple_key():
391                self.states.append(self.expect_block_mapping_simple_value)
392                self.expect_node(mapping=True, simple_key=True)
393            else:
394                self.write_indicator(u'?', True, indention=True)
395                self.states.append(self.expect_block_mapping_value)
396                self.expect_node(mapping=True)
397
398    def expect_block_mapping_simple_value(self):
399        self.write_indicator(u':', False)
400        self.states.append(self.expect_block_mapping_key)
401        self.expect_node(mapping=True)
402
403    def expect_block_mapping_value(self):
404        self.write_indent()
405        self.write_indicator(u':', True, indention=True)
406        self.states.append(self.expect_block_mapping_key)
407        self.expect_node(mapping=True)
408
409    # Checkers.
410
411    def check_empty_sequence(self):
412        return (isinstance(self.event, SequenceStartEvent) and self.events
413                and isinstance(self.events[0], SequenceEndEvent))
414
415    def check_empty_mapping(self):
416        return (isinstance(self.event, MappingStartEvent) and self.events
417                and isinstance(self.events[0], MappingEndEvent))
418
419    def check_empty_document(self):
420        if not isinstance(self.event, DocumentStartEvent) or not self.events:
421            return False
422        event = self.events[0]
423        return (isinstance(event, ScalarEvent) and event.anchor is None
424                and event.tag is None and event.implicit and event.value == u'')
425
426    def check_simple_key(self):
427        length = 0
428        if isinstance(self.event, NodeEvent) and self.event.anchor is not None:
429            if self.prepared_anchor is None:
430                self.prepared_anchor = self.prepare_anchor(self.event.anchor)
431            length += len(self.prepared_anchor)
432        if isinstance(self.event, (ScalarEvent, CollectionStartEvent))  \
433                and self.event.tag is not None:
434            if self.prepared_tag is None:
435                self.prepared_tag = self.prepare_tag(self.event.tag)
436            length += len(self.prepared_tag)
437        if isinstance(self.event, ScalarEvent):
438            if self.analysis is None:
439                self.analysis = self.analyze_scalar(self.event.value)
440            length += len(self.analysis.scalar)
441        return (length < 128 and (isinstance(self.event, AliasEvent)
442            or (isinstance(self.event, ScalarEvent)
443                    and not self.analysis.empty and not self.analysis.multiline)
444            or self.check_empty_sequence() or self.check_empty_mapping()))
445
446    # Anchor, Tag, and Scalar processors.
447
448    def process_anchor(self, indicator):
449        if self.event.anchor is None:
450            self.prepared_anchor = None
451            return
452        if self.prepared_anchor is None:
453            self.prepared_anchor = self.prepare_anchor(self.event.anchor)
454        if self.prepared_anchor:
455            self.write_indicator(indicator+self.prepared_anchor, True)
456        self.prepared_anchor = None
457
458    def process_tag(self):
459        tag = self.event.tag
460        if isinstance(self.event, ScalarEvent):
461            if self.style is None:
462                self.style = self.choose_scalar_style()
463            if ((not self.canonical or tag is None) and
464                ((self.style == '' and self.event.implicit[0])
465                        or (self.style != '' and self.event.implicit[1]))):
466                self.prepared_tag = None
467                return
468            if self.event.implicit[0] and tag is None:
469                tag = u'!'
470                self.prepared_tag = None
471        else:
472            if (not self.canonical or tag is None) and self.event.implicit:
473                self.prepared_tag = None
474                return
475        if tag is None:
476            raise EmitterError("tag is not specified")
477        if self.prepared_tag is None:
478            self.prepared_tag = self.prepare_tag(tag)
479        if self.prepared_tag:
480            self.write_indicator(self.prepared_tag, True)
481        self.prepared_tag = None
482
483    def choose_scalar_style(self):
484        if self.analysis is None:
485            self.analysis = self.analyze_scalar(self.event.value)
486        if self.event.style == '"' or self.canonical:
487            return '"'
488        if not self.event.style and self.event.implicit[0]:
489            if (not (self.simple_key_context and
490                    (self.analysis.empty or self.analysis.multiline))
491                and (self.flow_level and self.analysis.allow_flow_plain
492                    or (not self.flow_level and self.analysis.allow_block_plain))):
493                return ''
494        if self.event.style and self.event.style in '|>':
495            if not self.flow_level and self.analysis.allow_block:
496                return self.event.style
497        if not self.event.style or self.event.style == '\'':
498            if (self.analysis.allow_single_quoted and
499                    not (self.simple_key_context and self.analysis.multiline)):
500                return '\''
501        return '"'
502
503    def process_scalar(self):
504        if self.analysis is None:
505            self.analysis = self.analyze_scalar(self.event.value)
506        if self.style is None:
507            self.style = self.choose_scalar_style()
508        split = (not self.simple_key_context)
509        #if self.analysis.multiline and split    \
510        #        and (not self.style or self.style in '\'\"'):
511        #    self.write_indent()
512        if self.style == '"':
513            self.write_double_quoted(self.analysis.scalar, split)
514        elif self.style == '\'':
515            self.write_single_quoted(self.analysis.scalar, split)
516        elif self.style == '>':
517            self.write_folded(self.analysis.scalar)
518        elif self.style == '|':
519            self.write_literal(self.analysis.scalar)
520        else:
521            self.write_plain(self.analysis.scalar, split)
522        self.analysis = None
523        self.style = None
524
525    # Analyzers.
526
527    def prepare_version(self, version):
528        major, minor = version
529        if major != 1:
530            raise EmitterError("unsupported YAML version: %d.%d" % (major, minor))
531        return u'%d.%d' % (major, minor)
532
533    def prepare_tag_handle(self, handle):
534        if not handle:
535            raise EmitterError("tag handle must not be empty")
536        if handle[0] != u'!' or handle[-1] != u'!':
537            raise EmitterError("tag handle must start and end with '!': %r"
538                    % (handle.encode('utf-8')))
539        for ch in handle[1:-1]:
540            if not (u'0' <= ch <= u'9' or u'A' <= ch <= 'Z' or u'a' <= ch <= 'z'    \
541                    or ch in u'-_'):
542                raise EmitterError("invalid character %r in the tag handle: %r"
543                        % (ch.encode('utf-8'), handle.encode('utf-8')))
544        return handle
545
546    def prepare_tag_prefix(self, prefix):
547        if not prefix:
548            raise EmitterError("tag prefix must not be empty")
549        chunks = []
550        start = end = 0
551        if prefix[0] == u'!':
552            end = 1
553        while end < len(prefix):
554            ch = prefix[end]
555            if u'0' <= ch <= u'9' or u'A' <= ch <= 'Z' or u'a' <= ch <= 'z'  \
556                    or ch in u'-;/?!:@&=+$,_.~*\'()[]':
557                end += 1
558            else:
559                if start < end:
560                    chunks.append(prefix[start:end])
561                start = end = end+1
562                data = ch.encode('utf-8')
563                for ch in data:
564                    chunks.append(u'%%%02X' % ord(ch))
565        if start < end:
566            chunks.append(prefix[start:end])
567        return u''.join(chunks)
568
569    def prepare_tag(self, tag):
570        if not tag:
571            raise EmitterError("tag must not be empty")
572        if tag == u'!':
573            return tag
574        handle = None
575        suffix = tag
576        for prefix in self.tag_prefixes:
577            if tag.startswith(prefix)   \
578                    and (prefix == u'!' or len(prefix) < len(tag)):
579                handle = self.tag_prefixes[prefix]
580                suffix = tag[len(prefix):]
581        chunks = []
582        start = end = 0
583        while end < len(suffix):
584            ch = suffix[end]
585            if u'0' <= ch <= u'9' or u'A' <= ch <= 'Z' or u'a' <= ch <= 'z'  \
586                    or ch in u'-;/?:@&=+$,_.~*\'()[]'   \
587                    or (ch == u'!' and handle != u'!'):
588                end += 1
589            else:
590                if start < end:
591                    chunks.append(suffix[start:end])
592                start = end = end+1
593                data = ch.encode('utf-8')
594                for ch in data:
595                    chunks.append(u'%%%02X' % ord(ch))
596        if start < end:
597            chunks.append(suffix[start:end])
598        suffix_text = u''.join(chunks)
599        if handle:
600            return u'%s%s' % (handle, suffix_text)
601        else:
602            return u'!<%s>' % suffix_text
603
604    def prepare_anchor(self, anchor):
605        if not anchor:
606            raise EmitterError("anchor must not be empty")
607        for ch in anchor:
608            if not (u'0' <= ch <= u'9' or u'A' <= ch <= 'Z' or u'a' <= ch <= 'z'    \
609                    or ch in u'-_'):
610                raise EmitterError("invalid character %r in the anchor: %r"
611                        % (ch.encode('utf-8'), anchor.encode('utf-8')))
612        return anchor
613
614    def analyze_scalar(self, scalar):
615
616        # Empty scalar is a special case.
617        if not scalar:
618            return ScalarAnalysis(scalar=scalar, empty=True, multiline=False,
619                    allow_flow_plain=False, allow_block_plain=True,
620                    allow_single_quoted=True, allow_double_quoted=True,
621                    allow_block=False)
622
623        # Indicators and special characters.
624        block_indicators = False
625        flow_indicators = False
626        line_breaks = False
627        special_characters = False
628
629        # Whitespaces.
630        inline_spaces = False          # non-space space+ non-space
631        inline_breaks = False          # non-space break+ non-space
632        leading_spaces = False         # ^ space+ (non-space | $)
633        leading_breaks = False         # ^ break+ (non-space | $)
634        trailing_spaces = False        # (^ | non-space) space+ $
635        trailing_breaks = False        # (^ | non-space) break+ $
636        inline_breaks_spaces = False   # non-space break+ space+ non-space
637        mixed_breaks_spaces = False    # anything else
638
639        # Check document indicators.
640        if scalar.startswith(u'---') or scalar.startswith(u'...'):
641            block_indicators = True
642            flow_indicators = True
643
644        # First character or preceded by a whitespace.
645        preceeded_by_space = True
646
647        # Last character or followed by a whitespace.
648        followed_by_space = (len(scalar) == 1 or
649                scalar[1] in u'\0 \t\r\n\x85\u2028\u2029')
650
651        # The current series of whitespaces contain plain spaces.
652        spaces = False
653
654        # The current series of whitespaces contain line breaks.
655        breaks = False
656
657        # The current series of whitespaces contain a space followed by a
658        # break.
659        mixed = False
660
661        # The current series of whitespaces start at the beginning of the
662        # scalar.
663        leading = False
664
665        index = 0
666        while index < len(scalar):
667            ch = scalar[index]
668
669            # Check for indicators.
670
671            if index == 0:
672                # Leading indicators are special characters.
673                if ch in u'#,[]{}#&*!|>\'\"%@`': 
674                    flow_indicators = True
675                    block_indicators = True
676                if ch in u'?:':
677                    flow_indicators = True
678                    if followed_by_space:
679                        block_indicators = True
680                if ch == u'-' and followed_by_space:
681                    flow_indicators = True
682                    block_indicators = True
683            else:
684                # Some indicators cannot appear within a scalar as well.
685                if ch in u',?[]{}':
686                    flow_indicators = True
687                if ch == u':':
688                    flow_indicators = True
689                    if followed_by_space:
690                        block_indicators = True
691                if ch == u'#' and preceeded_by_space:
692                    flow_indicators = True
693                    block_indicators = True
694
695            # Check for line breaks, special, and unicode characters.
696
697            if ch in u'\n\x85\u2028\u2029':
698                line_breaks = True
699            if not (ch == u'\n' or u'\x20' <= ch <= u'\x7E'):
700                if ch < u'\x80' or ch == u'\uFEFF': # '\uFEFF' is BOM.
701                    special_characters = True
702                else:
703                    unicode_characters = True
704                    if not self.allow_unicode:
705                        special_characters = True
706
707            # Spaces, line breaks, and how they are mixed. State machine.
708
709            # Start or continue series of whitespaces.
710            if ch in u' \n\x85\u2028\u2029':
711                if spaces and breaks:
712                    if ch != u' ':      # break+ (space+ break+)    => mixed
713                        mixed = True
714                elif spaces:
715                    if ch != u' ':      # (space+ break+)   => mixed
716                        breaks = True
717                        mixed = True
718                elif breaks:
719                    if ch == u' ':      # break+ space+
720                        spaces = True
721                else:
722                    leading = (index == 0)
723                    if ch == u' ':      # space+
724                        spaces = True
725                    else:               # break+
726                        breaks = True
727
728            # Series of whitespaces ended with a non-space.
729            elif spaces or breaks:
730                if leading:
731                    if spaces and breaks:
732                        mixed_breaks_spaces = True
733                    elif spaces:
734                        leading_spaces = True
735                    elif breaks:
736                        leading_breaks = True
737                else:
738                    if mixed:
739                        mixed_breaks_spaces = True
740                    elif spaces and breaks:
741                        inline_breaks_spaces = True
742                    elif spaces:
743                        inline_spaces = True
744                    elif breaks:
745                        inline_breaks = True
746                spaces = breaks = mixed = leading = False
747
748            # Series of whitespaces reach the end.
749            if (spaces or breaks) and (index == len(scalar)-1):
750                if spaces and breaks:
751                    mixed_breaks_spaces = True
752                elif spaces:
753                    trailing_spaces = True
754                    if leading:
755                        leading_spaces = True
756                elif breaks:
757                    trailing_breaks = True
758                    if leading:
759                        leading_breaks = True
760                spaces = breaks = mixed = leading = False
761
762            # Prepare for the next character.
763            index += 1
764            preceeded_by_space = (ch in u'\0 \t\r\n\x85\u2028\u2029')
765            followed_by_space = (index+1 >= len(scalar) or
766                    scalar[index+1] in u'\0 \t\r\n\x85\u2028\u2029')
767
768        # Let's decide what styles are allowed.
769        allow_flow_plain = True
770        allow_block_plain = True
771        allow_single_quoted = True
772        allow_double_quoted = True
773        allow_block = True
774
775        # Leading and trailing whitespace are bad for plain scalars. We also
776        # do not want to mess with leading whitespaces for block scalars.
777        if leading_spaces or leading_breaks or trailing_spaces:
778            allow_flow_plain = allow_block_plain = allow_block = False
779
780        # Trailing breaks are fine for block scalars, but unacceptable for
781        # plain scalars.
782        if trailing_breaks:
783            allow_flow_plain = allow_block_plain = False
784
785        # The combination of (space+ break+) is only acceptable for block
786        # scalars.
787        if inline_breaks_spaces:
788            allow_flow_plain = allow_block_plain = allow_single_quoted = False
789
790        # Mixed spaces and breaks, as well as special character are only
791        # allowed for double quoted scalars.
792        if mixed_breaks_spaces or special_characters:
793            allow_flow_plain = allow_block_plain =  \
794            allow_single_quoted = allow_block = False
795
796        # We don't emit multiline plain scalars.
797        if line_breaks:
798            allow_flow_plain = allow_block_plain = False
799
800        # Flow indicators are forbidden for flow plain scalars.
801        if flow_indicators:
802            allow_flow_plain = False
803
804        # Block indicators are forbidden for block plain scalars.
805        if block_indicators:
806            allow_block_plain = False
807
808        return ScalarAnalysis(scalar=scalar,
809                empty=False, multiline=line_breaks,
810                allow_flow_plain=allow_flow_plain,
811                allow_block_plain=allow_block_plain,
812                allow_single_quoted=allow_single_quoted,
813                allow_double_quoted=allow_double_quoted,
814                allow_block=allow_block)
815
816    # Writers.
817
818    def flush_stream(self):
819        if hasattr(self.stream, 'flush'):
820            self.stream.flush()
821
822    def write_stream_start(self):
823        # Write BOM if needed.
824        if self.encoding and self.encoding.startswith('utf-16'):
825            self.stream.write(u'\xFF\xFE'.encode(self.encoding))
826
827    def write_stream_end(self):
828        self.flush_stream()
829
830    def write_indicator(self, indicator, need_whitespace,
831            whitespace=False, indention=False):
832        if self.whitespace or not need_whitespace:
833            data = indicator
834        else:
835            data = u' '+indicator
836        self.whitespace = whitespace
837        self.indention = self.indention and indention
838        self.column += len(data)
839        if self.encoding:
840            data = data.encode(self.encoding)
841        self.stream.write(data)
842
843    def write_indent(self):
844        indent = self.indent or 0
845        if not self.indention or self.column > indent   \
846                or (self.column == indent and not self.whitespace):
847            self.write_line_break()
848        if self.column < indent:
849            self.whitespace = True
850            data = u' '*(indent-self.column)
851            self.column = indent
852            if self.encoding:
853                data = data.encode(self.encoding)
854            self.stream.write(data)
855
856    def write_line_break(self, data=None):
857        if data is None:
858            data = self.best_line_break
859        self.whitespace = True
860        self.indention = True
861        self.line += 1
862        self.column = 0
863        if self.encoding:
864            data = data.encode(self.encoding)
865        self.stream.write(data)
866
867    def write_version_directive(self, version_text):
868        data = u'%%YAML %s' % version_text
869        if self.encoding:
870            data = data.encode(self.encoding)
871        self.stream.write(data)
872        self.write_line_break()
873
874    def write_tag_directive(self, handle_text, prefix_text):
875        data = u'%%TAG %s %s' % (handle_text, prefix_text)
876        if self.encoding:
877            data = data.encode(self.encoding)
878        self.stream.write(data)
879        self.write_line_break()
880
881    # Scalar streams.
882
883    def write_single_quoted(self, text, split=True):
884        self.write_indicator(u'\'', True)
885        spaces = False
886        breaks = False
887        start = end = 0
888        while end <= len(text):
889            ch = None
890            if end < len(text):
891                ch = text[end]
892            if spaces:
893                if ch is None or ch != u' ':
894                    if start+1 == end and self.column > self.best_width and split   \
895                            and start != 0 and end != len(text):
896                        self.write_indent()
897                    else:
898                        data = text[start:end]
899                        self.column += len(data)
900                        if self.encoding:
901                            data = data.encode(self.encoding)
902                        self.stream.write(data)
903                    start = end
904            elif breaks:
905                if ch is None or ch not in u'\n\x85\u2028\u2029':
906                    if text[start] == u'\n':
907                        self.write_line_break()
908                    for br in text[start:end]:
909                        if br == u'\n':
910                            self.write_line_break()
911                        else:
912                            self.write_line_break(br)
913                    self.write_indent()
914                    start = end
915            else:
916                if ch is None or ch in u' \n\x85\u2028\u2029' or ch == u'\'':
917                    if start < end:
918                        data = text[start:end]
919                        self.column += len(data)
920                        if self.encoding:
921                            data = data.encode(self.encoding)
922                        self.stream.write(data)
923                        start = end
924                    if ch == u'\'':
925                        data = u'\'\''
926                        self.column += 2
927                        if self.encoding:
928                            data = data.encode(self.encoding)
929                        self.stream.write(data)
930                        start = end + 1
931            if ch is not None:
932                spaces = (ch == u' ')
933                breaks = (ch in u'\n\x85\u2028\u2029')
934            end += 1
935        self.write_indicator(u'\'', False)
936
937    ESCAPE_REPLACEMENTS = {
938        u'\0':      u'0',
939        u'\x07':    u'a',
940        u'\x08':    u'b',
941        u'\x09':    u't',
942        u'\x0A':    u'n',
943        u'\x0B':    u'v',
944        u'\x0C':    u'f',
945        u'\x0D':    u'r',
946        u'\x1B':    u'e',
947        u'\"':      u'\"',
948        u'\\':      u'\\',
949        u'\x85':    u'N',
950        u'\xA0':    u'_',
951        u'\u2028':  u'L',
952        u'\u2029':  u'P',
953    }
954
955    def write_double_quoted(self, text, split=True):
956        self.write_indicator(u'"', True)
957        start = end = 0
958        while end <= len(text):
959            ch = None
960            if end < len(text):
961                ch = text[end]
962            if ch is None or ch in u'"\\\x85\u2028\u2029\uFEFF' \
963                    or not (u'\x20' <= ch <= u'\x7E'
964                            or (self.allow_unicode and ch > u'\x7F')):
965                if start < end:
966                    data = text[start:end]
967                    self.column += len(data)
968                    if self.encoding:
969                        data = data.encode(self.encoding)
970                    self.stream.write(data)
971                    start = end
972                if ch is not None:
973                    if ch in self.ESCAPE_REPLACEMENTS:
974                        data = u'\\'+self.ESCAPE_REPLACEMENTS[ch]
975                    elif ch <= u'\xFF':
976                        data = u'\\x%02X' % ord(ch)
977                    elif ch <= u'\uFFFF':
978                        data = u'\\u%04X' % ord(ch)
979                    else:
980                        data = u'\\U%08X' % ord(ch)
981                    self.column += len(data)
982                    if self.encoding:
983                        data = data.encode(self.encoding)
984                    self.stream.write(data)
985                    start = end+1
986            if 0 < end < len(text)-1 and (ch == u' ' or start >= end)   \
987                    and self.column+(end-start) > self.best_width and split:
988                data = text[start:end]+u'\\'
989                if start < end:
990                    start = end
991                self.column += len(data)
992                if self.encoding:
993                    data = data.encode(self.encoding)
994                self.stream.write(data)
995                self.write_indent()
996                self.whitespace = False
997                self.indention = False
998                if text[start] == u' ':
999                    data = u'\\'
1000                    self.column += len(data)
1001                    if self.encoding:
1002                        data = data.encode(self.encoding)
1003                    self.stream.write(data)
1004            end += 1
1005        self.write_indicator(u'"', False)
1006
1007    def determine_chomp(self, text):
1008        tail = text[-2:]
1009        while len(tail) < 2:
1010            tail = u' '+tail
1011        if tail[-1] in u'\n\x85\u2028\u2029':
1012            if tail[-2] in u'\n\x85\u2028\u2029':
1013                return u'+'
1014            else:
1015                return u''
1016        else:
1017            return u'-'
1018
1019    def write_folded(self, text):
1020        chomp = self.determine_chomp(text)
1021        self.write_indicator(u'>'+chomp, True)
1022        self.write_indent()
1023        leading_space = False
1024        spaces = False
1025        breaks = False
1026        start = end = 0
1027        while end <= len(text):
1028            ch = None
1029            if end < len(text):
1030                ch = text[end]
1031            if breaks:
1032                if ch is None or ch not in u'\n\x85\u2028\u2029':
1033                    if not leading_space and ch is not None and ch != u' '  \
1034                            and text[start] == u'\n':
1035                        self.write_line_break()
1036                    leading_space = (ch == u' ')
1037                    for br in text[start:end]:
1038                        if br == u'\n':
1039                            self.write_line_break()
1040                        else:
1041                            self.write_line_break(br)
1042                    if ch is not None:
1043                        self.write_indent()
1044                    start = end
1045            elif spaces:
1046                if ch != u' ':
1047                    if start+1 == end and self.column > self.best_width:
1048                        self.write_indent()
1049                    else:
1050                        data = text[start:end]
1051                        self.column += len(data)
1052                        if self.encoding:
1053                            data = data.encode(self.encoding)
1054                        self.stream.write(data)
1055                    start = end
1056            else:
1057                if ch is None or ch in u' \n\x85\u2028\u2029':
1058                    data = text[start:end]
1059                    if self.encoding:
1060                        data = data.encode(self.encoding)
1061                    self.stream.write(data)
1062                    if ch is None:
1063                        self.write_line_break()
1064                    start = end
1065            if ch is not None:
1066                breaks = (ch in u'\n\x85\u2028\u2029')
1067                spaces = (ch == u' ')
1068            end += 1
1069
1070    def write_literal(self, text):
1071        chomp = self.determine_chomp(text)
1072        self.write_indicator(u'|'+chomp, True)
1073        self.write_indent()
1074        breaks = False
1075        start = end = 0
1076        while end <= len(text):
1077            ch = None
1078            if end < len(text):
1079                ch = text[end]
1080            if breaks:
1081                if ch is None or ch not in u'\n\x85\u2028\u2029':
1082                    for br in text[start:end]:
1083                        if br == u'\n':
1084                            self.write_line_break()
1085                        else:
1086                            self.write_line_break(br)
1087                    if ch is not None:
1088                        self.write_indent()
1089                    start = end
1090            else:
1091                if ch is None or ch in u'\n\x85\u2028\u2029':
1092                    data = text[start:end]
1093                    if self.encoding:
1094                        data = data.encode(self.encoding)
1095                    self.stream.write(data)
1096                    if ch is None:
1097                        self.write_line_break()
1098                    start = end
1099            if ch is not None:
1100                breaks = (ch in u'\n\x85\u2028\u2029')
1101            end += 1
1102
1103    def write_plain(self, text, split=True):
1104        if not text:
1105            return
1106        if not self.whitespace:
1107            data = u' '
1108            self.column += len(data)
1109            if self.encoding:
1110                data = data.encode(self.encoding)
1111            self.stream.write(data)
1112        self.writespace = False
1113        self.indention = False
1114        spaces = False
1115        breaks = False
1116        start = end = 0
1117        while end <= len(text):
1118            ch = None
1119            if end < len(text):
1120                ch = text[end]
1121            if spaces:
1122                if ch != u' ':
1123                    if start+1 == end and self.column > self.best_width and split:
1124                        self.write_indent()
1125                        self.writespace = False
1126                        self.indention = False
1127                    else:
1128                        data = text[start:end]
1129                        self.column += len(data)
1130                        if self.encoding:
1131                            data = data.encode(self.encoding)
1132                        self.stream.write(data)
1133                    start = end
1134            elif breaks:
1135                if ch not in u'\n\x85\u2028\u2029':
1136                    if text[start] == u'\n':
1137                        self.write_line_break()
1138                    for br in text[start:end]:
1139                        if br == u'\n':
1140                            self.write_line_break()
1141                        else:
1142                            self.write_line_break(br)
1143                    self.write_indent()
1144                    self.whitespace = False
1145                    self.indention = False
1146                    start = end
1147            else:
1148                if ch is None or ch in u' \n\x85\u2028\u2029':
1149                    data = text[start:end]
1150                    self.column += len(data)
1151                    if self.encoding:
1152                        data = data.encode(self.encoding)
1153                    self.stream.write(data)
1154                    start = end
1155            if ch is not None:
1156                spaces = (ch == u' ')
1157                breaks = (ch in u'\n\x85\u2028\u2029')
1158            end += 1
1159
Note: See TracBrowser for help on using the repository browser.