Issue #27919: Deprecate extra_path option in distutils.

jaraco · jaraco · commit 5c071c1ff4c9 · 2016-09-01T13:55:33.000-04:00
diff --git a/Doc/whatsnew/3.6.rst b/Doc/whatsnew/3.6.rst
@@ -782,6 +782,12 @@ Deprecated features
   now deprecated.
   (Contributed by Serhiy Storchaka in :issue:`25791` and :issue:`26754`.)
 
+* The undocumented ``extra_path`` argument to a distutils Distribution
+  is now considered
+  deprecated, will raise a warning during install if set. Support for this
+  parameter will be dropped in a future Python release and likely earlier
+  through third party tools. See :issue:`27919` for details.
+
 
 Deprecated Python behavior
 --------------------------
diff --git a/Lib/distutils/command/install.py b/Lib/distutils/command/install.py
@@ -175,6 +175,7 @@ def initialize_options(self):
         self.compile = None
         self.optimize = None
 
+        # Deprecated
         # These two are for putting non-packagized distributions into their
         # own directory and creating a .pth file if it makes sense.
         # 'extra_path' comes from the setup file; 'install_path_file' can
@@ -344,6 +345,7 @@ def finalize_options(self):
                            'scripts', 'data', 'headers',
                            'userbase', 'usersite')
 
+        # Deprecated
         # Well, we're not actually fully completely finalized yet: we still
         # have to deal with 'extra_path', which is the hack for allowing
         # non-packagized module distributions (hello, Numerical Python!) to
@@ -490,6 +492,10 @@ def handle_extra_path(self):
             self.extra_path = self.distribution.extra_path
 
         if self.extra_path is not None:
+            log.warn(
+                "Distribution option extra_path is deprecated. "
+                "See issue27919 for details."
+            )
             if isinstance(self.extra_path, str):
                 self.extra_path = self.extra_path.split(',')
 
diff --git a/Misc/NEWS b/Misc/NEWS
@@ -60,6 +60,9 @@ Core and Builtins
 Library
 -------
 
+- Issue #27919: Deprecated ``extra_path`` distribution option in distutils
+  packaging.
+
 - Issue #23229: Add new ``cmath`` constants: ``cmath.inf`` and ``cmath.nan`` to
   match ``math.inf`` and ``math.nan``, and also ``cmath.infj`` and
   ``cmath.nanj`` to match the format used by complex repr.
