bpo-26120: make pydoc exclude __future__ imports from the data block of the module (GH-30888)

iritkatriel · web-flow · commit 15ba8167d78f · 2022-03-28T22:02:57.000+01:00
diff --git a/Lib/pydoc.py b/Lib/pydoc.py
@@ -54,6 +54,7 @@ class or function within a module or module in a package.  If the
 #     the current directory is changed with os.chdir(), an incorrect
 #     path will be displayed.
 
+import __future__
 import builtins
 import importlib._bootstrap
 import importlib._bootstrap_external
@@ -274,6 +275,8 @@ def _split_list(s, predicate):
             no.append(x)
     return yes, no
 
+_future_feature_names = set(__future__.all_feature_names)
+
 def visiblename(name, all=None, obj=None):
     """Decide whether to show documentation on a variable."""
     # Certain special names are redundant or internal.
@@ -288,6 +291,10 @@ def visiblename(name, all=None, obj=None):
     # Namedtuples have public fields and methods with a single leading underscore
     if name.startswith('_') and hasattr(obj, '_fields'):
         return True
+    # Ignore __future__ imports.
+    if name in _future_feature_names:
+        if isinstance(getattr(obj, name, None), __future__._Feature):
+            return False
     if all is not None:
         # only document that which the programmer exported in __all__
         return name in all
diff --git a/Lib/test/pydoc_mod.py b/Lib/test/pydoc_mod.py
@@ -1,5 +1,7 @@
 """This is a test module for test_pydoc"""
 
+from __future__ import print_function
+
 import types
 import typing
 
diff --git a/Misc/NEWS.d/next/Library/2022-01-25-15-45-04.bpo-26120.YzrBMO.rst b/Misc/NEWS.d/next/Library/2022-01-25-15-45-04.bpo-26120.YzrBMO.rst
@@ -0,0 +1 @@
+:mod:`pydoc` now excludes __future__ imports from the module's data items.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+:mod:`pydoc` now excludes __future__ imports from the module's data items.