bpo-31292: Fixed distutils check --restructuredtext for include directives (GH-10605)

This commit is contained in:
Philipp A 2019-03-27 22:34:19 +01:00 committed by Cheryl Sabella
parent a694f23948
commit d5a5a33f12
4 changed files with 20 additions and 2 deletions

View File

@ -120,7 +120,8 @@ class check(Command):
def _check_rst_data(self, data):
"""Returns warnings when the provided data doesn't compile."""
source_path = StringIO()
# the include and csv_table directives need this to be a path
source_path = self.distribution.script_name or 'setup.py'
parser = Parser()
settings = frontend.OptionParser(components=(Parser,)).get_default_values()
settings.tab_width = 4

View File

@ -0,0 +1 @@
This should be included.

View File

@ -1,4 +1,5 @@
"""Tests for distutils.command.check."""
import os
import textwrap
import unittest
from test.support import run_unittest
@ -13,13 +14,19 @@ except ImportError:
pygments = None
HERE = os.path.dirname(__file__)
class CheckTestCase(support.LoggingSilencer,
support.TempdirManager,
unittest.TestCase):
def _run(self, metadata=None, **options):
def _run(self, metadata=None, cwd=None, **options):
if metadata is None:
metadata = {}
if cwd is not None:
old_dir = os.getcwd()
os.chdir(cwd)
pkg_info, dist = self.create_dist(**metadata)
cmd = check(dist)
cmd.initialize_options()
@ -27,6 +34,8 @@ class CheckTestCase(support.LoggingSilencer,
setattr(cmd, name, value)
cmd.ensure_finalized()
cmd.run()
if cwd is not None:
os.chdir(old_dir)
return cmd
def test_check_metadata(self):
@ -99,6 +108,11 @@ class CheckTestCase(support.LoggingSilencer,
cmd = self._run(metadata, strict=1, restructuredtext=1)
self.assertEqual(cmd._warnings, 0)
# check that includes work to test #31292
metadata['long_description'] = 'title\n=====\n\n.. include:: includetest.rst'
cmd = self._run(metadata, cwd=HERE, strict=1, restructuredtext=1)
self.assertEqual(cmd._warnings, 0)
@unittest.skipUnless(HAS_DOCUTILS, "won't test without docutils")
def test_check_restructuredtext_with_syntax_highlight(self):
# Don't fail if there is a `code` or `code-block` directive

View File

@ -0,0 +1,2 @@
Fix ``setup.py check --restructuredtext`` for
files containing ``include`` directives.