oi%ddlZddlmZmZmZmZmZmZmZm Z m Z ddl m Z GddejjZy)N) BoolCallableDictEnumIntListTypeUnicodevalidate)warncLeZdZdZegddddZegddddZedddd Ze d dd Z e dddZ eddZ e d dd Ze ddd Zeedgdd Zeedgdd ZeddZeedgdd Zeedgdd ZeddZe idd Ze idd Zed dd! Ze d dd" Zedd#d$d%&Zedd'd'd(&Zeegd)*jAdZ!e d dd+ Z"ed,dd- Z#ed.ddd/Z$ed.ddd0Z%e d.ddd1Z&e ddd2 Z'e(d.ddd34Z)e(d.ddd54Z*e d dd6 Z+eedd7 Z,y.)8VoilaConfigurationzNCommon configuration options between the server extension and the application.)YESNOTEBOOKNOrz_ Allow overriding the template (YES), or not (NO), or only from the notebook metadata. T)helpconfigz\ Allow overriding the theme (YES), or not (NO), or only from the notebook metadata. labz"template name to be used by voila.)r allow_nonerFzFUse the jinja2-based tree page instead of the new JupyterLab-based one)rrz extra resources used by templates; example use with --template=reveal --VoilaConfiguration.resources="{'reveal': {'transition': 'fade', 'scroll': True}}" )rrrlight)rzXShow left and right margins for the "lab" template, this gives a "classic" template lookz Strip sources from rendered htmlz.*\.(png|jpg|gif|svg)a List of regular expressions for controlling which static files are served. All files that are served should at least match 1 allowlist rule, and no denylist rule Example: --VoilaConfiguration.file_allowlist="['.*\.(png|jpg|gif|svg)', 'public.*']" z Deprecated, use `file_allowlist`file_whitelistc0tdtd|dS)Nz:Deprecated, use VoilaConfiguration.file_allowlist instead. stacklevelvaluer DeprecationWarningselfproposals [/home/ubuntu/docker-apps/notebooks/venv/lib/python3.12/site-packages/voila/configuration.py_valid_file_whitelistz(VoilaConfiguration._valid_file_whitelistPs  H    z.*\.(ipynb|py)a List of regular expressions for controlling which static files are forbidden to be served. All files that are served should at least match 1 allowlist rule, and no denylist rule Example: --VoilaConfiguration.file_allowlist="['.*']" # all files --VoilaConfiguration.file_denylist="['private.*', '.*\.(ipynb)']" # except files in the private dir and notebook files zDeprecated, use `file_denylist`file_blacklistc0tdtd|dS)Nz9Deprecated, use VoilaConfiguration.file_denylist instead.rrrrrs r"_valid_file_blacklistz(VoilaConfiguration._valid_file_blacklistms  G    r$zMapping of language name to kernel name Example mapping python to use xeus-python, and C++11 to use xeus-cling: --VoilaConfiguration.extension_language_mapping='{"python": "xpython", "C++11": "xcpp11"}' zMapping of file extension to kernel language Example mapping .py files to a python language kernel, and .cpp to a C++11 language kernel: --VoilaConfiguration.extension_language_mapping='{".py": "python", ".cpp": "C++11"}' z When a cell takes a long time to execute, the http connection can timeout (possibly because of a proxy). Voila sends a 'heartbeat' message after the timeout is passed to keep the http connection alive. z4Whether to send tracebacks to clients on exceptions.zGjupyter_server.services.kernels.kernelmanager.AsyncMappingKernelManagerz4jupyter_client.multikernelmanager.MultiKernelManagerzThe kernel manager class. This is useful to specify a different kernel manager, for example a kernel manager with support for pooling. )r default_valueklassrz+jupyter_client.kernelspec.KernelSpecManagerzxThe kernel spec manager class. Allows for setting a custom kernel spec manager for finding and running kernels z List of HTTP Headers that should be passed as env vars to the kernel. Example: --VoilaConfiguration.http_header_envs="['X-CDSDASHBOARDS-JH-USER']" )rz:Flag to enable or disable pre-heat kernel option. zbSize of pre-heated kernel pool for each notebook. Zero or negative number means disabled. NzThe list of enabled JupyterLab extensions, if `None`, all extensions are loaded. This setting has higher priority than the `extension_denylist` zPThe list of disabled JupyterLab extensions, if `None`, all extensions are loadedzmThe dictionary of extension configuration, this dict is passed to the frontend through the PageConfigzVWhether or not voila should attempt to fix and resolve a notebooks kernelspec metadataaA function that is called prior to the launch of a new kernel instance when a user visits the voila webpage. Used for custom user authorization or any other necessary pre-launch functions. Should be of the form: def hook(req: tornado.web.RequestHandler, notebook: nbformat.NotebookNode, cwd: str) Although most customizations can leverage templates, if you need access to the request object (e.g. to inspect cookies for authentication), or to modify the notebook itself (e.g. to inject some custom structure, although much of this can be done by interacting with the kernel in javascript) the prelaunch hook lets you do that. )r)rrraA function that is called to modify the page config for a given notebook. Should be of the form: def page_config_hook( current_page_config: Dict[str, Any], base_url: str, settings: Dict[str, Any], log: Logger, voila_configuration: VoilaConfiguration, notebook_path: str ) -> Dict[str, Any]: The hook receives the default page_config dictionary and all its parameters, it should return a dictionary that will be passed to the template as the `page_config` variable and the NotebookRenderer. This can be used to pass custom configuration. zFlag to enable or disable progressive rendering option. This option is not compatible with preheat-kernel option. z7Extra paths to look for federated JupyterLab extensions)-__name__ __module__ __qualname____doc__rallow_template_overrideallow_theme_overrider templater classic_treer resourcestheme show_margins strip_sourcesrfile_allowlistrr r# file_denylistr%r'language_kernel_mappingextension_language_mappingrhttp_keep_alive_timeoutshow_tracebacksr multi_kernel_manager_classkernel_spec_manager_classtaghttp_header_envspreheat_kerneldefault_pool_sizeextension_allowlistextension_denylistextension_configattempt_fix_notebookrprelaunch_hookpage_config_hookprogressive_renderingextra_labextensions_pathr$r"rrsX"!   !   dt3WH VL  I GD )E  f Ld1STM !" N !" 3 N! !  M  2 N! !#  "&  ""  DO "&_D "!%C; !   cc  N       c  "    i  N,  ,!   $  J r$r)traitlets.config traitletsrrrrrrr r r warningsr r ConfigurablerrLr$r"rQs0TTTE))66Er$