Skip to content
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

Jump to bottom

Add deprecation note for ServerApp.preferred_dir #1396

Merged
merged 2 commits into from
Feb 15, 2024
Merged

Add deprecation note for ServerApp.preferred_dir #1396

merged 2 commits into from
Feb 15, 2024

Conversation

krassowski
Copy link
Collaborator

Passing --ServerApp.preferred_dir warns:

FutureWarning: ServerApp.preferred_dir config is deprecated in jupyter-server 2.0. Use FileContentsManager.preferred_dir instead
  return self._get_trait_default_generator(names[0])(self)

This is the case since #1162 see:

jupyter_server/jupyter_server/services/contents/filemanager.py

Lines 79 to 84 in 62f4ca2

if value is not None:
warnings.warn(
"ServerApp.preferred_dir config is deprecated in jupyter-server 2.0. Use FileContentsManager.preferred_dir instead",
FutureWarning,
stacklevel=3,
)

but this is not documented. This PR adds the warning to trait description for it to be picked up by the docs.

Of note this will not affect the description of the other trait as it is redefined in:

jupyter_server/jupyter_server/services/contents/manager.py

Lines 83 to 89 in 62f4ca2

preferred_dir = Unicode(
"",
config=True,
help=_i18n(
"Preferred starting directory to use for notebooks. This is an API path (`/` separated, relative to root dir)"
),
)

blink1073
blink1073 approved these changes Feb 15, 2024
View reviewed changes
Copy link
Contributor

