Python contentstate.ContentstateConverter类代码示例

 def test_image_after_list(self):
     """
     There should be no spacer paragraph inserted between a list and an image
     """
     converter = ContentstateConverter(features=['ul', 'image'])
     result = json.loads(converter.from_database_format(
         '''
         <ul>
             <li>Milk</li>
             <li>Eggs</li>
         </ul>
         <embed embedtype="image" alt="an image" id="1" format="left" />
         <ul>
             <li>More milk</li>
             <li>More eggs</li>
         </ul>
         '''
     ))
     self.assertContentStateEqual(result, {
         'entityMap': {
             '0': {
                 'data': {'format': 'left', 'alt': 'an image', 'id': '1', 'src': '/media/not-found'},
                 'mutability': 'IMMUTABLE', 'type': 'IMAGE'
             },
         },
         'blocks': [
             {'inlineStyleRanges': [], 'text': 'Milk', 'depth': 0, 'type': 'unordered-list-item', 'key': '00000', 'entityRanges': []},
             {'inlineStyleRanges': [], 'text': 'Eggs', 'depth': 0, 'type': 'unordered-list-item', 'key': '00000', 'entityRanges': []},
             {'key': '00000', 'inlineStyleRanges': [], 'entityRanges': [{'key': 1, 'offset': 0, 'length': 1}], 'depth': 0, 'text': ' ', 'type': 'atomic'},
             {'inlineStyleRanges': [], 'text': 'More milk', 'depth': 0, 'type': 'unordered-list-item', 'key': '00000', 'entityRanges': []},
             {'inlineStyleRanges': [], 'text': 'More eggs', 'depth': 0, 'type': 'unordered-list-item', 'key': '00000', 'entityRanges': []},
         ]
     })

 def test_add_spacer_paragraph_between_image_embeds(self):
     converter = ContentstateConverter(features=['image'])
     result = json.loads(converter.from_database_format(
         '''
         <embed embedtype="image" alt="an image" id="1" format="left" />
         <embed embedtype="image" alt="an image" id="1" format="left" />
         '''
     ))
     self.assertContentStateEqual(result, {
         'blocks': [
             {'key': '00000', 'inlineStyleRanges': [], 'entityRanges': [], 'depth': 0, 'text': '', 'type': 'unstyled'},
             {'key': '00000', 'inlineStyleRanges': [], 'entityRanges': [{'key': 0, 'offset': 0, 'length': 1}], 'depth': 0, 'text': ' ', 'type': 'atomic'},
             {'key': '00000', 'inlineStyleRanges': [], 'entityRanges': [], 'depth': 0, 'text': '', 'type': 'unstyled'},
             {'key': '00000', 'inlineStyleRanges': [], 'entityRanges': [{'key': 1, 'offset': 0, 'length': 1}], 'depth': 0, 'text': ' ', 'type': 'atomic'},
             {'key': '00000', 'inlineStyleRanges': [], 'entityRanges': [], 'depth': 0, 'text': '', 'type': 'unstyled'},
         ],
         'entityMap': {
             '0': {
                 'data': {'format': 'left', 'alt': 'an image', 'id': '1', 'src': '/media/not-found'},
                 'mutability': 'IMMUTABLE', 'type': 'IMAGE'
             },
             '1': {
                 'data': {'format': 'left', 'alt': 'an image', 'id': '1', 'src': '/media/not-found'},
                 'mutability': 'IMMUTABLE', 'type': 'IMAGE'
             },
         }
     })

 def test_add_spacer_paragraph_between_hrs(self):
     converter = ContentstateConverter(features=['hr'])
     result = json.loads(converter.from_database_format(
         '''
         <hr />
         <hr />
         '''
     ))
     self.assertContentStateEqual(result, {
         'blocks': [
             {'key': '00000', 'inlineStyleRanges': [], 'entityRanges': [], 'depth': 0, 'text': '', 'type': 'unstyled'},
             {'key': '00000', 'inlineStyleRanges': [], 'entityRanges': [{'key': 0, 'offset': 0, 'length': 1}], 'depth': 0, 'text': ' ', 'type': 'atomic'},
             {'key': '00000', 'inlineStyleRanges': [], 'entityRanges': [], 'depth': 0, 'text': '', 'type': 'unstyled'},
             {'key': '00000', 'inlineStyleRanges': [], 'entityRanges': [{'key': 1, 'offset': 0, 'length': 1}], 'depth': 0, 'text': ' ', 'type': 'atomic'},
             {'key': '00000', 'inlineStyleRanges': [], 'entityRanges': [], 'depth': 0, 'text': '', 'type': 'unstyled'},
         ],
         'entityMap': {
             '0': {
                 'data': {},
                 'mutability': 'IMMUTABLE', 'type': 'HORIZONTAL_RULE'
             },
             '1': {
                 'data': {},
                 'mutability': 'IMMUTABLE', 'type': 'HORIZONTAL_RULE'
             },
         }
     })

 def test_nested_list(self):
     converter = ContentstateConverter(features=['h1', 'ul'])
     result = json.loads(converter.from_database_format(
         '''
         <h1>Shopping list</h1>
         <ul>
             <li>Milk</li>
             <li>
                 Flour
                 <ul>
                     <li>Plain</li>
                     <li>Self-raising</li>
                 </ul>
             </li>
             <li>Eggs</li>
         </ul>
         '''
     ))
     self.assertContentStateEqual(result, {
         'entityMap': {},
         'blocks': [
             {'inlineStyleRanges': [], 'text': 'Shopping list', 'depth': 0, 'type': 'header-one', 'key': '00000', 'entityRanges': []},
             {'inlineStyleRanges': [], 'text': 'Milk', 'depth': 0, 'type': 'unordered-list-item', 'key': '00000', 'entityRanges': []},
             {'inlineStyleRanges': [], 'text': 'Flour', 'depth': 0, 'type': 'unordered-list-item', 'key': '00000', 'entityRanges': []},
             {'inlineStyleRanges': [], 'text': 'Plain', 'depth': 1, 'type': 'unordered-list-item', 'key': '00000', 'entityRanges': []},
             {'inlineStyleRanges': [], 'text': 'Self-raising', 'depth': 1, 'type': 'unordered-list-item', 'key': '00000', 'entityRanges': []},
             {'inlineStyleRanges': [], 'text': 'Eggs', 'depth': 0, 'type': 'unordered-list-item', 'key': '00000', 'entityRanges': []},
         ]
     })

