Issue #22665: Add missing get_terminal_size and SameFileError to shutil.__all__.

berkerpeksag · berkerpeksag · commit 8083cd6c3bd8 · 2014-11-01T11:04:06.000+02:00
diff --git a/Lib/shutil.py b/Lib/shutil.py
@@ -36,7 +36,8 @@
            "register_archive_format", "unregister_archive_format",
            "get_unpack_formats", "register_unpack_format",
            "unregister_unpack_format", "unpack_archive",
-           "ignore_patterns", "chown", "which"]
+           "ignore_patterns", "chown", "which", "get_terminal_size",
+           "SameFileError"]
            # disk_usage is added later, if available on the platform
 
 class Error(OSError):
diff --git a/Lib/test/test_shutil.py b/Lib/test/test_shutil.py
@@ -1762,5 +1762,23 @@ def test_stty_match(self):
         self.assertEqual(expected, actual)
 
 
+class PublicAPITests(unittest.TestCase):
+    """Ensures that the correct values are exposed in the public API."""
+
+    def test_module_all_attribute(self):
+        self.assertTrue(hasattr(shutil, '__all__'))
+        target_api = ['copyfileobj', 'copyfile', 'copymode', 'copystat',
+                      'copy', 'copy2', 'copytree', 'move', 'rmtree', 'Error',
+                      'SpecialFileError', 'ExecError', 'make_archive',
+                      'get_archive_formats', 'register_archive_format',
+                      'unregister_archive_format', 'get_unpack_formats',
+                      'register_unpack_format', 'unregister_unpack_format',
+                      'unpack_archive', 'ignore_patterns', 'chown', 'which',
+                      'get_terminal_size', 'SameFileError']
+        if hasattr(os, 'statvfs') or os.name == 'nt':
+            target_api.append('disk_usage')
+        self.assertEqual(set(shutil.__all__), set(target_api))
+
+
 if __name__ == '__main__':
     unittest.main()
diff --git a/Misc/NEWS b/Misc/NEWS
@@ -33,6 +33,9 @@ Core and Builtins
 Library
 -------
 
+- Issue #22665: Add missing get_terminal_size and SameFileError to
+  shutil.__all__.
+
 - Issue #17381: Fixed handling of case-insensitive ranges in regular
   expressions.
 
