Source code for

# Copyright 2021 IRT Saint Exupéry,
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License version 3 as published by the Free Software Foundation.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# Lesser General Public License for more details.
# You should have received a copy of the GNU Lesser General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
# Contributors:
#    INITIAL AUTHORS - initial API and implementation and/or initial
#                           documentation
#        :author: Matthias De Lozzo
"""A factory to create instances of :class:`.DatasetPlot`.

The module :mod:`` contains the :class:`.DatasetPlotFactory`
class which is a factory to instantiate a :class:`.DatasetPlot` from its class name. The
class can be internal to |g| or located in an external module whose path is provided to
the constructor. It also provides a list of available cache types and allows you to test
if a cache type is available.
from __future__ import annotations

import logging
from typing import TYPE_CHECKING

    from gemseo.core.dataset import Dataset

from gemseo.core.factory import Factory
from import DatasetPlot

LOGGER = logging.getLogger(__name__)

[docs]class DatasetPlotFactory: """This factory instantiates a :class:`.DatasetPlot` from its class name.""" def __init__(self) -> None: # noqa: D107 self.factory = Factory(DatasetPlot, ("",))
[docs] def create( self, plot_name: str, dataset: Dataset, **options, ) -> DatasetPlot: """Create a plot for dataset. Args: plot_name: The name of a plot method for dataset (its class name). dataset: The dataset to visualize. options: The additional options specific to this plot method. Returns: A plot method built from the provided dataset. """ return self.factory.create(plot_name, dataset=dataset, **options)
@property def plots(self) -> list[str]: """The available plot methods for dataset.""" return self.factory.classes
[docs] def is_available( self, plot_name: str, ) -> bool: """Check the availability of a plot for dataset. Args: plot_name: The name of a plot method for dataset (its class name). Returns: True if the plot method is available. """ return self.factory.is_available(plot_name)