Skip to content

bpo-40275: Use new test.support helper submodules in tests #21151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vstinner merged 3 commits into from
Jun 25, 2020
Merged

bpo-40275: Use new test.support helper submodules in tests #21151

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1b82ce4
Use new test.support helper submodules in tests
shihai1991 Jun 25, 2020
7397204
remove spaces
shihai1991 Jun 25, 2020
9883bd2
update code by victor's comment
shihai1991 Jun 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion Lib/distutils/tests/test_archive_util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@
ARCHIVE_FORMATS)
from distutils.spawn import find_executable, spawn
from distutils.tests import support
from test.support import check_warnings, run_unittest, patch, change_cwd
from test.support import run_unittest, patch
from test.support.os_helper import change_cwd
from test.support.warnings_helper import check_warnings

try:
import grp
Expand Down
3 changes: 2 additions & 1 deletion Lib/distutils/tests/test_bdist_msi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
"""Tests for distutils.command.bdist_msi."""
import sys
import unittest
from test.support import run_unittest, check_warnings
from test.support import run_unittest
from test.support.warnings_helper import check_warnings
from distutils.tests import support


Expand Down
3 changes: 2 additions & 1 deletion Lib/distutils/tests/test_bdist_wininst.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
import sys
import platform
import unittest
from test.support import run_unittest, check_warnings
from test.support import run_unittest
from test.support.warnings_helper import check_warnings

from distutils.command.bdist_wininst import bdist_wininst
from distutils.tests import support
Expand Down
10 changes: 5 additions & 5 deletions Lib/distutils/tests/test_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
import os
import shutil
import sys
import test.support
from test.support import captured_stdout, run_unittest
from test.support import os_helper
import unittest
from distutils.tests import support
from distutils import log
Expand Down Expand Up @@ -62,13 +62,13 @@ def tearDown(self):
super(CoreTestCase, self).tearDown()

def cleanup_testfn(self):
path = test.support.TESTFN
path = os_helper.TESTFN
if os.path.isfile(path):
os.remove(path)
elif os.path.isdir(path):
shutil.rmtree(path)

def write_setup(self, text, path=test.support.TESTFN):
def write_setup(self, text, path=os_helper.TESTFN):
f = open(path, "w")
try:
f.write(text)
Expand Down Expand Up @@ -105,8 +105,8 @@ def test_run_setup_uses_current_dir(self):
cwd = os.getcwd()

# Create a directory and write the setup.py file there:
os.mkdir(test.support.TESTFN)
setup_py = os.path.join(test.support.TESTFN, "setup.py")
os.mkdir(os_helper.TESTFN)
setup_py = os.path.join(os_helper.TESTFN, "setup.py")
distutils.core.run_setup(
self.write_setup(setup_prints_cwd, path=setup_py))

Expand Down
3 changes: 2 additions & 1 deletion Lib/distutils/tests/test_dist.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@
from distutils.cmd import Command

from test.support import (
TESTFN, captured_stdout, captured_stderr, run_unittest
captured_stdout, captured_stderr, run_unittest
)
from test.support.os_helper import TESTFN
from distutils.tests import support
from distutils import log

Expand Down
3 changes: 2 additions & 1 deletion Lib/distutils/tests/test_extension.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
import os
import warnings

from test.support import check_warnings, run_unittest
from test.support import run_unittest
from test.support.warnings_helper import check_warnings
from distutils.extension import read_setup_file, Extension

class ExtensionTestCase(unittest.TestCase):
Expand Down
4 changes: 3 additions & 1 deletion Lib/distutils/tests/test_file_util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
from distutils import log
from distutils.tests import support
from distutils.errors import DistutilsFileError
from test.support import run_unittest, unlink
from test.support import run_unittest
from test.support.os_helper import unlink


class FileUtilTestCase(support.TempdirManager, unittest.TestCase):

Expand Down
3 changes: 2 additions & 1 deletion Lib/distutils/tests/test_filelist.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
from distutils import filelist

import test.support
from test.support import os_helper
from test.support import captured_stdout, run_unittest
from distutils.tests import support

Expand Down Expand Up @@ -295,7 +296,7 @@ def test_process_template(self):


class FindAllTestCase(unittest.TestCase):
@test.support.skip_unless_symlink
@os_helper.skip_unless_symlink
def test_missing_symlink(self):
with test.support.temp_cwd():
os.symlink('foo', 'bar')
Expand Down
3 changes: 2 additions & 1 deletion Lib/distutils/tests/test_register.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
import urllib
import warnings

from test.support import check_warnings, run_unittest
from test.support import run_unittest
from test.support.warnings_helper import check_warnings

from distutils.command import register as register_module
from distutils.command.register import register
Expand Down
3 changes: 2 additions & 1 deletion Lib/distutils/tests/test_sdist.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
import zipfile
from os.path import join
from textwrap import dedent
from test.support import captured_stdout, check_warnings, run_unittest
from test.support import captured_stdout, run_unittest
from test.support.warnings_helper import check_warnings

