Skip to main content
`Ctrl`+`K`

# jupyter_server.services.config package

## Submodules

Tornado handlers for frontend config storage.

class jupyter_server.services.config.handlers.ConfigHandler(application, request, **kwargs)

  Bases: `APIHandler`

  A config API handler.

  auth_resource = 'config'
  get(section_name)

    Get config by section name.

  patch(section_name)

    Update a config section by name.

  put(section_name)

    Set a config section by name.

Manager to read and modify frontend config data in JSON files.

class jupyter_server.services.config.manager.ConfigManager(**kwargs)

  Bases: `LoggingConfigurable`

  Config Manager used for storing frontend config

  config_dir_name

    Name of the config directory.

  get(section_name)

    Get the config from all config sections.

  read_config_path

    An instance of a Python list.

  set(section_name, data)

    Set the config only to the user’s config.

  update(section_name, new_data)

    Update the config only to the user’s config.

  write_config_dir

    A trait for unicode strings.

  write_config_manager

    A trait whose value must be an instance of a specified class.

    The value can also be an instance of a subclass of the specified class.

    Subclasses can declare default classes by overriding the klass attribute

## Module contents

class jupyter_server.services.config.ConfigManager(**kwargs)

  Bases: `LoggingConfigurable`

  Config Manager used for storing frontend config

  config_dir_name

    Name of the config directory.

  get(section_name)

    Get the config from all config sections.

  read_config_path

    An instance of a Python list.

  set(section_name, data)

    Set the config only to the user’s config.

  update(section_name, new_data)

    Update the config only to the user’s config.

  write_config_dir

    A trait for unicode strings.

  write_config_manager

    A trait whose value must be an instance of a specified class.

    The value can also be an instance of a subclass of the specified class.

    Subclasses can declare default classes by overriding the klass attribute