mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
c66d3e85d1
* flake8-builtins ('A')
* flake8-blind-except ('BLE')
* flake8-copyright ('CPY')
* eradicate ('ERA')
* flake8-boolean-trap ('FBT')
* flake8-fixme ('FIX')
* flake8-implicit-str-concat ('ISC')
* pep8-naming ('N')
* flake8-use-pathlib ('PTH')
* flake8-self ('SLF')
* tryceratops ('TRY')
101 lines
2.8 KiB
Python
101 lines
2.8 KiB
Python
"""Tests util.utils functions."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import os
|
|
from typing import TYPE_CHECKING
|
|
|
|
import pytest
|
|
from docutils import nodes
|
|
|
|
from sphinx.util.docutils import (
|
|
SphinxFileOutput,
|
|
SphinxTranslator,
|
|
docutils_namespace,
|
|
new_document,
|
|
register_node,
|
|
)
|
|
|
|
if TYPE_CHECKING:
|
|
from sphinx.builders import Builder
|
|
|
|
|
|
def test_register_node():
|
|
class custom_node(nodes.Element):
|
|
pass
|
|
|
|
with docutils_namespace():
|
|
register_node(custom_node)
|
|
|
|
# check registered
|
|
assert hasattr(nodes.GenericNodeVisitor, 'visit_custom_node')
|
|
assert hasattr(nodes.GenericNodeVisitor, 'depart_custom_node')
|
|
assert hasattr(nodes.SparseNodeVisitor, 'visit_custom_node')
|
|
assert hasattr(nodes.SparseNodeVisitor, 'depart_custom_node')
|
|
|
|
# check unregistered outside namespace
|
|
assert not hasattr(nodes.GenericNodeVisitor, 'visit_custom_node')
|
|
assert not hasattr(nodes.GenericNodeVisitor, 'depart_custom_node')
|
|
assert not hasattr(nodes.SparseNodeVisitor, 'visit_custom_node')
|
|
assert not hasattr(nodes.SparseNodeVisitor, 'depart_custom_node')
|
|
|
|
|
|
def test_SphinxFileOutput(tmp_path):
|
|
content = 'Hello Sphinx World'
|
|
|
|
# write test.txt at first
|
|
filename = tmp_path / 'test.txt'
|
|
output = SphinxFileOutput(destination_path=str(filename))
|
|
output.write(content)
|
|
os.utime(filename, ns=(0, 0))
|
|
|
|
# overwrite it again
|
|
output.write(content)
|
|
assert filename.stat().st_mtime_ns != 0 # updated
|
|
|
|
# write test2.txt at first
|
|
filename = tmp_path / 'test2.txt'
|
|
output = SphinxFileOutput(destination_path=str(filename), overwrite_if_changed=True)
|
|
output.write(content)
|
|
os.utime(filename, ns=(0, 0))
|
|
|
|
# overwrite it again
|
|
output.write(content)
|
|
assert filename.stat().st_mtime_ns == 0 # not updated
|
|
|
|
# overwrite it again (content changed)
|
|
output.write(content + '; content change')
|
|
assert filename.stat().st_mtime_ns != 0 # updated
|
|
|
|
|
|
@pytest.mark.sphinx('html', testroot='root')
|
|
def test_SphinxTranslator(app):
|
|
class CustomNode(nodes.inline):
|
|
pass
|
|
|
|
class MyTranslator(SphinxTranslator):
|
|
def __init__(self, document: nodes.document, builder: Builder):
|
|
self.called: list[str] = []
|
|
super().__init__(document, builder)
|
|
|
|
def visit_document(self, node):
|
|
pass
|
|
|
|
def depart_document(self, node):
|
|
pass
|
|
|
|
def visit_inline(self, node):
|
|
self.called.append('visit_inline')
|
|
|
|
def depart_inline(self, node):
|
|
self.called.append('depart_inline')
|
|
|
|
document = new_document('')
|
|
document += CustomNode()
|
|
|
|
translator = MyTranslator(document, app.builder)
|
|
document.walkabout(translator)
|
|
|
|
# MyTranslator does not have visit_CustomNode. But it calls visit_inline instead.
|
|
assert translator.called == ['visit_inline', 'depart_inline']
|