source: pyyaml/trunk/lib3/yaml/emitter.py @ 355

Revision 355, 41.8 KB checked in by xi, 5 years ago (diff)

Merged some bug fixes from lib to lib3.

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