IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fix #3329: i18n: crashed by auto-symbol footnote references

Browse Source
This commit is contained in:
Takeshi KOMIYA 2018-07-15 20:48:39 +09:00
parent 62dbe44858
commit aad56c0361
5 changed files with 25 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGES
View File

@ -42,6 +42,7 @@ Bugs fixed
* autosummary: warnings of autosummary indicates wrong location (refs: #5146) * autosummary: warnings of autosummary indicates wrong location (refs: #5146)
* #5143: autodoc: crashed on inspecting dict like object which does not support * #5143: autodoc: crashed on inspecting dict like object which does not support
sorting sorting
* #3329: i18n: crashed by auto-symbol footnote references
Testing Testing
-------- --------

19
sphinx/transforms/i18n.py
View File

@ -275,10 +275,9 @@ class Locale(SphinxTransform):
continue # skip continue # skip
# auto-numbered foot note reference should use original 'ids'. # auto-numbered foot note reference should use original 'ids'.
def is_autonumber_footnote_ref(node): def is_autofootnote_ref(node):
# type: (nodes.Node) -> bool # type: (nodes.Node) -> bool
return isinstance(node, nodes.footnote_reference) and \ return isinstance(node, nodes.footnote_reference) and node.get('auto')
node.get('auto') == 1
def list_replace_or_append(lst, old, new): def list_replace_or_append(lst, old, new):
# type: (List, Any, Any) -> None # type: (List, Any, Any) -> None
@ -286,8 +285,8 @@ class Locale(SphinxTransform):
lst[lst.index(old)] = new lst[lst.index(old)] = new
else: else:
lst.append(new) lst.append(new)
old_foot_refs = node.traverse(is_autonumber_footnote_ref) old_foot_refs = node.traverse(is_autofootnote_ref)
new_foot_refs = patch.traverse(is_autonumber_footnote_ref) new_foot_refs = patch.traverse(is_autofootnote_ref)
if len(old_foot_refs) != len(new_foot_refs): if len(old_foot_refs) != len(new_foot_refs):
old_foot_ref_rawsources = [ref.rawsource for ref in old_foot_refs] old_foot_ref_rawsources = [ref.rawsource for ref in old_foot_refs]
new_foot_ref_rawsources = [ref.rawsource for ref in new_foot_refs] new_foot_ref_rawsources = [ref.rawsource for ref in new_foot_refs]
@ -308,8 +307,14 @@ class Locale(SphinxTransform):
new['ids'] = old['ids'] new['ids'] = old['ids']
for id in new['ids']: for id in new['ids']:
self.document.ids[id] = new self.document.ids[id] = new
list_replace_or_append(
self.document.autofootnote_refs, old, new) if new['auto'] == 1:
# autofootnote_refs
list_replace_or_append(self.document.autofootnote_refs, old, new)
else:
# symbol_footnote_refs
list_replace_or_append(self.document.symbol_footnote_refs, old, new)
if refname: if refname:
list_replace_or_append( list_replace_or_append(
self.document.footnote_refs.setdefault(refname, []), self.document.footnote_refs.setdefault(refname, []),

6
tests/roots/test-intl/footnote.po
View File

@ -19,8 +19,8 @@ msgstr ""
msgid "i18n with Footnote" msgid "i18n with Footnote"
msgstr "I18N WITH FOOTNOTE" msgstr "I18N WITH FOOTNOTE"
msgid "[100]_ Contents [#]_ for `i18n with Footnote`_ [ref]_ [#named]_." msgid "[100]_ Contents [#]_ for `i18n with Footnote`_ [ref]_ [#named]_ [*]_."
msgstr "`I18N WITH FOOTNOTE`_ INCLUDE THIS CONTENTS [#named]_ [ref]_ [#]_ [100]_." msgstr "`I18N WITH FOOTNOTE`_ INCLUDE THIS CONTENTS [#named]_ [ref]_ [#]_ [100]_ [*]_."
msgid "This is a auto numbered footnote." msgid "This is a auto numbered footnote."
msgstr "THIS IS A AUTO NUMBERED FOOTNOTE." msgstr "THIS IS A AUTO NUMBERED FOOTNOTE."
@ -34,3 +34,5 @@ msgstr "THIS IS A NUMBERED FOOTNOTE."
msgid "This is a auto numbered named footnote." msgid "This is a auto numbered named footnote."
msgstr "THIS IS A AUTO NUMBERED NAMED FOOTNOTE." msgstr "THIS IS A AUTO NUMBERED NAMED FOOTNOTE."
msgid "This is a auto symbol footnote."
msgstr "THIS IS A AUTO SYMBOL FOOTNOTE."

3
tests/roots/test-intl/footnote.txt
View File

@ -4,9 +4,10 @@ i18n with Footnote
================== ==================
.. #955 cant-build-html-with-footnotes-when-using .. #955 cant-build-html-with-footnotes-when-using
[100]_ Contents [#]_ for `i18n with Footnote`_ [ref]_ [#named]_. [100]_ Contents [#]_ for `i18n with Footnote`_ [ref]_ [#named]_ [*]_.
.. [#] This is a auto numbered footnote. .. [#] This is a auto numbered footnote.
.. [ref] This is a named footnote. .. [ref] This is a named footnote.
.. [100] This is a numbered footnote. .. [100] This is a numbered footnote.
.. [#named] This is a auto numbered named footnote. .. [#named] This is a auto numbered named footnote.
.. [*] This is a auto symbol footnote.

7
tests/test_intl.py
View File

@ -791,7 +791,7 @@ def test_xml_footnotes(app, warning):
assert_elem( assert_elem(
para0[0], para0[0],
['I18N WITH FOOTNOTE', 'INCLUDE THIS CONTENTS', ['I18N WITH FOOTNOTE', 'INCLUDE THIS CONTENTS',
'2', '[ref]', '1', '100', '.'], '2', '[ref]', '1', '100', '*', '.'],
['i18n-with-footnote', 'ref']) ['i18n-with-footnote', 'ref'])
footnote0 = secs[0].findall('footnote') footnote0 = secs[0].findall('footnote')
@ -810,6 +810,11 @@ def test_xml_footnotes(app, warning):
['2', 'THIS IS A AUTO NUMBERED NAMED FOOTNOTE.'], ['2', 'THIS IS A AUTO NUMBERED NAMED FOOTNOTE.'],
None, None,
['named']) ['named'])
assert_elem(
footnote0[3],
['*', 'THIS IS A AUTO SYMBOL FOOTNOTE.'],
None,
None)
citation0 = secs[0].findall('citation') citation0 = secs[0].findall('citation')
assert_elem( assert_elem(