8232758569

Committed 11 Mar 2024 12:27PM UTC coverage: 89.283% (-0.001%) from 89.284%

Build # 8232758569

Build Type

push

github

Committed by

web-flow

Commit Message

Fix spelling of StatevectorSampler import in API doc. (#11976) (#11984)

(cherry picked from commit f68da7f4a)

Co-authored-by: Blake Johnson <blakejohnson04@gmail.com>

Run Details

58908 of 65979 relevant lines covered (89.28%)

184262.59 hits per line

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

0.0

/qiskit/visualization/timeline/plotters/base_plotter.py

# This code is part of Qiskit.
#
# (C) Copyright IBM 2020.
#
# This code is licensed under the Apache License, Version 2.0. You may
# obtain a copy of this license in the LICENSE.txt file in the root directory
# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
#
# Any modifications or derivative works of this code must retain this
# copyright notice, and modified files need to carry a notice indicating
# that they have been altered from the originals.

"""Base plotter API."""

from abc import ABC, abstractmethod
from typing import Any

from qiskit.visualization.timeline import core


class BasePlotter(ABC):
    """Base class of Qiskit plotter."""

    def __init__(self, canvas: core.DrawerCanvas):
        """Create new plotter.
        Args:
            canvas: Configured drawer canvas object.
        """
        self.canvas = canvas

    @abstractmethod
    def initialize_canvas(self):
        """Format appearance of the canvas."""
        raise NotImplementedError

    @abstractmethod
    def draw(self):
        """Output drawings stored in canvas object."""
        raise NotImplementedError

    @abstractmethod
    def save_file(self, filename: str):
        """Save image to file.
        Args:
            filename: File path to output image data.
        """
        raise NotImplementedError

    @abstractmethod
    def get_image(self, interactive: bool = False) -> Any:
        """Get image data to return.
        Args:
            interactive: When set `True` show the circuit in a new window.
                This depends on the matplotlib backend being used supporting this.
        Returns:
            Image data. This depends on the plotter API.
        """
        raise NotImplementedError

1	# This code is part of Qiskit.
2	#
3	# (C) Copyright IBM 2020.
4	#
5	# This code is licensed under the Apache License, Version 2.0. You may
6	# obtain a copy of this license in the LICENSE.txt file in the root directory
7	# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
8	#
9	# Any modifications or derivative works of this code must retain this
10	# copyright notice, and modified files need to carry a notice indicating
11	# that they have been altered from the originals.
12
13	"""Base plotter API."""	×
14
15	from abc import ABC, abstractmethod	×
16	from typing import Any	×
17
18	from qiskit.visualization.timeline import core	×
19
20
21	class BasePlotter(ABC):	×
22	"""Base class of Qiskit plotter."""
23
24	def __init__(self, canvas: core.DrawerCanvas):	×
25	"""Create new plotter.
26	Args:
27	canvas: Configured drawer canvas object.
28	"""
29	self.canvas = canvas	×
30
31	@abstractmethod	×
32	def initialize_canvas(self):	×
33	"""Format appearance of the canvas."""
34	raise NotImplementedError	×
35
36	@abstractmethod	×
37	def draw(self):	×
38	"""Output drawings stored in canvas object."""
39	raise NotImplementedError	×
40
41	@abstractmethod	×
42	def save_file(self, filename: str):	×
43	"""Save image to file.
44	Args:
45	filename: File path to output image data.
46	"""
47	raise NotImplementedError	×
48
49	@abstractmethod	×
50	def get_image(self, interactive: bool = False) -> Any:	×
51	"""Get image data to return.
52	Args:
53	interactive: When set `True` show the circuit in a new window.
54	This depends on the matplotlib backend being used supporting this.
55	Returns:
56	Image data. This depends on the plotter API.
57	"""
58	raise NotImplementedError	×

Qiskit / qiskit / 8232758569

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