bpo-41521: Rename blacklist parameter to not_exported (GH-21824)

Rename "blacklist" parameter of test.support.check__all__() to
"not_exported".

Doc/library/test.rst

@@ -878,7 +878,7 @@ The :mod:`test.support` module defines the following functions:
    missing.
 
 
-.. function:: check__all__(test_case, module, name_of_module=None, extra=(), blacklist=())
+.. function:: check__all__(test_case, module, name_of_module=None, extra=(), not_exported=())
 
    Assert that the ``__all__`` variable of *module* contains all public names.
 
@@ -895,8 +895,8 @@ The :mod:`test.support` module defines the following functions:
    detected as "public", like objects without a proper ``__module__``
    attribute. If provided, it will be added to the automatically detected ones.
 
-   The *blacklist* argument can be a set of names that must not be treated as part of
+   The *not_exported* argument can be a set of names that must not be treated
-   the public API even though their names indicate otherwise.
+   as part of the public API even though their names indicate otherwise.
 
    Example use::
 
@@ -912,10 +912,10 @@ The :mod:`test.support` module defines the following functions:
       class OtherTestCase(unittest.TestCase):
           def test__all__(self):
               extra = {'BAR_CONST', 'FOO_CONST'}
-              blacklist = {'baz'}  # Undocumented name.
+              not_exported = {'baz'}  # Undocumented name.
               # bar imports part of its API from _bar.
               support.check__all__(self, bar, ('bar', '_bar'),
-                                   extra=extra, blacklist=blacklist)
+                                   extra=extra, not_exported=not_exported)
 
    .. versionadded:: 3.6
 

Lib/test/_test_multiprocessing.py

@@ -5581,9 +5581,11 @@ def test_namespace(self):
 
 class MiscTestCase(unittest.TestCase):
     def test__all__(self):
-        # Just make sure names in blacklist are excluded
+        # Just make sure names in not_exported are excluded
         support.check__all__(self, multiprocessing, extra=multiprocessing.__all__,
-                             blacklist=['SUBDEBUG', 'SUBWARNING'])
+                             not_exported=['SUBDEBUG', 'SUBWARNING'])
+
+
 #
 # Mixins
 #

Lib/test/support/__init__.py

@@ -1410,7 +1410,7 @@ def detect_api_mismatch(ref_api, other_api, *, ignore=()):
 
 
 def check__all__(test_case, module, name_of_module=None, extra=(),
-                 blacklist=()):
+                 not_exported=()):
     """Assert that the __all__ variable of 'module' contains all public names.
 
     The module's public names (its API) are detected automatically based on
@@ -1427,7 +1427,7 @@ def check__all__(test_case, module, name_of_module=None, extra=(),
     '__module__' attribute. If provided, it will be added to the
     automatically detected ones.
 
-    The 'blacklist' argument can be a set of names that must not be treated
+    The 'not_exported' argument can be a set of names that must not be treated
     as part of the public API even though their names indicate otherwise.
 
     Usage:
@@ -1443,10 +1443,10 @@ def test__all__(self):
         class OtherTestCase(unittest.TestCase):
             def test__all__(self):
                 extra = {'BAR_CONST', 'FOO_CONST'}
-                blacklist = {'baz'}  # Undocumented name.
+                not_exported = {'baz'}  # Undocumented name.
                 # bar imports part of its API from _bar.
                 support.check__all__(self, bar, ('bar', '_bar'),
-                                     extra=extra, blacklist=blacklist)
+                                     extra=extra, not_exported=not_exported)
 
     """
 
@@ -1458,7 +1458,7 @@ def test__all__(self):
     expected = set(extra)
 
     for name in dir(module):