class DraftailRichTextArea(WidgetWithScript, widgets.HiddenInput):
    # this class's constructor accepts a 'features' kwarg
    accepts_features = True

    def get_panel(self):
        return RichTextFieldPanel

    def __init__(self, *args, **kwargs):
        # note: this constructor will receive an 'options' kwarg taken from the WAGTAILADMIN_RICH_TEXT_EDITORS setting,
        # but we don't currently recognise any options from there (other than 'features', which is passed here as a separate kwarg)
        self.options = {}

        self.features = kwargs.pop('features', None)
        if self.features is None:
            self.features = feature_registry.get_default_features()

        for feature in self.features:
            plugin = feature_registry.get_editor_plugin('draftail', feature)
            if plugin:
                plugin.construct_options(self.options)

        self.converter = ContentstateConverter(self.features)

        super().__init__(*args, **kwargs)

    def translate_value(self, value):
        # Convert database rich text representation to the format required by
        # the input field

        if value is None:
            value = ''

        return self.converter.from_database_format(value)

    def render(self, name, value, attrs=None):
        if attrs is None:
            attrs = {}

        attrs['data-draftail-input'] = True

        translated_value = self.translate_value(value)
        return super().render(name, translated_value, attrs)

    def render_js_init(self, id_, name, value):
        return "window.draftail.initEditor('#{id}', {opts}, document.currentScript)".format(
            id=id_, opts=json.dumps(self.options))

    def value_from_datadict(self, data, files, name):
        original_value = super().value_from_datadict(data, files, name)
        if original_value is None:
            return None
        return self.converter.to_database_format(original_value)

    @property
    def media(self):
        return Media(js=[
            'wagtailadmin/js/draftail.js',
        ], css={
            'all': ['wagtailadmin/css/panels/draftail.css']
        })

    def test_add_spacer_paras_between_media_embeds(self, get_embed):
        get_embed.return_value = Embed(
            url='https://www.youtube.com/watch?v=Kh0Y2hVe_bw',
            max_width=None,
            type='video',
            html='test html',
            title='what are birds',
            author_name='look around you',
            provider_name='YouTube',
            thumbnail_url='http://test/thumbnail.url',
            width=1000,
            height=1000,
        )

        converter = ContentstateConverter(features=['embed'])
        result = json.loads(converter.from_database_format(
            '''
            <embed embedtype="media" url="https://www.youtube.com/watch?v=Kh0Y2hVe_bw" />
            <embed embedtype="media" url="https://www.youtube.com/watch?v=Kh0Y2hVe_bw" />
            '''
        ))
        self.assertContentStateEqual(result, {
            'blocks': [
                {'key': '00000', 'inlineStyleRanges': [], 'entityRanges': [], 'depth': 0, 'text': '', 'type': 'unstyled'},
                {'key': '00000', 'inlineStyleRanges': [], 'entityRanges': [{'key': 0, 'offset': 0, 'length': 1}], 'depth': 0, 'text': ' ', 'type': 'atomic'},
                {'key': '00000', 'inlineStyleRanges': [], 'entityRanges': [], 'depth': 0, 'text': '', 'type': 'unstyled'},
                {'key': '00000', 'inlineStyleRanges': [], 'entityRanges': [{'key': 1, 'offset': 0, 'length': 1}], 'depth': 0, 'text': ' ', 'type': 'atomic'},
                {'key': '00000', 'inlineStyleRanges': [], 'entityRanges': [], 'depth': 0, 'text': '', 'type': 'unstyled'},
            ],
            'entityMap': {
                '0': {
                    'data': {
                        'thumbnail': 'http://test/thumbnail.url',
                        'embedType': 'video',
                        'providerName': 'YouTube',
                        'title': 'what are birds',
                        'authorName': 'look around you',
                        'url': 'https://www.youtube.com/watch?v=Kh0Y2hVe_bw'
                    },
                    'mutability': 'IMMUTABLE', 'type': 'EMBED'
                },
                '1': {
                    'data': {
                        'thumbnail': 'http://test/thumbnail.url',
                        'embedType': 'video',
                        'providerName': 'YouTube',
                        'title': 'what are birds',
                        'authorName': 'look around you',
                        'url': 'https://www.youtube.com/watch?v=Kh0Y2hVe_bw'
                    },
                    'mutability': 'IMMUTABLE', 'type': 'EMBED'
                },
            }
        })

 def test_html_entities(self):
     converter = ContentstateConverter(features=[])
     result = json.loads(converter.from_database_format(
         '''
         <p>Arthur &quot;two sheds&quot; Jackson &lt;the third&gt; &amp; his wife</p>
         '''
     ))
     self.assertContentStateEqual(result, {
         'entityMap': {},
         'blocks': [
             {'inlineStyleRanges': [], 'text': 'Arthur "two sheds" Jackson <the third> & his wife', 'depth': 0, 'type': 'unstyled', 'key': '00000', 'entityRanges': []},
         ]
     })

 def test_ignore_unrecognised_tags_in_blocks(self):
     converter = ContentstateConverter(features=[])
     result = json.loads(converter.from_database_format(
         '''
         <p>Hello <foo>frabjuous</foo> world!</p>
         '''
     ))
     self.assertContentStateEqual(result, {
         'entityMap': {},
         'blocks': [
             {'inlineStyleRanges': [], 'text': 'Hello frabjuous world!', 'depth': 0, 'type': 'unstyled', 'key': '00000', 'entityRanges': []},
         ]
     })

 def test_br_element_in_paragraph(self):
     converter = ContentstateConverter(features=[])
     result = json.loads(converter.from_database_format(
         '''
         <p>before<br/>after</p>
         '''
     ))
     self.assertContentStateEqual(result, {
         'entityMap': {},
         'blocks': [
             {'key': '00000', 'inlineStyleRanges': [], 'entityRanges': [], 'depth': 0, 'text': 'before\nafter',
              'type': 'unstyled'}
         ],
     })

 def test_paragraphs(self):
     converter = ContentstateConverter(features=[])
     result = json.loads(converter.from_database_format(
         '''
         <p>Hello world!</p>
         <p>Goodbye world!</p>
         '''
     ))
     self.assertContentStateEqual(result, {
         'entityMap': {},
         'blocks': [
             {'inlineStyleRanges': [], 'text': 'Hello world!', 'depth': 0, 'type': 'unstyled', 'key': '00000', 'entityRanges': []},
             {'inlineStyleRanges': [], 'text': 'Goodbye world!', 'depth': 0, 'type': 'unstyled', 'key': '00000', 'entityRanges': []},
         ]
     })

    def __init__(self, *args, **kwargs):
        # note: this constructor will receive an 'options' kwarg taken from the WAGTAILADMIN_RICH_TEXT_EDITORS setting,
        # but we don't currently recognise any options from there (other than 'features', which is passed here as a separate kwarg)
        kwargs.pop('options', None)
        self.options = {}

        self._media = Media(js=[
            'wagtailadmin/js/draftail.js',
        ], css={
            'all': ['wagtailadmin/css/panels/draftail.css']
        })

        self.features = kwargs.pop('features', None)
        if self.features is None:
            self.features = feature_registry.get_default_features()

        for feature in self.features:
            plugin = feature_registry.get_editor_plugin('draftail', feature)
            if plugin:
                plugin.construct_options(self.options)
                self._media += plugin.media

        self.converter = ContentstateConverter(self.features)

        default_attrs = {'data-draftail-input': True}
        attrs = kwargs.get('attrs')
        if attrs:
            default_attrs.update(attrs)
        kwargs['attrs'] = default_attrs

        super().__init__(*args, **kwargs)

 def test_extra_end_tag_after(self):
     converter = ContentstateConverter(features=[])
     result = json.loads(converter.from_database_format(
         '''
         <p>After</p>
         </p>
         '''
     ))
     # The tailing </p> tag should be ignored instead of blowing up with a
     # pop from empty list error
     self.assertContentStateEqual(result, {
         'entityMap': {},
         'blocks': [
             {'inlineStyleRanges': [], 'text': 'After', 'depth': 0, 'type': 'unstyled', 'key': '00000', 'entityRanges': []},
         ]
     })

 def test_link_in_bare_text(self):
     converter = ContentstateConverter(features=['link'])
     result = json.loads(converter.from_database_format(
         '''an <a href="http://wagtail.io">external</a> link'''
     ))
     self.assertContentStateEqual(result, {
         'entityMap': {
             '0': {'mutability': 'MUTABLE', 'type': 'LINK', 'data': {'url': 'http://wagtail.io'}}
         },
         'blocks': [
             {
                 'inlineStyleRanges': [], 'text': 'an external link', 'depth': 0, 'type': 'unstyled', 'key': '00000',
                 'entityRanges': [{'offset': 3, 'length': 8, 'key': 0}]
             },
         ]
     })

 def test_collapse_targeted_whitespace_characters(self):
     # We expect all targeted whitespace characters (one or more consecutively)
     # to be replaced by a single space. (\xa0 is a non-breaking whitespace)
     converter = ContentstateConverter(features=[])
     result = json.loads(converter.from_database_format(
         '''
         <p>Multiple whitespaces:     should  be reduced</p>
         <p>Multiple non-breaking whitespace characters:  \xa0\xa0\xa0  should be preserved</p>
         '''
     ))
     self.assertContentStateEqual(result, {
         'entityMap': {},
         'blocks': [
             {'inlineStyleRanges': [], 'text': 'Multiple whitespaces: should be reduced', 'depth': 0, 'type': 'unstyled', 'key': '00000', 'entityRanges': []},
             {'inlineStyleRanges': [], 'text': 'Multiple non-breaking whitespace characters: \xa0\xa0\xa0 should be preserved', 'depth': 0, 'type': 'unstyled', 'key': '00000', 'entityRanges': []},
         ]
     })

 def test_inline_styles_at_start_of_bare_block(self):
     converter = ContentstateConverter(features=['bold', 'italic'])
     result = json.loads(converter.from_database_format(
         '''<b>Seriously</b>, stop talking about <i>Fight Club</i> already.'''
     ))
     self.assertContentStateEqual(result, {
         'entityMap': {},
         'blocks': [
             {
                 'inlineStyleRanges': [
                     {'offset': 0, 'length': 9, 'style': 'BOLD'},
                     {'offset': 30, 'length': 10, 'style': 'ITALIC'},
                 ],
                 'text': 'Seriously, stop talking about Fight Club already.', 'depth': 0, 'type': 'unstyled', 'key': '00000', 'entityRanges': []
             },
         ]
     })