summaryrefslogtreecommitdiffstats
path: root/tests/test_docutils.py
diff options
context:
space:
mode:
Diffstat (limited to 'tests/test_docutils.py')
-rw-r--r--tests/test_docutils.py116
1 files changed, 116 insertions, 0 deletions
diff --git a/tests/test_docutils.py b/tests/test_docutils.py
new file mode 100644
index 0000000..f6f5d36
--- /dev/null
+++ b/tests/test_docutils.py
@@ -0,0 +1,116 @@
+import io
+from dataclasses import dataclass, field, fields
+from textwrap import dedent
+
+import pytest
+from docutils import VersionInfo, __version_info__
+from typing_extensions import Literal
+
+from myst_parser.mdit_to_docutils.base import make_document
+from myst_parser.parsers.docutils_ import (
+ Parser,
+ attr_to_optparse_option,
+ cli_html,
+ cli_html5,
+ cli_latex,
+ cli_pseudoxml,
+ cli_xml,
+)
+
+
+def test_attr_to_optparse_option():
+ @dataclass
+ class Config:
+ name: Literal["a"] = field(default="default")
+
+ output = attr_to_optparse_option(fields(Config)[0], "default")
+ assert len(output) == 3
+
+
+def test_parser():
+ """Test calling `Parser.parse` directly."""
+ parser = Parser()
+ document = make_document(parser_cls=Parser)
+ parser.parse("something", document)
+ assert (
+ document.pformat().strip()
+ == '<document source="notset">\n <paragraph>\n something'
+ )
+
+
+def test_cli_html(monkeypatch, capsys):
+ monkeypatch.setattr("sys.stdin", io.TextIOWrapper(io.BytesIO(b"text")))
+ cli_html([])
+ captured = capsys.readouterr()
+ assert not captured.err
+ assert "text" in captured.out
+
+
+def test_cli_html5(monkeypatch, capsys):
+ monkeypatch.setattr("sys.stdin", io.TextIOWrapper(io.BytesIO(b"text")))
+ cli_html5([])
+ captured = capsys.readouterr()
+ assert not captured.err
+ assert "text" in captured.out
+
+
+def test_cli_latex(monkeypatch, capsys):
+ monkeypatch.setattr("sys.stdin", io.TextIOWrapper(io.BytesIO(b"text")))
+ cli_latex([])
+ captured = capsys.readouterr()
+ assert not captured.err
+ assert "text" in captured.out
+
+
+def test_cli_xml(monkeypatch, capsys):
+ monkeypatch.setattr("sys.stdin", io.TextIOWrapper(io.BytesIO(b"text")))
+ cli_xml([])
+ captured = capsys.readouterr()
+ assert not captured.err
+ assert "text" in captured.out
+
+
+def test_cli_pseudoxml(monkeypatch, capsys):
+ monkeypatch.setattr("sys.stdin", io.TextIOWrapper(io.BytesIO(b"text")))
+ cli_pseudoxml([])
+ captured = capsys.readouterr()
+ assert not captured.err
+ assert "text" in captured.out
+
+
+def test_help_text():
+ """Test retrieving settings help text."""
+ from docutils.frontend import OptionParser
+
+ stream = io.StringIO()
+ OptionParser(components=(Parser,)).print_help(stream)
+ assert "MyST options" in stream.getvalue()
+
+
+@pytest.mark.skipif(
+ __version_info__ < VersionInfo(0, 17, 0, "final", 0, True),
+ reason="parser option added in docutils 0.17",
+)
+def test_include_from_rst(tmp_path):
+ """Test including a MyST file from within an RST file."""
+ from docutils.parsers.rst import Parser as RSTParser
+
+ include_path = tmp_path.joinpath("include.md")
+ include_path.write_text("# Title")
+
+ parser = RSTParser()
+ document = make_document(parser_cls=RSTParser)
+ parser.parse(
+ f".. include:: {include_path}\n :parser: myst_parser.docutils_", document
+ )
+ assert (
+ document.pformat().strip()
+ == dedent(
+ """\
+ <document source="notset">
+ <section ids="title" names="title">
+ <title>
+ Title
+ """
+ ).strip()
+ )