Merge branch 'main' of github.com:jupyter-server/jupyter_server

.github/workflows/python-tests.yml

@@ -79,8 +79,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 -v .

.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
@@ -28,14 +29,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]"]

CHANGELOG.md

@@ -271,7 +271,7 @@ All notable changes to this project will be documented in this file.
 
 ### Bugs fixed
 
-- Reapply preferred_dir fix, now with better backwards compatability [#1162](https://github.com/jupyter-server/jupyter_server/pull/1162) ([@vidartf](https://github.com/vidartf))
+- Reapply preferred_dir fix, now with better backwards compatibility [#1162](https://github.com/jupyter-server/jupyter_server/pull/1162) ([@vidartf](https://github.com/vidartf))
 
 ### Maintenance and upkeep improvements
 
@@ -1055,7 +1055,7 @@ All notable changes to this project will be documented in this file.
 
 ### Bugs fixed
 
-- Regression in connection URL calcuation in ServerApp [#761](https://github.com/jupyter-server/jupyter_server/pull/761) ([@jhamet93](https://github.com/jhamet93))
+- Regression in connection URL calculation in ServerApp [#761](https://github.com/jupyter-server/jupyter_server/pull/761) ([@jhamet93](https://github.com/jhamet93))
 - Include explicit package data [#757](https://github.com/jupyter-server/jupyter_server/pull/757) ([@blink1073](https://github.com/blink1073))
 - Ensure terminal cwd exists [#755](https://github.com/jupyter-server/jupyter_server/pull/755) ([@fcollonval](https://github.com/fcollonval))
 - make 'cwd' param for TerminalManager absolute [#749](https://github.com/jupyter-server/jupyter_server/pull/749) ([@rccern](https://github.com/rccern))
@@ -1947,7 +1947,7 @@ This was a broken release and was yanked from PyPI.
 
 ### Added
 
-- ([#191](https://github.com/jupyter/jupyter_server/pull/191)) Async kernel managment is now possible using the `AsyncKernelManager` from `jupyter_client`
+- ([#191](https://github.com/jupyter/jupyter_server/pull/191)) Async kernel management is now possible using the `AsyncKernelManager` from `jupyter_client`
 - ([#201](https://github.com/jupyter/jupyter_server/pull/201)) Parameters can now be passed to new terminals created by the `terminals` REST API.
 
 ### Changed

CONTRIBUTING.rst

@@ -40,11 +40,11 @@ from any directory in your system with::
 
 Code Styling and Quality Checks
 -------------------------------
-`jupyter_server` has adopted automatic code formatting so you shouldn't
+``jupyter_server`` has adopted automatic code formatting so you shouldn't
 need to worry too much about your code style.
 As long as your code is valid,
 the pre-commit hook should take care of how it should look.
-`pre-commit` and its associated hooks will automatically be installed when
+``pre-commit`` and its associated hooks will automatically be installed when
 you run ``pip install -e ".[test]"``
 
 To install ``pre-commit`` hook manually, run the following::

docs/source/conf.py

@@ -44,7 +44,7 @@
 ]
 
 try:
-    import enchant  # type:ignore  # noqa
+    import enchant  # type:ignore[import]  # noqa
 
     extensions += ["sphinxcontrib.spelling"]
 except ImportError:

docs/source/developers/contents.rst

@@ -109,39 +109,39 @@ model. There are three model types: **notebook**, **file**, and **directory**.
 
     # Notebook Model with Content
     {
-        'content': {
-            'metadata': {},
-            'nbformat': 4,
-            'nbformat_minor': 0,
-            'cells': [
+        "content": {
+            "metadata": {},
+            "nbformat": 4,
+            "nbformat_minor": 0,
+            "cells": [
                 {
-                    'cell_type': 'markdown',
-                    'metadata': {},
-                    'source': 'Some **Markdown**',
+                    "cell_type": "markdown",
+                    "metadata": {},
+                    "source": "Some **Markdown**",
                 },
             ],
         },
-        'created': datetime(2015, 7, 25, 19, 50, 19, 19865),
-        'format': 'json',
-        'last_modified': datetime(2015, 7, 25, 19, 50, 19, 19865),
-        'mimetype': None,
-        'name': 'a.ipynb',
-        'path': 'foo/a.ipynb',
-        'type': 'notebook',
-        'writable': True,
+        "created": datetime(2015, 7, 25, 19, 50, 19, 19865),
+        "format": "json",
+        "last_modified": datetime(2015, 7, 25, 19, 50, 19, 19865),
+        "mimetype": None,
+        "name": "a.ipynb",
+        "path": "foo/a.ipynb",
+        "type": "notebook",
+        "writable": True,
     }
 
     # Notebook Model without Content
     {
-        'content': None,
-        'created': datetime.datetime(2015, 7, 25, 20, 17, 33, 271931),
-        'format': None,
-        'last_modified': datetime.datetime(2015, 7, 25, 20, 17, 33, 271931),
-        'mimetype': None,
-        'name': 'a.ipynb',
-        'path': 'foo/a.ipynb',
-        'type': 'notebook',
-        'writable': True
+        "content": None,
+        "created": datetime.datetime(2015, 7, 25, 20, 17, 33, 271931),
+        "format": None,
+        "last_modified": datetime.datetime(2015, 7, 25, 20, 17, 33, 271931),
+        "mimetype": None,
+        "name": "a.ipynb",
+        "path": "foo/a.ipynb",
+        "type": "notebook",
+        "writable": True,
     }
 
 
@@ -227,21 +227,28 @@ return for a more complete implementation.
 
     class NoOpCheckpoints(GenericCheckpointsMixin, Checkpoints):
         """requires the following methods:"""
+
         def create_file_checkpoint(self, content, format, path):
-            """ -> checkpoint model"""
+            """-> checkpoint model"""
+
         def create_notebook_checkpoint(self, nb, path):
-            """ -> checkpoint model"""
+            """-> checkpoint model"""
+
         def get_file_checkpoint(self, checkpoint_id, path):
-            """ -> {'type': 'file', 'content': <str>, 'format': {'text', 'base64'}}"""
+            """-> {'type': 'file', 'content': <str>, 'format': {'text', 'base64'}}"""
+
         def get_notebook_checkpoint(self, checkpoint_id, path):
-            """ -> {'type': 'notebook', 'content': <output of nbformat.read>}"""
+            """-> {'type': 'notebook', 'content': <output of nbformat.read>}"""
+
         def delete_checkpoint(self, checkpoint_id, path):
             """deletes a checkpoint for a file"""
+
         def list_checkpoints(self, path):
             """returns a list of checkpoint models for a given file,
             default just does one per file
             """
             return []
+
         def rename_checkpoint(self, checkpoint_id, old_path, new_path):
             """renames checkpoint from old path to new path"""