17569144994

Committed 09 Sep 2025 01:39AM UTC coverage: 90.14% (+0.06%) from 90.077%

Build # 17569144994

Build Type

push

github

Committed by

morganjwilliams

Commit Message

Update example for interactive plotting API

Run Details

0 of 30 new or added lines in 2 files covered. (0.0%)

53 existing lines in 6 files now uncovered.

6226 of 6907 relevant lines covered (90.14%)

10.81 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/pyrolite/util/plot/backend.py

import warnings

import pandas as pd

from ..log import Handle
from ...plot import pyroplot_matplotlib

logger = Handle(__name__)

BACKEND = "matplotlib"


def _get_backend():
    return BACKEND


_backend_accessors = {"matplotlib": pyroplot_matplotlib}
try:
    import plotly.graph_objects as go

    HAVE_PLOTLY = True

    from .plotly import pyroplot_plotly

    _backend_accessors["plotly"] = pyroplot_plotly

except ImportError:
    HAVE_PLOTLY = False


def set_plotting_backend(backend=None, revert=False):
    if backend is not None:
        if backend in ["matplotlib", "plotly"]:
            global BACKEND
            if BACKEND != backend:
                logger.debug(
                    "{} plotting backend to {}".format(
                        "Reverting" if revert else "Setting", backend
                    )
                )
                BACKEND = backend
        else:
            raise NotImplementedError("Backend {} not available.")


class pyroplot(object):
    def __init__(self, obj):
        """
        Custom dataframe accessor for pyrolite plotting.

        Notes
        -----
            This accessor enables the coexistence of array-based plotting functions and
            methods for pandas objects. This enables some separation of concerns.
        """
        self._obj = obj

    def scatter(self, *args, backend=None, **kwargs):
        with Backend(backend=backend):
            return _backend_accessors[_get_backend()](self._obj).scatter(
                *args, **kwargs
            )

    def spider(self, *args, backend=None, **kwargs):
        with Backend(backend=backend):
            return _backend_accessors[_get_backend()](self._obj).spider(*args, **kwargs)


with warnings.catch_warnings():
    # can get invalid values which raise RuntimeWarnings
    # consider changing to np.errstate
    warnings.simplefilter("ignore", category=UserWarning)
    pd.api.extensions.register_dataframe_accessor("pyroplot")(
        pyroplot  # _backend_accessors.get(self.backend)
    )


class Backend:
    """
    Backend context manager for pyrolite plotting.
    """

    def __init__(self, backend=None):
        self.start = _get_backend()
        self.backend = backend
        set_plotting_backend(self.backend)

    def __enter__(self):
        return self

    def __exit__(self, exc_type, exc_value, exc_traceback):
        # only reset when changed in the first place?
        if self.backend is not None:
            set_plotting_backend(self.start, revert=True)

1	import warnings	×
2
3	import pandas as pd	×
4
5	from ..log import Handle	×
6	from ...plot import pyroplot_matplotlib	×
7
8	logger = Handle(__name__)	×
9
10	BACKEND = "matplotlib"	×
11
12
NEW 13	def _get_backend():	×
NEW 14	return BACKEND	×
15
16
17	_backend_accessors = {"matplotlib": pyroplot_matplotlib}	×
18	try:	×
19	import plotly.graph_objects as go	×
20
UNCOV 21	HAVE_PLOTLY = True	×
22
23	from .plotly import pyroplot_plotly	×
24
UNCOV 25	_backend_accessors["plotly"] = pyroplot_plotly	×
26
UNCOV 27	except ImportError:	×
28	HAVE_PLOTLY = False	×
29
30
UNCOV 31	def set_plotting_backend(backend=None, revert=False):	×
32	if backend is not None:	×
33	if backend in ["matplotlib", "plotly"]:	×
34	global BACKEND
NEW 35	if BACKEND != backend:	×
NEW 36	logger.debug(	×
37	"{} plotting backend to {}".format(
38	"Reverting" if revert else "Setting", backend
39	)
40	)
NEW 41	BACKEND = backend	×
42	else:
UNCOV 43	raise NotImplementedError("Backend {} not available.")	×
44
45
NEW 46	class pyroplot(object):	×
NEW 47	def __init__(self, obj):	×
48	"""
49	Custom dataframe accessor for pyrolite plotting.
50
51	Notes
52	-----
53	This accessor enables the coexistence of array-based plotting functions and
54	methods for pandas objects. This enables some separation of concerns.
55	"""
NEW 56	self._obj = obj	×
57
NEW 58	def scatter(self, args, backend=None, *kwargs):	×
NEW 59	with Backend(backend=backend):	×
NEW 60	return _backend_accessors[_get_backend()](self._obj).scatter(	×
61	args, *kwargs
62	)
63
NEW 64	def spider(self, args, backend=None, *kwargs):	×
NEW 65	with Backend(backend=backend):	×
NEW 66	return _backend_accessors[_get_backend()](self._obj).spider(args, *kwargs)	×
67
68
NEW 69	with warnings.catch_warnings():	×
70	# can get invalid values which raise RuntimeWarnings
71	# consider changing to np.errstate
NEW 72	warnings.simplefilter("ignore", category=UserWarning)	×
NEW 73	pd.api.extensions.register_dataframe_accessor("pyroplot")(	×
74	pyroplot # _backend_accessors.get(self.backend)
75	)
76
77
78	class Backend:	×
79	"""
80	Backend context manager for pyrolite plotting.
81	"""
82
UNCOV 83	def __init__(self, backend=None):	×
NEW 84	self.start = _get_backend()	×
85	self.backend = backend	×
UNCOV 86	set_plotting_backend(self.backend)	×
87
UNCOV 88	def __enter__(self):	×
89	return self	×
90
91	def __exit__(self, exc_type, exc_value, exc_traceback):	×
92	# only reset when changed in the first place?
UNCOV 93	if self.backend is not None:	×
UNCOV 94	set_plotting_backend(self.start, revert=True)	×

morganjwilliams / pyrolite / 17569144994

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous