File size: 2,232 Bytes
d1ceb73 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
"""Manager to read and modify frontend config data in JSON files."""
# Copyright (c) Jupyter Development Team.
# Distributed under the terms of the Modified BSD License.
import os.path
import typing as t
from jupyter_core.paths import jupyter_config_dir, jupyter_config_path
from traitlets import Instance, List, Unicode, default, observe
from traitlets.config import LoggingConfigurable
from jupyter_server.config_manager import BaseJSONConfigManager, recursive_update
class ConfigManager(LoggingConfigurable):
"""Config Manager used for storing frontend config"""
config_dir_name = Unicode("serverconfig", help="""Name of the config directory.""").tag(
config=True
)
# Public API
def get(self, section_name):
"""Get the config from all config sections."""
config: t.Dict[str, t.Any] = {}
# step through back to front, to ensure front of the list is top priority
for p in self.read_config_path[::-1]:
cm = BaseJSONConfigManager(config_dir=p)
recursive_update(config, cm.get(section_name))
return config
def set(self, section_name, data):
"""Set the config only to the user's config."""
return self.write_config_manager.set(section_name, data)
def update(self, section_name, new_data):
"""Update the config only to the user's config."""
return self.write_config_manager.update(section_name, new_data)
# Private API
read_config_path = List(Unicode())
@default("read_config_path")
def _default_read_config_path(self):
return [os.path.join(p, self.config_dir_name) for p in jupyter_config_path()]
write_config_dir = Unicode()
@default("write_config_dir")
def _default_write_config_dir(self):
return os.path.join(jupyter_config_dir(), self.config_dir_name)
write_config_manager = Instance(BaseJSONConfigManager)
@default("write_config_manager")
def _default_write_config_manager(self):
return BaseJSONConfigManager(config_dir=self.write_config_dir)
@observe("write_config_dir")
def _update_write_config_dir(self, change):
self.write_config_manager = BaseJSONConfigManager(config_dir=self.write_config_dir)
|