-        if name.startswith('_') or name in blacklist:
+        if name.startswith('_') or name in not_exported:
             continue
         obj = getattr(module, name)
         if (getattr(obj, '__module__', None) in name_of_module or

Lib/test/test_calendar.py

@@ -934,12 +934,12 @@ def test_html_output_year_css(self):
 
 class MiscTestCase(unittest.TestCase):
     def test__all__(self):
-        blacklist = {'mdays', 'January', 'February', 'EPOCH',
+        not_exported = {
-                     'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY',
+            'mdays', 'January', 'February', 'EPOCH', 'MONDAY', 'TUESDAY',
-                     'SATURDAY', 'SUNDAY', 'different_locale', 'c',
+            'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY',
-                     'prweek', 'week', 'format', 'formatstring', 'main',
+            'different_locale', 'c', 'prweek', 'week', 'format',
-                     'monthlen', 'prevmonth', 'nextmonth'}
+            'formatstring', 'main', 'monthlen', 'prevmonth', 'nextmonth'}
-        support.check__all__(self, calendar, blacklist=blacklist)
+        support.check__all__(self, calendar, not_exported=not_exported)
 
 
 class TestSubClassingCase(unittest.TestCase):

Lib/test/test_cgi.py

@@ -553,9 +553,10 @@ def test_parse_header(self):
             ("form-data", {"name": "files", "filename": 'fo"o;bar'}))
 
     def test_all(self):
-        blacklist = {"logfile", "logfp", "initlog", "dolog", "nolog",
+        not_exported = {
-                     "closelog", "log", "maxlen", "valid_boundary"}
+            "logfile", "logfp", "initlog", "dolog", "nolog", "closelog", "log",
-        support.check__all__(self, cgi, blacklist=blacklist)
+            "maxlen", "valid_boundary"}
+        support.check__all__(self, cgi, not_exported=not_exported)
 
 
 BOUNDARY = "---------------------------721837373350705526688164684"

Lib/test/test_configparser.py

@@ -2128,8 +2128,7 @@ def test_instance_assignment(self):
 
 class MiscTestCase(unittest.TestCase):
     def test__all__(self):
-        blacklist = {"Error"}
+        support.check__all__(self, configparser, not_exported={"Error"})
-        support.check__all__(self, configparser, blacklist=blacklist)
 
 
 if __name__ == '__main__':

Lib/test/test_ftplib.py

@@ -1107,10 +1107,11 @@ def testTimeoutDirectAccess(self):
 
 class MiscTestCase(TestCase):
     def test__all__(self):
-        blacklist = {'MSG_OOB', 'FTP_PORT', 'MAXLINE', 'CRLF', 'B_CRLF',
+        not_exported = {
-                     'Error', 'parse150', 'parse227', 'parse229', 'parse257',
+            'MSG_OOB', 'FTP_PORT', 'MAXLINE', 'CRLF', 'B_CRLF', 'Error',
-                     'print_line', 'ftpcp', 'test'}
+            'parse150', 'parse227', 'parse229', 'parse257', 'print_line',
-        support.check__all__(self, ftplib, blacklist=blacklist)
+            'ftpcp', 'test'}
+        support.check__all__(self, ftplib, not_exported=not_exported)
 
 
 def test_main():

Lib/test/test_gettext.py

@@ -820,8 +820,8 @@ def test_cache(self):
 
 class MiscTestCase(unittest.TestCase):
     def test__all__(self):
-        blacklist = {'c2py', 'ENOENT'}
+        support.check__all__(self, gettext,
-        support.check__all__(self, gettext, blacklist=blacklist)
+                             not_exported={'c2py', 'ENOENT'})
 
 
 if __name__ == '__main__':

Lib/test/test_logging.py

@@ -5363,12 +5363,12 @@ def test_basic(self):
 
 class MiscTestCase(unittest.TestCase):
     def test__all__(self):
-        blacklist = {'logThreads', 'logMultiprocessing',
+        not_exported = {
-                     'logProcesses', 'currentframe',
+            'logThreads', 'logMultiprocessing', 'logProcesses', 'currentframe',
             'PercentStyle', 'StrFormatStyle', 'StringTemplateStyle',
-                     'Filterer', 'PlaceHolder', 'Manager', 'RootLogger',
+            'Filterer', 'PlaceHolder', 'Manager', 'RootLogger', 'root',
-                     'root', 'threading'}
+            'threading'}
-        support.check__all__(self, logging, blacklist=blacklist)
+        support.check__all__(self, logging, not_exported=not_exported)
 
 
 # Set the locale to the platform-dependent default.  I have no idea

Lib/test/test_mailbox.py

@@ -2296,8 +2296,8 @@ def test_nonempty_maildir_both(self):
 
 class MiscTestCase(unittest.TestCase):
     def test__all__(self):
-        blacklist = {"linesep", "fcntl"}
+        support.check__all__(self, mailbox,
-        support.check__all__(self, mailbox, blacklist=blacklist)
+                             not_exported={"linesep", "fcntl"})
 
 
 def test_main():

