Source code for imod.util.context

import contextlib
import os
import pathlib
import warnings
from typing import Union




@contextlib.contextmanager
def ignore_warnings():
    """
    Contextmanager to ignore RuntimeWarnings as they are frequently
    raised by the Dask delayed scheduler.

    Examples
    --------
    >>> with imod.util.context.ignore_warnings():
            function_that_throws_warnings()

    """
    with warnings.catch_warnings():
        warnings.simplefilter("ignore", RuntimeWarning)
        yield





@contextlib.contextmanager
def cd(path: Union[str, pathlib.Path]):
    """
    Change directory, and change it back after the with block.

    Examples
    --------
    >>> with imod.util.context.cd("docs"):
            do_something_in_docs()

    """
    curdir = os.getcwd()
    os.chdir(path)
    try:
        yield
    finally:
        os.chdir(curdir)





@contextlib.contextmanager
def print_if_error(exception_type: type[BaseException]):
    """
    Prints error instead of raising it. Useful for cases when pieces of code are
    expected to fail, but the script needs to continue. This is a common
    use-case for examples in the documentation.

    Parameters
    ----------
    exception_type: Exception
        Exception to accept

    Examples
    --------
    >>> with print_if_error(TypeError):
            1 + "a"
    """
    try:
        yield
    except exception_type as e:
        print(e)