hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-17 15:03:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Apply suggestions from code review

Browse Source 
Co-authored-by: Simon Li <orpheus+devel@gmail.com>
This commit is contained in:
Min RK
2025-04-03 11:29:22 +02:00
committed by GitHub
parent 43a868d00b
commit 8002cbb873
2 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/source/reference/spawners.md
View File

@@ -240,6 +240,7 @@ This is because the users can specify arbitrary option dictionary by using the A
so it is part of your Spawner and/or deployment configuration to expose the options you trust your users to set.
[](#Spawner.apply_user_options) is the hook for taking `user_options` and applying whatever configuration it may represent.
It is critical that `apply_user_options` validates all input, since these are provided by the user.
```python
def apply_user_options(spawner, user_options):
@@ -274,7 +275,7 @@ c.Spawner.options_from_form = "simple"
c.Spawner.apply_user_options = {"image_input": "image", "debug_checkbox": "debug"}
```
The `simple` options_from_form does the very simplest interpretation of an html form,
`options_from_form = "simple"` uses a built-in method to do the very simplest interpretation of an html form,
casting the lists of strings to single strings by getting the first item when there is only one.
The only extra processing it performs is casting the checkbox value of `on` to True.
@@ -287,7 +288,7 @@ So it turns this formdata:
}
```
into this `.user_options`
into this `user_options`
```python
{
@@ -303,7 +304,7 @@ which means you can set numbers and things this way as well,
even though `options_from_form` leaves these as strings.
So in the above configuration, we have exposed `Spawner.debug` and `Spawner.image` without needing to write any functions.
In jupyterhub helm chart yaml, this would look like:
In the JupyterHub helm chart YAML, this would look like:
```yaml
hub: