Register 3d projection by default.

anntzer · anntzer · commit 3c87da1a72c4 · 2019-02-26T10:45:53.000+01:00
Now that we always install mpl_toolkits, we may as well always register
mplot3d and save an "apparently unused" import for the users.
diff --git a/doc/api/next_api_changes/2019-02-26-AL.rst b/doc/api/next_api_changes/2019-02-26-AL.rst
@@ -0,0 +1,5 @@
+mplot3d is always registered by default
+```````````````````````````````````````
+
+It is not necessary to import mplot3d anymore to create 3d axes with
+``fig.add_subplot(111, projection="3d")``.
diff --git a/doc/users/next_whats_new/2019-01-06-shaded-voxels.rst b/doc/users/next_whats_new/2019-01-06-shaded-voxels.rst
@@ -12,7 +12,6 @@ The plot below shows how this affects the output.
 
 	import matplotlib.pyplot as plt
 	import numpy as np
-	from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
 
 	# prepare some coordinates
 	x, y, z = np.indices((8, 8, 8))
diff --git a/examples/frontpage/3D.py b/examples/frontpage/3D.py
@@ -6,8 +6,6 @@
 This example reproduces the frontpage 3D example.
 
 """
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
 
 from matplotlib import cbook
 from matplotlib import cm
diff --git a/examples/mplot3d/2dcollections3d.py b/examples/mplot3d/2dcollections3d.py
@@ -7,9 +7,6 @@
 selective axes of a 3D plot.
 """
 
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
-
 import numpy as np
 import matplotlib.pyplot as plt
 
diff --git a/examples/mplot3d/3d_bars.py b/examples/mplot3d/3d_bars.py
@@ -10,8 +10,6 @@
 
 import numpy as np
 import matplotlib.pyplot as plt
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
 
 
 # setup the figure and axes
diff --git a/examples/mplot3d/bars3d.py b/examples/mplot3d/bars3d.py
@@ -7,9 +7,6 @@
 planes y=0, y=1, etc.
 """
 
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
-
 import matplotlib.pyplot as plt
 import numpy as np
 
diff --git a/examples/mplot3d/custom_shaded_3d_surface.py b/examples/mplot3d/custom_shaded_3d_surface.py
@@ -6,9 +6,6 @@
 Demonstrates using custom hillshading in a 3D surface plot.
 """
 
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
-
 from matplotlib import cbook
 from matplotlib import cm
 from matplotlib.colors import LightSource
diff --git a/examples/mplot3d/hist3d.py b/examples/mplot3d/hist3d.py
@@ -6,9 +6,6 @@
 Demo of a histogram for 2 dimensional data as a bar graph in 3D.
 """
 
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
-
 import matplotlib.pyplot as plt
 import numpy as np
 
diff --git a/examples/mplot3d/lines3d.py b/examples/mplot3d/lines3d.py
@@ -6,9 +6,6 @@
 This example demonstrates plotting a parametric curve in 3D.
 '''
 
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
-
 import numpy as np
 import matplotlib.pyplot as plt
 
diff --git a/examples/mplot3d/lorenz_attractor.py b/examples/mplot3d/lorenz_attractor.py
@@ -15,8 +15,6 @@
 
 import numpy as np
 import matplotlib.pyplot as plt
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
 
 
 def lorenz(x, y, z, s=10, r=28, b=2.667):
diff --git a/examples/mplot3d/mixed_subplots.py b/examples/mplot3d/mixed_subplots.py
@@ -5,8 +5,6 @@
 
 This example shows a how to plot a 2D and 3D plot on the same figure.
 """
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
 
 import matplotlib.pyplot as plt
 import numpy as np
diff --git a/examples/mplot3d/offset.py b/examples/mplot3d/offset.py
@@ -13,9 +13,6 @@
 automatically trigger it.
 '''
 
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
-
 import matplotlib.pyplot as plt
 import numpy as np
 
diff --git a/examples/mplot3d/pathpatch3d.py b/examples/mplot3d/pathpatch3d.py
@@ -11,8 +11,6 @@
 from matplotlib.patches import Circle, PathPatch
 from matplotlib.text import TextPath
 from matplotlib.transforms import Affine2D
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
 import mpl_toolkits.mplot3d.art3d as art3d
 
 
diff --git a/examples/mplot3d/polys3d.py b/examples/mplot3d/polys3d.py
@@ -8,9 +8,6 @@
 of 'jagged stained glass' effect.
 """
 
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
-
 from matplotlib.collections import PolyCollection
 import matplotlib.pyplot as plt
 from matplotlib import colors as mcolors
diff --git a/examples/mplot3d/quiver3d.py b/examples/mplot3d/quiver3d.py
@@ -6,9 +6,6 @@
 Demonstrates plotting directional arrows at points on a 3d meshgrid.
 '''
 
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
-
 import matplotlib.pyplot as plt
 import numpy as np
 
diff --git a/examples/mplot3d/scatter3d.py b/examples/mplot3d/scatter3d.py
@@ -6,9 +6,6 @@
 Demonstration of a basic scatterplot in 3D.
 '''
 
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
-
 import matplotlib.pyplot as plt
 import numpy as np
 
diff --git a/examples/mplot3d/subplot3d.py b/examples/mplot3d/subplot3d.py
@@ -11,8 +11,6 @@
 import numpy as np
 
 from mpl_toolkits.mplot3d.axes3d import get_test_data
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
 
 
 # set up a figure twice as wide as it is tall
diff --git a/examples/mplot3d/surface3d.py b/examples/mplot3d/surface3d.py
@@ -10,9 +10,6 @@
 z axis tick labels.
 '''
 
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
-
 import matplotlib.pyplot as plt
 from matplotlib import cm
 from matplotlib.ticker import LinearLocator, FormatStrFormatter
diff --git a/examples/mplot3d/surface3d_2.py b/examples/mplot3d/surface3d_2.py
@@ -6,9 +6,6 @@
 Demonstrates a very basic plot of a 3D surface using a solid color.
 '''
 
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
-
 import matplotlib.pyplot as plt
 import numpy as np
 
diff --git a/examples/mplot3d/surface3d_3.py b/examples/mplot3d/surface3d_3.py
@@ -6,9 +6,6 @@
 Demonstrates plotting a 3D surface colored in a checkerboard pattern.
 '''
 
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
-
 import matplotlib.pyplot as plt
 from matplotlib.ticker import LinearLocator
 import numpy as np
diff --git a/examples/mplot3d/surface3d_radial.py b/examples/mplot3d/surface3d_radial.py
@@ -10,9 +10,6 @@
 Example contributed by Armin Moser.
 '''
 
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
-
 import matplotlib.pyplot as plt
 import numpy as np
 
diff --git a/examples/mplot3d/text3d.py b/examples/mplot3d/text3d.py
@@ -16,9 +16,6 @@
 
 '''
 
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
-
 import matplotlib.pyplot as plt
 
 
diff --git a/examples/mplot3d/tricontour3d.py b/examples/mplot3d/tricontour3d.py
@@ -9,9 +9,6 @@
 tricontourf3d_demo shows the filled version of this example.
 """
 
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
-
 import matplotlib.pyplot as plt
 import matplotlib.tri as tri
 import numpy as np
diff --git a/examples/mplot3d/tricontourf3d.py b/examples/mplot3d/tricontourf3d.py
@@ -9,9 +9,6 @@
 tricontour3d_demo shows the unfilled version of this example.
 """
 
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
-
 import matplotlib.pyplot as plt
 import matplotlib.tri as tri
 import numpy as np
diff --git a/examples/mplot3d/trisurf3d.py b/examples/mplot3d/trisurf3d.py
@@ -6,9 +6,6 @@
 Plot a 3D surface with a triangular mesh.
 '''
 
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
-
 import matplotlib.pyplot as plt
 import numpy as np
 
diff --git a/examples/mplot3d/trisurf3d_2.py b/examples/mplot3d/trisurf3d_2.py
@@ -14,9 +14,6 @@
 import matplotlib.pyplot as plt
 import matplotlib.tri as mtri
 
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
-
 
 fig = plt.figure(figsize=plt.figaspect(0.5))
 
diff --git a/examples/mplot3d/voxels.py b/examples/mplot3d/voxels.py
@@ -9,9 +9,6 @@
 import matplotlib.pyplot as plt
 import numpy as np
 
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
-
 
 # prepare some coordinates
 x, y, z = np.indices((8, 8, 8))
diff --git a/examples/mplot3d/voxels_numpy_logo.py b/examples/mplot3d/voxels_numpy_logo.py
@@ -8,9 +8,6 @@
 import matplotlib.pyplot as plt
 import numpy as np
 
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
-
 
 def explode(data):
     size = np.array(data.shape)*2
diff --git a/examples/mplot3d/voxels_rgb.py b/examples/mplot3d/voxels_rgb.py
@@ -9,9 +9,6 @@
 import matplotlib.pyplot as plt
 import numpy as np
 
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
-
 
 def midpoints(x):
     sl = ()
diff --git a/examples/mplot3d/voxels_torus.py b/examples/mplot3d/voxels_torus.py
@@ -10,9 +10,6 @@
 import matplotlib.colors
 import numpy as np
 
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
-
 
 def midpoints(x):
     sl = ()
diff --git a/examples/mplot3d/wire3d_animation_sgskip.py b/examples/mplot3d/wire3d_animation_sgskip.py
@@ -9,10 +9,6 @@
 intentionally takes a long time to run)
 """
 
-
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
-
 import matplotlib.pyplot as plt
 import numpy as np
 import time
diff --git a/examples/pyplots/whats_new_1_subplot3d.py b/examples/pyplots/whats_new_1_subplot3d.py
@@ -5,8 +5,6 @@
 
 Create two three-dimensional plots in the same figure.
 """
-# This import registers the 3D projection, but is otherwise unused.
-from mpl_toolkits.mplot3d import Axes3D  # noqa: F401 unused import
 
 from matplotlib import cm
 #from matplotlib.ticker import LinearLocator, FixedLocator, FormatStrFormatter
diff --git a/lib/matplotlib/projections/__init__.py b/lib/matplotlib/projections/__init__.py
@@ -70,3 +70,7 @@ def get_projection_names():
     Get a list of acceptable projection names.
     """
     return projection_registry.get_projection_names()
+
+
+# Register Axes3D.
+from mpl_toolkits import mplot3d as _  # noqa: F402 non-top-import.
