-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathio.py
More file actions
100 lines (86 loc) · 3.68 KB
/
io.py
File metadata and controls
100 lines (86 loc) · 3.68 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
"""Input/Output files"""
from __future__ import annotations
from typing import TYPE_CHECKING, Any
from docutils.core import Publisher
from docutils.io import FileInput, Input, NullOutput
from docutils.readers import standalone
from docutils.transforms.references import DanglingReferences
from docutils.writers import UnfilteredWriter
from sphinx import addnodes
from sphinx.transforms import AutoIndexUpgrader, DoctreeReadEvent, SphinxTransformer
from sphinx.transforms.i18n import Locale, PreserveTranslatableMessages, RemoveTranslatableInline
from sphinx.transforms.references import SphinxDomains
from sphinx.util import logging
from sphinx.util.docutils import LoggingReporter
from sphinx.versioning import UIDTransform
if TYPE_CHECKING:
from docutils import nodes
from docutils.frontend import Values
from docutils.parsers import Parser
from docutils.transforms import Transform
from sphinx.application import Sphinx
from sphinx.environment import BuildEnvironment
logger = logging.getLogger(__name__)
class SphinxBaseReader(standalone.Reader):
"""
A base class of readers for Sphinx.
This replaces reporter by Sphinx's on generating document.
"""
transforms: list[type[Transform]] = []
def __init__(self, *args: Any, **kwargs: Any) -> None:
from sphinx.application import Sphinx
if len(args) > 0 and isinstance(args[0], Sphinx):
self._app = args[0]
self._env = self._app.env
args = args[1:]
super().__init__(*args, **kwargs)
def new_document(self) -> nodes.document:
"""
Creates a new document object which has a special reporter object good
for logging.
"""
document = super().new_document()
document.reporter = LoggingReporter.from_reporter(document.reporter)
return document
class SphinxStandaloneReader(SphinxBaseReader):
"""
A basic document reader for Sphinx.
"""
def read_source(self, env: BuildEnvironment) -> str:
"""Read content from source and do post-process."""
if isinstance(self.source, SphinxFileInput):
self.source.set_fs_encoding(env.fs_encoding)
return super().read()
class SphinxI18nReader(SphinxBaseReader):
"""
A document reader for i18n.
This returns the source line number of original text as current source line number
to let users know where the error happened.
Because the translated texts are partial and they don't have correct line numbers.
"""
class SphinxDummyWriter(UnfilteredWriter):
"""Dummy writer module used for generating doctree."""
supported = ('html',)
def SphinxDummySourceClass(source: Any, *args: Any, **kwargs: Any) -> Any:
"""Bypass source object as is to cheat Publisher."""
return source
def create_publisher(app: Sphinx | None=None, doctree: nodes.document | None=None) -> Publisher:
"""Create and return a publisher object."""
pub = Publisher(reader=None,
parser=None,
writer=SphinxDummyWriter(),
source_class=SphinxDummySourceClass,
destination=NullOutput())
pub.reader = SphinxStandaloneReader(app)
pub.parser = app.registry.create_source_parser(app, 'restructuredtext')
pub.document = doctree
pub.settings = pub.get_settings(traceback=True, warning_stream=None)
return pub
class SphinxFileInput(FileInput):
"""A basic FileInput for Sphinx."""
def __init__(self, *args: Any, **kwargs: Any) -> None:
kwargs['error_handler'] = 'sphinx'
super().__init__(*args, **kwargs)
def set_fs_encoding(self, fs_encoding: str) -> None:
"""Set the filesystem encoding."""
self.fs_encoding = fs_encoding