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

Revision 307, 43.2 KB checked in by xi, 5 years ago (diff)

Fixed typos in attribute names (Thanks to ingy).

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