Skip to content

config_context

sklearn_wrap.config.config_context(*, trusted_modules=None)

Context manager to temporarily set sklearn-wrap configuration.

Configuration is restored to its previous state when the context exits, even if an exception is raised.

Parameters

Name Type Description Default
trusted_modules frozenset[str] or None

If not None, temporarily replace the trusted modules set.

 None

Examples

>>> with config_context(trusted_modules=frozenset({"sklearn", "xgboost"})):
...     get_config()["trusted_modules"] == frozenset({"sklearn", "xgboost"})
True
>>> get_config()["trusted_modules"] == DEFAULT_TRUSTED_MODULES
True

See Also

set_config : Persistently update the configuration. get_config : Retrieve the current configuration.

Source Code

View on GitHub

Show/Hide source 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
@contextlib.contextmanager
def config_context(*, trusted_modules: frozenset[str] | None = None) -> Generator[None, None, None]:
    """Context manager to temporarily set sklearn-wrap configuration.

    Configuration is restored to its previous state when the context exits,
    even if an exception is raised.

    Parameters
    ----------
    trusted_modules : frozenset[str] or None
        If not ``None``, temporarily replace the trusted modules set.

    Examples
    --------
    >>> with config_context(trusted_modules=frozenset({"sklearn", "xgboost"})):
    ...     get_config()["trusted_modules"] == frozenset({"sklearn", "xgboost"})
    True
    >>> get_config()["trusted_modules"] == DEFAULT_TRUSTED_MODULES
    True

    See Also
    --------
    set_config : Persistently update the configuration.
    get_config : Retrieve the current configuration.
    """
    old_config = getattr(_threadlocal, "config", {}).copy()
    try:
        set_config(trusted_modules=trusted_modules)
        yield
    finally:
        _threadlocal.config = old_config