Fix docs : remove "if 1:" blocks in examples

abhinuvpitale · QuLogic · commit 5cbc0721be89 · 2018-09-27T00:47:06.000-04:00
* change proposed in issue #12191 removed the confusing if 1: as propsed in #12191 * change requested in #12191 * added main() to resolve comments from #12191 * update #12191 * flake-8 corrections #12191 * update ```plt.show``` for #12191 * flake8 update #12191 * Update demo_annotation_box.py * Update demo_agg_filter.py * Update patheffect_demo.py * Update demo_text_rotation_mode.py * Update demo_text_path.py * Update demo_curvelinear_grid.py * Update demo_curvelinear_grid2.py * flake8 compliant * flake8 compliant * flake8 compliant * Update patheffect_demo.py * Update demo_annotation_box.py * flake8 compliant * Update demo_text_rotation_mode.py * Update patheffect_demo.py * Update demo_annotation_box.py
diff --git a/examples/axisartist/demo_curvelinear_grid.py b/examples/axisartist/demo_curvelinear_grid.py
@@ -131,7 +131,7 @@ def curvelinear_test2(fig):
     ax1.grid(True, zorder=0)
 
 
-if 1:
+if __name__ == "__main__":
     fig = plt.figure(figsize=(7, 4))
 
     curvelinear_test1(fig)
diff --git a/examples/axisartist/demo_curvelinear_grid2.py b/examples/axisartist/demo_curvelinear_grid2.py
@@ -64,7 +64,7 @@ def inv_tr(x, y):
     grid_helper.grid_finder.grid_locator2._nbins = 6
 
 
-if 1:
+if __name__ == "__main__":
     fig = plt.figure(figsize=(7, 4))
     curvelinear_test1(fig)
     plt.show()
diff --git a/examples/misc/demo_agg_filter.py b/examples/misc/demo_agg_filter.py
@@ -307,7 +307,7 @@ def light_filter_pie(ax):
     shadow.set_zorder(pies[0][0].get_zorder() - 0.1)
 
 
-if 1:
+if __name__ == "__main__":
 
     plt.figure(figsize=(6, 6))
     plt.subplots_adjust(left=0.05, right=0.95)
diff --git a/examples/misc/patheffect_demo.py b/examples/misc/patheffect_demo.py
@@ -8,40 +8,39 @@
 import matplotlib.patheffects as PathEffects
 import numpy as np
 
-if 1:
-    plt.figure(figsize=(8, 3))
-    ax1 = plt.subplot(131)
-    ax1.imshow([[1, 2], [2, 3]])
-    txt = ax1.annotate("test", (1., 1.), (0., 0),
-                       arrowprops=dict(arrowstyle="->",
-                                       connectionstyle="angle3", lw=2),
-                       size=20, ha="center",
-                       path_effects=[PathEffects.withStroke(linewidth=3,
-                                                            foreground="w")])
-    txt.arrow_patch.set_path_effects([
-        PathEffects.Stroke(linewidth=5, foreground="w"),
-        PathEffects.Normal()])
-
-    pe = [PathEffects.withStroke(linewidth=3,
-                                 foreground="w")]
-    ax1.grid(True, linestyle="-", path_effects=pe)
-
-    ax2 = plt.subplot(132)
-    arr = np.arange(25).reshape((5, 5))
-    ax2.imshow(arr)
-    cntr = ax2.contour(arr, colors="k")
-
-    plt.setp(cntr.collections, path_effects=[
-        PathEffects.withStroke(linewidth=3, foreground="w")])
-
-    clbls = ax2.clabel(cntr, fmt="%2.0f", use_clabeltext=True)
-    plt.setp(clbls, path_effects=[
-        PathEffects.withStroke(linewidth=3, foreground="w")])
-
-    # shadow as a path effect
-    ax3 = plt.subplot(133)
-    p1, = ax3.plot([0, 1], [0, 1])
-    leg = ax3.legend([p1], ["Line 1"], fancybox=True, loc='upper left')
-    leg.legendPatch.set_path_effects([PathEffects.withSimplePatchShadow()])
-
-    plt.show()
+plt.figure(figsize=(8, 3))
+ax1 = plt.subplot(131)
+ax1.imshow([[1, 2], [2, 3]])
+txt = ax1.annotate("test", (1., 1.), (0., 0),
+                   arrowprops=dict(arrowstyle="->",
+                                   connectionstyle="angle3", lw=2),
+                   size=20, ha="center",
+                   path_effects=[PathEffects.withStroke(linewidth=3,
+                                                        foreground="w")])
+txt.arrow_patch.set_path_effects([
+    PathEffects.Stroke(linewidth=5, foreground="w"),
+    PathEffects.Normal()])
+
+pe = [PathEffects.withStroke(linewidth=3,
+                             foreground="w")]
+ax1.grid(True, linestyle="-", path_effects=pe)
+
+ax2 = plt.subplot(132)
+arr = np.arange(25).reshape((5, 5))
+ax2.imshow(arr)
+cntr = ax2.contour(arr, colors="k")
+
+plt.setp(cntr.collections, path_effects=[
+    PathEffects.withStroke(linewidth=3, foreground="w")])
+
+clbls = ax2.clabel(cntr, fmt="%2.0f", use_clabeltext=True)
+plt.setp(clbls, path_effects=[
+    PathEffects.withStroke(linewidth=3, foreground="w")])
+
+# shadow as a path effect
+ax3 = plt.subplot(133)
+p1, = ax3.plot([0, 1], [0, 1])
+leg = ax3.legend([p1], ["Line 1"], fancybox=True, loc='upper left')
+leg.legendPatch.set_path_effects([PathEffects.withSimplePatchShadow()])
+
+plt.show()
diff --git a/examples/text_labels_and_annotations/demo_annotation_box.py b/examples/text_labels_and_annotations/demo_annotation_box.py
@@ -13,86 +13,85 @@
 from matplotlib.cbook import get_sample_data
 
 
