jupyter_server.services package

Subpackages

• jupyter_server.services.api package
  • Submodules
    • APISpecHandler
      • APISpecHandler.auth_resource
      • APISpecHandler.get()
      • APISpecHandler.get_content_type()
      • APISpecHandler.head()
      • APISpecHandler.initialize()
    • APIStatusHandler
      • APIStatusHandler.auth_resource
      • APIStatusHandler.get()
    • IdentityHandler
      • IdentityHandler.get()
  • Module contents
• jupyter_server.services.config package
  • Submodules
    • ConfigHandler
      • ConfigHandler.auth_resource
      • ConfigHandler.get()
      • ConfigHandler.patch()
      • ConfigHandler.put()
    • ConfigManager
      • ConfigManager.config_dir_name
      • ConfigManager.get()
      • ConfigManager.read_config_path
      • ConfigManager.set()
      • ConfigManager.update()
      • ConfigManager.write_config_dir
      • ConfigManager.write_config_manager
  • Module contents
    • ConfigManager
      • ConfigManager.config_dir_name
      • ConfigManager.get()
      • ConfigManager.read_config_path
      • ConfigManager.set()
      • ConfigManager.update()
      • ConfigManager.write_config_dir
      • ConfigManager.write_config_manager
• jupyter_server.services.contents package
  • Submodules
    • AsyncCheckpoints
      • AsyncCheckpoints.create_checkpoint()
      • AsyncCheckpoints.delete_all_checkpoints()
      • AsyncCheckpoints.delete_checkpoint()
      • AsyncCheckpoints.list_checkpoints()
      • AsyncCheckpoints.rename_all_checkpoints()
      • AsyncCheckpoints.rename_checkpoint()
      • AsyncCheckpoints.restore_checkpoint()
    • AsyncGenericCheckpointsMixin
      • AsyncGenericCheckpointsMixin.create_checkpoint()
      • AsyncGenericCheckpointsMixin.create_file_checkpoint()
      • AsyncGenericCheckpointsMixin.create_notebook_checkpoint()
      • AsyncGenericCheckpointsMixin.get_file_checkpoint()
      • AsyncGenericCheckpointsMixin.get_notebook_checkpoint()
      • AsyncGenericCheckpointsMixin.restore_checkpoint()
    • Checkpoints
      • Checkpoints.create_checkpoint()
      • Checkpoints.delete_all_checkpoints()
      • Checkpoints.delete_checkpoint()
      • Checkpoints.list_checkpoints()
      • Checkpoints.rename_all_checkpoints()
      • Checkpoints.rename_checkpoint()
      • Checkpoints.restore_checkpoint()
    • GenericCheckpointsMixin
      • GenericCheckpointsMixin.create_checkpoint()
      • GenericCheckpointsMixin.create_file_checkpoint()
      • GenericCheckpointsMixin.create_notebook_checkpoint()
      • GenericCheckpointsMixin.get_file_checkpoint()
      • GenericCheckpointsMixin.get_notebook_checkpoint()
      • GenericCheckpointsMixin.restore_checkpoint()
    • AsyncFileCheckpoints
      • AsyncFileCheckpoints.checkpoint_model()
      • AsyncFileCheckpoints.create_checkpoint()
      • AsyncFileCheckpoints.delete_checkpoint()
      • AsyncFileCheckpoints.list_checkpoints()
      • AsyncFileCheckpoints.rename_checkpoint()
      • AsyncFileCheckpoints.restore_checkpoint()
    • AsyncGenericFileCheckpoints
      • AsyncGenericFileCheckpoints.create_file_checkpoint()
      • AsyncGenericFileCheckpoints.create_notebook_checkpoint()
      • AsyncGenericFileCheckpoints.get_file_checkpoint()
      • AsyncGenericFileCheckpoints.get_notebook_checkpoint()
    • FileCheckpoints
      • FileCheckpoints.checkpoint_dir
      • FileCheckpoints.checkpoint_model()
      • FileCheckpoints.checkpoint_path()
      • FileCheckpoints.create_checkpoint()
      • FileCheckpoints.delete_checkpoint()
      • FileCheckpoints.list_checkpoints()
      • FileCheckpoints.no_such_checkpoint()
      • FileCheckpoints.rename_checkpoint()
      • FileCheckpoints.restore_checkpoint()
      • FileCheckpoints.root_dir
    • GenericFileCheckpoints
      • GenericFileCheckpoints.create_file_checkpoint()
      • GenericFileCheckpoints.create_notebook_checkpoint()
      • GenericFileCheckpoints.get_file_checkpoint()
      • GenericFileCheckpoints.get_notebook_checkpoint()
    • AsyncFileManagerMixin
    • FileManagerMixin
      • FileManagerMixin.atomic_writing()
      • FileManagerMixin.hash_algorithm
      • FileManagerMixin.open()
      • FileManagerMixin.perm_to_403()
      • FileManagerMixin.use_atomic_writing
    • async_copy2_safe()
    • async_replace_file()
    • atomic_writing()
    • copy2_safe()
    • path_to_intermediate()
    • path_to_invalid()
    • replace_file()
    • AsyncFileContentsManager
      • AsyncFileContentsManager.check_folder_size()
      • AsyncFileContentsManager.copy()
      • AsyncFileContentsManager.delete_file()
      • AsyncFileContentsManager.dir_exists()
      • AsyncFileContentsManager.file_exists()
      • AsyncFileContentsManager.get()
      • AsyncFileContentsManager.get_kernel_path()
      • AsyncFileContentsManager.is_hidden()
      • AsyncFileContentsManager.rename_file()
      • AsyncFileContentsManager.save()
    • FileContentsManager
      • FileContentsManager.always_delete_dir
      • FileContentsManager.check_folder_size()
      • FileContentsManager.copy()
      • FileContentsManager.delete_file()
      • FileContentsManager.delete_to_trash
      • FileContentsManager.dir_exists()
      • FileContentsManager.exists()
      • FileContentsManager.file_exists()
      • FileContentsManager.get()
      • FileContentsManager.get_kernel_path()
      • FileContentsManager.info_string()
      • FileContentsManager.is_hidden()
      • FileContentsManager.is_writable()
      • FileContentsManager.max_copy_folder_size_mb
      • FileContentsManager.rename_file()
      • FileContentsManager.root_dir
      • FileContentsManager.save()
    • CheckpointsHandler
      • CheckpointsHandler.get()
      • CheckpointsHandler.post()
    • ContentsAPIHandler
      • ContentsAPIHandler.auth_resource
    • ContentsHandler
      • ContentsHandler.delete()
      • ContentsHandler.get()
      • ContentsHandler.location_url()
      • ContentsHandler.patch()
      • ContentsHandler.post()
      • ContentsHandler.put()
    • ModifyCheckpointsHandler
      • ModifyCheckpointsHandler.delete()
      • ModifyCheckpointsHandler.post()
    • NotebooksRedirectHandler
      • NotebooksRedirectHandler.SUPPORTED_METHODS
      • NotebooksRedirectHandler.delete()
      • NotebooksRedirectHandler.get()
      • NotebooksRedirectHandler.patch()
      • NotebooksRedirectHandler.post()
      • NotebooksRedirectHandler.put()
    • TrustNotebooksHandler
      • TrustNotebooksHandler.post()
    • validate_model()
    • AsyncLargeFileManager
      • AsyncLargeFileManager.save()
    • LargeFileManager
      • LargeFileManager.save()
    • AsyncContentsManager
      • AsyncContentsManager.checkpoints
      • AsyncContentsManager.checkpoints_class
      • AsyncContentsManager.checkpoints_kwargs
      • AsyncContentsManager.copy()
      • AsyncContentsManager.create_checkpoint()
      • AsyncContentsManager.delete()
      • AsyncContentsManager.delete_checkpoint()
      • AsyncContentsManager.delete_file()
      • AsyncContentsManager.dir_exists()
      • AsyncContentsManager.exists()
      • AsyncContentsManager.file_exists()
      • AsyncContentsManager.get()
      • AsyncContentsManager.increment_filename()
      • AsyncContentsManager.is_hidden()
      • AsyncContentsManager.list_checkpoints()
      • AsyncContentsManager.new()
      • AsyncContentsManager.new_untitled()
      • AsyncContentsManager.rename()
      • AsyncContentsManager.rename_file()
      • AsyncContentsManager.restore_checkpoint()
      • AsyncContentsManager.save()
      • AsyncContentsManager.trust_notebook()
      • AsyncContentsManager.update()
    • ContentsManager
      • ContentsManager.allow_hidden
      • ContentsManager.check_and_sign()
      • ContentsManager.checkpoints
      • ContentsManager.checkpoints_class
      • ContentsManager.checkpoints_kwargs
      • ContentsManager.copy()
      • ContentsManager.create_checkpoint()
      • ContentsManager.delete()
      • ContentsManager.delete_checkpoint()
      • ContentsManager.delete_file()
      • ContentsManager.dir_exists()
      • ContentsManager.emit()
      • ContentsManager.event_logger
      • ContentsManager.event_schema_id
      • ContentsManager.exists()
      • ContentsManager.file_exists()
      • ContentsManager.files_handler_class
      • ContentsManager.files_handler_params
      • ContentsManager.get()
      • ContentsManager.get_extra_handlers()
      • ContentsManager.get_kernel_path()
      • ContentsManager.hide_globs
      • ContentsManager.increment_filename()
      • ContentsManager.info_string()
      • ContentsManager.is_hidden()
      • ContentsManager.list_checkpoints()
      • ContentsManager.log_info()
      • ContentsManager.mark_trusted_cells()
      • ContentsManager.new()
      • ContentsManager.new_untitled()
      • ContentsManager.notary
      • ContentsManager.post_save_hook
      • ContentsManager.pre_save_hook
      • ContentsManager.preferred_dir
      • ContentsManager.register_post_save_hook()
      • ContentsManager.register_pre_save_hook()
      • ContentsManager.rename()
      • ContentsManager.rename_file()
      • ContentsManager.restore_checkpoint()
      • ContentsManager.root_dir
      • ContentsManager.run_post_save_hook()
      • ContentsManager.run_post_save_hooks()
      • ContentsManager.run_pre_save_hook()
      • ContentsManager.run_pre_save_hooks()
      • ContentsManager.save()
      • ContentsManager.should_list()
      • ContentsManager.trust_notebook()
      • ContentsManager.untitled_directory
      • ContentsManager.untitled_file
      • ContentsManager.untitled_notebook
      • ContentsManager.update()
      • ContentsManager.validate_notebook_model()
  • Module contents
