chore: update the commit hooks list (#268)

Author: 12rambau

.pre-commit-config.yaml

@@ -1,59 +1,41 @@
-ci:
-  autoupdate_schedule: monthly
-  autoupdate_commit_msg: "chore: update pre-commit hooks"
-
 repos:
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+  - repo: "https://github.com/psf/black"
+    rev: "22.3.0"
     hooks:
-      - id: check-case-conflict
-      - id: check-ast
-      - id: check-docstring-first
-      - id: check-executables-have-shebangs
-      - id: check-added-large-files
-      - id: check-case-conflict
-      - id: check-merge-conflict
-      - id: check-json
-      - id: check-toml
-      - id: check-yaml
-      - id: debug-statements
-      - id: end-of-file-fixer
-      - id: trailing-whitespace
+      - id: black
 
-  - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 0.27.1
+  - repo: "https://github.com/kynan/nbstripout"
+    rev: "0.5.0"
     hooks:
-      - id: check-github-workflows
+      - id: nbstripout
 
-  - repo: https://github.com/executablebooks/mdformat
-    rev: 0.7.17
+  - repo: "https://github.com/pre-commit/mirrors-prettier"
+    rev: "v2.7.1"
     hooks:
-      - id: mdformat
+      - id: prettier
+        exclude: tests\/test_.+\.
 
-  - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: "v3.0.3"
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: "v0.0.215"
     hooks:
-      - id: prettier
-        types_or: [yaml, html, json]
+      - id: ruff
 
-  - repo: https://github.com/codespell-project/codespell
-    rev: "v2.2.6"
+  - repo: https://github.com/PyCQA/doc8
+    rev: "v1.1.1"
     hooks:
-      - id: codespell
-        args: ["-L", "sur,nd"]
+      - id: doc8
 
-  - repo: https://github.com/pre-commit/pygrep-hooks
-    rev: "v1.10.0"
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.4
     hooks:
-      - id: rst-backticks
-      - id: rst-directive-colons
-      - id: rst-inline-touching-normal
+      - id: codespell
+        stages: [commit]
+        additional_dependencies:
+          - tomli
 
-  - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.1.5
+  # Prevent committing inline conflict markers
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
     hooks:
-      - id: ruff
-        types_or: [python, jupyter]
-        args: ["--fix", "--show-fixes"]
-      - id: ruff-format
-        types_or: [python, jupyter]
+      - id: check-merge-conflict
+        args: [--assume-in-merge]

jupyter_sphinx/__init__.py

@@ -29,9 +29,7 @@
 from .execute import ExecuteJupyterCells, JupyterKernel
 from .thebelab import ThebeButton, ThebeButtonNode, ThebeOutputNode, ThebeSourceNode
 
-REQUIRE_URL_DEFAULT = (
-    "https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"
-)
+REQUIRE_URL_DEFAULT = "https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"
 THEBELAB_URL_DEFAULT = "https://unpkg.com/thebelab@^0.4.0"
 
 logger = logging.getLogger(__name__)
@@ -93,29 +91,26 @@ def visit_thebe_source(self, node):
 
 # Sphinx callback functions
 def builder_inited(app: Sphinx):
-    """
+    """Init the build.
+
     2 cases
     case 1: ipywidgets 7, with require
-    case 2: ipywidgets 7, no require
+    case 2: ipywidgets 7, no require.
     """
     require_url = app.config.jupyter_sphinx_require_url
     if require_url:
         app.add_js_file(require_url)
         embed_url = (
-            app.config.jupyter_sphinx_embed_url
-            or ipywidgets.embed.DEFAULT_EMBED_REQUIREJS_URL
+            app.config.jupyter_sphinx_embed_url or ipywidgets.embed.DEFAULT_EMBED_REQUIREJS_URL
         )
     else:
-        embed_url = (
-            app.config.jupyter_sphinx_embed_url
-            or ipywidgets.embed.DEFAULT_EMBED_SCRIPT_URL
-        )
+        embed_url = app.config.jupyter_sphinx_embed_url or ipywidgets.embed.DEFAULT_EMBED_SCRIPT_URL
     if embed_url:
         app.add_js_file(embed_url)
 
 
 def copy_file(src: Path, dst: Path):
-    """wrapper of copy_asset_file to handle path"""
+    """Wrapper of copy_asset_file to handle path."""
     copy_asset_file(str(src.resolve()), str(dst.resolve()))
 
 

jupyter_sphinx/_version.py

@@ -1,7 +1,4 @@
-"""
-store the current version info of the project.
-
-"""
+"""store the current version info of the project."""
 import re
 from typing import List
 

jupyter_sphinx/ast.py

@@ -1,4 +1,4 @@
-"""Manipulating the Sphinx AST with Jupyter objects"""
+"""Manipulating the Sphinx AST with Jupyter objects."""
 
 import json
 import warnings
@@ -34,9 +34,7 @@ def load_content(cell, location, logger):
         env.note_dependency(rel_filename)
         if cell.content:
             logger.warning(
-                'Ignoring inline code in Jupyter cell included from "{}"'.format(
-                    rel_filename
-                ),
+                'Ignoring inline code in Jupyter cell included from "{}"'.format(rel_filename),
                 location=location,
             )
         try:
@@ -60,9 +58,7 @@ def get_highlights(cell, content, location, logger):
         hl_lines = parselinenos(emphasize_linespec, nlines)
         if any(i >= nlines for i in hl_lines):
             logger.warning(
-                "Line number spec is out of range(1-{}): {}".format(
-                    nlines, emphasize_linespec
-                ),
+                "Line number spec is out of range(1-{}): {}".format(nlines, emphasize_linespec),
                 location=location,
             )
         hl_lines = [i + 1 for i in hl_lines if i < nlines]
@@ -78,7 +74,7 @@ class JupyterCell(Directive):
     executed when the directive is parsed, but later during a doctree
     transformation.
 
-    Arguments
+    Arguments:
     ---------
     filename : str (optional)
         If provided, a path to a file containing code.
@@ -166,7 +162,7 @@ def run(self):
 class CellInput(Directive):
     """Define a code cell to be included verbatim but not executed.
 
-    Arguments
+    Arguments:
     ---------
     filename : str (optional)
         If provided, a path to a file containing code.
@@ -237,7 +233,7 @@ def run(self):
 class CellOutput(Directive):
     """Define an output cell to be included verbatim.
 
-    Arguments
+    Arguments:
     ---------
     filename : str (optional)
         If provided, a path to a file containing output.
@@ -323,12 +319,10 @@ def __init__(self, rawsource="", *children, **attributes):
         super().__init__("", *children, mimetypes=attributes["mimetypes"])
 
     def render_as(self, visitor):
-        """Determine which node to show based on the visitor"""
+        """Determine which node to show based on the visitor."""
         try:
             # Or should we go to config via the node?
-            priority = visitor.builder.env.app.config[
-                "render_priority_" + visitor.builder.format
-            ]
+            priority = visitor.builder.env.app.config["render_priority_" + visitor.builder.format]
         except (AttributeError, KeyError):
             # Not sure what do to, act as a container and show everything just in case.
             return super()
@@ -367,9 +361,7 @@ def __init__(self, rawsource="", *children, **attributes):
         super().__init__("", view_spec=attributes["view_spec"])
 
     def html(self):
-        return ipywidgets.embed.widget_view_template.format(
-            view_spec=json.dumps(self["view_spec"])
-        )
+        return ipywidgets.embed.widget_view_template.format(view_spec=json.dumps(self["view_spec"]))
 
 
 class JupyterWidgetStateNode(docutils.nodes.Element):
@@ -414,7 +406,7 @@ def cell_output_to_nodes(outputs, write_stderr, out_dir, thebe_config, inline=Fa
     inline: False
         Whether the nodes will be placed in-line with the text.
 
-    Returns
+    Returns:
     -------
     to_add : list of docutils nodes
         Each output, converted into a docutils node.
@@ -509,9 +501,7 @@ def output2sphinx(data, mime_type, metadata, out_dir, inline=False):
         math_node = math_block
 
     if mime_type == "text/html":
-        return docutils.nodes.raw(
-            text=data, format="html", classes=["output", "text_html"]
-        )
+        return docutils.nodes.raw(text=data, format="html", classes=["output", "text_html"])
     elif mime_type == "text/plain":
         return literal_node(
             text=data,

jupyter_sphinx/css/jupyter-sphinx.css

@@ -23,15 +23,14 @@ After a build, this stylesheet is loaded from ./_static/jupyter-sphinx.css .
 
 */
 
-
 div.jupyter_container {
-    padding: .4em;
-    margin: 0 0 .4em 0;
-    background-color: #FFFF;
-    border: 1px solid #CCC;
-    -moz-box-shadow: 2px 2px 4px rgba(87, 87, 87, 0.2);
-    -webkit-box-shadow: 2px 2px 4px rgba(87, 87, 87, 0.2);
-    box-shadow: 2px 2px 4px rgba(87, 87, 87, 0.2);
+  padding: 0.4em;
+  margin: 0 0 0.4em 0;
+  background-color: #ffff;
+  border: 1px solid #ccc;
+  -moz-box-shadow: 2px 2px 4px rgba(87, 87, 87, 0.2);
+  -webkit-box-shadow: 2px 2px 4px rgba(87, 87, 87, 0.2);
+  box-shadow: 2px 2px 4px rgba(87, 87, 87, 0.2);
 }
 .jupyter_container div.code_cell {
   border: 1px solid #cfcfcf;
@@ -59,8 +58,8 @@ div.jupyter_container div.highlight {
   background-color: #f7f7f7; /* for haiku */
 }
 div.jupyter_container {
-    padding: 0;
-    margin: 0;
+  padding: 0;
+  margin: 0;
 }
 
 /* Prevent alabaster breaking highlight alignment */
@@ -70,10 +69,10 @@ div.jupyter_container .hll {
 }
 
 /* overrides for sphinx_rtd_theme */
-.rst-content .jupyter_container div[class^='highlight'],
-.document .jupyter_container div[class^='highlight'],
+.rst-content .jupyter_container div[class^="highlight"],
+.document .jupyter_container div[class^="highlight"],
 .rst-content .jupyter_container pre.literal-block {
-  border:none;
+  border: none;
   margin: 0;
   padding: 0;
   background: none;
@@ -86,21 +85,21 @@ div.jupyter_container .hll {
   text-align: center;
 }
 .jupyter_container .stderr {
-    background-color: #FCC;
-    border: none;
-    padding: 3px;
+  background-color: #fcc;
+  border: none;
+  padding: 3px;
 }
 .jupyter_container .output {
-    border: none;
+  border: none;
 }
 .jupyter_container div.output pre {
-    background-color: white;
-    background: none;
-    padding: 4px;
-    border: none;
-    box-shadow: none;
-    -webkit-box-shadow: none; /* for nature */
-    -moz-box-shadow: none; /* for nature */
+  background-color: white;
+  background: none;
+  padding: 4px;
+  border: none;
+  box-shadow: none;
+  -webkit-box-shadow: none; /* for nature */
+  -moz-box-shadow: none; /* for nature */
 }
 .jupyter_container .code_cell td.linenos {
   text-align: right;
@@ -114,10 +113,10 @@ div.jupyter_container .hll {
 /* combine sequential jupyter cells,
    by moving sequential ones up higher on y-axis */
 div.jupyter_container + div.jupyter_container {
-    margin: -.5em 0 .4em 0;
+  margin: -0.5em 0 0.4em 0;
 }
 
 /* Fix for sphinx_rtd_theme spacing after jupyter_container #91 */
 .rst-content .jupyter_container {
-    margin: 0 0 24px 0;
+  margin: 0 0 24px 0;
 }

jupyter_sphinx/execute.py

@@ -65,7 +65,7 @@ def LoggerAdapterWrapper(logger_adapter):
 class JupyterKernel(Directive):
     """Specify a new Jupyter Kernel.
 
-    Arguments
+    Arguments:
     ---------
     kernel_name : str (optional)
         The name of the kernel in which to execute future Jupyter cells, as
@@ -166,16 +166,10 @@ def apply(self):
 
             # Raise error if cells raised exceptions and were not marked as doing so
             for node, cell in zip(nodes, notebook.cells):
-                errors = [
-                    output
-                    for output in cell.outputs
-                    if output["output_type"] == "error"
-                ]
+                errors = [output for output in cell.outputs if output["output_type"] == "error"]
                 allowed_errors = node.attributes.get("raises") or []
                 raises_provided = node.attributes["raises"] is not None
-                if (
-                    raises_provided and not allowed_errors
-                ):  # empty 'raises': suppress all errors
+                if raises_provided and not allowed_errors:  # empty 'raises': suppress all errors
                     pass
                 elif errors and not any(e["ename"] in allowed_errors for e in errors):
                     raise ExtensionError(
@@ -192,9 +186,7 @@ def apply(self):
                     if output["output_type"] == "stream" and output["name"] == "stderr"
                 ]
                 if stderr and not node.attributes["stderr"]:
-                    js.logger.warning(
-                        "Cell printed to stderr:\n{}".format(stderr[0]["text"])
-                    )
+                    js.logger.warning(f"Cell printed to stderr:\n{stderr[0]['text']}")
 
             # Insert input/output into placeholders for non-executed cells
             for node, cell in zip(nodes, notebook.cells):
@@ -224,9 +216,7 @@ def apply(self):
                 # The literal_block node with the source
                 source = node.children[0].children[0]
                 nlines = source.rawsource.count("\n") + 1
-                show_numbering = (
-                    linenos_config or source["linenos"] or source["linenostart"]
-                )
+                show_numbering = linenos_config or source["linenos"] or source["linenostart"]
 
                 if show_numbering:
                     source["linenos"] = True
@@ -251,9 +241,7 @@ def apply(self):
             # Write certain cell outputs (e.g. images) to separate files, and
             # modify the metadata of the associated cells in 'notebook' to
             # include the path to the output file.
-            write_notebook_output(
-                notebook, str(output_dir), file_name, self.env.docname
-            )
+            write_notebook_output(notebook, str(output_dir), file_name, self.env.docname)
 
             try:
                 cm_language = notebook.metadata.language_info.codemirror_mode.name