Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: jupyter-server/jupyter_server
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v1.16.0
Choose a base ref
...
head repository: jupyter-server/jupyter_server
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 2b296099777d50aa86f67faf94d5cbfde906b169
Choose a head ref
  • 18 commits
  • 81 files changed
  • 10 contributors

Commits on Mar 29, 2022

  1. Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    f28d2f7 View commit details

Commits on Mar 31, 2022

  1. Copy the full SHA
    45ce912 View commit details
  2. Copy the full SHA
    25ec3ed View commit details

Commits on Apr 2, 2022

  1. Add explicit handling of warnings (#771)

    * add explicit handling of warnings
    
    * ignore warning on min version test
    
    * fix process shutdown
    
    * fix remaining warnings
    
    * fixup
    
    * add cleanup_suprocesses
    blink1073 authored Apr 2, 2022
    Copy the full SHA
    f6f8c3f View commit details
  2. update some metadata fields, sort deps (#675)

    Co-authored-by: Steven Silvester <steven.silvester@ieee.org>
    bollwyvl and blink1073 authored Apr 2, 2022
    Copy the full SHA
    36489e3 View commit details
  3. Copy the full SHA
    35e24f7 View commit details

Commits on Apr 4, 2022

  1. [pre-commit.ci] pre-commit autoupdate (#775)

    Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
    pre-commit-ci[bot] authored Apr 4, 2022
    Copy the full SHA
    5f7bcdd View commit details

Commits on Apr 5, 2022

  1. Copy the full SHA
    77be2f5 View commit details

Commits on Apr 8, 2022

  1. Copy the full SHA
    02e5f3a View commit details
  2. Copy the full SHA
    80ac07e View commit details
  3. Copy the full SHA
    3e1ba01 View commit details

Commits on Apr 11, 2022

  1. [pre-commit.ci] pre-commit autoupdate (#785)

    Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
    pre-commit-ci[bot] authored Apr 11, 2022
    Copy the full SHA
    cc8bdf4 View commit details

Commits on Apr 12, 2022

  1. Copy the full SHA
    64555ff View commit details

Commits on Apr 20, 2022

  1. Copy the full SHA
    e1720c8 View commit details
  2. Backport PR #793 on branch 1.x ([pre-commit.ci] pre-commit autoupdate) (

    #795)
    
    Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
    meeseeksmachine and pre-commit-ci[bot] authored Apr 20, 2022
    Copy the full SHA
    bb677f5 View commit details

Commits on Apr 25, 2022

  1. Backport PR #798 on branch 1.x (missing required arguments in utils.f…

    …etch) (#799)
    
    Co-authored-by: Min RK <benjaminrk@gmail.com>
    meeseeksmachine and minrk authored Apr 25, 2022
    Copy the full SHA
    ffa9848 View commit details

Commits on Apr 26, 2022

  1. Backport PR #804 on branch 1.x (Add the root_dir value to the logging…

    … message in case of non compliant preferred_dir) (#805)
    
    Co-authored-by: Eric Charles <eric@datalayer.io>
    meeseeksmachine and echarles authored Apr 26, 2022
    Copy the full SHA
    1f5f64b View commit details
  2. Backport PR #797 on branch 1.x (Add helper jobs for branch protection) (

    #807)
    
    Co-authored-by: Steven Silvester <steven.silvester@ieee.org>
    meeseeksmachine and blink1073 authored Apr 26, 2022
    Copy the full SHA
    2b29609 View commit details
Showing with 500 additions and 405 deletions.
  1. +1 −2 .github/workflows/check-release.yml
  2. +2 −0 .github/workflows/enforce-label.yml
  3. +13 −2 .github/workflows/integration-tests.yml
  4. +44 −31 .github/workflows/python-tests.yml
  5. +0 −27 .github/workflows/trigger_precommit.yml
  6. +20 −7 .pre-commit-config.yaml
  7. +4 −1 CONTRIBUTING.rst
  8. +5 −5 README.md
  9. +1 −1 docs/README.md
  10. +0 −1 docs/source/conf.py
  11. +16 −4 docs/source/contributors/team-meetings.rst
  12. +9 −3 docs/source/developers/dependency.rst
  13. +39 −11 docs/source/developers/extensions.rst
  14. +12 −0 docs/source/developers/savehooks.rst
  15. +4 −1 docs/source/developers/websocket-protocols.rst
  16. +1 −1 docs/source/index.rst
  17. +6 −2 docs/source/operators/configuring-extensions.rst
  18. +6 −2 docs/source/operators/multiple-extensions.rst
  19. +6 −6 docs/source/operators/public-server.rst
  20. +5 −1 docs/source/other/full-config.rst
  21. +4 −1 docs/source/users/configuration.rst
  22. +3 −1 docs/source/users/index.rst
  23. +4 −1 docs/source/users/installation.rst
  24. +7 −2 docs/source/users/launching.rst
  25. +7 −7 examples/simple/simple_ext1/application.py
  26. +6 −6 examples/simple/simple_ext1/handlers.py
  27. +3 −3 examples/simple/simple_ext11/application.py
  28. +1 −1 examples/simple/simple_ext2/application.py
  29. +3 −3 examples/simple/simple_ext2/handlers.py
  30. +2 −2 examples/simple/tests/test_handlers.py
  31. +0 −1 jupyter_server/_sysinfo.py
  32. +0 −1 jupyter_server/_tz.py
  33. +1 −1 jupyter_server/_version.py
  34. +1 −1 jupyter_server/auth/login.py
  35. +2 −3 jupyter_server/auth/security.py
  36. +21 −24 jupyter_server/base/handlers.py
  37. +3 −4 jupyter_server/base/zmqhandlers.py
  38. +2 −8 jupyter_server/config_manager.py
  39. +8 −8 jupyter_server/extension/application.py
  40. +4 −4 jupyter_server/extension/handler.py
  41. +4 −4 jupyter_server/extension/manager.py
  42. +12 −13 jupyter_server/extension/serverextension.py
  43. +1 −1 jupyter_server/files/handlers.py
  44. +1 −1 jupyter_server/gateway/gateway_client.py
  45. +11 −15 jupyter_server/gateway/handlers.py
  46. +7 −8 jupyter_server/gateway/managers.py
  47. +2 −3 jupyter_server/i18n/__init__.py
  48. +1 −1 jupyter_server/nbconvert/handlers.py
  49. +1 −1 jupyter_server/prometheus/log_functions.py
  50. +5 −5 jupyter_server/pytest_plugin.py
  51. +20 −19 jupyter_server/serverapp.py
  52. +1 −1 jupyter_server/services/contents/checkpoints.py
  53. +1 −1 jupyter_server/services/contents/filecheckpoints.py
  54. +9 −10 jupyter_server/services/contents/fileio.py
  55. +8 −10 jupyter_server/services/contents/filemanager.py
  56. +4 −4 jupyter_server/services/contents/handlers.py
  57. +10 −19 jupyter_server/services/contents/largefilemanager.py
  58. +8 −8 jupyter_server/services/contents/manager.py
  59. +12 −12 jupyter_server/services/kernels/handlers.py
  60. +1 −1 jupyter_server/services/sessions/sessionmanager.py
  61. +3 −4 jupyter_server/terminal/handlers.py
  62. +2 −2 jupyter_server/terminal/terminalmanager.py
  63. +1 −1 jupyter_server/traittypes.py
  64. +8 −4 jupyter_server/utils.py
  65. +0 −1 jupyter_server/view/handlers.py
  66. +12 −1 pyproject.toml
  67. +27 −19 setup.cfg
  68. +3 −0 tests/auth/test_authorizer.py
  69. +2 −2 tests/extension/test_app.py
  70. +5 −0 tests/extension/test_launch.py
  71. +3 −4 tests/extension/test_serverextension.py
  72. +0 −1 tests/nbconvert/test_handlers.py
  73. +7 −7 tests/services/contents/test_api.py
  74. +9 −10 tests/services/contents/test_fileio.py
  75. +5 −5 tests/services/contents/test_manager.py
  76. +0 −6 tests/services/kernelspecs/test_api.py
  77. +1 −1 tests/services/sessions/test_api.py
  78. +2 −2 tests/services/sessions/test_manager.py
  79. +2 −2 tests/test_serverapp.py
  80. +1 −1 tests/unix_sockets/conftest.py
  81. +12 −5 tests/unix_sockets/test_serverapp_integration.py
3 changes: 1 addition & 2 deletions .github/workflows/check-release.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
name: Check Release
on:
push:
branches: ["main"]
branches: ["1.x"]
pull_request:
branches: ["*"]

jobs:
check_release:
2 changes: 2 additions & 0 deletions .github/workflows/enforce-label.yml
Original file line number Diff line number Diff line change
@@ -6,6 +6,8 @@ on:
jobs:
enforce-label:
runs-on: ubuntu-latest
permissions:
pull-requests: write
steps:
- name: enforce-triage-label
uses: jupyterlab/maintainer-tools/.github/actions/enforce-label@v1
15 changes: 13 additions & 2 deletions .github/workflows/integration-tests.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: Jupyter Server Integration Tests [Linux]
on:
push:
branches: ["main"]
branches: ["1.x"]
pull_request:
branches: ["*"]

jobs:
build:
runs-on: ${{ matrix.os }}
@@ -28,3 +28,14 @@ jobs:
- name: Run the tests
run: |
pytest -vv --integration_tests=true tests
integration_check: # This job does nothing and is only used for the branch protection
if: always()
needs:
- build
runs-on: ubuntu-latest
steps:
- name: Decide whether the needed jobs succeeded or failed
uses: re-actors/alls-green@release/v1
with:
jobs: ${{ toJSON(needs) }}
75 changes: 44 additions & 31 deletions .github/workflows/python-tests.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Jupyter Server Tests
on:
push:
branches: ["main"]
branches: ["1.x"]
pull_request:
schedule:
- cron: "0 8 * * *"
@@ -33,8 +33,8 @@ jobs:
- name: Run the tests
if: ${{ !startsWith(matrix.python-version, 'pypy') && !startsWith(matrix.os, 'windows') }}
run: |
args="-vv --cov jupyter_server --cov-branch --cov-report term-missing:skip-covered --cov-fail-under 70"
python -m pytest $args || python -m pytest $args --lf
args="-vv --cov jupyter_server --cov-branch --cov-report term-missing:skip-covered"
python -m pytest $args --cov-fail-under 70 || python -m pytest $args --lf
- name: Run the tests on pypy and windows
if: ${{ startsWith(matrix.python-version, 'pypy') || startsWith(matrix.os, 'windows') }}
run: |
@@ -43,6 +43,26 @@ jobs:
run: |
codecov
pre-commit:
name: pre-commit
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
- uses: pre-commit/action@v2.0.0
with:
extra_args: --all-files --hook-stage=manual
- name: Help message if pre-commit fail
if: ${{ failure() }}
run: |
echo "You can install pre-commit hooks to automatically run formatting"
echo "on each commit with:"
echo " pre-commit install"
echo "or you can run by hand on staged files with"
echo " pre-commit run"
echo "or after-the-fact on already committed files with"
echo " pre-commit run --all-files --hook-stage=manual"
test_docs_and_examples:
name: Test Docs and Examples
timeout-minutes: 10
@@ -78,7 +98,7 @@ jobs:
uses: jupyterlab/maintainer-tools/.github/actions/install-minimums@v1
- name: Run the unit tests
run: |
pytest -vv || pytest -vv --lf
pytest -vv -W default || pytest -vv -W default --lf
test_prereleases:
name: Test Prereleases
@@ -103,39 +123,32 @@ jobs:
make_sdist:
name: Make SDist
runs-on: ubuntu-latest
timeout-minutes: 20
timeout-minutes: 10
steps:
- uses: actions/checkout@v2
- name: Base Setup
uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
- name: Build SDist
run: |
pip install build
python -m build --sdist
- uses: actions/upload-artifact@v2
with:
name: "sdist"
path: dist/*.tar.gz
- uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
- uses: jupyterlab/maintainer-tools/.github/actions/make-sdist@v1

test_sdist:
runs-on: ubuntu-latest
needs: [make_sdist]
name: Install from SDist and Test
timeout-minutes: 20
steps:
- name: Base Setup
uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
- name: Download sdist
uses: actions/download-artifact@v2
- name: Install From SDist
run: |
set -ex
cd sdist
mkdir test
tar --strip-components=1 -zxvf *.tar.gz -C ./test
cd test
pip install .[test]
- name: Run Test
run: |
cd sdist/test
pytest -vv || pytest -vv --lf
- uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
- uses: jupyterlab/maintainer-tools/.github/actions/test-sdist@v1

python_tests_check: # This job does nothing and is only used for the branch protection
if: always()
needs:
- build
- pre-commit
- test_prereleases
- make_sdist
- test_sdist
runs-on: ubuntu-latest
steps:
- name: Decide whether the needed jobs succeeded or failed
uses: re-actors/alls-green@release/v1
with:
jobs: ${{ toJSON(needs) }}
27 changes: 0 additions & 27 deletions .github/workflows/trigger_precommit.yml

This file was deleted.

27 changes: 20 additions & 7 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
ci:
skip: [check-jsonschema]

repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.1.0
rev: v4.2.0
hooks:
- id: end-of-file-fixer
- id: check-case-conflict
@@ -32,10 +29,23 @@ repos:
args: [--profile=black]

- repo: https://github.com/pre-commit/mirrors-prettier
rev: v2.6.1
rev: v2.6.2
hooks:
- id: prettier

- repo: https://github.com/asottile/pyupgrade
rev: v2.32.0
hooks:
- id: pyupgrade
args: [--py37-plus]

- repo: https://github.com/PyCQA/doc8
rev: 0.11.1
hooks:
- id: doc8
args: [--max-line-length=200]
stages: [manual]

- repo: https://github.com/pycqa/flake8
rev: 4.0.1
hooks:
@@ -46,17 +56,20 @@ repos:
"flake8-logging-format==0.6.0",
"flake8-implicit-str-concat==0.2.0",
]
stages: [manual]

- repo: https://github.com/pre-commit/mirrors-eslint
rev: v8.12.0
rev: v8.13.0
hooks:
- id: eslint
stages: [manual]

- repo: https://github.com/sirosen/check-jsonschema
rev: 0.14.1
rev: 0.14.3
hooks:
- id: check-jsonschema
name: "Check GitHub Workflows"
files: ^\.github/workflows/
types: [yaml]
args: ["--schemafile", "https://json.schemastore.org/github-workflow"]
stages: [manual]
5 changes: 4 additions & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -59,14 +59,17 @@ You can invoke the pre-commit hook by hand at any time with::

which should run any autoformatting on your code
and tell you about any errors it couldn't fix automatically.
You may also install [black integration](https://github.com/psf/black#editor-integration)
You may also install `black integration <https://github.com/psf/black#editor-integration>`_
into your text editor to format code automatically.

If you have already committed files before setting up the pre-commit
hook with ``pre-commit install``, you can fix everything up using
``pre-commit run --all-files``. You need to make the fixing commit
yourself after that.

Some of the hooks only run on CI by default, but you can invoke them by
running with the ``--hook-stage manual`` argument.

Troubleshooting the Installation
--------------------------------

10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Jupyter Server

[![Build Status](https://github.com/jupyter/jupyter_server/workflows/CI/badge.svg?query=branch%3Amain++)](https://github.com/jupyter-server/jupyter_server/actions?query=branch%3Amain++)
[![Documentation Status](https://readthedocs.org/projects/jupyter-server/badge/?version=latest)](http://jupyter-server.readthedocs.io/en/latest/?badge=latest)
[![Build Status](https://github.com/jupyter/jupyter_server/workflows/CI/badge.svg?query=branch%3A1.x++)](https://github.com/jupyter-server/jupyter_server/actions?query=branch%3A1.x++)
[![Documentation Status](https://readthedocs.org/projects/jupyter-server/badge/?version=stable)](http://jupyter-server.readthedocs.io/en/latest/?badge=stable)

The Jupyter Server provides the backend (i.e. the core services, APIs, and REST endpoints) for Jupyter web applications like Jupyter notebook, JupyterLab, and Voila.

For more information, read our [documentation here](http://jupyter-server.readthedocs.io/en/latest/?badge=latest).
For more information, read our [documentation here](http://jupyter-server.readthedocs.io/en/stable/?badge=latest).

## Installation and Basic usage

@@ -22,7 +22,7 @@ If Jupyter Server is a dependency of your project/application, it is important t

When a new minor version is released on PyPI, a branch for that version will be created in this repository, and the version of the main branch will be bumped to the next minor version number. That way, the main branch always reflects the latest un-released version.

To see the changes between releases, checkout the [CHANGELOG](https://github.com/jupyter/jupyter_server/blob/main/CHANGELOG.md).
To see the changes between releases, checkout the [CHANGELOG](https://github.com/jupyter/jupyter_server/blob/1.x/CHANGELOG.md).

## Usage - Running Jupyter Server

@@ -34,7 +34,7 @@ Launch with:

### Testing

See [CONTRIBUTING](https://github.com/jupyter-server/jupyter_server/blob/main/CONTRIBUTING.rst#running-tests).
See [CONTRIBUTING](https://github.com/jupyter-server/jupyter_server/blob/1.x/CONTRIBUTING.rst#running-tests).

## Contributing

2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Jupyter Server Docs Sources

Read [this page](https://jupyter-server.readthedocs.io/en/latest/contributors/contributing.html#building-the-docs) to build the docs.
Read [this page](https://jupyter-server.readthedocs.io/en/stable/contributors/contributing.html#building-the-docs) to build the docs.
1 change: 0 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Jupyter Server documentation build configuration file, created by
# sphinx-quickstart on Mon Apr 13 09:51:11 2015.
20 changes: 16 additions & 4 deletions docs/source/contributors/team-meetings.rst
Original file line number Diff line number Diff line change
@@ -5,16 +5,28 @@ Team Meetings, Road Map and Calendar

Many of the lead Jupyter Server developers meet weekly over Zoom. These meetings are open to everyone.

To see when the next meeting is happening, watch this Github issue:
To see when the next meeting is happening and how to attend, watch this Github issue:

https://github.com/jupyter/jupyter_server/issues/126
https://github.com/jupyter-server/team-compass/issues/15

Meeting Notes
-------------

- `2022 <https://github.com/jupyter-server/team-compass/issues/15>`_
- `2021 <https://github.com/jupyter-server/team-compass/issues/4>`_
- `2019-2020 <https://github.com/jupyter-server/team-compass/issues/1>`_

Roadmap
-------

Also check out Jupyter Server's roadmap where we track future plans for Jupyter Server:

https://github.com/jupyter/jupyter_server/issues/127
`Jupyter Server 2.0 Discussion <https://github.com/jupyter-server/team-compass/issues/24>`_

`Archived roadmap <https://github.com/jupyter/jupyter_server/issues/127>`_

Jupyter Calendar:
Jupyter Calendar
----------------

.. raw:: html

12 changes: 9 additions & 3 deletions docs/source/developers/dependency.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
Depending on Jupyter Server
===========================

If your project depends directly on Jupyter Server, be sure to watch Jupyter Server's ChangeLog and pin your project to a version that works for your application. Major releases represent possible backwards-compatibility breaking API changes or features.

When a new major version in released on PyPI, a branch for that version will be created in this repository, and the version of the master branch will be bumped to the next major version number. That way, the master branch always reflects the latest un-released version.
If your project depends directly on Jupyter Server, be sure to watch Jupyter
Server's ChangeLog and pin your project to a version that works for your
application. Major releases represent possible backwards-compatibility breaking
API changes or features.

When a new major version in released on PyPI, a branch for that version will be
created in this repository, and the version of the master branch will be bumped
to the next major version number. That way, the master branch always reflects
the latest un-released version.

To install the latest patch of a given version:

Loading