Lib/test/test_optparse.py

@@ -1652,8 +1652,8 @@ def test_numeric_options(self):
 
 class MiscTestCase(unittest.TestCase):
     def test__all__(self):
-        blacklist = {'check_builtin', 'AmbiguousOptionError', 'NO_DEFAULT'}
+        not_exported = {'check_builtin', 'AmbiguousOptionError', 'NO_DEFAULT'}
-        support.check__all__(self, optparse, blacklist=blacklist)
+        support.check__all__(self, optparse, not_exported=not_exported)
 
 
 def test_main():

Lib/test/test_pickletools.py

@@ -63,7 +63,8 @@ def test_optimize_binput_and_memoize(self):
 
 class MiscTestCase(unittest.TestCase):
     def test__all__(self):
-        blacklist = {'bytes_types',
+        not_exported = {
+            'bytes_types',
             'UP_TO_NEWLINE', 'TAKEN_FROM_ARGUMENT1',
             'TAKEN_FROM_ARGUMENT4', 'TAKEN_FROM_ARGUMENT4U',
             'TAKEN_FROM_ARGUMENT8U', 'ArgumentDescriptor',
@@ -90,7 +91,7 @@ def test__all__(self):
             'markobject', 'stackslice', 'OpcodeInfo', 'opcodes',
             'code2op',
         }
-        support.check__all__(self, pickletools, blacklist=blacklist)
+        support.check__all__(self, pickletools, not_exported=not_exported)
 
 
 def test_main():

Lib/test/test_plistlib.py

@@ -672,8 +672,8 @@ def test_keyed_archive_data(self):
 
 class MiscTestCase(unittest.TestCase):
     def test__all__(self):
-        blacklist = {"PlistFormat", "PLISTHEADER"}
+        not_exported = {"PlistFormat", "PLISTHEADER"}
-        support.check__all__(self, plistlib, blacklist=blacklist)
+        support.check__all__(self, plistlib, not_exported=not_exported)
 
 
 if __name__ == '__main__':

Lib/test/test_smtpd.py

@@ -1003,12 +1003,11 @@ def test_multiple_emails_with_extended_command_length(self):
 
 class MiscTestCase(unittest.TestCase):
     def test__all__(self):
-        blacklist = {
+        not_exported = {
             "program", "Devnull", "DEBUGSTREAM", "NEWLINE", "COMMASPACE",
             "DATA_SIZE_DEFAULT", "usage", "Options", "parseargs",
-
         }
-        support.check__all__(self, smtpd, blacklist=blacklist)
+        support.check__all__(self, smtpd, not_exported=not_exported)
 
 
 if __name__ == "__main__":

Lib/test/test_support.py

@@ -391,14 +391,14 @@ def test_detect_api_mismatch__ignore(self):
 
     def test_check__all__(self):
         extra = {'tempdir'}
-        blacklist = {'template'}
+        not_exported = {'template'}
         support.check__all__(self,
                              tempfile,
                              extra=extra,
-                             blacklist=blacklist)
+                             not_exported=not_exported)
 
         extra = {'TextTestResult', 'installHandler'}
-        blacklist = {'load_tests', "TestProgram", "BaseTestSuite"}
+        not_exported = {'load_tests', "TestProgram", "BaseTestSuite"}
 
         support.check__all__(self,
                              unittest,
@@ -407,7 +407,7 @@ def test_check__all__(self):
                               "unittest.main", "unittest.runner",
                               "unittest.signals", "unittest.async_case"),
                              extra=extra,
-                             blacklist=blacklist)
+                             not_exported=not_exported)
 
         self.assertRaises(AssertionError, support.check__all__, self, unittest)
 

Lib/test/test_tarfile.py

@@ -2257,22 +2257,19 @@ def test_number_field_limits(self):
             tarfile.itn(0x10000000000, 6, tarfile.GNU_FORMAT)
 
     def test__all__(self):
