T260: Add a pre-commit hook for cleaning ipynb files (#260)

* Add a pre-commit hook for cleaning ipynb files Add a Python script that cleans ipynb files by resetting execution counts, removing outputs, and removing metadata. Add the script as a pre-commit hook. This commit also contains the results of running the hook on all the existing ipynb files in the repository. * Include path name when cleanipynb.py fails * Improve cleanipynb hooks Extend cleanipynb with an argument that allows leaving output cells as-is, and pass this argument when processing notebook files that are immediate descendents of the notebooks/ folder so that example outputs are retained but metadata are removed. Another hook runs for notebooks in the notebooks/helpers/ folder so that both outputs and metadata are removed. * Incorporate feedback 1. Reset execution counts to "null" when removing outputs and to an increasing integer series starting from one when leaving outputs. 2. Checkout all example notebooks (notebooks\*.ipynb) from develop to make sure no other changes beyond the final cleanipynb behavior were made. 3. Fix a bug in .pre-commit-config.yml where both cleanipynb hooks would be run for files in the notebooks\helpers\ folder. * Fix documentation build Link to the docs for the currently-running version of Python during the doc build.
ansys · May 11, 2023 · 2967f11 · 2967f11
1 parent 7f9a44e
commit 2967f11
Show file tree

Hide file tree

Showing 13 changed files with 108 additions and 216 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -52,3 +52,18 @@ repos:
         ^src/ansys/api/|
         ^protos
       )
+
+- repo: local
+  hooks:
+    - id: cleanipynb-helpers
+      name: cleanipynb-helpers
+      language: system
+      entry: python scripts/cleanipynb.py
+      files: notebooks/helpers/[^/]*\.ipynb$
+
+    - id: cleanipynb
+      name: cleanipynb
+      language: system
+      entry: python scripts/cleanipynb.py
+      args: [--leave-outputs]
+      files: notebooks/[^/]*\.ipynb$
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -1,6 +1,7 @@
 """Sphinx documentation configuration file."""
 from datetime import datetime
 import os
+import sys
 
 from ansys_sphinx_theme import ansys_favicon, get_version_match, pyansys_logo_black
 
@@ -56,7 +57,7 @@
 
 # Intersphinx mapping
 intersphinx_mapping = {
-    "python": ("https://docs.python.org/dev", None),
+    "python": (f"https://docs.python.org/{'.'.join((str(i) for i in sys.version_info[:2]))}", None),
     # kept here as an example
     # "scipy": ("https://docs.scipy.org/doc/scipy/reference", None),
     # "numpy": ("https://numpy.org/devdocs", None),

diff --git a/notebooks/3d_comp_placement.ipynb b/notebooks/3d_comp_placement.ipynb
@@ -91,25 +91,7 @@
    ]
   }
  ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.7.0"
-  }
- },
+ "metadata": {},
  "nbformat": 4,
  "nbformat_minor": 5
-}
+}
diff --git a/notebooks/Cutout_region.ipynb b/notebooks/Cutout_region.ipynb
@@ -248,25 +248,7 @@
    ]
   }
  ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.7.0"
-  }
- },
+ "metadata": {},
  "nbformat": 4,
  "nbformat_minor": 5
-}
+}
diff --git a/notebooks/Define_and_assign_bondwire_profiles.ipynb b/notebooks/Define_and_assign_bondwire_profiles.ipynb
@@ -12,9 +12,7 @@
    "cell_type": "code",
    "execution_count": 1,
    "id": "87bc6dac",
-   "metadata": {
-    "scrolled": true
-   },
+   "metadata": {},
    "outputs": [
     {
      "name": "stdout",
@@ -298,25 +296,7 @@
    ]
   }
  ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.7.0"
-  }
- },
+ "metadata": {},
  "nbformat": 4,
  "nbformat_minor": 5
-}
+}
diff --git a/notebooks/Move_geometry_from_existing_layer_to_new_layer.ipynb b/notebooks/Move_geometry_from_existing_layer_to_new_layer.ipynb
@@ -12,9 +12,7 @@
    "cell_type": "code",
    "execution_count": 1,
    "id": "87bc6dac",
-   "metadata": {
-    "scrolled": true
-   },
+   "metadata": {},
    "outputs": [
     {
      "name": "stdout",
@@ -177,25 +175,7 @@
    ]
   }
  ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.7.0"
-  }
- },
+ "metadata": {},
  "nbformat": 4,
  "nbformat_minor": 5
-}
+}
diff --git a/notebooks/PolygonOperations.ipynb b/notebooks/PolygonOperations.ipynb
@@ -4,9 +4,7 @@
    "cell_type": "code",
    "execution_count": 1,
    "id": "cd7e721c",
-   "metadata": {
-    "scrolled": true
-   },
+   "metadata": {},
    "outputs": [
     {
      "name": "stdout",
@@ -113,25 +111,7 @@
    ]
   }
  ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.7.0"
-  }
- },
+ "metadata": {},
  "nbformat": 4,
  "nbformat_minor": 5
-}
+}
diff --git a/notebooks/Remove_all_geometry_and_layers_below_L2.ipynb b/notebooks/Remove_all_geometry_and_layers_below_L2.ipynb
@@ -12,9 +12,7 @@
    "cell_type": "code",
    "execution_count": 1,
    "id": "87bc6dac",
-   "metadata": {
-    "scrolled": true
-   },
+   "metadata": {},
    "outputs": [
     {
      "name": "stdout",
@@ -263,25 +261,7 @@
    ]
   }
  ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.7.0"
-  }
- },
+ "metadata": {},
  "nbformat": 4,
  "nbformat_minor": 5
-}
+}
diff --git a/notebooks/helpers/example_setup.ipynb b/notebooks/helpers/example_setup.ipynb
@@ -100,25 +100,7 @@
    ]
   }
  ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.7.0"
-  }
- },
+ "metadata": {},
  "nbformat": 4,
  "nbformat_minor": 5
-}
+}
diff --git a/notebooks/helpers/example_teardown.ipynb b/notebooks/helpers/example_teardown.ipynb
@@ -34,25 +34,7 @@
    ]
   }
  ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.7.0"
-  }
- },
+ "metadata": {},
  "nbformat": 4,
  "nbformat_minor": 5
-}
+}
diff --git a/notebooks/helpers/plot.ipynb b/notebooks/helpers/plot.ipynb
@@ -97,25 +97,7 @@
    ]
   }
  ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.7.0"
-  }
- },
+ "metadata": {},
  "nbformat": 4,
  "nbformat_minor": 5
-}
+}
diff --git a/notebooks/template.ipynb b/notebooks/template.ipynb
@@ -2,7 +2,7 @@
  "cells": [
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 1,
    "id": "cd7e721c",
    "metadata": {},
    "outputs": [],
@@ -12,7 +12,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 2,
    "id": "abd5a80d",
    "metadata": {},
    "outputs": [],
@@ -22,7 +22,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 3,
    "id": "3290a8f6",
    "metadata": {},
    "outputs": [],
@@ -31,25 +31,7 @@
    ]
   }
  ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.7.0"
-  }
- },
+ "metadata": {},
  "nbformat": 4,
  "nbformat_minor": 5
-}
+}