diff --git a/.binder/postBuild b/.binder/postBuild
index 25b43dd..66d2ae0 100644
--- a/.binder/postBuild
+++ b/.binder/postBuild
@@ -1,7 +1,7 @@
#!/usr/bin/env bash
# we already know which python and lab we want
-export RFJL_LOCKDIR=test/linux-64/py3.10/lab3
+export RFJL_LOCKDIR=test/linux-64/py3.11/lab3
# some things we just don't need to do on binder
export IN_BINDER=1
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..5ae7bf9
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,86 @@
+---
+name: Bug report
+about: Create a report to help us improve
+labels: bug
+---
+
+
+
+## Description
+
+
+
+## Reproduce
+
+
+
+1. Go to '...'
+2. Click on '...'
+3. Scroll down to '...'
+4. See error '...'
+
+
+
+## Expected behavior
+
+
+
+## Context
+
+
+
+- Operating System and version:
+- Browser and version:
+- `robotframework-jupyterlibrary` version(s):
+- Jupyter Client and Server versions:
+ - `notebook`:
+ - `jupyterlab`:
+ - `jupyter_server`:
+
+Required: installed server extensions
+
+ Paste the output from running `jupyter server extension list` (JupyterLab >= 3)
+ or `jupyter serverextension list` (JupyterLab < 3) from the command line here.
+ You may want to sanitize the paths in the output.
+
+Required: installed lab extensions
+
+ Paste the output from running `jupyter labextension list` from the command line here.
+ You may want to sanitize the paths in the output.
+
+Troubleshoot Output
+
+ Paste the output from running `jupyter troubleshoot` from the command line here.
+ You may want to sanitize the paths in the output.
+
+Command Line Output
+
+ Paste the output from your command line running `jupyter lab` here, use `--debug` if possible.
+
+Browser Output (recommended for all interface issues)
+
+ Paste the output from your browser JavaScript console replacing the text in here.
+
+To learn how to open the developer tools in your browser:
+https://developer.mozilla.org/en-US/docs/Learn/Common_questions/What_are_browser_developer_tools#How_to_open_the_devtools_in_your_browser
+If too many messages accumulated after many hours of working in JupyterLab, consider
+refreshing the window and then reproducing the bug to reduce the noise in the logs.
+
+
+
`3.10.6`
`3.11.0` |\n",
+ "| Robot Framework | `4.1.3`
`6.0.1` |\n",
+ "| Jupyter Notebook Classic | `6.5.2` |\n",
+ "| JupyterLab | `1.2.21`
`2.3.2`
`3.5.2` |\n",
+ "| Jupyter Server | `1.21.0`
`1.23.4`
`2.0.6` |\n",
"\n",
"- supports `robotframework` 6\n",
- "- drops support for `robotframework` 3"
+ "- drops support for `robotframework` 3\n",
+ "- tests `jupyter_server` 2\n",
+ " - to account for some deprecations, the _app name_ may need to be set\n",
+ " when starting a managed Jupyter/notebook server\n",
+ " - the new keywords `Set Default Jupyter App` and `Get Jupyter App Name`\n",
+ " allow for changing auto-detection based on CLI command\n",
+ " - an environment variable `%{JUPYTER_LIBRARY_APP}` (_default_: `NotebookApp`)\n",
+ " can be set to `ServerApp` for when combinations of `notebook`,\n",
+ " `nbclassic`, `jupyter_server` and `jupyterlab` break autodetection.\n"
]
},
{
@@ -30,8 +41,8 @@
"\n",
"| Products under test | Versions |\n",
"|-----------------------------|--------------------------|\n",
- "| Jupyter Notebook Classic | 6.5.1 |\n",
- "| JupyterLab | 1.2.21, 2.3.2, 3.4.8 |\n",
+ "| Jupyter Notebook Classic | `6.5.1` |\n",
+ "| JupyterLab | `1.2.21`
`2.3.2`
`3.4.8` |\n",
"\n",
"- `selenium` 4.5 is now supported\n",
" - `Get WebElements Relative To` (and the singular) are now available as keywords\n",
@@ -47,14 +58,14 @@
"\n",
"| Products under test | Versions |\n",
"|-----------------------------|--------------------------|\n",
- "| Jupyter Notebook Classic | 6.4.6 |\n",
- "| JupyterLab | 1.2.21, 2.3.2, 3.2.5 |\n",
+ "| Jupyter Notebook Classic | `6.4.6` |\n",
+ "| JupyterLab | `1.2.21`
`2.3.2`
`3.2.5` |\n",
"\n",
"\n",
"| Products under review | Versions |\n",
"|-----------------------------|--------------------------|\n",
- "| Retrolab | 0.3.13 |\n",
- "| Voila | 0.3.0 |\n",
+ "| Retrolab | `0.3.13` |\n",
+ "| Voila | `0.3.0` |\n",
"\n",
"- Kernel launcher keywords are more lax to account for more-spefic names, e.g. `Python 3 (ipykernel)`\n",
"- Put all robot source code under formatting/linting by [robotidy] and [robocop]\n",
@@ -73,14 +84,14 @@
"\n",
"| Products under test | Versions |\n",
"|-----------------------------|--------------------------|\n",
- "| Jupyter Notebook Classic | 6.3.0 |\n",
- "| JupyterLab | 1.2.16, 2.3.1, 3.0.14 |\n",
+ "| Jupyter Notebook Classic | `6.3.0` |\n",
+ "| JupyterLab | `1.2.16`
`2.3.1`
`3.0.14` |\n",
"\n",
"\n",
"| Products under review | Versions |\n",
"|-----------------------------|--------------------------|\n",
- "| JupyterLab Classic | 0.1.10 |\n",
- "| Voila | 0.2.9 |\n",
+ "| JupyterLab Classic | `0.1.10` |\n",
+ "| Voila | `0.2.9` |\n",
"\n",
"- Several JupyterLab keywords now accept an `${n}` argument to handle multiple documents on the page.\n",
"- Many JupyterLab keywords that wait for certain events can be configured with `${timeout}` and `${sleep}` to suit.\n",
@@ -95,8 +106,8 @@
"\n",
"| Products under test | Versions |\n",
"|-----------------------------|--------------------------|\n",
- "| Jupyter Notebook Classic | 6.1.5 |\n",
- "| JupyterLab | 1.2.16, 2.2.9, 3.0.0rc10 |\n",
+ "| Jupyter Notebook Classic | `6.1.5` |\n",
+ "| JupyterLab | `1.2.16`
`2.2.9`
`3.0.0rc10` |\n",
"\n",
"- Require SeleniumLibrary 4.5 and RobotFramework 3.2\n",
"- Expanded support for newer Notebook Classic and JupyterLab versions in keywords\n",
@@ -140,7 +151,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
- "version": "3.10.6"
+ "version": "3.7.12"
}
},
"nbformat": 4,
diff --git a/docs/LIMITS.ipynb b/docs/LIMITS.ipynb
index 706391e..ceb4f5d 100644
--- a/docs/LIMITS.ipynb
+++ b/docs/LIMITS.ipynb
@@ -7,6 +7,23 @@
"# LIMITS"
]
},
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "## `NotebookApp` vs `ServerApp`\n",
+ "\n",
+ "Prior to JupyterLibrary `0.4.2`, `Start New Jupyter Server` relied on backwards compatibility of `jupyter_server` with `notebook`, using e.g. `--NotebookApp.token` to configure temporary credentials.\n",
+ "\n",
+ "With `jupyter_server>=2`, `nbclassic` and various other newer packages vying for the CLI, this doesn't _always_ pick the correct tool, so several options are available:\n",
+ "\n",
+ "- explicitly setting the named `app_name` parameter when launching a server\n",
+ "- explicitly setting the `command` parameter will _usually_ pick the correct server\n",
+ " - e.g. `jupyter-lab` should _usually_ be `ServerApp`\n",
+ "- using the new keyword `Set Default Jupyter App Name`\n",
+ "- setting the `JUPYTER_LIBRARY_APP` environment variable, either from the CLI, or in CI `environment`, will influence the default behavior"
+ ]
+ },
{
"cell_type": "markdown",
"metadata": {},
@@ -46,7 +63,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
- "version": "3.8.12"
+ "version": "3.7.12"
}
},
"nbformat": 4,
diff --git a/docs/WHY.ipynb b/docs/WHY.ipynb
index f8fd197..1e25984 100644
--- a/docs/WHY.ipynb
+++ b/docs/WHY.ipynb
@@ -61,7 +61,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
- "version": "3.8.12"
+ "version": "3.11.0"
}
},
"nbformat": 4,
diff --git a/docs/rtd.yml b/docs/rtd.yml
index ebe3329..5be4d21 100644
--- a/docs/rtd.yml
+++ b/docs/rtd.yml
@@ -2,20 +2,21 @@
#
# This was generated from .github/locks/docs/linux-64/conda.lock
#
-# doit docs:rtdenv
+# doit docs:rtd:env
#
channels:
- conda-forge
- nodefaults
dependencies:
- https://conda.anaconda.org/conda-forge/linux-64/_libgcc_mutex-0.1-conda_forge.tar.bz2#d7c89558ba9fa0495403155b64376d81
- - https://conda.anaconda.org/conda-forge/linux-64/ca-certificates-2022.9.24-ha878542_0.tar.bz2#41e4e87062433e283696cf384f952ef6
- - https://conda.anaconda.org/conda-forge/linux-64/ld_impl_linux-64-2.39-hc81fddc_0.tar.bz2#c2719e2faa7bd7076d3a4b52271e5622
- - https://conda.anaconda.org/conda-forge/linux-64/libstdcxx-ng-12.2.0-h46fd767_18.tar.bz2#f19e96f96cc89617da02fed96f28974c
- - https://conda.anaconda.org/conda-forge/noarch/tzdata-2022e-h191b570_0.tar.bz2#b6bd89cf71494c41a181cac13cc5a8ea
- - https://conda.anaconda.org/conda-forge/linux-64/libgomp-12.2.0-h65d4601_18.tar.bz2#51caef63c24f3b09810832df2751e6b1
+ - https://conda.anaconda.org/conda-forge/linux-64/ca-certificates-2022.12.7-ha878542_0.conda#ff9f73d45c4a07d6f424495288a26080
+ - https://conda.anaconda.org/conda-forge/linux-64/ld_impl_linux-64-2.39-hcc3a1bd_1.conda#737be0d34c22d24432049ab7a3214de4
+ - https://conda.anaconda.org/conda-forge/linux-64/libstdcxx-ng-12.2.0-h46fd767_19.tar.bz2#1030b1f38c129f2634eae026f704fe60
+ - https://conda.anaconda.org/conda-forge/linux-64/python_abi-3.11-3_cp311.conda#c2e2630ddb68cf52eec74dc7dfab20b5
+ - https://conda.anaconda.org/conda-forge/noarch/tzdata-2022g-h191b570_0.conda#51fc4fcfb19f5d95ffc8c339db5068e8
+ - https://conda.anaconda.org/conda-forge/linux-64/libgomp-12.2.0-h65d4601_19.tar.bz2#cedcee7c064c01c403f962c9e8d3c373
- https://conda.anaconda.org/conda-forge/linux-64/_openmp_mutex-4.5-2_gnu.tar.bz2#73aaf86a425cc6e73fcf236a5a46396d
- - https://conda.anaconda.org/conda-forge/linux-64/libgcc-ng-12.2.0-h65d4601_18.tar.bz2#b0c1965ee67430d0621d0912c8e61d4d
+ - https://conda.anaconda.org/conda-forge/linux-64/libgcc-ng-12.2.0-h65d4601_19.tar.bz2#e4c94f80aef025c17ab0828cd85ef535
- https://conda.anaconda.org/conda-forge/linux-64/bzip2-1.0.8-h7f98852_4.tar.bz2#a1fd65c7ccbf10880423d82bca54eb54
- https://conda.anaconda.org/conda-forge/linux-64/icu-70.1-h27087fc_0.tar.bz2#87473a15119779e021c314249d4b4aed
- https://conda.anaconda.org/conda-forge/linux-64/libffi-3.4.2-h7f98852_5.tar.bz2#d645c6d2ac96843a2bfaccd2d62b3ac3
@@ -25,47 +26,55 @@ dependencies:
- https://conda.anaconda.org/conda-forge/linux-64/libuv-1.44.2-h166bdaf_0.tar.bz2#e5cb4fe581a18ca2185a016eb848fc00
- https://conda.anaconda.org/conda-forge/linux-64/libzlib-1.2.13-h166bdaf_4.tar.bz2#f3f9de449d32ca9b9c66a22863c96f41
- https://conda.anaconda.org/conda-forge/linux-64/ncurses-6.3-h27087fc_1.tar.bz2#4acfc691e64342b9dae57cf2adc63238
- - https://conda.anaconda.org/conda-forge/linux-64/openssl-1.1.1q-h166bdaf_0.tar.bz2#07acc367c7fc8b716770cd5b36d31717
+ - https://conda.anaconda.org/conda-forge/linux-64/openssl-3.0.7-h0b41bf4_1.conda#7adaac6ff98219bcb99b45e408b80f4e
- https://conda.anaconda.org/conda-forge/linux-64/xz-5.2.6-h166bdaf_0.tar.bz2#2161070d867d1b1204ea749c8eec4ef0
- https://conda.anaconda.org/conda-forge/linux-64/yaml-0.2.5-h7f98852_2.tar.bz2#4cb3ad778ec2d5a7acbdf254eb1c42ae
- - https://conda.anaconda.org/conda-forge/linux-64/libsqlite-3.39.4-h753d276_0.tar.bz2#978924c298fc2215f129e8171bbea688
+ - https://conda.anaconda.org/conda-forge/linux-64/libsqlite-3.40.0-h753d276_0.tar.bz2#2e5f9a37d487e1019fd4d8113adb2f9f
- https://conda.anaconda.org/conda-forge/linux-64/readline-8.1.2-h0f457ee_0.tar.bz2#db2ebbe2943aae81ed051a6a9af8e0fa
- https://conda.anaconda.org/conda-forge/linux-64/tk-8.6.12-h27826a3_0.tar.bz2#5b8c42eb62e9fc961af70bdd6a26e168
- https://conda.anaconda.org/conda-forge/linux-64/zeromq-4.3.4-h9c3ff4c_1.tar.bz2#21743a8d2ea0c8cfbbf8fe489b0347df
- https://conda.anaconda.org/conda-forge/linux-64/zlib-1.2.13-h166bdaf_4.tar.bz2#4b11e365c0275b808be78b30f904e295
- - https://conda.anaconda.org/conda-forge/linux-64/nodejs-18.11.0-h96d913c_0.tar.bz2#1a98de19be456d005a8ca0d64a073ad7
- - https://conda.anaconda.org/conda-forge/linux-64/python-3.10.6-h582c2e5_0_cpython.tar.bz2#6f009f92084e84884d1dff862b85eb00
+ - https://conda.anaconda.org/conda-forge/linux-64/nodejs-18.12.1-h8839609_0.tar.bz2#305f25b78340b0f7b391a6919d1246f2
+ - https://conda.anaconda.org/conda-forge/linux-64/python-3.11.0-ha86cf86_0_cpython.tar.bz2#531b2b97ce96cc95a587bdf7c74e31c0
+ - https://conda.anaconda.org/conda-forge/noarch/_ipython_minor_entry_point-8.7.0-h0c17e10_0.conda#8a63fb4d63db7b245ecf3c6f907935ff
- https://conda.anaconda.org/conda-forge/noarch/alabaster-0.7.12-py_0.tar.bz2#2489a97287f90176ecdc3ca982b4b0a0
- https://conda.anaconda.org/conda-forge/noarch/async_generator-1.10-py_0.tar.bz2#d56c596e61b1c4952acf0a9920856c12
- - https://conda.anaconda.org/conda-forge/noarch/attrs-22.1.0-pyh71513ae_1.tar.bz2#6d3ccbc56256204925bfa8378722792f
+ - https://conda.anaconda.org/conda-forge/noarch/attrs-22.2.0-pyh71513ae_0.conda#8b76db7818a4e401ed4486c4c1635cd9
- https://conda.anaconda.org/conda-forge/noarch/backcall-0.2.0-pyh9f0ad1d_0.tar.bz2#6006a6d08a3fa99268a2681c7fb55213
- - https://conda.anaconda.org/conda-forge/noarch/backports-1.0-py_2.tar.bz2#0da16b293affa6ac31812376f8eb79dd
- - https://conda.anaconda.org/conda-forge/noarch/certifi-2022.9.24-pyhd8ed1ab_0.tar.bz2#f66309b099374af91369e67e84af397d
+ - https://conda.anaconda.org/conda-forge/noarch/backports-1.0-pyhd8ed1ab_3.conda#54ca2e08b3220c148a1d8329c2678e02
+ - https://conda.anaconda.org/conda-forge/noarch/certifi-2022.12.7-pyhd8ed1ab_0.conda#fb9addc3db06e56abe03e0e9f21a63e6
- https://conda.anaconda.org/conda-forge/noarch/charset-normalizer-2.1.1-pyhd8ed1ab_0.tar.bz2#c1d5b294fbf9a795dec349a6f4d8be8e
+ - https://conda.anaconda.org/conda-forge/noarch/click-8.1.3-unix_pyhd8ed1ab_2.tar.bz2#20e4087407c7cb04a40817114b333dbf
- https://conda.anaconda.org/conda-forge/noarch/cloudpickle-2.2.0-pyhd8ed1ab_0.tar.bz2#a6cf47b09786423200d7982d1faa19eb
- - https://conda.anaconda.org/conda-forge/noarch/colorama-0.4.5-pyhd8ed1ab_0.tar.bz2#c267da48ce208905d7d976d49dfd9433
+ - https://conda.anaconda.org/conda-forge/noarch/colorama-0.4.6-pyhd8ed1ab_0.tar.bz2#3faab06a954c2a04039983f2c4a50d99
+ - https://conda.anaconda.org/conda-forge/linux-64/debugpy-1.6.4-py311ha362b79_0.conda#7cfc802c1a673662f49cdb76de669b39
- https://conda.anaconda.org/conda-forge/noarch/decorator-5.1.1-pyhd8ed1ab_0.tar.bz2#43afe5ab04e35e17ba28649471dd7364
+ - https://conda.anaconda.org/conda-forge/linux-64/docutils-0.19-py311h38be061_1.tar.bz2#599159b0740e9b82e7eef0e8471be3c2
- https://conda.anaconda.org/conda-forge/noarch/entrypoints-0.4-pyhd8ed1ab_0.tar.bz2#3cf04868fee0a029769bd41f4b2fbf2d
- - https://conda.anaconda.org/conda-forge/noarch/exceptiongroup-1.0.0rc9-pyhd8ed1ab_0.tar.bz2#1dc545bc6e916bafb8a028df5fb1a26d
- - https://conda.anaconda.org/conda-forge/noarch/executing-1.1.1-pyhd8ed1ab_0.tar.bz2#1ed759c44597c5e189625017f5875cbc
+ - https://conda.anaconda.org/conda-forge/noarch/executing-1.2.0-pyhd8ed1ab_0.tar.bz2#4c1bc140e2be5c8ba6e3acab99e25c50
+ - https://conda.anaconda.org/conda-forge/linux-64/greenlet-2.0.1-py311ha362b79_0.tar.bz2#7adf8b182f4fd2cd313349bce924afdd
- https://conda.anaconda.org/conda-forge/noarch/idna-3.4-pyhd8ed1ab_0.tar.bz2#34272b248891bddccc64479f9a7fffed
- https://conda.anaconda.org/conda-forge/noarch/imagesize-1.4.1-pyhd8ed1ab_0.tar.bz2#7de5386c8fea29e76b303f37dde4c352
+ - https://conda.anaconda.org/conda-forge/linux-64/markupsafe-2.1.1-py311hd4cff14_2.tar.bz2#6b0d96114b4a841630ef7d0dff10d4e8
- https://conda.anaconda.org/conda-forge/noarch/mdurl-0.1.0-pyhd8ed1ab_0.tar.bz2#f8dab71fdc13b1bf29a01248b156d268
- https://conda.anaconda.org/conda-forge/noarch/nest-asyncio-1.5.6-pyhd8ed1ab_0.tar.bz2#7b868f21adde0d9b8b38f9c16836589b
+ - https://conda.anaconda.org/conda-forge/noarch/packaging-22.0-pyhd8ed1ab_0.conda#0e8e1bd93998978fc3125522266d12db
- https://conda.anaconda.org/conda-forge/noarch/parso-0.8.3-pyhd8ed1ab_0.tar.bz2#17a565a0c3899244e938cdf417e7b094
- https://conda.anaconda.org/conda-forge/noarch/pickleshare-0.7.5-py_1003.tar.bz2#415f0ebb6198cc2801c73438a9fb5761
- https://conda.anaconda.org/conda-forge/noarch/pkgutil-resolve-name-1.3.10-pyhd8ed1ab_0.tar.bz2#89e3c7cdde7d3aaa2aee933b604dd07f
- - https://conda.anaconda.org/conda-forge/noarch/port-for-0.6.2-pyhd8ed1ab_0.tar.bz2#948e335f1d7f8d47fdc6b8b03003877b
+ - https://conda.anaconda.org/conda-forge/noarch/port-for-0.6.3-pyhd8ed1ab_0.conda#cfc0df39511f323ad3d999203d86fe8d
+ - https://conda.anaconda.org/conda-forge/linux-64/psutil-5.9.4-py311hd4cff14_0.tar.bz2#6fbda857a56adb4140bed339fbe0b801
- https://conda.anaconda.org/conda-forge/noarch/ptyprocess-0.7.0-pyhd3deb0d_0.tar.bz2#359eeb6536da0e687af562ed265ec263
- https://conda.anaconda.org/conda-forge/noarch/pure_eval-0.2.2-pyhd8ed1ab_0.tar.bz2#6784285c7e55cb7212efabc79e4c2883
- https://conda.anaconda.org/conda-forge/noarch/pycparser-2.21-pyhd8ed1ab_0.tar.bz2#076becd9e05608f8dc72757d5f3a91ff
- - https://conda.anaconda.org/conda-forge/noarch/pyparsing-3.0.9-pyhd8ed1ab_0.tar.bz2#e8fbc1b54b25f4b08281467bc13b70cc
+ - https://conda.anaconda.org/conda-forge/linux-64/pyrsistent-0.19.2-py311hd4cff14_0.tar.bz2#e6808d85cbd28e4fb2d61294627fa1b1
- https://conda.anaconda.org/conda-forge/noarch/pysocks-1.7.1-pyha2e5f31_6.tar.bz2#2a7de29fb590ca14b5243c4c812c8025
- https://conda.anaconda.org/conda-forge/noarch/python-fastjsonschema-2.16.2-pyhd8ed1ab_0.tar.bz2#5fe4b6002f505336734ce92961b3e6a0
- - https://conda.anaconda.org/conda-forge/linux-64/python_abi-3.10-2_cp310.tar.bz2#9e7160cd0d865e98f6803f1fe15c8b61
- - https://conda.anaconda.org/conda-forge/noarch/pytz-2022.5-pyhd8ed1ab_0.tar.bz2#565724d09157870f0e469b1a0a172a6d
- - https://conda.anaconda.org/conda-forge/noarch/robotframework-6.0-pyhd8ed1ab_0.tar.bz2#837cfa1a48c6aec3105628216a2cd1f2
- - https://conda.anaconda.org/conda-forge/noarch/setuptools-65.5.0-pyhd8ed1ab_0.tar.bz2#462466739c786f85f9ed555f87099fe1
+ - https://conda.anaconda.org/conda-forge/noarch/pytz-2022.7-pyhd8ed1ab_0.conda#c8d7e34ca76d6ecc03b84bedfd99d689
+ - https://conda.anaconda.org/conda-forge/linux-64/pyyaml-6.0-py311hd4cff14_5.tar.bz2#da8769492e423103c59f469f4f17f8d9
+ - https://conda.anaconda.org/conda-forge/linux-64/pyzmq-24.0.1-py311ha4b6469_1.tar.bz2#7d57a4cdfa05e444ed955b0319b97eed
+ - https://conda.anaconda.org/conda-forge/noarch/robotframework-6.0.1-pyhd8ed1ab_0.tar.bz2#515ba8a4b796d568e702c7ff3eb491e4
+ - https://conda.anaconda.org/conda-forge/noarch/setuptools-65.6.3-pyhd8ed1ab_0.conda#9600fc9524d3f821e6a6d58c52f5bf5a
- https://conda.anaconda.org/conda-forge/noarch/six-1.16.0-pyh6c4a22f_0.tar.bz2#e5f25f8dbc060e9a8d912e432202afc2
- https://conda.anaconda.org/conda-forge/noarch/sniffio-1.3.0-pyhd8ed1ab_0.tar.bz2#dd6cbc539e74cb1f430efbd4575b9303
- https://conda.anaconda.org/conda-forge/noarch/snowballstemmer-2.2.0-pyhd8ed1ab_0.tar.bz2#4d22a9315e78c6827f806065957d566e
@@ -78,64 +87,56 @@ dependencies:
- https://conda.anaconda.org/conda-forge/noarch/sphinxcontrib-qthelp-1.0.3-py_0.tar.bz2#d01180388e6d1838c3e1ad029590aa7a
- https://conda.anaconda.org/conda-forge/noarch/sphinxcontrib-serializinghtml-1.1.5-pyhd8ed1ab_2.tar.bz2#9ff55a0901cf952f05c654394de76bf7
- https://conda.anaconda.org/conda-forge/noarch/tabulate-0.9.0-pyhd8ed1ab_1.tar.bz2#4759805cce2d914c38472f70bf4d8bcb
- - https://conda.anaconda.org/conda-forge/noarch/traitlets-5.5.0-pyhd8ed1ab_0.tar.bz2#63650c013737b2801811bcd94524e863
+ - https://conda.anaconda.org/conda-forge/linux-64/tornado-6.2-py311hd4cff14_1.tar.bz2#4d86cd6dbdc1185f4e72d974f1f1f852
+ - https://conda.anaconda.org/conda-forge/noarch/traitlets-5.8.0-pyhd8ed1ab_0.conda#75fa7ac3992a41e6a06102594bbf67d0
- https://conda.anaconda.org/conda-forge/noarch/typing_extensions-4.4.0-pyha770c72_0.tar.bz2#2d93b130d148d7fc77e583677792fc6a
- - https://conda.anaconda.org/conda-forge/noarch/wheel-0.37.1-pyhd8ed1ab_0.tar.bz2#1ca02aaf78d9c70d9a81a3bed5752022
- - https://conda.anaconda.org/conda-forge/noarch/zipp-3.9.0-pyhd8ed1ab_0.tar.bz2#6f3fd8c9e0ab504010fb4216d5919c24
- - https://conda.anaconda.org/conda-forge/noarch/asttokens-2.0.8-pyhd8ed1ab_0.tar.bz2#4d725d10caaad25d9c31bfb263044fb4
- - https://conda.anaconda.org/conda-forge/noarch/babel-2.10.3-pyhd8ed1ab_0.tar.bz2#72f1c6d03109d7a70087bc1d029a8eda
+ - https://conda.anaconda.org/conda-forge/noarch/wheel-0.38.4-pyhd8ed1ab_0.tar.bz2#c829cfb8cb826acb9de0ac1a2df0a940
+ - https://conda.anaconda.org/conda-forge/noarch/zipp-3.11.0-pyhd8ed1ab_0.conda#09b5b885341697137879a4f039a9e5a1
+ - https://conda.anaconda.org/conda-forge/noarch/asttokens-2.2.1-pyhd8ed1ab_0.conda#bf7f54dd0f25c3f06ecb82a07341841a
+ - https://conda.anaconda.org/conda-forge/noarch/babel-2.11.0-pyhd8ed1ab_0.tar.bz2#2ea70fde8d581ba9425a761609eed6ba
- https://conda.anaconda.org/conda-forge/noarch/backports.functools_lru_cache-1.6.4-pyhd8ed1ab_0.tar.bz2#c5b3edc62d6309088f4970b3eaaa65a6
- https://conda.anaconda.org/conda-forge/noarch/beautifulsoup4-4.11.1-pyha770c72_0.tar.bz2#eeec8814bd97b2681f708bb127478d7d
- - https://conda.anaconda.org/conda-forge/linux-64/cffi-1.15.1-py310h255011f_1.tar.bz2#408fd3c0253b3c8a6fbf4f88708c71cb
- - https://conda.anaconda.org/conda-forge/linux-64/click-8.1.3-py310hff52083_0.tar.bz2#a09e14173c5ded52ef7917b249c9280e
- - https://conda.anaconda.org/conda-forge/linux-64/debugpy-1.6.3-py310hd8f1fbe_0.tar.bz2#c1f8fb014e5713c1d23c69568a8665ad
- - https://conda.anaconda.org/conda-forge/linux-64/docutils-0.19-py310hff52083_0.tar.bz2#82eeac1b2161ba30a9b53eb8a5cea7f1
- - https://conda.anaconda.org/conda-forge/linux-64/greenlet-1.1.3-py310hd8f1fbe_0.tar.bz2#bc56f6568390e1195052feb713a6dc2c
+ - https://conda.anaconda.org/conda-forge/linux-64/cffi-1.15.1-py311h409f033_3.conda#9025d0786dbbe4bc91fd8e85502decce
+ - https://conda.anaconda.org/conda-forge/noarch/comm-0.1.2-pyhd8ed1ab_0.conda#3c78af4752bb1600ebe5e83ef4588eaa
- https://conda.anaconda.org/conda-forge/noarch/h11-0.14.0-pyhd8ed1ab_0.tar.bz2#b21ed0883505ba1910994f1df031a428
- - https://conda.anaconda.org/conda-forge/linux-64/importlib-metadata-4.11.4-py310hff52083_0.tar.bz2#8ea386e64531f1ecf4a5765181579e7e
- - https://conda.anaconda.org/conda-forge/noarch/importlib_resources-5.10.0-pyhd8ed1ab_0.tar.bz2#eb521efe7f5550de7573bc1629b74a05
- - https://conda.anaconda.org/conda-forge/noarch/jedi-0.18.1-pyhd8ed1ab_2.tar.bz2#0e613217e78777045199372a2b0d5bd2
- - https://conda.anaconda.org/conda-forge/linux-64/jupyter_core-4.11.1-py310hff52083_0.tar.bz2#e7c04d9bc3f51cc42fa4ba6c70bb3de1
+ - https://conda.anaconda.org/conda-forge/noarch/importlib-metadata-5.2.0-pyha770c72_0.conda#2e8eec7a08bcf85547a3778225f00634
+ - https://conda.anaconda.org/conda-forge/noarch/importlib_resources-5.10.1-pyhd8ed1ab_1.conda#5b48ca365913b08b819884bc21d4fb56
+ - https://conda.anaconda.org/conda-forge/noarch/jedi-0.18.2-pyhd8ed1ab_0.conda#b5e695ef9c3f0d27d6cd96bf5adc9e07
+ - https://conda.anaconda.org/conda-forge/noarch/jinja2-3.1.2-pyhd8ed1ab_1.tar.bz2#c8490ed5c70966d232fdd389d0dbed37
+ - https://conda.anaconda.org/conda-forge/noarch/livereload-2.6.3-pyh9f0ad1d_0.tar.bz2#b7190e3ec3eff52839434bf4698e2d62
- https://conda.anaconda.org/conda-forge/noarch/markdown-it-py-2.1.0-pyhd8ed1ab_0.tar.bz2#d821ebc1ebe21d4cac2555278c2cd970
- - https://conda.anaconda.org/conda-forge/linux-64/markupsafe-2.1.1-py310h5764c6d_1.tar.bz2#ec5a727504409ad1380fc2a84f83d002
- https://conda.anaconda.org/conda-forge/noarch/matplotlib-inline-0.1.6-pyhd8ed1ab_0.tar.bz2#b21613793fcc81d944c76c9f2864a7de
- https://conda.anaconda.org/conda-forge/noarch/outcome-1.2.0-pyhd8ed1ab_0.tar.bz2#3dbb9ece72652131f12d66e889da7c0a
- - https://conda.anaconda.org/conda-forge/noarch/packaging-21.3-pyhd8ed1ab_0.tar.bz2#71f1ab2de48613876becddd496371c85
- - https://conda.anaconda.org/conda-forge/noarch/pexpect-4.8.0-pyh9f0ad1d_2.tar.bz2#5909e7b978141dd80d28dbf9de627827
- - https://conda.anaconda.org/conda-forge/noarch/pip-22.3-pyhd8ed1ab_0.tar.bz2#6f4c6de9fed2a9bd8043283611b09587
- - https://conda.anaconda.org/conda-forge/linux-64/psutil-5.9.3-py310h5764c6d_0.tar.bz2#828fad8cec3489e088b784ade1cc975b
+ - https://conda.anaconda.org/conda-forge/noarch/pexpect-4.8.0-pyh1a96a4e_2.tar.bz2#330448ce4403cc74990ac07c555942a1
+ - https://conda.anaconda.org/conda-forge/noarch/pip-22.3.1-pyhd8ed1ab_0.tar.bz2#da66f2851b9836d3a7c5190082a45f7d
- https://conda.anaconda.org/conda-forge/noarch/pygments-2.13.0-pyhd8ed1ab_0.tar.bz2#9f478e8eedd301008b5f395bad0caaed
- - https://conda.anaconda.org/conda-forge/linux-64/pyrsistent-0.18.1-py310h5764c6d_1.tar.bz2#d6bf97f14e0cc9d2024cf66b11bb79b8
- https://conda.anaconda.org/conda-forge/noarch/python-dateutil-2.8.2-pyhd8ed1ab_0.tar.bz2#dd999d1cc9f79e67dbb855c8924c7984
- - https://conda.anaconda.org/conda-forge/linux-64/pyyaml-6.0-py310h5764c6d_4.tar.bz2#505dcf6be997e732d7a33831950dc3cf
- - https://conda.anaconda.org/conda-forge/linux-64/pyzmq-24.0.1-py310h330234f_0.tar.bz2#f0c811d312b017e6d9168a6c56c23e9b
- - https://conda.anaconda.org/conda-forge/noarch/robotframework-pythonlibcore-3.0.0-pyhd8ed1ab_0.tar.bz2#5651c801936eed0acac65983bf87f9e4
- - https://conda.anaconda.org/conda-forge/linux-64/tornado-6.2-py310h5764c6d_0.tar.bz2#c42dcb37acd84b3ca197f03f57ef927d
+ - https://conda.anaconda.org/conda-forge/noarch/robotframework-pythonlibcore-4.0.0-pyhd8ed1ab_0.tar.bz2#e3dd7ba929a82a21c6e568c00d5b538c
+ - https://conda.anaconda.org/conda-forge/linux-64/sqlalchemy-1.4.45-py311h2582759_0.conda#c8452b47661df1285d72803934abc594
- https://conda.anaconda.org/conda-forge/noarch/typing-extensions-4.4.0-hd8ed1ab_0.tar.bz2#be969210b61b897775a0de63cd9e9026
- - https://conda.anaconda.org/conda-forge/linux-64/brotlipy-0.7.0-py310h5764c6d_1004.tar.bz2#6499bb11b7feffb63b26847fc9181319
- - https://conda.anaconda.org/conda-forge/linux-64/cryptography-38.0.2-py310h597c629_0.tar.bz2#06d8c591a75ff4ff52e6742bb4d7192f
+ - https://conda.anaconda.org/conda-forge/linux-64/brotlipy-0.7.0-py311hd4cff14_1005.tar.bz2#9bdac7084ecfc08338bae1b976535724
+ - https://conda.anaconda.org/conda-forge/linux-64/cryptography-38.0.4-py311h42a1071_0.conda#34c95722eb879d7a9ee0546671084b2d
- https://conda.anaconda.org/conda-forge/noarch/doit-0.36.0-pyhd8ed1ab_0.tar.bz2#fc5e53d070f1ee7bb38c2ece282dcb82
- - https://conda.anaconda.org/conda-forge/noarch/jinja2-3.1.2-pyhd8ed1ab_1.tar.bz2#c8490ed5c70966d232fdd389d0dbed37
- - https://conda.anaconda.org/conda-forge/noarch/jsonschema-4.16.0-pyhd8ed1ab_0.tar.bz2#f39774717a77d98673ea29d28a586a84
- - https://conda.anaconda.org/conda-forge/noarch/jupyter_client-7.4.2-pyhd8ed1ab_0.tar.bz2#8861f3816cd0e94029b539459d46a26c
- - https://conda.anaconda.org/conda-forge/noarch/livereload-2.6.3-pyh9f0ad1d_0.tar.bz2#b7190e3ec3eff52839434bf4698e2d62
- - https://conda.anaconda.org/conda-forge/noarch/mdit-py-plugins-0.3.1-pyhd8ed1ab_0.tar.bz2#093f4820d06d57f2c5d03303440dab54
- - https://conda.anaconda.org/conda-forge/linux-64/sqlalchemy-1.4.42-py310h5764c6d_0.tar.bz2#9097531a3e57510d262d7acbcd2f3b5f
- - https://conda.anaconda.org/conda-forge/noarch/stack_data-0.5.1-pyhd8ed1ab_0.tar.bz2#3282a2d79f5f4d25469d71bc851771e3
- - https://conda.anaconda.org/conda-forge/linux-64/trio-0.22.0-py310hff52083_0.tar.bz2#666eeb9119d2d04adc0177eb87661c37
+ - https://conda.anaconda.org/conda-forge/noarch/jsonschema-4.17.3-pyhd8ed1ab_0.conda#723268a468177cd44568eb8f794e0d80
+ - https://conda.anaconda.org/conda-forge/noarch/mdit-py-plugins-0.3.3-pyhd8ed1ab_0.conda#7a69c057183706bc7ba6ac7c9130566a
+ - https://conda.anaconda.org/conda-forge/noarch/platformdirs-2.6.2-pyhd8ed1ab_0.conda#0b4cc3f8181b0d8446eb5387d7848a54
+ - https://conda.anaconda.org/conda-forge/noarch/stack_data-0.6.2-pyhd8ed1ab_0.conda#e7df0fdd404616638df5ece6e69ba7af
+ - https://conda.anaconda.org/conda-forge/linux-64/trio-0.22.0-py311h38be061_1.tar.bz2#0564e63c41c0527f8085a572a931f1e6
- https://conda.anaconda.org/conda-forge/noarch/wcwidth-0.2.5-pyh9f0ad1d_2.tar.bz2#5266fcd697043c59621fda522b3d78ee
- https://conda.anaconda.org/conda-forge/noarch/wsproto-1.2.0-pyhd8ed1ab_0.tar.bz2#00ba804b54f451d102f6a7615f08470d
- - https://conda.anaconda.org/conda-forge/noarch/nbformat-5.7.0-pyhd8ed1ab_0.tar.bz2#f8439ce65664bec6d348346590ed57f0
- - https://conda.anaconda.org/conda-forge/noarch/prompt-toolkit-3.0.31-pyha770c72_0.tar.bz2#94fee21afe199936bc361608e537cd11
+ - https://conda.anaconda.org/conda-forge/linux-64/jupyter_core-5.1.1-py311h38be061_0.conda#7a8cea41b480b295e083a39076342ca1
+ - https://conda.anaconda.org/conda-forge/noarch/prompt-toolkit-3.0.36-pyha770c72_0.conda#4d79ec192e0bfd530a254006d123b9a6
- https://conda.anaconda.org/conda-forge/noarch/pyopenssl-22.1.0-pyhd8ed1ab_0.tar.bz2#fbfa0a180d48c800f922a10a114a8632
- https://conda.anaconda.org/conda-forge/noarch/trio-websocket-0.9.2-pyhd8ed1ab_0.tar.bz2#7acf3fc982eef23b24aed10e80d5dc99
- - https://conda.anaconda.org/conda-forge/noarch/ipython-8.5.0-pyh41d4057_1.tar.bz2#83600908360af344d9324c3409e0dfea
+ - https://conda.anaconda.org/conda-forge/noarch/ipython-8.7.0-pyh41d4057_0.conda#adc2f96edf35423c091dba93b642573a
+ - https://conda.anaconda.org/conda-forge/noarch/jupyter_client-7.4.8-pyhd8ed1ab_0.conda#bd4951aa5fbf3336a249e25c90f50333
+ - https://conda.anaconda.org/conda-forge/noarch/nbformat-5.7.1-pyhd8ed1ab_0.conda#facb42913140f1a399a5ebb65b30915e
+ - https://conda.anaconda.org/conda-forge/noarch/urllib3-1.26.13-pyhd8ed1ab_0.conda#3078ef2359efd6ecadbc7e085c5e0592
+ - https://conda.anaconda.org/conda-forge/noarch/ipykernel-6.19.4-pyh210e3f2_0.conda#65372b6dd819e2c36345cf91eeb4ff06
- https://conda.anaconda.org/conda-forge/noarch/nbclient-0.5.13-pyhd8ed1ab_0.tar.bz2#3edde88a191701cf052216c4ba353a83
- - https://conda.anaconda.org/conda-forge/noarch/urllib3-1.26.11-pyhd8ed1ab_0.tar.bz2#0738978569b10669bdef41c671252dd1
- - https://conda.anaconda.org/conda-forge/noarch/ipykernel-6.16.0-pyh210e3f2_0.tar.bz2#6a07cee9d25338f0b638576f6b476bf7
- - https://conda.anaconda.org/conda-forge/noarch/jupyter-cache-0.5.0-pyhd8ed1ab_0.tar.bz2#293ede7de6b604f3586efbfa615ee2e1
- https://conda.anaconda.org/conda-forge/noarch/requests-2.28.1-pyhd8ed1ab_1.tar.bz2#089382ee0e2dc2eae33a04cc3c2bddb0
- - https://conda.anaconda.org/conda-forge/noarch/selenium-4.5.0-pyhd8ed1ab_0.tar.bz2#20e905e5b29efa80f218f9c16693ce41
+ - https://conda.anaconda.org/conda-forge/noarch/selenium-4.7.2-pyhd8ed1ab_0.conda#4f6238a5e80996ee0bbee28b487aada5
+ - https://conda.anaconda.org/conda-forge/noarch/jupyter-cache-0.5.0-pyhd8ed1ab_0.tar.bz2#293ede7de6b604f3586efbfa615ee2e1
- https://conda.anaconda.org/conda-forge/noarch/robotframework-seleniumlibrary-6.0.0-pyhd8ed1ab_0.tar.bz2#2acaef9c04081dc3644501ac575953bf
- https://conda.anaconda.org/conda-forge/noarch/sphinx-5.3.0-pyhd8ed1ab_0.tar.bz2#f9e1fcfe235d655900bfeb6aee426472
- https://conda.anaconda.org/conda-forge/noarch/myst-parser-0.18.1-pyhd8ed1ab_0.tar.bz2#bcfdf5c7d8bf5c6f6be7b4c66fff2eca
diff --git a/dodo.py b/dodo.py
index 060c1f7..1d3d914 100644
--- a/dodo.py
+++ b/dodo.py
@@ -156,7 +156,7 @@ def _env_from_lock():
f"#\n"
f"# This was generated from {lockfile.relative_to(P.ROOT)}\n"
f"#\n"
- f"# doit docs:rtdenv\n"
+ f"# doit docs:rtd:env\n"
f"#\n"
) + header
diff --git a/package.json b/package.json
index 29a9d5e..da58276 100644
--- a/package.json
+++ b/package.json
@@ -4,10 +4,11 @@
"version": "0.0.0",
"prettier": {
"proseWrap": "always",
- "singleQuote": true
+ "singleQuote": true,
+ "printWidth": 88
},
"devDependencies": {
- "prettier": "^2.7.1"
+ "prettier": "^2.8.1"
},
"scripts": {
"prettier": "prettier --write --list-different \"./*.{json,md,yml}\" \"{.github,.binder,docs}/**/*.{json,md,yml,css}\""
diff --git a/setup.cfg b/setup.cfg
index 8321a89..eea6855 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -38,6 +38,7 @@ classifiers =
Programming Language :: Python :: 3.8
Programming Language :: Python :: 3.9
Programming Language :: Python :: 3.10
+ Programming Language :: Python :: 3.11
Programming Language :: Python :: 3 :: Only
Topic :: Software Development :: Quality Assurance
Topic :: Software Development :: Testing
diff --git a/src/JupyterLibrary/core.py b/src/JupyterLibrary/core.py
index cec276c..5296561 100644
--- a/src/JupyterLibrary/core.py
+++ b/src/JupyterLibrary/core.py
@@ -33,7 +33,7 @@ def __init__(
implicit_wait=0.0,
run_on_failure="Capture Page Screenshot",
screenshot_root_directory=None,
- **kwargs
+ **kwargs,
):
"""JupyterLibrary can be imported with several optional arguments.
- ``timeout``:
@@ -51,7 +51,7 @@ def __init__(
implicit_wait=implicit_wait,
run_on_failure=run_on_failure,
screenshot_root_directory=screenshot_root_directory,
- **kwargs
+ **kwargs,
)
self.add_library_components(
[Component(self) for Component in component_classes]
@@ -69,14 +69,12 @@ def start_suite(self, name, attrs):
resources = []
for common in COMMON:
- resources += ["JupyterLibrary/common/{}".format(basename(common))]
+ resources += [f"JupyterLibrary/common/{basename(common)}"]
for client in CLIENTS:
for path in glob(join(client, "*.resource")):
resources += [
- "JupyterLibrary/clients/{}/{}".format(
- basename(client), basename(path)
- )
+ f"JupyterLibrary/clients/{basename(client)}/{basename(path)}"
]
for resource in resources:
diff --git a/src/JupyterLibrary/keywords/server.py b/src/JupyterLibrary/keywords/server.py
index f8ecdf3..3878d67 100644
--- a/src/JupyterLibrary/keywords/server.py
+++ b/src/JupyterLibrary/keywords/server.py
@@ -21,12 +21,54 @@ class ServerKeywords(LibraryComponent):
_base_urls = {}
_tokens = {}
+ _app_name = None
+
+ @keyword
+ def set_default_jupyter_app_name(
+ self, app_name: typing.Optional[str] = None
+ ) -> typing.Optional[str]:
+ """Set the current ``traitlets.Configurable`` Jupyter Server application,
+ returning the previous value.
+
+ A value of ``None`` (the default) will try to detect the app based on
+ command name, such as:
+
+ - ``jupyter-notebook`` is configured with ``NotebookApp``
+ - ``jupyter-lab`` and most other are configured with ``ServerApp``
+
+ This may also be set externally via the ``JUPYTER_LIBRARY_APP`` environment
+ variable, but any explicit argument will override this.
+
+ See [#Get Jupyter App Name] for more.
+ """
+ old_app_name = self.app_name
+ self.app_name = app_name
+ return old_app_name
+
+ @keyword
+ def get_jupyter_app_name(
+ self, command: typing.Optional[str] = None
+ ) -> typing.Optional[str]:
+ """Get the current ``traitlets.Configurable`` Jupyter Server application,
+ optionally for a specific CLI command.
+
+ See [#Set Default Jupyter App Name] for more.
+ """
+ app_name = os.environ.get("JUPYTER_LIBRARY_APP")
+
+ if self._app_name is not None:
+ app_name = self._app_name
+ elif command is not None and "jupyter-notebook" in command:
+ app_name = "NotebookApp"
+
+ return app_name or "ServerApp"
+
@keyword
def start_new_jupyter_server(
self,
- command: typing.Optional[str] = None,
+ command: typing.Optional[str] = "jupyter-notebook",
port: typing.Optional[int] = None,
- base_url: typing.Optional[str] = None,
+ base_url: typing.Optional[str] = "/@rf/",
notebook_dir: typing.Optional[str] = None,
token: typing.Optional[str] = None,
*args,
@@ -34,25 +76,31 @@ def start_new_jupyter_server(
) -> subprocess.Popen:
"""Start a Jupyter server. All arguments are optional.
- | = argument = | = default = | = notes = |
- | ``command`` | ``jupyter-notebook`` | |
- | ``port`` | an unused port | |
- | ``base_url`` | ``/@rf/`` | |
- | ``notebook_dir`` | a temporary directory | |
- | ``token`` | a random ``uuid4`` | |
- | ``*args`` | | extra server arguments |
- | ``**config`` | | extra process arguments |
-
-
- If not configured, the ``$HOME`` environment variable and current
+ | = argument = | = default = | = notes = |
+ | ``command`` | ``jupyter-notebook`` | e.g. ``jupyter-lab`` |
+ | ``port`` | an unused port | |
+ | ``base_url`` | ``/@rf/`` | |
+ | ``notebook_dir`` | a temporary directory | |
+ | ``token`` | a random ``uuid4`` | |
+ | ``*args`` | | extra server arguments |
+ | ``**config`` | | extra process arguments |
+ | ``app_name`` | ``None`` (detect) | e.g. ``NotebookApp``, `ServerApp`` |
+
+ If not configured, the ``%{HOME}`` environment variable and current
working directory will be set to avoid leaking configuration
between between runs (or the test instance) itself. These
directories will be cleaned up after the server process is
[#Terminate All Jupyter Servers|terminated].
+
+ The ``app_name`` argument is as described for the [#Get Jupyter App Name|app name],
+ with the default being to autodetect from the command and environment.
"""
- command = command or "jupyter-notebook"
+ app_name = (
+ config.pop("app_name", None)
+ or config.get("env:JUPYTER_LIBRARY_APP")
+ or self.get_jupyter_app_name(command)
+ )
port = port or self.get_unused_port()
- base_url = base_url or "/@rf/"
token = str(uuid4()) if token is None else token
BuiltIn().import_library("Process")
@@ -76,7 +124,9 @@ def start_new_jupyter_server(
os.mkdir(notebook_dir)
config["cwd"] = notebook_dir
- args = args or self.build_jupyter_server_arguments(port, base_url, token)
+ args = args or self.build_jupyter_server_arguments(
+ port, base_url, token, app_name
+ )
handle = plib.start_process(command, *args, **config)
@@ -91,15 +141,23 @@ def start_new_jupyter_server(
@keyword
def build_jupyter_server_arguments(
- self, port: int, base_url: str, token: str
+ self,
+ port: int,
+ base_url: str,
+ token: str,
+ app_name: typing.Optional[str] = None,
) -> typing.List[str]:
- """Some default jupyter arguments"""
+ """Build Some default Jupyter application arguments.
+
+ If the ``app_name`` is not provided, it will be detected based on the rules
+ in [#Get Jupyter App Name]."""
+ app_name = app_name or self.get_jupyter_app_name()
return [
"--no-browser",
"--debug",
- "--port={}".format(port),
- "--NotebookApp.token='{}'".format(token),
- "--NotebookApp.base_url='{}'".format(base_url),
+ f"--port={port}",
+ f"--{app_name}.token={token}",
+ f"--{app_name}.base_url={base_url}",
]
@keyword
@@ -170,10 +228,9 @@ def wait_for_jupyter_server_to_be_ready(
time.sleep(interval)
error = _error
- assert ready == len(
- nbservers
- ), "Only {} of {} servers were ready after {}s. Last error: {} {}".format(
- ready, len(nbservers), interval * retries, type(error), error
+ assert ready == len(nbservers), (
+ f"Only {ready} of {len(nbservers)} servers were ready after "
+ f"{interval * retries}s. Last error: {type(error)} {error}"
)
return ready
@@ -183,7 +240,7 @@ def get_jupyter_server_url(
) -> str:
"""Get the given (or most recently-launched) server's URL"""
nbh = nbserver or self._handles[-1]
- return "http://localhost:{}{}".format(self._ports[nbh], self._base_urls[nbh])
+ return f"http://127.0.0.1:{self._ports[nbh]}{self._base_urls[nbh]}"
@keyword
def get_jupyter_server_token(
@@ -221,7 +278,7 @@ def terminate_all_jupyter_servers(self, timeout: str = "6s") -> int:
url = self.get_jupyter_server_url(nbh)
token = self.get_jupyter_server_token(nbh)
try:
- urlopen("{}api/shutdown?token={}".format(url, token), data=[])
+ urlopen(f"{url}api/shutdown?token={token}", data=[])
shutdown += 1
except Exception as err:
BuiltIn().log(err)
diff --git a/src/JupyterLibrary/magic.py b/src/JupyterLibrary/magic.py
index 451da36..34a6651 100644
--- a/src/JupyterLibrary/magic.py
+++ b/src/JupyterLibrary/magic.py
@@ -208,14 +208,14 @@ def execute(self, args, cell, content_hash):
]
display(
HTML(
+ f"""
+
"""
-
- """.format(
- len(files), "\n".join(files)
- )
)
)
display(Markdown(f"- _🤖 returned {rc}_"))
diff --git a/yarn.lock b/yarn.lock
index b0dff29..c7b6820 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -2,7 +2,7 @@
# yarn lockfile v1
-prettier@^2.7.1:
- version "2.7.1"
- resolved "https://registry.npmjs.org/prettier/-/prettier-2.7.1.tgz#e235806850d057f97bb08368a4f7d899f7760c64"
- integrity sha512-ujppO+MkdPqoVINuDFDRLClm7D78qbDt0/NR+wp5FqEZOoTNAjPHWj17QRhu7geIHJfcNhRk1XVQmF8Bp3ye+g==
+prettier@^2.8.1:
+ version "2.8.1"
+ resolved "https://registry.npmjs.org/prettier/-/prettier-2.8.1.tgz#4e1fd11c34e2421bc1da9aea9bd8127cd0a35efc"
+ integrity sha512-lqGoSJBQNJidqCHE80vqZJHWHRFoNYsSpP9AjFhlhi9ODCJA541svILes/+/1GM3VaL/abZi7cpFzOpdR9UPKg==