matador.config package

The config simply loads the default or user-specified config.

matador.config.load_custom_settings(config_fname=None, quiet=False, debug=False, no_quickstart=True)[source]

Load mongodb settings dict from file given by fname, or from defaults. Hierarchy of filenames to check:

  1. .matadorrc

  2. ~/.matadorrc

  3. ~/.config/matadorrc

Keyword Arguments:

  • fname (str) – filename of custom settings file.

  • quiet (bool) – print nothing on loading.

  • no_quickstart (bool) – for testing purposes, override any questions.

  • debug (bool) – print settings on loading.

matador.config.set_settings(settings, override=True)[source]

Updates the global settings with the dictionary provided.

Parameters:

settings (dict) – the key-value pairs to use.

Keyword Arguments:

override (bool) – whether or not to override previous settings, or just update.

Submodules

matador.config.config module

This file implements the loading custom settings for plotting and for database collections.

matador.config.config.load_custom_settings(config_fname=None, quiet=False, debug=False, no_quickstart=True)[source]

Load mongodb settings dict from file given by fname, or from defaults. Hierarchy of filenames to check:

  1. .matadorrc

  2. ~/.matadorrc

  3. ~/.config/matadorrc

Keyword Arguments:

  • fname (str) – filename of custom settings file.

  • quiet (bool) – print nothing on loading.

  • no_quickstart (bool) – for testing purposes, override any questions.

  • debug (bool) – print settings on loading.

matador.config.config.set_settings(settings, override=True)[source]

Updates the global settings with the dictionary provided.

Parameters:

settings (dict) – the key-value pairs to use.

Keyword Arguments:

override (bool) – whether or not to override previous settings, or just update.

matador.config.quickstart module

This submodule includes functionality to create a template .matadorrc file.

matador.config.quickstart.quickstart_settings()[source]

Call this if no user-specified configuration file is found. A series of questions will be asked to create a basic matadorrc.

matador.config.settings module

class matador.config.settings.Settings(settings=None)[source]

Bases: object

Light wrapper for global matador settings.

get(key, default=None)[source]
reset()[source]