Configuration file routines (config)

Functions:

get_git_root_path([cwd])	Get root path of git repo.
get_config_files([cwd, home, config_name])	Find the config file
create_config(host, port, root, dir_prefix, ...)	Create a configuration file.

Classes:

Config(data[, default_params])

Configuration handler

open_notebook.config.get_git_root_path(cwd=None)

Get root path of git repo.

open_notebook.config.get_config_files(cwd='.', home=None, config_name='.open-notebook.toml')

Find the config file

Order for search is “current directory”, “git root”, “user home”.

Parameters:

• cwd (str or Path, default ".") – Current directory.

• home (str or Path, optional) – Defaults to pathlib.Path.home. For testing purposes.

• config_name (str, default ".open-notebook.ini")

• Name of config file

class open_notebook.config.Config(data, default_params=None)

Bases: object

Configuration handler

Accepts multiple mappings. Will parse them left to right for matches

Methods:

get(*keys[, default, factory])	Get value from config(s)
get_option(key[, passed, section, default, ...])	Get option value from either passed in option, or from config file (left to right).
host([section, passed, default])	Host option.
port([section, passed, default])	Port option.
root([section, passed, default])	Root option.
dir_prefix([section, passed, default])	Directory prefix option.
file_prefix([section, passed, default])	File prefix option.
to_options_dict([section])	Convert options to dictionary.
from_paths(paths[, default_params])	Create from path(s).
from_strings(strings[, default_params])	Create from string(s).
from_config_files([name, cwd, home, ...])	Create from config file(s).

get(*keys, default=MISSING, factory=None)

Get value from config(s)

get_option(key, passed=MISSING, section=None, default=MISSING, factory=None)

Get option value from either passed in option, or from config file (left to right).

Order of checking is:

• passed

• data[section][key] for data in self.data.

• data[key] for data in self.data.

• factory

• default

Parameters:

• key (str, optional) – key to look for.

• passed (default MISSING) – Passed in value. If not MISSING, this will be the returned value.

• section (str, optional) – The table section to check. Fall back to top level of any dict.

• factory (callable(), optional) – If no value found, return factory().

• default – Fallback value to return

host(section=None, passed=MISSING, default=MISSING)

Host option.

port(section=None, passed=MISSING, default=MISSING)

Port option.

root(section=None, passed=MISSING, default=MISSING)

Root option.

dir_prefix(section=None, passed=MISSING, default=MISSING)

Directory prefix option.

file_prefix(section=None, passed=MISSING, default=MISSING)

File prefix option.

to_options_dict(section=None, **kws)

Convert options to dictionary.

classmethod from_paths(paths, default_params=None)

Create from path(s).

classmethod from_strings(strings, default_params=None)

Create from string(s).

classmethod from_config_files(name='.open-notebook.toml', cwd='.', home=None, default_params=None)

Create from config file(s).

open_notebook.config.create_config(host, port, root, dir_prefix, file_prefix, path=None, overwrite=False, home=None)

Create a configuration file.