Function get

dask/config.py:604–657

Get elements from global config If ``override_with`` is not None this value will be passed straight back. Useful for getting kwarg defaults from Dask config. Use '.' for nested access Examples -------- >>> from dask import config >>> config.get('foo') # doctest:

(
    key: str,
    default: Any = no_default,
    config: dict | None = None,
    override_with: Any = None,
)

def get(
    key: str,
    default: Any = no_default,
    config: dict | None = None,
    override_with: Any = None,
) -> Any:
    """
    Get elements from global config

    If ``override_with`` is not None this value will be passed straight back.
    Useful for getting kwarg defaults from Dask config.

    Use '.' for nested access

    Examples
    --------
    >>> from dask import config
    >>> config.get('foo')  # doctest: +SKIP
    {'x': 1, 'y': 2}

    >>> config.get('foo.x')  # doctest: +SKIP
    1

    >>> config.get('foo.x.y', default=123)  # doctest: +SKIP
    123

    >>> config.get('foo.y', override_with=None)  # doctest: +SKIP
    2

    >>> config.get('foo.y', override_with=3)  # doctest: +SKIP
    3

    See Also
    --------
    dask.config.set
    """
    if override_with is not None:
        return override_with

    if config is None:  # Keep Sphinx autofunction documentation clean
        config = global_config

    keys = key.split(".")
    result = config
    for k in keys:
        k = canonical_name(k, result)
        try:
            result = result[k]
        except (TypeError, IndexError, KeyError):
            if default is no_default:
                raise
            return default

    return result


def pop(key: str, default: Any = no_default, config: dict = config) -> Any: