encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-22 09:36:49 +03:00
Code Issues Packages Projects Releases Wiki Activity

Bumped Markdown version to 3.3 (#7590)

Browse Source
This commit is contained in:
David Smith 2020-10-13 17:27:08 +01:00 committed by GitHub
parent 95f0b0867a
commit 04e0c2b9ab
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 182 additions and 193 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
requirements/requirements-optionals.txt
View File

@ -1,6 +1,7 @@
# Optional packages which may be used with REST framework. # Optional packages which may be used with REST framework.
psycopg2-binary>=2.8.5, <2.9 psycopg2-binary>=2.8.5, <2.9
markdown==3.1.1 markdown==3.3;python_version>="3.6"
markdown==3.2.2;python_version=="3.5"
pygments==2.4.2 pygments==2.4.2
django-guardian==2.2.0 django-guardian==2.2.0
django-filter>=2.2.0, <2.3 django-filter>=2.2.0, <2.3

74
tests/test_description.py
View File

@ -1,3 +1,6 @@
import sys
import pytest
from django.test import TestCase from django.test import TestCase
from rest_framework.compat import apply_markdown from rest_framework.compat import apply_markdown
@ -30,36 +33,7 @@ indented
# If markdown is installed we also test it's working # If markdown is installed we also test it's working
# (and that our wrapped forces '=' to h2 and '-' to h3) # (and that our wrapped forces '=' to h2 and '-' to h3)
MARKED_DOWN_HILITE = """ MARKDOWN_BASE = """<h2 id="an-example-docstring">an example docstring</h2>
<div class="highlight"><pre><span></span><span \
class="p">[{</span><br /> <span class="nt">&quot;alpha&quot;</span><span\
class="p">:</span> <span class="mi">1</span><span class="p">,</span><br />\
<span class="nt">&quot;beta: &quot;</span><span class="err">this</span>\
<span class="err">is</span> <span class="err">a</span> <span class="err">\
string&quot;</span><br /><span class="p">}]</span><br /></pre></div>
<p><br /></p>"""
MARKED_DOWN_NOT_HILITE = """
<p><code>json
[{
"alpha": 1,
"beta: "this is a string"
}]</code></p>"""
# We support markdown < 2.1 and markdown >= 2.1
MARKED_DOWN_lt_21 = """<h2>an example docstring</h2>
<ul>
<li>list</li>
<li>list</li>
</ul>
<h3>another header</h3>
<pre><code>code block
</code></pre>
<p>indented</p>
<h2 id="hash_style_header">hash style header</h2>%s"""
MARKED_DOWN_gte_21 = """<h2 id="an-example-docstring">an example docstring</h2>
<ul> <ul>
<li>list</li> <li>list</li>
<li>list</li> <li>list</li>
@ -70,6 +44,27 @@ MARKED_DOWN_gte_21 = """<h2 id="an-example-docstring">an example docstring</h2>
<p>indented</p> <p>indented</p>
<h2 id="hash-style-header">hash style header</h2>%s""" <h2 id="hash-style-header">hash style header</h2>%s"""
MARKDOWN_gte_33 = """
<div class="highlight"><pre><span></span><span class="p">[{</span><br />\
<span class="nt">&quot;alpha&quot;</span><span class="p">:</span>\
<span class="mi">1</span><span class="p">,</span><br />\
<span class="nt">&quot;beta: &quot;</span><span class="err">this\
</span> <span class="err">is</span> <span class="err">a</span> \
<span class="err">string&quot;</span><br /><span class="p">}]</span>\
<br /></pre></div>
<p><br /></p>"""
MARKDOWN_lt_33 = """
<div class="highlight"><pre><span></span><span class="p">[{</span><br />\
<span class="nt">&quot;alpha&quot;</span><span class="p">:</span>\
<span class="mi">1</span><span class="p">,</span><br />\
<span class="nt">&quot;beta: &quot;</span><span class="err">this\
</span> <span class="err">is</span> <span class="err">a</span>\
<span class="err">string&quot;</span><br /><span class="p">}]</span>\
<br /></pre></div>
<p><br /></p>"""
class TestViewNamesAndDescriptions(TestCase): class TestViewNamesAndDescriptions(TestCase):
def test_view_name_uses_class_name(self): def test_view_name_uses_class_name(self):
@ -165,23 +160,16 @@ class TestViewNamesAndDescriptions(TestCase):
assert MockView().get_view_description() == 'a gettext string' assert MockView().get_view_description() == 'a gettext string'
@pytest.mark.skipif(not apply_markdown, reason="Markdown is not installed")
def test_markdown(self): def test_markdown(self):
""" """
Ensure markdown to HTML works as expected. Ensure markdown to HTML works as expected.
""" """
if apply_markdown: # Markdown 3.3 is only supported on Python 3.6 and higher
md_applied = apply_markdown(DESCRIPTION) if sys.version_info >= (3, 6):
gte_21_match = ( assert apply_markdown(DESCRIPTION) == MARKDOWN_BASE % MARKDOWN_gte_33
md_applied == ( else:
MARKED_DOWN_gte_21 % MARKED_DOWN_HILITE) or assert apply_markdown(DESCRIPTION) == MARKDOWN_BASE % MARKDOWN_lt_33
md_applied == (
MARKED_DOWN_gte_21 % MARKED_DOWN_NOT_HILITE))
lt_21_match = (
md_applied == (
MARKED_DOWN_lt_21 % MARKED_DOWN_HILITE) or
md_applied == (
MARKED_DOWN_lt_21 % MARKED_DOWN_NOT_HILITE))
assert gte_21_match or lt_21_match
def test_dedent_tabs(): def test_dedent_tabs():