"""
Python Markdown
A Python implementation of John Gruber's Markdown.
Documentation: https://python-markdown.github.io/
GitHub: https://github.com/Python-Markdown/markdown/
PyPI: https://pypi.org/project/Markdown/
Started by Manfred Stienstra (http://www.dwerg.net/).
Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
Currently maintained by Waylan Limberg (https://github.com/waylan),
Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
Copyright 2007-2023 The Python Markdown Project (v. 1.7 and later)
Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
Copyright 2004 Manfred Stienstra (the original version)
License: BSD (see LICENSE.md for details).
"""
from markdown.test_tools import TestCase
class TestFootnotes(TestCase):
default_kwargs = {'extensions': ['footnotes']}
maxDiff = None
def test_basic_footnote(self):
self.assertMarkdownRenders(
self.dedent(
"""
paragraph[^1]
[^1]: A Footnote
"""
),
'paragraph
\n'
''
)
def test_multiple_footnotes(self):
self.assertMarkdownRenders(
self.dedent(
"""
foo[^1]
bar[^2]
[^1]: Footnote 1
[^2]: Footnote 2
"""
),
'foo
\n'
'bar
\n'
''
)
def test_multiple_footnotes_multiline(self):
self.assertMarkdownRenders(
self.dedent(
"""
foo[^1]
bar[^2]
[^1]: Footnote 1
line 2
[^2]: Footnote 2
"""
),
'foo
\n'
'bar
\n'
''
)
def test_footnote_multi_line(self):
self.assertMarkdownRenders(
self.dedent(
"""
paragraph[^1]
[^1]: A Footnote
line 2
"""
),
'paragraph
\n'
''
)
def test_footnote_multi_line_lazy_indent(self):
self.assertMarkdownRenders(
self.dedent(
"""
paragraph[^1]
[^1]: A Footnote
line 2
"""
),
'paragraph
\n'
''
)
def test_footnote_multi_line_complex(self):
self.assertMarkdownRenders(
self.dedent(
"""
paragraph[^1]
[^1]:
A Footnote
line 2
* list item
> blockquote
"""
),
'paragraph
\n'
''
)
def test_footnote_multple_complex(self):
self.assertMarkdownRenders(
self.dedent(
"""
foo[^1]
bar[^2]
[^1]:
A Footnote
line 2
* list item
> blockquote
[^2]: Second footnote
paragraph 2
"""
),
'foo
\n'
'bar
\n'
''
)
def test_footnote_multple_complex_no_blank_line_between(self):
self.assertMarkdownRenders(
self.dedent(
"""
foo[^1]
bar[^2]
[^1]:
A Footnote
line 2
* list item
> blockquote
[^2]: Second footnote
paragraph 2
"""
),
'foo
\n'
'bar
\n'
''
)
def test_backlink_text(self):
"""Test back-link configuration."""
self.assertMarkdownRenders(
'paragraph[^1]\n\n[^1]: A Footnote',
'paragraph
\n'
'',
extension_configs={'footnotes': {'BACKLINK_TEXT': 'back'}}
)
def test_footnote_separator(self):
"""Test separator configuration."""
self.assertMarkdownRenders(
'paragraph[^1]\n\n[^1]: A Footnote',
'paragraph
\n'
'',
extension_configs={'footnotes': {'SEPARATOR': '-'}}
)
def test_backlink_title(self):
"""Test back-link title configuration without placeholder."""
self.assertMarkdownRenders(
'paragraph[^1]\n\n[^1]: A Footnote',
'paragraph
\n'
'',
extension_configs={'footnotes': {'BACKLINK_TITLE': 'Jump back to footnote'}}
)
def test_superscript_text(self):
"""Test superscript text configuration."""
self.assertMarkdownRenders(
'paragraph[^1]\n\n[^1]: A Footnote',
'paragraph
\n'
'',
extension_configs={'footnotes': {'SUPERSCRIPT_TEXT': '[{}]'}}
)
def test_footnote_order(self):
"""Test that footnotes occur in order of reference appearance."""
self.assertMarkdownRenders(
self.dedent(
"""
First footnote reference[^first]. Second footnote reference[^last].
[^last]: Second footnote.
[^first]: First footnote.
"""
),
'First footnote reference. Second footnote reference'
'.
\n'
''
)
def test_footnote_order_tricky(self):
"""Test a tricky sequence of footnote references."""
self.assertMarkdownRenders(
self.dedent(
"""
`Footnote reference in code spans should be ignored[^tricky]`.
A footnote reference[^ordinary].
Another footnote reference[^tricky].
[^ordinary]: This should be the first footnote.
[^tricky]: This should be the second footnote.
"""
),
'Footnote reference in code spans should be ignored[^tricky].\n'
'A footnote reference'
'.\n'
'Another footnote reference'
'.
\n'
''
)
def test_footnote_order_by_definition(self):
"""Test that footnotes occur in order of definition occurrence when so configured."""
self.assertMarkdownRenders(
self.dedent(
"""
First footnote reference[^last_def]. Second footnote reference[^first_def].
[^first_def]: First footnote.
[^last_def]: Second footnote.
"""
),
'First footnote reference. Second footnote reference'
'.
\n'
'',
extension_configs={'footnotes': {'USE_DEFINITION_ORDER': True}}
)
def test_footnote_reference_within_code_span(self):
"""Test footnote reference within a code span."""
self.assertMarkdownRenders(
'A `code span with a footnote[^1] reference`.',
'A code span with a footnote[^1] reference.
'
)
def test_footnote_reference_within_link(self):
"""Test footnote reference within a link."""
self.assertMarkdownRenders(
'A [link with a footnote[^1] reference](http://example.com).',
'A link with a footnote[^1] reference.
'
)
def test_footnote_reference_within_footnote_definition(self):
"""Test footnote definition containing another footnote reference."""
self.assertMarkdownRenders(
self.dedent(
"""
Main footnote[^main].
[^main]: This footnote references another[^nested].
[^nested]: Nested footnote.
"""
),
'Main footnote.
\n'
''
)
def test_footnote_reference_within_blockquote(self):
"""Test footnote reference within a blockquote."""
self.assertMarkdownRenders(
self.dedent(
"""
> This is a quote with a footnote[^quote].
[^quote]: Quote footnote.
"""
),
'\n'
'This is a quote with a footnote'
'.
\n'
'
\n'
''
)
def test_footnote_reference_within_list(self):
"""Test footnote reference within a list item."""
self.assertMarkdownRenders(
self.dedent(
"""
1. First item with footnote[^note]
1. Second item
[^note]: List footnote.
"""
),
'\n'
'- First item with footnote'
'
\n'
'- Second item
\n'
'
\n'
''
)
def test_footnote_references_within_loose_list(self):
"""Test footnote references within loose list items."""
self.assertMarkdownRenders(
self.dedent(
'''
* Reference to [^first]
* Reference to [^second]
[^first]: First footnote definition
[^second]: Second footnote definition
'''
),
'\n'
'- \n'
'
Reference to
\n'
' \n'
'- \n'
'
Reference to
\n'
' \n'
'
\n'
''
)
def test_footnote_reference_within_html(self):
"""Test footnote reference within HTML tags."""
self.assertMarkdownRenders(
self.dedent(
"""
A footnote reference[^1] within a span element.
[^1]: The footnote.
"""
),
'A footnote reference'
''
' within a span element.
\n'
''
)
def test_duplicate_footnote_references(self):
"""Test multiple references to the same footnote."""
self.assertMarkdownRenders(
self.dedent(
"""
First[^dup] and second[^dup] reference.
[^dup]: Duplicate footnote.
"""
),
'First'
' and second'
' reference.
\n'
''
)
def test_footnote_reference_without_definition(self):
"""Test footnote reference without corresponding definition."""
self.assertMarkdownRenders(
'This has a missing footnote[^missing].',
'This has a missing footnote[^missing].
'
)
def test_footnote_definition_without_reference(self):
"""Test footnote definition without corresponding reference."""
self.assertMarkdownRenders(
self.dedent(
"""
No reference here.
[^orphan]: Orphaned footnote.
"""
),
'No reference here.
\n'
''
)
def test_footnote_id_with_special_chars(self):
"""Test footnote id containing special and Unicode characters."""
self.assertMarkdownRenders(
self.dedent(
"""
Special footnote id[^!#¤%/()=?+}{§øé].
[^!#¤%/()=?+}{§øé]: The footnote.
"""
),
'Special footnote id'
'.
\n'
''
)