# coding: utf-8
"""Warning module of the psyplot python module.
This module controls the warning behaviour of the module via the python
builtin warnings module and introduces three new warning classes:
..autosummay::
PsPylotRuntimeWarning
PsyPlotWarning
PsyPlotCritical"""
# SPDX-FileCopyrightText: 2016-2024 University of Lausanne
# SPDX-FileCopyrightText: 2020-2021 Helmholtz-Zentrum Geesthacht
# SPDX-FileCopyrightText: 2021-2024 Helmholtz-Zentrum hereon GmbH
#
# SPDX-License-Identifier: LGPL-3.0-only
import logging
import warnings
# disable a warning about "comparison to 'None' in backend_pdf which occurs
# in the matplotlib.backends.backend_pdf.PdfPages class
warnings.filterwarnings(
"ignore",
"comparison",
FutureWarning,
"matplotlib.backends.backend_pdf",
2264,
)
# disable a warning about "np.array_split" that occurs for certain numpy
# versions
warnings.filterwarnings(
"ignore",
"in the future np.array_split will retain",
FutureWarning,
"numpy.lib.shape_base",
431,
)
# disable a warning about "elementwise comparison of a string" in the
# matplotlib.collection.Collection.get_edgecolor method that occurs for certain
# matplotlib and numpy versions
warnings.filterwarnings(
"ignore",
"elementwise comparison failed",
FutureWarning,
"matplotlib.collections",
590,
)
logger = logging.getLogger(__name__)
[docs]
class PsyPlotRuntimeWarning(RuntimeWarning):
"""Runtime warning that appears only ones"""
pass
[docs]
class PsyPlotWarning(UserWarning):
"""Normal UserWarning for psyplot module"""
pass
[docs]
class PsyPlotCritical(UserWarning):
"""Critical UserWarning for psyplot module"""
pass
_issued_psyplot_warnings = []
warnings.simplefilter("default", PsyPlotWarning)
warnings.simplefilter("always", PsyPlotCritical)
[docs]
def disable_warnings(critical=False):
"""Function that disables all warnings and all critical warnings (if
critical evaluates to True) related to the psyplot Module.
Please note that you can also configure the warnings via the
psyplot.warning logger (logging.getLogger(psyplot.warning))."""
warnings.filterwarnings("ignore", r"\w", PsyPlotWarning, "psyplot", 0)
if critical:
warnings.filterwarnings("ignore", r"\w", PsyPlotCritical, "psyplot", 0)
[docs]
def warn(message, category=PsyPlotWarning, logger=None):
"""wrapper around the warnings.warn function for non-critical warnings.
logger may be a logging.Logger instance"""
if logger is not None:
message = "[Warning by %s]\n%s" % (logger.name, message)
warnings.warn(message, category, stacklevel=3)
[docs]
def critical(message, category=PsyPlotCritical, logger=None):
"""wrapper around the warnings.warn function for critical warnings.
logger may be a logging.Logger instance"""
if logger is not None:
message = "[Critical warning by %s]\n%s" % (logger.name, message)
warnings.warn(message, category, stacklevel=2)
old_showwarning = warnings.showwarning
[docs]
def customwarn(message, category, filename, lineno, *args, **kwargs):
"""Use the psyplot.warning logger for categories being out of
PsyPlotWarning and PsyPlotCritical and the default warnings.showwarning
function for all the others."""
if category is PsyPlotWarning:
# for whatever reason, the `default` warnings filter does not work
# when hovering over plots. This is why we implement a custom warning
# filter here
key = (str(message), filename, lineno)
if key not in _issued_psyplot_warnings:
logger.warning(
warnings.formatwarning(
"\n%s" % message, category, filename, lineno
)
)
_issued_psyplot_warnings.append(key)
elif category is PsyPlotCritical:
logger.critical(
warnings.formatwarning(
"\n%s" % message, category, filename, lineno
),
exc_info=True,
)
else:
old_showwarning(message, category, filename, lineno, *args, **kwargs)
warnings.showwarning = customwarn