-if 1:
-    fig, ax = plt.subplots()
-
-    # Define a 1st position to annotate (display it with a marker)
-    xy = (0.5, 0.7)
-    ax.plot(xy[0], xy[1], ".r")
-
-    # Annotate the 1st position with a text box ('Test 1')
-    offsetbox = TextArea("Test 1", minimumdescent=False)
-
-    ab = AnnotationBbox(offsetbox, xy,
-                        xybox=(-20, 40),
-                        xycoords='data',
-                        boxcoords="offset points",
-                        arrowprops=dict(arrowstyle="->"))
-    ax.add_artist(ab)
-
-    # Annotate the 1st position with another text box ('Test')
-    offsetbox = TextArea("Test", minimumdescent=False)
-
-    ab = AnnotationBbox(offsetbox, xy,
-                        xybox=(1.02, xy[1]),
-                        xycoords='data',
-                        boxcoords=("axes fraction", "data"),
-                        box_alignment=(0., 0.5),
-                        arrowprops=dict(arrowstyle="->"))
-    ax.add_artist(ab)
-
-    # Define a 2nd position to annotate (don't display with a marker this time)
-    xy = [0.3, 0.55]
-
-    # Annotate the 2nd position with a circle patch
-    da = DrawingArea(20, 20, 0, 0)
-    p = Circle((10, 10), 10)
-    da.add_artist(p)
-
-    ab = AnnotationBbox(da, xy,
-                        xybox=(1.02, xy[1]),
-                        xycoords='data',
-                        boxcoords=("axes fraction", "data"),
-                        box_alignment=(0., 0.5),
-                        arrowprops=dict(arrowstyle="->"))
-
-    ax.add_artist(ab)
-
-    # Annotate the 2nd position with an image (a generated array of pixels)
-    arr = np.arange(100).reshape((10, 10))
-    im = OffsetImage(arr, zoom=2)
-    im.image.axes = ax
-
-    ab = AnnotationBbox(im, xy,
-                        xybox=(-50., 50.),
-                        xycoords='data',
-                        boxcoords="offset points",
-                        pad=0.3,
-                        arrowprops=dict(arrowstyle="->"))
-
-    ax.add_artist(ab)
-
-    # Annotate the 2nd position with another image (a Grace Hopper portrait)
-    fn = get_sample_data("grace_hopper.png", asfileobj=False)
-    arr_img = plt.imread(fn, format='png')
-
-    imagebox = OffsetImage(arr_img, zoom=0.2)
-    imagebox.image.axes = ax
-
-    ab = AnnotationBbox(imagebox, xy,
-                        xybox=(120., -80.),
-                        xycoords='data',
-                        boxcoords="offset points",
-                        pad=0.5,
-                        arrowprops=dict(
-                            arrowstyle="->",
-                            connectionstyle="angle,angleA=0,angleB=90,rad=3")
-                        )
-
-    ax.add_artist(ab)
-
-    # Fix the display limits to see everything
-    ax.set_xlim(0, 1)
-    ax.set_ylim(0, 1)
-
-    plt.show()
+fig, ax = plt.subplots()
+
+# Define a 1st position to annotate (display it with a marker)
+xy = (0.5, 0.7)
+ax.plot(xy[0], xy[1], ".r")
+
+# Annotate the 1st position with a text box ('Test 1')
+offsetbox = TextArea("Test 1", minimumdescent=False)
+
+ab = AnnotationBbox(offsetbox, xy,
+                    xybox=(-20, 40),
+                    xycoords='data',
+                    boxcoords="offset points",
+                    arrowprops=dict(arrowstyle="->"))
+ax.add_artist(ab)
+
+# Annotate the 1st position with another text box ('Test')
+offsetbox = TextArea("Test", minimumdescent=False)
+
+ab = AnnotationBbox(offsetbox, xy,
+                    xybox=(1.02, xy[1]),
+                    xycoords='data',
+                    boxcoords=("axes fraction", "data"),
+                    box_alignment=(0., 0.5),
+                    arrowprops=dict(arrowstyle="->"))
+ax.add_artist(ab)
+
+# Define a 2nd position to annotate (don't display with a marker this time)
+xy = [0.3, 0.55]
+
+# Annotate the 2nd position with a circle patch
+da = DrawingArea(20, 20, 0, 0)
+p = Circle((10, 10), 10)
+da.add_artist(p)
+
+ab = AnnotationBbox(da, xy,
+                    xybox=(1.02, xy[1]),
+                    xycoords='data',
+                    boxcoords=("axes fraction", "data"),
+                    box_alignment=(0., 0.5),
+                    arrowprops=dict(arrowstyle="->"))
+
+ax.add_artist(ab)
+
+# Annotate the 2nd position with an image (a generated array of pixels)
+arr = np.arange(100).reshape((10, 10))
+im = OffsetImage(arr, zoom=2)
+im.image.axes = ax
+
+ab = AnnotationBbox(im, xy,
+                    xybox=(-50., 50.),
+                    xycoords='data',
+                    boxcoords="offset points",
+                    pad=0.3,
+                    arrowprops=dict(arrowstyle="->"))
+
+ax.add_artist(ab)
+
+# Annotate the 2nd position with another image (a Grace Hopper portrait)
+fn = get_sample_data("grace_hopper.png", asfileobj=False)
+arr_img = plt.imread(fn, format='png')
+
+imagebox = OffsetImage(arr_img, zoom=0.2)
+imagebox.image.axes = ax
+
+ab = AnnotationBbox(imagebox, xy,
+                    xybox=(120., -80.),
+                    xycoords='data',
+                    boxcoords="offset points",
+                    pad=0.5,
+                    arrowprops=dict(
+                        arrowstyle="->",
+                        connectionstyle="angle,angleA=0,angleB=90,rad=3")
+                    )
+
+ax.add_artist(ab)
+
+# Fix the display limits to see everything
+ax.set_xlim(0, 1)
+ax.set_ylim(0, 1)
+
+plt.show()
diff --git a/examples/text_labels_and_annotations/demo_text_path.py b/examples/text_labels_and_annotations/demo_text_path.py
@@ -56,7 +56,7 @@ def draw(self, renderer=None):
         mpatches.PathPatch.draw(self, renderer)
 
 
-if 1:
+if __name__ == "__main__":
 
     usetex = plt.rcParams["text.usetex"]
 
diff --git a/examples/text_labels_and_annotations/demo_text_rotation_mode.py b/examples/text_labels_and_annotations/demo_text_rotation_mode.py
@@ -42,7 +42,7 @@ def test_rotation_mode(fig, mode, subplot_location):
             i += 1
 
 
-if 1:
+if __name__ == "__main__":
     import matplotlib.pyplot as plt
     fig = plt.figure(figsize=(5.5, 4))
     test_rotation_mode(fig, "default", 121)