try:
import zlib
Expand Down
5 changes: 4 additions & 1 deletion Lib/distutils/tests/test_sysconfig.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@
from distutils import sysconfig
from distutils.ccompiler import get_default_compiler
from distutils.tests import support
from test.support import TESTFN, run_unittest, check_warnings, swap_item
from test.support import run_unittest, swap_item
from test.support.os_helper import TESTFN
from test.support.warnings_helper import check_warnings


class SysconfigTestCase(support.EnvironGuard, unittest.TestCase):
def setUp(self):
Expand Down
3 changes: 2 additions & 1 deletion Lib/distutils/tests/test_unixccompiler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
"""Tests for distutils.unixccompiler."""
import sys
import unittest
from test.support import EnvironmentVarGuard, run_unittest
from test.support import run_unittest
from test.support.os_helper import EnvironmentVarGuard

from distutils import sysconfig
from distutils.unixccompiler import UnixCCompiler
Expand Down
3 changes: 2 additions & 1 deletion Lib/test/test_buffer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import contextlib
import unittest
from test import support
from test.support import os_helper
from itertools import permutations, product
from random import randrange, sample, choice
import warnings
Expand All @@ -39,7 +40,7 @@
ctypes = None

try:
with support.EnvironmentVarGuard() as os.environ, \
with os_helper.EnvironmentVarGuard() as os.environ, \
warnings.catch_warnings():
from numpy import ndarray as numpy_array
except ImportError:
Expand Down
4 changes: 3 additions & 1 deletion Lib/test/test_compile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@
import tempfile
import types
from test import support
from test.support import script_helper, FakePath
from test.support import script_helper
from test.support.os_helper import FakePath


class TestSpecifics(unittest.TestCase):

Expand Down
7 changes: 4 additions & 3 deletions Lib/test/test_filecmp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,14 @@
import unittest

from test import support
from test.support import os_helper


class FileCompareTestCase(unittest.TestCase):
def setUp(self):
self.name = support.TESTFN
self.name_same = support.TESTFN + '-same'
self.name_diff = support.TESTFN + '-diff'
self.name = os_helper.TESTFN
self.name_same = os_helper.TESTFN + '-same'
self.name_diff = os_helper.TESTFN + '-diff'
data = 'Contents of file go here.\n'
for name in [self.name, self.name_same, self.name_diff]:
with open(name, 'w') as output:
Expand Down
20 changes: 11 additions & 9 deletions Lib/test/test_fileinput.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@
from fileinput import FileInput, hook_encoded
from pathlib import Path

from test.support import verbose, TESTFN, check_warnings
from test.support import unlink as safe_unlink
from test.support import verbose
from test.support.os_helper import TESTFN
from test.support.os_helper import unlink as safe_unlink
from test.support import warnings_helper
from test import support
from unittest import mock

Expand All @@ -39,7 +41,7 @@ class BaseTests:
# temp file's name.
def writeTmp(self, content, *, mode='w'): # opening in text mode is the default
fd, name = tempfile.mkstemp()
self.addCleanup(support.unlink, name)
self.addCleanup(safe_unlink, name)

@vstinner vstinner Jun 25, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer to use os_helper.unlink here, rather than changing the function name.

@shihai1991 shihai1991 Jun 25, 2020

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done.
I use safe_unlink in here's reason is that test_fileinput have import unlink as safe_unlink.
if I import os_helper again, the imports looks like more duplicated~

@vstinner vstinner Jun 25, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's common to import a module and import some symbols of the same module. "Inconsistencies" are common, especially in tests which are old :-)

@vstinner vstinner Jun 25, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For such PR which basically updates tests to point to new submodules, I prefer to leave the tests unchanged, don't change the coding style in the same PR.

@vstinner vstinner Jun 25, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Also, PR which only changes coding style are usually rejected. In short, the coding style cannot be updated in Python code base :-))

@shihai1991 shihai1991 Jun 25, 2020

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Also, PR which only changes coding style are usually rejected. In short, the coding style cannot be updated in Python code base :-))

Got it, Thanks. I have know the pain of code churn( not easy for finding the historical record ;-) )

with open(fd, mode) as f:
f.write(content)
return name
Expand Down Expand Up @@ -234,9 +236,9 @@ def test_opening_mode(self):
pass
# try opening in universal newline mode
t1 = self.writeTmp(b"A\nB\r\nC\rD", mode="wb")
with check_warnings(('', DeprecationWarning)):
with warnings_helper.check_warnings(('', DeprecationWarning)):
fi = FileInput(files=t1, mode="U")
with check_warnings(('', DeprecationWarning)):
with warnings_helper.check_warnings(('', DeprecationWarning)):
lines = list(fi)
self.assertEqual(lines, ["A\n", "B\n", "C\n", "D"])

Expand Down Expand Up @@ -353,7 +355,7 @@ def test_empty_files_list_specified_to_constructor(self):
with FileInput(files=[]) as fi:
self.assertEqual(fi._files, ('-',))