@blink1073 blink1073 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@blink1073 blink1073 merged commit 7d3264d into jupyter-server:main Feb 15, 2024
34 of 37 checks passed
sigmarkarl added a commit to spotinst/jupyter_server that referenced this pull request Oct 8, 2024
@sigmarkarl @bloomsa
@blink1073 @IITII @Wh1isper @fcollonval @minrk @pre-commit-ci @Zsailer @bollwyvl @krassowski @epignot @tornaria @mwouts @yuvipanda @Timeroot @oliver-sanders @hansepac @manics @dependabot @holzman @markypizz @lresende @kevin-bates @Carreau @willingc @gogasca
Bgd 5953 workspace switching kernel causes an error (#18)
717ab33 
* ContentsHandler return 404 rather than raise exc (jupyter-server#1357)

* Add more typings (jupyter-server#1356)

* Publish 2.10.1

SHA256 hashes:

jupyter_server-2.10.1-py3-none-any.whl: 20519e355d951fc5e1b6ac5952854fe7620d0cfb56588fa4efe362a758977ed3

jupyter_server-2.10.1.tar.gz: e6da2657a954a7879eed28cc08e0817b01ffd81d7eab8634660397b55f926472

* Bump to 2.11.0.dev0

* typo: ServerApp (jupyter-server#1361)

* Support get file(notebook) md5 (jupyter-server#1363)

* Update ruff and typings (jupyter-server#1365)

* Update api docs with md5 param (jupyter-server#1364)

* Publish 2.11.0

SHA256 hashes:

jupyter_server-2.11.0-py3-none-any.whl: c9bd6e6d71dc5a2a25df167dc323422997f14682b008bfecb5d7920a55020ea7

jupyter_server-2.11.0.tar.gz: 78c97ec8049f9062f0151725bc8a1364dfed716646a66819095e0e8a24793eba

* Bump to 2.12.0.dev0

* Change md5 to hash and hash_algorithm, fix incompatibility (jupyter-server#1367)

Co-authored-by: Frédéric Collonval <[email protected]>

* avoid unhandled error on some invalid paths (jupyter-server#1369)

* Publish 2.11.1

SHA256 hashes:

jupyter_server-2.11.1-py3-none-any.whl: 4b3a16e3ed16fd202588890f10b8ca589bd3e29405d128beb95935f059441373

jupyter_server-2.11.1.tar.gz: fe80bab96493acf5f7d6cd9a1575af8fbd253dc2591aa4d015131a1e03b5799a

* Bump to 2.12.0.dev0

* Merge pull request from GHSA-h56g-gq9v-vc8r

Co-authored-by: Steven Silvester <[email protected]>

* Publish 2.11.2

SHA256 hashes:

jupyter_server-2.11.2-py3-none-any.whl: 0c548151b54bcb516ca466ec628f7f021545be137d01b5467877e87f6fff4374

jupyter_server-2.11.2.tar.gz: 0c99f9367b0f24141e527544522430176613f9249849be80504c6d2b955004bb

* Bump to 2.12.0.dev0

* chore: update pre-commit hooks (jupyter-server#1370)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Steven Silvester <[email protected]>

* Update for tornado 6.4 (jupyter-server#1372)

* Support async Authorizers (jupyter-server#1373)

* Publish 2.12.0

SHA256 hashes:

jupyter_server-2.12.0-py3-none-any.whl: 3482912efa4387bb1edc23ba60531796aff3b6d6a6e93a5810f5719e2bdb48b7

jupyter_server-2.12.0.tar.gz: 9fa74ed3bb931cf33f42b3d9046e2788328ec9e6dcc59d48aa3e0910a491e3e4

* Bump to 2.13.0.dev0

* log extension import time at debug level unless it's actually slow (jupyter-server#1375)

* Add support for async Authorizers (part 2) (jupyter-server#1374)

* Publish 2.12.1

SHA256 hashes:

jupyter_server-2.12.1-py3-none-any.whl: fd030dd7be1ca572e4598203f718df6630c12bd28a599d7f1791c4d7938e1010

jupyter_server-2.12.1.tar.gz: dc77b7dcc5fc0547acba2b2844f01798008667201eea27c6319ff9257d700a6d

* Bump to 2.13.0.dev0

* Use ruff docstring-code-format (jupyter-server#1377)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Enable htmlzip and epub on readthedocs (jupyter-server#1379)

* Update pre-commit deps (jupyter-server#1380)

* Fix a typo in error message (jupyter-server#1381)

* Force legacy ws subprotocol when using gateway (jupyter-server#1311)

Co-authored-by: Emmanuel Pignot <[email protected]>
Co-authored-by: Zachary Sailer <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Zachary Sailer <[email protected]>

* Publish 2.12.2

SHA256 hashes:

jupyter_server-2.12.2-py3-none-any.whl: abcfa33f98a959f908c8733aa2d9fa0101d26941cbd49b148f4cef4d3046fc61

jupyter_server-2.12.2.tar.gz: 5eae86be15224b5375cdec0c3542ce72ff20f7a25297a2a8166a250bb455a519

* Bump to 2.13.0.dev0

* Fix test param for pytest-xdist (jupyter-server#1382)

* Simplify the jupytext downstream test (jupyter-server#1383)

* Import User unconditionally (jupyter-server#1384)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Publish 2.12.3

SHA256 hashes:

jupyter_server-2.12.3-py3-none-any.whl: 6f85310ea5e6068568a521f079fba99d8d17e4884dd1d602ab0f43b3115204a8

jupyter_server-2.12.3.tar.gz: a1d2d51e497b1a6256c48b6940b0dd49b2553981baf1690077c37792f1fa23a1

* Bump to 2.13.0.dev0

* Fix log arguments for gateway client error (jupyter-server#1385)

* Publish 2.12.4

SHA256 hashes:

jupyter_server-2.12.4-py3-none-any.whl: a125ae18a60de568f78f55c84dd58759901a18ef279abf0418ac220653ca1320

jupyter_server-2.12.4.tar.gz: 41f4a1e6b912cc24a7c6c694851b37d3d8412b180f43d72315fe422cb2b85cc2

* Bump to 2.13.0.dev0

* Improve warning handling (jupyter-server#1386)

* Publish 2.12.5

SHA256 hashes:

jupyter_server-2.12.5-py3-none-any.whl: 184a0f82809a8522777cfb6b760ab6f4b1bb398664c5860a27cec696cb884923

jupyter_server-2.12.5.tar.gz: 0edb626c94baa22809be1323f9770cf1c00a952b17097592e40d03e6a3951689

* Bump to 2.13.0.dev0

* fix "Shutdown" -> "Shut down" (jupyter-server#1389)

* chore: update pre-commit hooks (jupyter-server#1390)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* websockets: add configurations for ping interval and timeout (jupyter-server#1391)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Add deprecation note for `ServerApp.preferred_dir` (jupyter-server#1396)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Fix color in windows log console with colorama (jupyter-server#1397)

* Replace _jupyter_server_extension_paths in apidocs (jupyter-server#1393)

* Add an option to have authentication enabled for all endpoints by default (jupyter-server#1392)

* Update release workflows (jupyter-server#1399)

* Publish 2.13.0

SHA256 hashes:

jupyter_server-2.13.0-py3-none-any.whl: 77b2b49c3831fbbfbdb5048cef4350d12946191f833a24e5f83e5f8f4803e97b

jupyter_server-2.13.0.tar.gz: c80bfb049ea20053c3d9641c2add4848b38073bf79f1729cea1faed32fc1c78e

* Bump to 2.14.0.dev0

* Pin to Pytest 7 (jupyter-server#1401)

* Update pytest requirement from <8,>=7.0 to >=7.0,<9 (jupyter-server#1402)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Don't crash on invalid JSON in page_config (jupyter-server#1403) (jupyter-server#1404)

* Ignore zero-length page_config.json, restore previous behavior of crashing for invalid JSON (jupyter-server#1405)

* don't include token in dashboard link, when available (jupyter-server#1406)

* chore: update pre-commit hooks (jupyter-server#1409)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Update simple extension README to cd into correct subdirectory (jupyter-server#1410)

Co-authored-by: Mark Pizzutillo <[email protected]>

* Set all min deps (jupyter-server#1411)

* Fix jupytext and lint CI failures (jupyter-server#1413)

* docs: list server extensions (jupyter-server#1412)

* Link to GitHub repo from the docs (jupyter-server#1415)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Publish 2.14.0

SHA256 hashes:

jupyter_server-2.14.0-py3-none-any.whl: fb6be52c713e80e004fac34b35a0990d6d36ba06fd0a2b2ed82b899143a64210

jupyter_server-2.14.0.tar.gz: 659154cea512083434fd7c93b7fe0897af7a2fd0b9dd4749282b42eaac4ae677

* Bump to 2.15.0.dev0

* chore: update pre-commit hooks (jupyter-server#1421)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Steven Silvester <[email protected]>

* Removing excessive logging from reading local files (jupyter-server#1420)

Co-authored-by: Kevin Bates <[email protected]>

* Use hatch fmt command (jupyter-server#1424)

* Merge pull request from GHSA-hrw6-wg82-cm62

* filefind: avoid handling absolute paths

we don't need or want absolute path support,
which we inherited from generic ipython_genutils

only supporting relative paths lets us avoid attempting to accessing files we know we won't accept

* Apply suggestions from code review

Co-authored-by: M Bussonnier <[email protected]>

* filefind: only accept Sequence[str]

we only call it one place, might as well be simple about it

* version_info gate for is_relative_to

* clarify docstring

Co-authored-by: Carol Willing <[email protected]>

---------

Co-authored-by: M Bussonnier <[email protected]>
Co-authored-by: Carol Willing <[email protected]>

* Publish 2.14.1

SHA256 hashes:

jupyter_server-2.14.1-py3-none-any.whl: 16f7177c3a4ea8fe37784e2d31271981a812f0b2874af17339031dc3510cc2a5

jupyter_server-2.14.1.tar.gz: 12558d158ec7a0653bf96cc272bc7ad79e0127d503b982ed144399346694f726

* Bump to 2.15.0.dev0

* Update simple extension examples: _jupyter_server_extension_points (jupyter-server#1426)

* chore: update pre-commit hooks (jupyter-server#1427)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Steven Silvester <[email protected]>

* Add Changelog for 2.14.1 (jupyter-server#1430)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* chore: update pre-commit hooks (jupyter-server#1441)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Steven Silvester <[email protected]>

* Update documentation for `cookie_secret` (jupyter-server#1433)

* Do not log environment variables passed to kernels (jupyter-server#1437)

* Pass session_id during Websocket connect (jupyter-server#1440)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Publish 2.14.2

SHA256 hashes:

jupyter_server-2.14.2-py3-none-any.whl: 47ff506127c2f7851a17bf4713434208fc490955d0e8632e95014a9a9afbeefd

jupyter_server-2.14.2.tar.gz: 66095021aa9638ced276c248b1d81862e4c50f292d575920bbe960de1c56b12b

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Sam Bloomquist <[email protected]>
Co-authored-by: Steven Silvester <[email protected]>
Co-authored-by: blink1073 <[email protected]>
Co-authored-by: IITII <[email protected]>
Co-authored-by: Zhongsheng Ji <[email protected]>
Co-authored-by: Frédéric Collonval <[email protected]>
Co-authored-by: Min RK <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Zachary Sailer <[email protected]>
Co-authored-by: Zsailer <[email protected]>
Co-authored-by: Nicholas Bollweg <[email protected]>
Co-authored-by: Michał Krassowski <[email protected]>
Co-authored-by: Manu <[email protected]>
Co-authored-by: Emmanuel Pignot <[email protected]>
Co-authored-by: Zachary Sailer <[email protected]>
Co-authored-by: Gonzalo Tornaría <[email protected]>
Co-authored-by: Marc Wouts <[email protected]>
Co-authored-by: Yuvi Panda <[email protected]>
Co-authored-by: Alex Meiburg <[email protected]>
Co-authored-by: Oliver Sanders <[email protected]>
Co-authored-by: hansepac <[email protected]>
Co-authored-by: Simon Li <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Burt Holzman <[email protected]>
Co-authored-by: Mark <[email protected]>
Co-authored-by: Mark Pizzutillo <[email protected]>
Co-authored-by: Luciano Resende <[email protected]>
Co-authored-by: Kevin Bates <[email protected]>
Co-authored-by: M Bussonnier <[email protected]>
Co-authored-by: Carol Willing <[email protected]>
Co-authored-by: Steven Silvester <[email protected]>
Co-authored-by: Gonzalo Gasca Meza <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@blink1073 blink1073 blink1073 approved these changes

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@krassowski @blink1073