Sphinx文档处理器扩展对HTML和LaTeX输出的工作方式不同？

Question

我有一个简单的狮身人面像扩展，如下所示：

from docutils import nodes
from docutils.parsers.rst import directives
from sphinx.util.compat import Directive

class testnode(nodes.Element):
    def __init__(self, *args, **kwargs):
        super(testnode, self).__init__(*args, **kwargs)
        self['foo'] = '?'

def visit_testnode_latex(self, node):
    self.body.append('Test: %s' % node['foo'])

def depart_testnode_latex(self, node):
    pass

def visit_testnode_html(self, node):
    self.body.append('<p>Test: %s</p>' % node['foo'])

def depart_testnode_html(self, node):
    pass

class TestDirective(Directive):
    has_content = False
    required_arguments = 0
    optional_arguments = 0
    final_argument_whitespace = False
    option_spec = {
        'foo': directives.unchanged,
    }

    def run(self):
        node = testnode()
        node['foo'] = self.options.get('foo')
        return [node]

def setup(app):
    app.add_directive("testdirective", TestDirective)
    app.add_node(testnode,
                 html=(visit_testnode_html,
                       depart_testnode_html),
                 latex=(visit_testnode_latex,
                        depart_testnode_latex))

给一个包含

^{pr2}$

HTML输出包含»Test:bar«，但LaTeX输出包含»Test:？«（默认值）。我检查了node['foo']在TestDirective.run()中的赋值后是否具有正确的值，但在LaTeX编写器运行之前，该值似乎不会一直存在。在

我做错什么了？在

Answer 1

在仔细阅读了斯芬克斯的乳胶书写器之后，我在这里发现了问题。这是您在testnode初始值设定项中为'foo'关键字设置默认值的方式。在

LaTexWriter的一点是，它会对整个文档树进行深度复制，以便将其内联到另一个树中。Element节点上的deepcopy初始化同一类的新节点，并通过构造函数传递原始节点的所有属性和内容。因此，当您的testnode被复制时，您的构造函数将覆盖传递给构造函数的原始“foo”属性。相反，应该这样写，它应该可以工作：

class testnode(nodes.Element):
    def __init__(self, *args, **kwargs):
        super(testnode, self).__init__(*args, **kwargs)
        if 'foo' not in self:
            self['foo'] = '?'

这将防止您的预设值覆写传递给建构函式的属性的任何显式值。还有其他几种可能的变化。在