Skip to content

Fix outdated ContentsManager testing guidance #1611

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
terminalchai wants to merge 2 commits into
base: main
Choose a base branch
from
+11 −9
Open

Fix outdated ContentsManager testing guidance #1611

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
faf85d8
docs: fix contents manager testing guidance
terminalchai Mar 22, 2026
78aca08
Merge branch 'main' into docs/fix-contents-testing-docs
Zsailer Apr 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions docs/source/developers/contents.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,19 +278,21 @@ for a more complete example.

Testing
-------
.. currentmodule:: jupyter_server.services.contents.tests

:mod:`jupyter_server.services.contents.tests` includes several test suites written
against the abstract Contents API. This means that an excellent way to test a
new ContentsManager subclass is to subclass our tests to make them use your
ContentsManager.
Jupyter Server's ContentsManager test suites live in the
`tests/services/contents <https://github.com/jupyter-server/jupyter_server/tree/main/tests/services/contents>`_
directory in the source repository rather than in an importable
``jupyter_server.services.contents.tests`` module. This means that an
excellent way to test a new ``ContentsManager`` subclass is to copy or adapt
the relevant tests from the repository so that they use your
``ContentsManager`` implementation.

.. note::

PGContents_ is an example of a complete implementation of a custom
``ContentsManager``. It stores notebooks and files in PostgreSQL_ and encodes
directories as SQL relations. PGContents also provides an example of how to
reuse the notebook's tests.
PGContents_ is an example of a complete implementation of a custom
``ContentsManager``. It stores notebooks and files in PostgreSQL_, encodes
directories as SQL relations, and shows how to adapt Jupyter Server's tests
for a custom backend.

.. _NBFormat: https://nbformat.readthedocs.io/en/latest/index.html
.. _PGContents: https://github.com/quantopian/pgcontents
Expand Down
Loading