Issue #7425: Refactor test_pydoc test case for '-k' behavior and add
new test cases for importing bad packages and unreadable packages dirs.
This commit is contained in:
Ned Deily
parent
eeb7eea1f9
commit
92a81a1eec
|
|
@ -7,7 +7,6 @@ import pydoc
|
|||
import keyword
|
||||
import re
|
||||
import string
|
||||
import subprocess
|
||||
import test.support
|
||||
import time
|
||||
import unittest
|
||||
|
|
@ -15,11 +14,9 @@ import xml.etree
|
|||
import textwrap
|
||||
from io import StringIO
|
||||
from collections import namedtuple
|
||||
from contextlib import contextmanager
|
||||
|
||||
from test.script_helper import assert_python_ok
|
||||
from test.support import (
|
||||
TESTFN, forget, rmtree, EnvironmentVarGuard,
|
||||
TESTFN, rmtree,
|
||||
reap_children, reap_threads, captured_output, captured_stdout, unlink
|
||||
)
|
||||
from test import pydoc_mod
|
||||
|
|
@ -209,7 +206,8 @@ def run_pydoc(module_name, *args, **env):
|
|||
output of pydoc.
|
||||
"""
|
||||
args = args + (module_name,)
|
||||
rc, out, err = assert_python_ok(pydoc.__file__, *args, **env)
|
||||
# do not write bytecode files to avoid caching errors
|
||||
rc, out, err = assert_python_ok('-B', pydoc.__file__, *args, **env)
|
||||
return out.strip()
|
||||
|
||||
def get_pydoc_html(module):
|
||||
|
|
@ -291,43 +289,6 @@ class PydocDocTest(unittest.TestCase):
|
|||
self.assertEqual(expected, result,
|
||||
"documentation for missing module found")
|
||||
|
||||
def test_badimport(self):
|
||||
# This tests the fix for issue 5230, where if pydoc found the module
|
||||
# but the module had an internal import error pydoc would report no doc
|
||||
# found.
|
||||
modname = 'testmod_xyzzy'
|
||||
testpairs = (
|
||||
('i_am_not_here', 'i_am_not_here'),
|
||||
('test.i_am_not_here_either', 'i_am_not_here_either'),
|
||||
('test.i_am_not_here.neither_am_i', 'i_am_not_here.neither_am_i'),
|
||||
('i_am_not_here.{}'.format(modname),
|
||||
'i_am_not_here.{}'.format(modname)),
|
||||
('test.{}'.format(modname), modname),
|
||||
)
|
||||
|
||||
@contextmanager
|
||||
def newdirinpath(dir):
|
||||
os.mkdir(dir)
|
||||
sys.path.insert(0, dir)
|
||||
try:
|
||||
yield
|
||||
finally:
|
||||
sys.path.pop(0)
|
||||
rmtree(dir)
|
||||
|
||||
with newdirinpath(TESTFN):
|
||||
fullmodname = os.path.join(TESTFN, modname)
|
||||
sourcefn = fullmodname + os.extsep + "py"
|
||||
for importstring, expectedinmsg in testpairs:
|
||||
with open(sourcefn, 'w') as f:
|
||||
f.write("import {}\n".format(importstring))
|
||||
try:
|
||||
result = run_pydoc(modname, PYTHONPATH=TESTFN).decode("ascii")
|
||||
finally:
|
||||
forget(modname)
|
||||
expected = badimport_pattern % (modname, expectedinmsg)
|
||||
self.assertEqual(expected, result)
|
||||
|
||||
def test_input_strip(self):
|
||||
missing_module = " test.i_am_not_here "
|
||||
result = str(run_pydoc(missing_module), 'ascii')
|
||||
|
|
@ -403,6 +364,55 @@ class PydocDocTest(unittest.TestCase):
|
|||
self.assertEqual(synopsis, 'line 1: h\xe9')
|
||||
|
||||
|
||||
class PydocImportTest(unittest.TestCase):
|
||||
|
||||
def setUp(self):
|
||||
self.test_dir = os.mkdir(TESTFN)
|
||||
self.addCleanup(rmtree, TESTFN)
|
||||
|
||||
def test_badimport(self):
|
||||
# This tests the fix for issue 5230, where if pydoc found the module
|
||||
# but the module had an internal import error pydoc would report no doc
|
||||
# found.
|
||||
modname = 'testmod_xyzzy'
|
||||
testpairs = (
|
||||
('i_am_not_here', 'i_am_not_here'),
|
||||
('test.i_am_not_here_either', 'i_am_not_here_either'),
|
||||
('test.i_am_not_here.neither_am_i', 'i_am_not_here.neither_am_i'),
|
||||
('i_am_not_here.{}'.format(modname),
|
||||
'i_am_not_here.{}'.format(modname)),
|
||||
('test.{}'.format(modname), modname),
|
||||
)
|
||||
|
||||
sourcefn = os.path.join(TESTFN, modname) + os.extsep + "py"
|
||||
for importstring, expectedinmsg in testpairs:
|
||||
with open(sourcefn, 'w') as f:
|
||||
f.write("import {}\n".format(importstring))
|
||||
result = run_pydoc(modname, PYTHONPATH=TESTFN).decode("ascii")
|
||||
expected = badimport_pattern % (modname, expectedinmsg)
|
||||
self.assertEqual(expected, result)
|
||||
|
||||
def test_apropos_with_bad_package(self):
|
||||
# Issue 7425 - pydoc -k failed when bad package on path
|
||||
pkgdir = os.path.join(TESTFN, "syntaxerr")
|
||||
os.mkdir(pkgdir)
|
||||
badsyntax = os.path.join(pkgdir, "__init__") + os.extsep + "py"
|
||||
with open(badsyntax, 'w') as f:
|
||||
f.write("invalid python syntax = $1\n")
|
||||
result = run_pydoc('nothing', '-k', PYTHONPATH=TESTFN)
|
||||
self.assertEqual(b'', result)
|
||||
|
||||
def test_apropos_with_unreadable_dir(self):
|
||||
# Issue 7367 - pydoc -k failed when unreadable dir on path
|
||||
self.unreadable_dir = os.path.join(TESTFN, "unreadable")
|
||||
os.mkdir(self.unreadable_dir, 0)
|
||||
self.addCleanup(os.rmdir, self.unreadable_dir)
|
||||
# Note, on Windows the directory appears to be still
|
||||
# readable so this is not really testing the issue there
|
||||
result = run_pydoc('nothing', '-k', PYTHONPATH=TESTFN)
|
||||
self.assertEqual(b'', result)
|
||||
|
||||
|
||||
class TestDescriptions(unittest.TestCase):
|
||||
|
||||
def test_module(self):
|
||||
|
|
@ -511,6 +521,7 @@ class TestHelper(unittest.TestCase):
|
|||
def test_main():
|
||||
try:
|
||||
test.support.run_unittest(PydocDocTest,
|
||||
PydocImportTest,
|
||||
TestDescriptions,
|
||||
PydocServerTest,
|
||||
PydocUrlHandlerTest,
|
||||
|
|
|
|||
Loading…
Reference in New Issue