Use sp-repo-review (#1146)

Author: blink1073

.github/workflows/ci.yml

@@ -81,8 +81,8 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
-      -  name: Run Linters
-         run: |
+      - name: Run Linters
+        run: |
           hatch run typing:test
           hatch run lint:style
           pipx run interrogate -vv .

.pre-commit-config.yaml

@@ -1,5 +1,6 @@
 ci:
   autoupdate_schedule: monthly
+  autoupdate_commit_msg: "chore: update pre-commit hooks"
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
@@ -29,14 +30,47 @@ repos:
     rev: 0.7.17
     hooks:
       - id: mdformat
+        additional_dependencies:
+          [mdformat-gfm, mdformat-frontmatter, mdformat-footnote]
 
-  - repo: https://github.com/psf/black
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: "v3.0.2"
+    hooks:
+      - id: prettier
+        types_or: [yaml, html, json]
+
+  - repo: https://github.com/adamchainz/blacken-docs
+    rev: "1.16.0"
+    hooks:
+      - id: blacken-docs
+        additional_dependencies: [black==23.7.0]
+
+  - repo: https://github.com/psf/black-pre-commit-mirror
     rev: 23.7.0
     hooks:
       - id: black
 
+  - repo: https://github.com/codespell-project/codespell
+    rev: "v2.2.5"
+    hooks:
+      - id: codespell
+        args: ["-L", "sur,nd"]
+
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: "v1.10.0"
+    hooks:
+      - id: rst-backticks
+      - id: rst-directive-colons
+      - id: rst-inline-touching-normal
+
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.0.287
     hooks:
       - id: ruff
-        args: ["--fix"]
+        args: ["--fix", "--show-fixes"]
+
+  - repo: https://github.com/scientific-python/cookie
+    rev: "2023.08.23"
+    hooks:
+      - id: sp-repo-review
+        additional_dependencies: ["repo-review[cli]"]

examples/embedding/inprocess_qtconsole.py

@@ -19,7 +19,7 @@ def init_asyncio_patch():
     asyncio implementation on Windows
     Pick the older SelectorEventLoopPolicy on Windows
     if the known-incompatible default policy is in use.
-    do this as early as possible to make it a low priority and overrideable
+    do this as early as possible to make it a low priority and overridable
     ref: https://github.com/tornadoweb/tornado/issues/2608
     FIXME: if/when tornado supports the defaults in asyncio,
            remove and bump tornado requirement for py38

examples/embedding/inprocess_terminal.py

@@ -19,7 +19,7 @@ def init_asyncio_patch():
     asyncio implementation on Windows
     Pick the older SelectorEventLoopPolicy on Windows
     if the known-incompatible default policy is in use.
-    do this as early as possible to make it a low priority and overrideable
+    do this as early as possible to make it a low priority and overridable
     ref: https://github.com/tornadoweb/tornado/issues/2608
     FIXME: if/when tornado supports the defaults in asyncio,
            remove and bump tornado requirement for py38

ipykernel/debugger.py

@@ -40,7 +40,7 @@
         raise e
 
 
-# Required for backwards compatiblity
+# Required for backwards compatibility
 ROUTING_ID = getattr(zmq, "ROUTING_ID", None) or zmq.IDENTITY
 
 
@@ -644,7 +644,7 @@ async def richInspectVariables(self, message):
         repr_data = {}
         repr_metadata = {}
         if not self.stopped_threads:
-            # The code did not hit a breakpoint, we use the intepreter
+            # The code did not hit a breakpoint, we use the interpreter
             # to get the rich representation of the variable
             result = get_ipython().user_expressions({var_name: var_name})[var_name]
             if result.get("status", "error") == "ok":

ipykernel/eventloops.py

@@ -429,7 +429,7 @@ async def close_loop():
         close_loop()
 
     elif not loop.is_closed():
-        loop.run_until_complete(close_loop)  # type:ignore
+        loop.run_until_complete(close_loop)  # type:ignore[arg-type]
         loop.close()
 
 
@@ -566,8 +566,12 @@ def enable_gui(gui, kernel=None):
             make_qt_app_for_kernel(gui, kernel)
 
     loop = loop_map[gui]
-    if loop and kernel.eventloop is not None and kernel.eventloop is not loop:
-        msg = "Cannot activate multiple GUI eventloops"
+    if (
+        loop
+        and kernel.eventloop is not None
+        and kernel.eventloop is not loop  # type:ignore[unreachable]
+    ):
+        msg = "Cannot activate multiple GUI eventloops"  # type:ignore[unreachable]
         raise RuntimeError(msg)
     kernel.eventloop = loop
     # We set `eventloop`; the function the user chose is executed in `Kernel.enter_eventloop`, thus

ipykernel/inprocess/channels.py

@@ -18,7 +18,7 @@ class InProcessChannel:
     proxy_methods: List[object] = []
 
     def __init__(self, client=None):
-        """Initialze the channel."""
+        """Initialize the channel."""
         super().__init__()
         self.client = client
         self._is_alive = False

ipykernel/inprocess/client.py

@@ -193,7 +193,7 @@ def _dispatch_to_kernel(self, msg):
             dispatch_shell = run_sync(kernel.dispatch_shell)
             dispatch_shell(msg_parts)
         else:
-            loop = asyncio.get_event_loop()
+            loop = asyncio.get_event_loop()  # type:ignore[unreachable]
             loop.run_until_complete(kernel.dispatch_shell(msg_parts))
         idents, reply_msg = self.session.recv(stream, copy=False)
         self.shell_channel.call_handlers_later(reply_msg)

ipykernel/inprocess/ipkernel.py

@@ -111,7 +111,7 @@ def _input_request(self, prompt, ident, parent, password=False):
         # Await a response.
         while self.raw_input_str is None:
             frontend.stdin_channel.process_events()
-        return self.raw_input_str
+        return self.raw_input_str  # type:ignore[unreachable]
 
     # -------------------------------------------------------------------------
     # Protected interface

ipykernel/iostream.py

@@ -93,7 +93,7 @@ def _start_event_gc():
         if self._event_pipe_gc_task is not None:
             # cancel gc task to avoid pending task warnings
             async def _cancel():
-                self._event_pipe_gc_task.cancel()  # type:ignore
+                self._event_pipe_gc_task.cancel()  # type:ignore[union-attr]
 
             if not self._stopped:
                 self.io_loop.run_sync(_cancel)
@@ -373,7 +373,7 @@ def fileno(self):
 
     def _watch_pipe_fd(self):
         """
-        We've redirected standards steams 0 and 1 into a pipe.
+        We've redirected standards streams 0 and 1 into a pipe.
 
         We need to watch in a thread and redirect them to the right places.
 
@@ -424,7 +424,7 @@ def __init__(
             that will swap the give file descriptor for a pipe, read from the
             pipe, and insert this into the current Stream.
         isatty : bool (default, False)
-            Indication of whether this stream has termimal capabilities (e.g. can handle colors)
+            Indication of whether this stream has terminal capabilities (e.g. can handle colors)
 
         """
         if pipe is not None:
@@ -634,7 +634,7 @@ def write(self, string: str) -> Optional[int]:  # type:ignore[override]
         """
 
         if not isinstance(string, str):
-            msg = f"write() argument must be str, not {type(string)}"
+            msg = f"write() argument must be str, not {type(string)}"  # type:ignore[unreachable]
             raise TypeError(msg)
 
         if self.echo is not None: