#! /usr/bin/env python3
# $Id: test_html5_polyglot_parts.py 9642 2024-04-15 12:27:35Z milde $
# Author: reggie dugard
# Copyright: This module has been placed in the public domain.
"""
Test for fragment code in HTML writer.
Note: the 'body' and 'whole' entries have been removed from the parts
dictionaries (redundant), along with 'meta' and 'stylesheet' entries with
standard values, and any entries with empty values.
"""
from pathlib import Path
import os
import re
import sys
import unittest
if __name__ == '__main__':
# prepend the "docutils root" to the Python library path
# so we import the local `docutils` package.
sys.path.insert(0, str(Path(__file__).resolve().parents[2]))
import docutils
import docutils.core
from docutils.parsers.rst.directives.images import PIL
from docutils.utils.code_analyzer import with_pygments
if with_pygments:
import pygments
_pv = re.match(r'^([0-9]+)\.([0-9]*)', pygments.__version__)
if (int(_pv[1]), int(_pv[2])) >= (2, 14):
# pygments output changed in version 2.14
with_pygments = False
ROOT_PREFIX = (Path(__file__).parent.parent/'functional'/'input').as_posix()
DATA_ROOT = os.path.abspath(os.path.join(__file__, '..', '..', 'data'))
# Pillow/PIL is optional:
if PIL:
REQUIRES_PIL = ''
ONLY_LOCAL = 'Can only read local images.'
DUMMY_PNG_NOT_FOUND = "[Errno 2] No such file or directory: 'dummy.png'"
# Pillow reports the absolute path since version 10.3.0 (cf. [bugs: 485])
if (tuple(int(i) for i in PIL.__version__.split('.')) >= (10, 3)):
DUMMY_PNG_NOT_FOUND = ("[Errno 2] No such file or directory: '%s'"
% Path('dummy.png').resolve())
SCALING_OUTPUT = 'style="width: 32.0px; height: 32.0px;" '
NO_PIL_SYSTEM_MESSAGE = ''
else:
REQUIRES_PIL = '\n Requires Python Imaging Library.'
ONLY_LOCAL = 'Requires Python Imaging Library.'
DUMMY_PNG_NOT_FOUND = 'Requires Python Imaging Library.'
SCALING_OUTPUT = ''
NO_PIL_SYSTEM_MESSAGE = (
'\n')
class Html5WriterPublishPartsTestCase(unittest.TestCase):
"""Test case for HTML writer via the publish_parts interface."""
maxDiff = None
def test_publish(self):
if not with_pygments:
del totest['syntax_highlight']
writer_name = 'html5'
for name, (settings_overrides, cases) in totest.items():
for casenum, (case_input, case_expected) in enumerate(cases):
with self.subTest(id=f'totest[{name!r}][{casenum}]'):
parts = docutils.core.publish_parts(
source=case_input,
writer_name=writer_name,
settings_overrides={
'_disable_config': True,
'strict_visitor': True,
'stylesheet': '',
'section_self_link': True,
**settings_overrides,
}
)
self.assertEqual(case_expected, self.format_output(parts))
standard_content_type_template = '\n'
standard_generator_template = (
'\n')
standard_viewport_value = (
'\n')
standard_html_meta_value = (standard_content_type_template
+ standard_generator_template
+ standard_viewport_value)
standard_meta_value = standard_html_meta_value % 'utf-8'
standard_html_prolog = '\n'
standard_html_body_template = '\n%s\n'
def format_output(self, parts):
"""Minimize & standardize the output."""
# remove redundant parts & uninteresting parts:
del parts['whole']
assert parts['body'] == parts['fragment']
del parts['body']
del parts['body_pre_docinfo']
del parts['body_prefix']
del parts['body_suffix']
del parts['head']
del parts['head_prefix']
del parts['encoding']
del parts['errors']
del parts['version']
# remove standard portions:
parts['meta'] = parts['meta'].replace(self.standard_meta_value, '')
parts['html_head'] = parts['html_head'].replace(
self.standard_html_meta_value, '...')
parts['html_head'] = parts['html_head'].replace(
'...<string>\n', '')
parts['html_prolog'] = parts['html_prolog'].replace(
self.standard_html_prolog, '')
parts['html_body'] = parts['html_body'].replace(
self.standard_html_body_template % parts['fragment'], '')
# remove empty keys and return
return {k: v for k, v in parts.items() if v}
totest = {}
totest['standard'] = ({'stylesheet_path': '',
'embed_stylesheet': False}, [
["""\
Simple String
""",
{'fragment': '
Simple String
\n',
}],
["""\
Simple String with *markup*
""",
{'fragment': '
Simple String with markup
\n',
}],
["""\
Simple String with an even simpler ``inline literal``
""",
{'fragment': '
\n',
}],
["""\
One paragraph.
Two paragraphs.
""",
{'fragment': """\
One paragraph.
Two paragraphs.
""",
}],
["""\
A simple `named reference`_ with stuff in between the
reference and the target.
.. _`named reference`: http://www.test.com/test_url
""",
{'fragment': """\
A simple named reference with stuff in between the
reference and the target.
""",
}],
["""\
.. [CIT2022] A citation.
""",
{'fragment': """\
[CIT2022]
A citation.
""",
}],
["""\
+++++
Title
+++++
Subtitle
========
Some stuff
Section
-------
Some more stuff
Another Section
...............
And even more stuff
""",
{'fragment': """\
\n',
}],
["""\
A simple `named reference`_ with stuff in between the
reference and the target.
.. _`named reference`: http://www.test.com/test_url
""",
{'fragment': """\
A simple named reference with stuff in between the
reference and the target.
""",
}],
["""\
+++++
Title
+++++
Not A Subtitle
==============
Some stuff
Section
-------
Some more stuff
Another Section
...............
And even more stuff
""",
{'fragment': """\
Title
Not A Subtitle
Some stuff
Section
Some more stuff
Another Section
And even more stuff
""",
}],
["""\
* bullet
* list
""",
{'fragment': """\
""",
}],
["""\
Not a docinfo.
:This: .. _target:
is
:a:
:simple:
:field: list
""",
{'fragment': """\
Not a docinfo.
This:
is
a:
simple:
field:
list
""",
}],
["""\
Not a docinfo.
:This is: a
:simple field list with loooong field: names
""",
{'fragment': """\
Not a docinfo.
This is:
a
simple field list with loooong field:
names
""",
}],
["""\
Not a docinfo.
.. class:: field-indent-200
:This: is a
:simple: field list with custom indent.
""",
{'fragment': """\
Not a docinfo.
This:
is a
simple:
field list with custom indent.
""",
}],
["""\
Not a docinfo.
.. class:: field-indent-200uf
:This: is a
:simple: field list without custom indent,
because the unit "uf" is invalid.
""",
{'fragment': """\
Not a docinfo.
This:
is a
simple:
field list without custom indent,
because the unit "uf" is invalid.
""",
}],
["""\
.. figure:: dummy.png
The figure's caption.
A legend.
The legend's second paragraph.
""",
{'fragment': """\
The figure's caption.
A legend.
The legend's second paragraph.
""",
}],
["""\
.. figure:: dummy.png
The figure's caption, no legend.
""",
{'fragment': """\
The figure's caption, no legend.
""",
}],
["""\
.. figure:: dummy.png
..
A legend without caption.
""",
{'fragment': """\
A legend without caption.
""",
}],
["""\
.. figure:: dummy.png
No caption nor legend.
""",
{'fragment': """\
\n{NO_PIL_SYSTEM_MESSAGE}'
'
""",
}],
[f"""\
.. image:: {DATA_ROOT}/circle-broken.svg
:loading: embed
""",
{'fragment': f"""\
"""
}],
[r"""Broken :math:`\sin \my`.
""",
{'fragment': """\