• jupyter_server.services.events package
  • Submodules
    • EventHandler
      • EventHandler.auth_resource
      • EventHandler.post()
    • SubscribeWebsocket
      • SubscribeWebsocket.auth_resource
      • SubscribeWebsocket.event_listener()
      • SubscribeWebsocket.get()
      • SubscribeWebsocket.on_close()
      • SubscribeWebsocket.open()
      • SubscribeWebsocket.pre_get()
    • get_timestamp()
    • validate_model()
  • Module contents
• jupyter_server.services.kernels package
  • Subpackages
    • jupyter_server.services.kernels.connection package
      • Submodules
      • Module contents
  • Submodules
    • KernelActionHandler
      • KernelActionHandler.post()
    • KernelHandler
      • KernelHandler.delete()
      • KernelHandler.get()
    • KernelsAPIHandler
      • KernelsAPIHandler.auth_resource
    • MainKernelHandler
      • MainKernelHandler.get()
      • MainKernelHandler.post()
    • AsyncMappingKernelManager
    • MappingKernelManager
      • MappingKernelManager.allow_tracebacks
      • MappingKernelManager.allowed_message_types
      • MappingKernelManager.buffer_offline_messages
      • MappingKernelManager.cull_busy
      • MappingKernelManager.cull_connected
      • MappingKernelManager.cull_idle_timeout
      • MappingKernelManager.cull_interval
      • MappingKernelManager.cull_interval_default
      • MappingKernelManager.cull_kernel_if_idle()
      • MappingKernelManager.cull_kernels()
      • MappingKernelManager.cwd_for_path()
      • MappingKernelManager.get_buffer()
      • MappingKernelManager.initialize_culler()
      • MappingKernelManager.kernel_argv
      • MappingKernelManager.kernel_info_timeout
      • MappingKernelManager.kernel_model()
      • MappingKernelManager.last_kernel_activity
      • MappingKernelManager.list_kernels()
      • MappingKernelManager.notify_connect()
      • MappingKernelManager.notify_disconnect()
      • MappingKernelManager.ports_changed()
      • MappingKernelManager.restart_kernel()
      • MappingKernelManager.root_dir
      • MappingKernelManager.shutdown_kernel()
      • MappingKernelManager.start_buffering()
      • MappingKernelManager.start_kernel()
      • MappingKernelManager.start_watching_activity()
      • MappingKernelManager.stop_buffering()
      • MappingKernelManager.stop_watching_activity()
      • MappingKernelManager.traceback_replacement_message
      • MappingKernelManager.track_message_type()
      • MappingKernelManager.untracked_message_types
    • ServerKernelManager
      • ServerKernelManager.core_event_schema_paths
      • ServerKernelManager.emit()
      • ServerKernelManager.event_logger
      • ServerKernelManager.execution_state
      • ServerKernelManager.extra_event_schema_paths
      • ServerKernelManager.interrupt_kernel()
      • ServerKernelManager.last_activity
      • ServerKernelManager.reason
      • ServerKernelManager.restart_kernel()
      • ServerKernelManager.shutdown_kernel()
      • ServerKernelManager.start_kernel()
    • emit_kernel_action_event()
    • KernelWebsocketHandler
      • KernelWebsocketHandler.auth_resource
      • KernelWebsocketHandler.get()
      • KernelWebsocketHandler.get_compression_options()
      • KernelWebsocketHandler.kernel_websocket_connection_class
      • KernelWebsocketHandler.on_close()
      • KernelWebsocketHandler.on_message()
      • KernelWebsocketHandler.open()
      • KernelWebsocketHandler.pre_get()
      • KernelWebsocketHandler.select_subprotocol()
      • KernelWebsocketHandler.set_default_headers()
  • Module contents
