-
Notifications
You must be signed in to change notification settings - Fork 5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Backport PR #7244 on branch 7.0.x (Add documentation for updating `no…
…tebook` imports) (#7245) * Backport PR #7244: Add documentation for updating `notebook` imports * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: Jeremy Tuloup <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
- Loading branch information
1 parent
9d2cbd8
commit 99db942
Showing
3 changed files
with
44 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Server Imports in Notebook 7 | ||
|
||
Notebook 7 is now based on Jupyter Server, which lets users run multiple Jupyter frontends (e.g. Notebook, JupyterLab, NBClassic, etc.) on the same server. | ||
|
||
Prior to Notebook 7, the Classic Notebook server included the server modules in the `notebook` package. This means it was possible to import the server modules from the `notebook` package, for example: | ||
|
||
```python | ||
from notebook.auth import passwd | ||
|
||
passwd("foo") | ||
``` | ||
|
||
Or: | ||
|
||
```python | ||
from notebook import notebookapp | ||
|
||
notebookapp.list_running_servers() | ||
``` | ||
|
||
In Notebook 7, these server modules are now exposed by the `jupyter_server` package. The code snippets above should be updated to: | ||
|
||
```python | ||
from jupyter_server.auth import passwd | ||
|
||
passwd("foo") | ||
``` | ||
|
||
And: | ||
|
||
```python | ||
from jupyter_server import serverapp | ||
|
||
serverapp.list_running_servers() | ||
``` | ||
|
||
These are just examples, so you may have to adjust your use of `notebook` imports based on the specific server modules you were using. |