summaryrefslogtreecommitdiff
path: root/tests/admin_docs/test_utils.py
diff options
context:
space:
mode:
authordjango-bot <ops@djangoproject.com>2022-02-03 20:24:19 +0100
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2022-02-07 20:37:05 +0100
commit9c19aff7c7561e3a82978a272ecdaad40dda5c00 (patch)
treef0506b668a013d0063e5fba3dbf4863b466713ba /tests/admin_docs/test_utils.py
parentf68fa8b45dfac545cfc4111d4e52804c86db68d3 (diff)
Refs #33476 -- Reformatted code with Black.
Diffstat (limited to 'tests/admin_docs/test_utils.py')
-rw-r--r--tests/admin_docs/test_utils.py70
1 files changed, 38 insertions, 32 deletions
diff --git a/tests/admin_docs/test_utils.py b/tests/admin_docs/test_utils.py
index 9ffc25392c..18c6769fad 100644
--- a/tests/admin_docs/test_utils.py
+++ b/tests/admin_docs/test_utils.py
@@ -1,7 +1,9 @@
import unittest
from django.contrib.admindocs.utils import (
- docutils_is_available, parse_docstring, parse_rst,
+ docutils_is_available,
+ parse_docstring,
+ parse_rst,
)
from django.test.utils import captured_stderr
@@ -29,41 +31,42 @@ class TestUtils(AdminDocsSimpleTestCase):
some_metadata: some data
"""
+
def setUp(self):
self.docstring = self.__doc__
def test_parse_docstring(self):
title, description, metadata = parse_docstring(self.docstring)
docstring_title = (
- 'This __doc__ output is required for testing. I copied this example from\n'
- '`admindocs` documentation. (TITLE)'
+ "This __doc__ output is required for testing. I copied this example from\n"
+ "`admindocs` documentation. (TITLE)"
)
docstring_description = (
- 'Display an individual :model:`myapp.MyModel`.\n\n'
- '**Context**\n\n``RequestContext``\n\n``mymodel``\n'
- ' An instance of :model:`myapp.MyModel`.\n\n'
- '**Template:**\n\n:template:`myapp/my_template.html` '
- '(DESCRIPTION)'
+ "Display an individual :model:`myapp.MyModel`.\n\n"
+ "**Context**\n\n``RequestContext``\n\n``mymodel``\n"
+ " An instance of :model:`myapp.MyModel`.\n\n"
+ "**Template:**\n\n:template:`myapp/my_template.html` "
+ "(DESCRIPTION)"
)
self.assertEqual(title, docstring_title)
self.assertEqual(description, docstring_description)
- self.assertEqual(metadata, {'some_metadata': 'some data'})
+ self.assertEqual(metadata, {"some_metadata": "some data"})
def test_title_output(self):
title, description, metadata = parse_docstring(self.docstring)
- title_output = parse_rst(title, 'model', 'model:admindocs')
- self.assertIn('TITLE', title_output)
+ title_output = parse_rst(title, "model", "model:admindocs")
+ self.assertIn("TITLE", title_output)
title_rendered = (
- '<p>This __doc__ output is required for testing. I copied this '
+ "<p>This __doc__ output is required for testing. I copied this "
'example from\n<a class="reference external" '
'href="/admindocs/models/admindocs/">admindocs</a> documentation. '
- '(TITLE)</p>\n'
+ "(TITLE)</p>\n"
)
self.assertHTMLEqual(title_output, title_rendered)
def test_description_output(self):
title, description, metadata = parse_docstring(self.docstring)
- description_output = parse_rst(description, 'model', 'model:admindocs')
+ description_output = parse_rst(description, "model", "model:admindocs")
description_rendered = (
'<p>Display an individual <a class="reference external" '
'href="/admindocs/models/myapp.mymodel/">myapp.MyModel</a>.</p>\n'
@@ -71,35 +74,35 @@ class TestUtils(AdminDocsSimpleTestCase):
'RequestContext</tt></p>\n<dl class="docutils">\n<dt><tt class="'
'docutils literal">mymodel</tt></dt>\n<dd>An instance of <a class="'
'reference external" href="/admindocs/models/myapp.mymodel/">'
- 'myapp.MyModel</a>.</dd>\n</dl>\n<p><strong>Template:</strong></p>'
+ "myapp.MyModel</a>.</dd>\n</dl>\n<p><strong>Template:</strong></p>"
'\n<p><a class="reference external" href="/admindocs/templates/'
'myapp/my_template.html/">myapp/my_template.html</a> (DESCRIPTION)'
- '</p>\n'
+ "</p>\n"
)
self.assertHTMLEqual(description_output, description_rendered)
def test_initial_header_level(self):
- header = 'should be h3...\n\nHeader\n------\n'
- output = parse_rst(header, 'header')
- self.assertIn('<h3>Header</h3>', output)
+ header = "should be h3...\n\nHeader\n------\n"
+ output = parse_rst(header, "header")
+ self.assertIn("<h3>Header</h3>", output)
def test_parse_rst(self):
"""
parse_rst() should use `cmsreference` as the default role.
"""
markup = '<p><a class="reference external" href="/admindocs/%s">title</a></p>\n'
- self.assertEqual(parse_rst('`title`', 'model'), markup % 'models/title/')
- self.assertEqual(parse_rst('`title`', 'view'), markup % 'views/title/')
- self.assertEqual(parse_rst('`title`', 'template'), markup % 'templates/title/')
- self.assertEqual(parse_rst('`title`', 'filter'), markup % 'filters/#title')
- self.assertEqual(parse_rst('`title`', 'tag'), markup % 'tags/#title')
+ self.assertEqual(parse_rst("`title`", "model"), markup % "models/title/")
+ self.assertEqual(parse_rst("`title`", "view"), markup % "views/title/")
+ self.assertEqual(parse_rst("`title`", "template"), markup % "templates/title/")
+ self.assertEqual(parse_rst("`title`", "filter"), markup % "filters/#title")
+ self.assertEqual(parse_rst("`title`", "tag"), markup % "tags/#title")
def test_parse_rst_with_docstring_no_leading_line_feed(self):
- title, body, _ = parse_docstring('firstline\n\n second line')
+ title, body, _ = parse_docstring("firstline\n\n second line")
with captured_stderr() as stderr:
- self.assertEqual(parse_rst(title, ''), '<p>firstline</p>\n')
- self.assertEqual(parse_rst(body, ''), '<p>second line</p>\n')
- self.assertEqual(stderr.getvalue(), '')
+ self.assertEqual(parse_rst(title, ""), "<p>firstline</p>\n")
+ self.assertEqual(parse_rst(body, ""), "<p>second line</p>\n")
+ self.assertEqual(stderr.getvalue(), "")
def test_publish_parts(self):
"""
@@ -108,8 +111,11 @@ class TestUtils(AdminDocsSimpleTestCase):
``cmsreference`` (#6681).
"""
import docutils
- self.assertNotEqual(docutils.parsers.rst.roles.DEFAULT_INTERPRETED_ROLE, 'cmsreference')
- source = 'reST, `interpreted text`, default role.'
- markup = '<p>reST, <cite>interpreted text</cite>, default role.</p>\n'
+
+ self.assertNotEqual(
+ docutils.parsers.rst.roles.DEFAULT_INTERPRETED_ROLE, "cmsreference"
+ )
+ source = "reST, `interpreted text`, default role."
+ markup = "<p>reST, <cite>interpreted text</cite>, default role.</p>\n"
parts = docutils.core.publish_parts(source=source, writer_name="html4css1")
- self.assertEqual(parts['fragment'], markup)
+ self.assertEqual(parts["fragment"], markup)