• jupyter_server.services.kernelspecs package
  • Submodules
    • KernelSpecHandler
      • KernelSpecHandler.get()
    • KernelSpecsAPIHandler
      • KernelSpecsAPIHandler.auth_resource
    • MainKernelSpecHandler
      • MainKernelSpecHandler.get()
    • is_kernelspec_model()
    • kernelspec_model()
  • Module contents
• jupyter_server.services.nbconvert package
  • Submodules
    • NbconvertRootHandler
      • NbconvertRootHandler.auth_resource
      • NbconvertRootHandler.get()
      • NbconvertRootHandler.initialize()
  • Module contents
• jupyter_server.services.security package
  • Submodules
    • CSPReportHandler
      • CSPReportHandler.auth_resource
      • CSPReportHandler.check_xsrf_cookie()
      • CSPReportHandler.post()
      • CSPReportHandler.skip_check_origin()
  • Module contents
• jupyter_server.services.sessions package
  • Submodules
    • SessionHandler
      • SessionHandler.delete()
      • SessionHandler.get()
      • SessionHandler.patch()
    • SessionRootHandler
      • SessionRootHandler.get()
      • SessionRootHandler.post()
    • SessionsAPIHandler
      • SessionsAPIHandler.auth_resource
    • KernelSessionRecord
      • KernelSessionRecord.kernel_id
      • KernelSessionRecord.session_id
      • KernelSessionRecord.update()
    • KernelSessionRecordConflict
    • KernelSessionRecordList
      • KernelSessionRecordList.get()
      • KernelSessionRecordList.remove()
      • KernelSessionRecordList.update()
    • SessionManager
      • SessionManager.close()
      • SessionManager.connection
      • SessionManager.contents_manager
      • SessionManager.create_session()
      • SessionManager.cursor
      • SessionManager.database_filepath
      • SessionManager.delete_session()
      • SessionManager.get_kernel_env()
      • SessionManager.get_session()
      • SessionManager.kernel_culled()
      • SessionManager.kernel_manager
      • SessionManager.list_sessions()
      • SessionManager.new_session_id()
      • SessionManager.row_to_model()
      • SessionManager.save_session()
      • SessionManager.session_exists()
      • SessionManager.start_kernel_for_session()
      • SessionManager.update_session()
  • Module contents

Submodules

HTTP handler to shut down the Jupyter server.

class jupyter_server.services.shutdown.ShutdownHandler(application, request, **kwargs)

Bases: JupyterHandler

A shutdown API handler.

auth_resource = 'server'

post()

Shut down the server.

Module contents