-        blacklist = {'version', 'grp', 'pwd', 'symlink_exception',
+        not_exported = {
-                     'NUL', 'BLOCKSIZE', 'RECORDSIZE', 'GNU_MAGIC',
+            'version', 'grp', 'pwd', 'symlink_exception', 'NUL', 'BLOCKSIZE',
-                     'POSIX_MAGIC', 'LENGTH_NAME', 'LENGTH_LINK',
+            'RECORDSIZE', 'GNU_MAGIC', 'POSIX_MAGIC', 'LENGTH_NAME',
-                     'LENGTH_PREFIX', 'REGTYPE', 'AREGTYPE', 'LNKTYPE',
+            'LENGTH_LINK', 'LENGTH_PREFIX', 'REGTYPE', 'AREGTYPE', 'LNKTYPE',
-                     'SYMTYPE', 'CHRTYPE', 'BLKTYPE', 'DIRTYPE', 'FIFOTYPE',
+            'SYMTYPE', 'CHRTYPE', 'BLKTYPE', 'DIRTYPE', 'FIFOTYPE', 'CONTTYPE',
-                     'CONTTYPE', 'GNUTYPE_LONGNAME', 'GNUTYPE_LONGLINK',
+            'GNUTYPE_LONGNAME', 'GNUTYPE_LONGLINK', 'GNUTYPE_SPARSE',
-                     'GNUTYPE_SPARSE', 'XHDTYPE', 'XGLTYPE', 'SOLARIS_XHDTYPE',
+            'XHDTYPE', 'XGLTYPE', 'SOLARIS_XHDTYPE', 'SUPPORTED_TYPES',
-                     'SUPPORTED_TYPES', 'REGULAR_TYPES', 'GNU_TYPES',
+            'REGULAR_TYPES', 'GNU_TYPES', 'PAX_FIELDS', 'PAX_NAME_FIELDS',
-                     'PAX_FIELDS', 'PAX_NAME_FIELDS', 'PAX_NUMBER_FIELDS',
+            'PAX_NUMBER_FIELDS', 'stn', 'nts', 'nti', 'itn', 'calc_chksums',
-                     'stn', 'nts', 'nti', 'itn', 'calc_chksums', 'copyfileobj',
+            'copyfileobj', 'filemode', 'EmptyHeaderError',
-                     'filemode',
+            'TruncatedHeaderError', 'EOFHeaderError', 'InvalidHeaderError',
-                     'EmptyHeaderError', 'TruncatedHeaderError',
+            'SubsequentHeaderError', 'ExFileObject', 'main'}
-                     'EOFHeaderError', 'InvalidHeaderError',
+        support.check__all__(self, tarfile, not_exported=not_exported)
-                     'SubsequentHeaderError', 'ExFileObject',
-                     'main'}
-        support.check__all__(self, tarfile, blacklist=blacklist)
 
 
 class CommandLineTest(unittest.TestCase):

Lib/test/test_threading.py

@@ -1365,9 +1365,9 @@ class BarrierTests(lock_tests.BarrierTests):
 class MiscTestCase(unittest.TestCase):
     def test__all__(self):
         extra = {"ThreadError"}
-        blacklist = {'currentThread', 'activeCount'}
+        not_exported = {'currentThread', 'activeCount'}
         support.check__all__(self, threading, ('threading', '_thread'),
-                             extra=extra, blacklist=blacklist)
+                             extra=extra, not_exported=not_exported)
 
 
 class InterruptMainTests(unittest.TestCase):

Lib/test/test_wave.py

@@ -107,8 +107,7 @@ class WavePCM32Test(WaveTest, unittest.TestCase):
 
 class MiscTestCase(unittest.TestCase):
     def test__all__(self):
-        blacklist = {'WAVE_FORMAT_PCM'}
+        support.check__all__(self, wave, not_exported={'WAVE_FORMAT_PCM'})
-        support.check__all__(self, wave, blacklist=blacklist)
 
 
 class WaveLowLevelTest(unittest.TestCase):

Lib/test/test_xml_etree.py

@@ -128,7 +128,7 @@ def test_sanity(self):
 
     def test_all(self):
         names = ("xml.etree.ElementTree", "_elementtree")
-        support.check__all__(self, ET, names, blacklist=("HTML_EMPTY",))
+        support.check__all__(self, ET, names, not_exported=("HTML_EMPTY",))
 
 
 def serialize(elem, to_string=True, encoding='unicode', **options):

Misc/NEWS.d/next/Tests/2020-08-11-14-59-13.bpo-41521.w2UYK7.rst

@@ -0,0 +1,2 @@
+:mod:`test.support`: Rename ``blacklist`` parameter of
+:func:`~test.support.check__all__` to ``not_exported``.