@support.ignore_warnings(category=DeprecationWarning)
@warnings_helper.ignore_warnings(category=DeprecationWarning)
def test__getitem__(self):
"""Tests invoking FileInput.__getitem__() with the current
line number"""
Expand All @@ -371,7 +373,7 @@ def test__getitem___deprecation(self):
with FileInput(files=[t]) as fi:
self.assertEqual(fi[0], "line1\n")

@support.ignore_warnings(category=DeprecationWarning)
@warnings_helper.ignore_warnings(category=DeprecationWarning)
def test__getitem__invalid_key(self):
"""Tests invoking FileInput.__getitem__() with an index unequal to
the line number"""
Expand All @@ -381,7 +383,7 @@ def test__getitem__invalid_key(self):
fi[1]
self.assertEqual(cm.exception.args, ("accessing lines out of order",))

@support.ignore_warnings(category=DeprecationWarning)
@warnings_helper.ignore_warnings(category=DeprecationWarning)
def test__getitem__eof(self):
"""Tests invoking FileInput.__getitem__() with the line number but at
end-of-input"""
Expand All @@ -400,7 +402,7 @@ def test_nextfile_oserror_deleting_backup(self):
os_unlink_replacement = UnconditionallyRaise(OSError)
try:
t = self.writeTmp("\n")
self.addCleanup(support.unlink, t + '.bak')
self.addCleanup(safe_unlink, t + '.bak')
with FileInput(files=[t], inplace=True) as fi:
next(fi) # make sure the file is opened
os.unlink = os_unlink_replacement
Expand Down
4 changes: 3 additions & 1 deletion Lib/test/test_readline.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@
import sys
import tempfile
import unittest
from test.support import import_module, unlink, temp_dir, TESTFN, verbose
from test.support import verbose
from test.support.import_helper import import_module
from test.support.os_helper import unlink, temp_dir, TESTFN
from test.support.script_helper import assert_python_ok

# Skip tests if there is no readline module
Expand Down
3 changes: 2 additions & 1 deletion Lib/test/test_smtpnet.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
import unittest
from test import support
from test.support import import_helper
from test.support import socket_helper
import smtplib
import socket

ssl = support.import_module("ssl")
ssl = import_helper.import_module("ssl")

support.requires("network")

Expand Down
17 changes: 9 additions & 8 deletions Lib/test/test_structmembers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import unittest
from test import support
from test.support import import_helper
from test.support import warnings_helper

# Skip this test if the _testcapi module isn't available.
support.import_module('_testcapi')
import_helper.import_module('_testcapi')
from _testcapi import _test_structmembersType, \
CHAR_MAX, CHAR_MIN, UCHAR_MAX, \
SHRT_MAX, SHRT_MIN, USHRT_MAX, \
Expand Down Expand Up @@ -116,27 +117,27 @@ def test_inplace_string(self):
class TestWarnings(unittest.TestCase):

def test_byte_max(self):
with support.check_warnings(('', RuntimeWarning)):
with warnings_helper.check_warnings(('', RuntimeWarning)):
ts.T_BYTE = CHAR_MAX+1

def test_byte_min(self):
with support.check_warnings(('', RuntimeWarning)):
with warnings_helper.check_warnings(('', RuntimeWarning)):
ts.T_BYTE = CHAR_MIN-1

def test_ubyte_max(self):
with support.check_warnings(('', RuntimeWarning)):
with warnings_helper.check_warnings(('', RuntimeWarning)):
ts.T_UBYTE = UCHAR_MAX+1

def test_short_max(self):
with support.check_warnings(('', RuntimeWarning)):
with warnings_helper.check_warnings(('', RuntimeWarning)):
ts.T_SHORT = SHRT_MAX+1

def test_short_min(self):
with support.check_warnings(('', RuntimeWarning)):
with warnings_helper.check_warnings(('', RuntimeWarning)):
ts.T_SHORT = SHRT_MIN-1

def test_ushort_max(self):
with support.check_warnings(('', RuntimeWarning)):
with warnings_helper.check_warnings(('', RuntimeWarning)):
ts.T_USHORT = USHRT_MAX+1


Expand Down
5 changes: 3 additions & 2 deletions Lib/test/test_tools/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import os.path
import unittest
from test import support
from test.support import import_helper

basepath = os.path.normpath(
os.path.dirname( # <src/install dir>
Expand All @@ -26,11 +27,11 @@ def skip_if_missing(tool=None):
@contextlib.contextmanager
def imports_under_tool(name, *subdirs):
tooldir = os.path.join(toolsdir, name, *subdirs)
with support.DirsOnSysPath(tooldir) as cm:
with import_helper.DirsOnSysPath(tooldir) as cm:
yield cm

def import_tool(toolname):
with support.DirsOnSysPath(scriptsdir):
with import_helper.DirsOnSysPath(scriptsdir):
return importlib.import_module(toolname)

def load_tests(*args):
Expand Down