Source code for pytorch_forecasting.utils._dependencies._dependencies

"""Utilities for managing dependencies.

Copied from sktime/skbase.
"""

from skbase.utils.dependencies import _check_soft_dependencies

__all__ = ["_check_soft_dependencies", "_check_matplotlib"]




def _check_matplotlib(ref="This feature", raise_error=True):
    """Check if matplotlib is installed.

    Parameters
    ----------
    ref : str, optional (default="This feature")
        reference to the feature that requires matplotlib, used in error message
    raise_error : bool, optional (default=True)
        whether to raise an error if matplotlib is not installed

    Returns
    -------
    bool : whether matplotlib is installed
    """
    matplotlib_present = _check_soft_dependencies("matplotlib", severity="none")
    if raise_error and not matplotlib_present:
        raise ImportError(
            f"{ref} requires matplotlib."
            " Please install matplotlib with `pip install matplotlib`."
        )

    return matplotlib_present