Skip to content

get_config

yohou.plotting._utils.get_config()

Return a copy of the current global plotting configuration.

Returns

Type Description
dict

Dictionary with current configuration values.

Examples

>>> from yohou.plotting import get_config
>>> get_config()["resampler"]
False

See Also

set_config : Set global configuration values. config_context : Temporarily override configuration.

Source Code

View on GitHub

Show/Hide source 
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
def get_config() -> dict:
    """Return a copy of the current global plotting configuration.

    Returns
    -------
    dict
        Dictionary with current configuration values.

    Examples
    --------
    >>> from yohou.plotting import get_config
    >>> get_config()["resampler"]
    False

    See Also
    --------
    [`set_config`][yohou.plotting.set_config] : Set global configuration values.
    [`config_context`][yohou.plotting.config_context] : Temporarily override configuration.
    """
    return _global_config.copy()