mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
bade33c7e4
In Python 3, the default encoding of source files is utf-8. The encoding cookie is now unnecessary and redundant so remove it. For more details, see the docs: https://docs.python.org/3/howto/unicode.html#the-string-type > The default encoding for Python source code is UTF-8, so you can > simply include a Unicode character in a string literal ... Includes a fix for the flake8 header checks to stop expecting an encoding cookie.
81 lines
2.6 KiB
Python
81 lines
2.6 KiB
Python
"""
|
|
test_roles
|
|
~~~~~~~~~~
|
|
|
|
Test sphinx.roles
|
|
|
|
:copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
"""
|
|
|
|
from docutils import nodes
|
|
from mock import Mock
|
|
|
|
from sphinx.roles import emph_literal_role
|
|
from sphinx.testing.util import assert_node
|
|
|
|
|
|
def test_samp():
|
|
# normal case
|
|
text = 'print 1+{variable}'
|
|
ret, msg = emph_literal_role('samp', text, text, 0, Mock())
|
|
assert_node(ret[0], [nodes.literal, ("print 1+",
|
|
[nodes.emphasis, "variable"])])
|
|
assert msg == []
|
|
|
|
# two emphasis items
|
|
text = 'print {1}+{variable}'
|
|
ret, msg = emph_literal_role('samp', text, text, 0, Mock())
|
|
assert_node(ret[0], [nodes.literal, ("print ",
|
|
[nodes.emphasis, "1"],
|
|
"+",
|
|
[nodes.emphasis, "variable"])])
|
|
assert msg == []
|
|
|
|
# empty curly brace
|
|
text = 'print 1+{}'
|
|
ret, msg = emph_literal_role('samp', text, text, 0, Mock())
|
|
assert_node(ret[0], [nodes.literal, "print 1+{}"])
|
|
assert msg == []
|
|
|
|
# half-opened variable
|
|
text = 'print 1+{variable'
|
|
ret, msg = emph_literal_role('samp', text, text, 0, Mock())
|
|
assert_node(ret[0], [nodes.literal, "print 1+{variable"])
|
|
assert msg == []
|
|
|
|
# nested
|
|
text = 'print 1+{{variable}}'
|
|
ret, msg = emph_literal_role('samp', text, text, 0, Mock())
|
|
assert_node(ret[0], [nodes.literal, ("print 1+",
|
|
[nodes.emphasis, "{variable"],
|
|
"}")])
|
|
assert msg == []
|
|
|
|
# emphasized item only
|
|
text = '{variable}'
|
|
ret, msg = emph_literal_role('samp', text, text, 0, Mock())
|
|
assert_node(ret[0], [nodes.literal, nodes.emphasis, "variable"])
|
|
assert msg == []
|
|
|
|
# escaping
|
|
text = r'print 1+\{variable}'
|
|
ret, msg = emph_literal_role('samp', text, text, 0, Mock())
|
|
assert_node(ret[0], [nodes.literal, "print 1+{variable}"])
|
|
assert msg == []
|
|
|
|
# escaping (2)
|
|
text = r'print 1+\{{variable}\}'
|
|
ret, msg = emph_literal_role('samp', text, text, 0, Mock())
|
|
assert_node(ret[0], [nodes.literal, ("print 1+{",
|
|
[nodes.emphasis, "variable"],
|
|
"}")])
|
|
assert msg == []
|
|
|
|
# escape a backslash
|
|
text = r'print 1+\\{variable}'
|
|
ret, msg = emph_literal_role('samp', text, text, 0, Mock())
|
|
assert_node(ret[0], [nodes.literal, ("print 1+\\",
|
|
[nodes.emphasis, "variable"])])
|
|
assert msg == []
|