9960299837

Committed 16 Jul 2024 03:10PM UTC coverage: 89.952% (+0.008%) from 89.944%

Build # 9960299837

Build Type

push

github

Committed by

web-flow

Commit Message

Fix pass-manager drawing tests for pydot 3.0 (#12775) (#12778)

* Fix pass-manager drawing tests for pydot 3.0

Two changes in pydot 3 changed the reference output:

1. previously, attributes were sorted before being output.  Pydot 3
   stores them in declaration order.  Here, we sort our attributes to
   maintain the closest behaviour between the two versions.

2. Text fields (like `label`) that contain special characters now have
   their values enclosed in quote marks.  This is a difference between
   the two versions, and we update the reference files to the new
   version since that's what we'll be using in CI.

Qiskit is still compatible with pydot 2 in general usage, it's just our
tests that are a little more tied to the current version.

* Add test-only constraint on pydot

(cherry picked from commit c3b468c83)

Co-authored-by: Jake Lishman <jake.lishman@ibm.com>

Run Details

0 of 2 new or added lines in 1 file covered. (0.0%)

8 existing lines in 3 files now uncovered.

61853 of 68762 relevant lines covered (89.95%)

233652.15 hits per line

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

17.54

/qiskit/visualization/pass_manager_visualization.py

# This code is part of Qiskit.
#
# (C) Copyright IBM 2019.
#
# 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.

"""
Visualization function for a pass manager. Passes are grouped based on their
flow controller, and coloured based on the type of pass.
"""
from __future__ import annotations

import os
import inspect
import tempfile

from qiskit.utils import optionals as _optionals
from qiskit.passmanager.base_tasks import BaseController, GenericPass
from qiskit.passmanager.flow_controllers import FlowControllerLinear
from qiskit.transpiler.basepasses import AnalysisPass, TransformationPass
from .exceptions import VisualizationError

DEFAULT_STYLE = {AnalysisPass: "red", TransformationPass: "blue"}


@_optionals.HAS_GRAPHVIZ.require_in_call
@_optionals.HAS_PYDOT.require_in_call
def pass_manager_drawer(pass_manager, filename=None, style=None, raw=False):
    """
    Draws the pass manager.

    This function needs `pydot <https://github.com/pydot/pydot>`__, which in turn needs
    `Graphviz <https://www.graphviz.org/>`__ to be installed.

    Args:
        pass_manager (PassManager): the pass manager to be drawn
        filename (str): file path to save image to
        style (dict or OrderedDict): keys are the pass classes and the values are
            the colors to make them. An example can be seen in the DEFAULT_STYLE. An ordered
            dict can be used to ensure a priority coloring when pass falls into multiple
            categories. Any values not included in the provided dict will be filled in from
            the default dict
        raw (Bool) : True if you want to save the raw Dot output not an image. The
            default is False.
    Returns:
        PIL.Image or None: an in-memory representation of the pass manager. Or None if
        no image was generated or PIL is not installed.
    Raises:
        MissingOptionalLibraryError: when nxpd or pydot not installed.
        VisualizationError: If raw=True and filename=None.

    Example:
        .. code-block::

             %matplotlib inline
            from qiskit import QuantumCircuit
            from qiskit.compiler import transpile
            from qiskit.transpiler import PassManager
            from qiskit.visualization import pass_manager_drawer
            from qiskit.transpiler.passes import Unroller

            circ = QuantumCircuit(3)
            circ.ccx(0, 1, 2)
            circ.draw()

            pass_ = Unroller(['u1', 'u2', 'u3', 'cx'])
            pm = PassManager(pass_)
            new_circ = pm.run(circ)
            new_circ.draw(output='mpl')

            pass_manager_drawer(pm, "passmanager.jpg")
    """
    import pydot

    if not style:
        style = DEFAULT_STYLE

    # create the overall graph
    graph = pydot.Dot()

    # identifiers for nodes need to be unique, so assign an id
    # can't just use python's id in case the exact same pass was
    # appended more than once
    component_id = 0

    prev_node = None

    for index, controller_group in enumerate(pass_manager.to_flow_controller().tasks):
        subgraph, component_id, prev_node = draw_subgraph(
            controller_group, component_id, style, prev_node, index
        )
        graph.add_subgraph(subgraph)

    output = make_output(graph, raw, filename)
    return output


def _get_node_color(pss, style):
    # look in the user provided dict first
    for typ, color in style.items():
        if isinstance(pss, typ):
            return color

    # failing that, look in the default
    for typ, color in DEFAULT_STYLE.items():
        if isinstance(pss, typ):
            return color

    return "black"


@_optionals.HAS_GRAPHVIZ.require_in_call
@_optionals.HAS_PYDOT.require_in_call
def staged_pass_manager_drawer(pass_manager, filename=None, style=None, raw=False):
    """
    Draws the staged pass manager.

        This function needs `pydot <https://github.com/erocarrera/pydot>`__, which in turn needs
    `Graphviz <https://www.graphviz.org/>`__ to be installed.

    Args:
        pass_manager (StagedPassManager): the staged pass manager to be drawn
        filename (str): file path to save image to
        style (dict or OrderedDict): keys are the pass classes and the values are
            the colors to make them. An example can be seen in the DEFAULT_STYLE. An ordered
            dict can be used to ensure a priority coloring when pass falls into multiple
            categories. Any values not included in the provided dict will be filled in from
            the default dict
        raw (Bool) : True if you want to save the raw Dot output not an image. The
            default is False.
    Returns:
        PIL.Image or None: an in-memory representation of the pass manager. Or None if
        no image was generated or PIL is not installed.
    Raises:
        MissingOptionalLibraryError: when nxpd or pydot not installed.
        VisualizationError: If raw=True and filename=None.

    Example:
        .. code-block::

            %matplotlib inline
            from qiskit.providers.fake_provider import GenericBackendV2
            from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager

            pass_manager = generate_preset_pass_manager(3, GenericBackendV2(num_qubits=5))
            pass_manager.draw()
    """
    import pydot

    # only include stages that have passes
    stages = list(filter(lambda s: s is not None, pass_manager.expanded_stages))

    if not style:
        style = DEFAULT_STYLE

    # create the overall graph
    graph = pydot.Dot()

    # identifiers for nodes need to be unique, so assign an id
    # can't just use python's id in case the exact same pass was
    # appended more than once
    component_id = 0

    # keep a running count of indexes across stages
    idx = 0

    prev_node = None

    for st in stages:
        stage = getattr(pass_manager, st)

        if stage is not None:
            stagegraph = pydot.Cluster(str(st), fontname="helvetica", label=str(st), labeljust="l")
            for controller_group in stage.to_flow_controller().tasks:
                subgraph, component_id, prev_node = draw_subgraph(
                    controller_group, component_id, style, prev_node, idx
                )
                stagegraph.add_subgraph(subgraph)
                idx += 1
            graph.add_subgraph(stagegraph)

    output = make_output(graph, raw, filename)
    return output


def draw_subgraph(controller_group, component_id, style, prev_node, idx):
    """Draw subgraph."""
    import pydot

    # label is the name of the flow controller parameter
    label = f"[{idx}] "
    if isinstance(controller_group, BaseController) and not isinstance(
        controller_group, FlowControllerLinear
    ):
        label += f"{controller_group.__class__.__name__}"

    # create the subgraph for this controller
    subgraph = pydot.Cluster(str(component_id), fontname="helvetica", label=label, labeljust="l")
    component_id += 1

    if isinstance(controller_group, BaseController):
        # Assume linear pipeline
        # TODO: support pipeline branching when such controller is introduced
        tasks = getattr(controller_group, "tasks", [])
    elif isinstance(controller_group, GenericPass):
        tasks = [controller_group]
    elif isinstance(controller_group, (list, tuple)):
        tasks = controller_group
    else:
        # Invalid data
        return subgraph, component_id, prev_node

    flatten_tasks = []
    for task in tasks:
        # Flatten nested linear flow controller.
        # This situation often occurs in the builtin pass managers because it constructs
        # some stages by appending other pass manager instance converted into a linear controller.
        # Flattening inner linear controller tasks doesn't change the execution.
        if isinstance(task, FlowControllerLinear):
            flatten_tasks.extend(task.tasks)
        else:
            flatten_tasks.append(task)

    for task in flatten_tasks:
        if isinstance(task, BaseController):
            # Partly nested flow controller
            # TODO recursively inject subgraph into subgraph
            node = pydot.Node(
                str(component_id),
                color="k",
                fontname="helvetica",
                label="Nested flow controller",
                shape="rectangle",
            )
        else:
            # label is the name of the pass
            node = pydot.Node(
                str(component_id),
                color=_get_node_color(task, style),
                fontname="helvetica",
                label=str(type(task).__name__),
                shape="rectangle",
            )

        subgraph.add_node(node)
        component_id += 1

        # the arguments that were provided to the pass when it was created
        arg_spec = inspect.getfullargspec(task.__init__)
        # 0 is the args, 1: to remove the self arg
        args = arg_spec[0][1:]

        num_optional = len(arg_spec[3]) if arg_spec[3] else 0

        # add in the inputs to the pass
        for arg_index, arg in enumerate(args):
            nd_style = "solid"
            # any optional args are dashed
            # the num of optional counts from the end towards the start of the list
            if arg_index >= (len(args) - num_optional):
                nd_style = "dashed"

            input_node = pydot.Node(
                component_id,
                color="black",
                fontname="helvetica",
                fontsize=10,
                label=arg,
                shape="ellipse",
                style=nd_style,
            )
            subgraph.add_node(input_node)
            component_id += 1
            subgraph.add_edge(pydot.Edge(input_node, node))

        # if there is a previous node, add an edge between them
        if prev_node:
            subgraph.add_edge(pydot.Edge(prev_node, node))

        prev_node = node

    return subgraph, component_id, prev_node


def make_output(graph, raw, filename):
    """Produce output for pass_manager."""
    if raw:
        if filename:
            graph.write(filename, format="raw")
            return None
        else:
            raise VisualizationError("if format=raw, then a filename is required.")

    if not _optionals.HAS_PIL and filename:
        # pylint says this isn't a method - it is
        graph.write_png(filename)
        return None

    _optionals.HAS_PIL.require_now("pass manager drawer")

    with tempfile.TemporaryDirectory() as tmpdirname:
        from PIL import Image

        tmppath = os.path.join(tmpdirname, "pass_manager.png")

        # pylint says this isn't a method - it is
        graph.write_png(tmppath)

        image = Image.open(tmppath)
        os.remove(tmppath)
        if filename:
            image.save(filename, "PNG")
        return image

1	# This code is part of Qiskit.
2	#
3	# (C) Copyright IBM 2019.
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	"""	1✔
14	Visualization function for a pass manager. Passes are grouped based on their
15	flow controller, and coloured based on the type of pass.
16	"""
17	from __future__ import annotations	1✔
18
19	import os	1✔
20	import inspect	1✔
21	import tempfile	1✔
22
23	from qiskit.utils import optionals as _optionals	1✔
24	from qiskit.passmanager.base_tasks import BaseController, GenericPass	1✔
25	from qiskit.passmanager.flow_controllers import FlowControllerLinear	1✔
26	from qiskit.transpiler.basepasses import AnalysisPass, TransformationPass	1✔
27	from .exceptions import VisualizationError	1✔
28
29	DEFAULT_STYLE = {AnalysisPass: "red", TransformationPass: "blue"}	1✔
30
31
32	@_optionals.HAS_GRAPHVIZ.require_in_call	1✔
33	@_optionals.HAS_PYDOT.require_in_call	1✔
34	def pass_manager_drawer(pass_manager, filename=None, style=None, raw=False):	1✔
35	"""
36	Draws the pass manager.
37
38	This function needs `pydot <https://github.com/pydot/pydot>`__, which in turn needs
39	`Graphviz <https://www.graphviz.org/>`__ to be installed.
40
41	Args:
42	pass_manager (PassManager): the pass manager to be drawn
43	filename (str): file path to save image to
44	style (dict or OrderedDict): keys are the pass classes and the values are
45	the colors to make them. An example can be seen in the DEFAULT_STYLE. An ordered
46	dict can be used to ensure a priority coloring when pass falls into multiple
47	categories. Any values not included in the provided dict will be filled in from
48	the default dict
49	raw (Bool) : True if you want to save the raw Dot output not an image. The
50	default is False.
51	Returns:
52	PIL.Image or None: an in-memory representation of the pass manager. Or None if
53	no image was generated or PIL is not installed.
54	Raises:
55	MissingOptionalLibraryError: when nxpd or pydot not installed.
56	VisualizationError: If raw=True and filename=None.
57
58	Example:
59	.. code-block::
60
61	%matplotlib inline
62	from qiskit import QuantumCircuit
63	from qiskit.compiler import transpile
64	from qiskit.transpiler import PassManager
65	from qiskit.visualization import pass_manager_drawer
66	from qiskit.transpiler.passes import Unroller
67
68	circ = QuantumCircuit(3)
69	circ.ccx(0, 1, 2)
70	circ.draw()
71
72	pass_ = Unroller(['u1', 'u2', 'u3', 'cx'])
73	pm = PassManager(pass_)
74	new_circ = pm.run(circ)
75	new_circ.draw(output='mpl')
76
77	pass_manager_drawer(pm, "passmanager.jpg")
78	"""
79	import pydot	×
80
81	if not style:	×
82	style = DEFAULT_STYLE	×
83
84	# create the overall graph
85	graph = pydot.Dot()	×
86
87	# identifiers for nodes need to be unique, so assign an id
88	# can't just use python's id in case the exact same pass was
89	# appended more than once
90	component_id = 0	×
91
92	prev_node = None	×
93
94	for index, controller_group in enumerate(pass_manager.to_flow_controller().tasks):	×
95	subgraph, component_id, prev_node = draw_subgraph(	×
96	controller_group, component_id, style, prev_node, index
97	)
98	graph.add_subgraph(subgraph)	×
99
100	output = make_output(graph, raw, filename)	×
101	return output	×
102
103
104	def _get_node_color(pss, style):	1✔
105	# look in the user provided dict first
106	for typ, color in style.items():	×
107	if isinstance(pss, typ):	×
108	return color	×
109
110	# failing that, look in the default
111	for typ, color in DEFAULT_STYLE.items():	×
112	if isinstance(pss, typ):	×
113	return color	×
114
115	return "black"	×
116
117
118	@_optionals.HAS_GRAPHVIZ.require_in_call	1✔
119	@_optionals.HAS_PYDOT.require_in_call	1✔
120	def staged_pass_manager_drawer(pass_manager, filename=None, style=None, raw=False):	1✔
121	"""
122	Draws the staged pass manager.
123
124	This function needs `pydot <https://github.com/erocarrera/pydot>`__, which in turn needs
125	`Graphviz <https://www.graphviz.org/>`__ to be installed.
126
127	Args:
128	pass_manager (StagedPassManager): the staged pass manager to be drawn
129	filename (str): file path to save image to
130	style (dict or OrderedDict): keys are the pass classes and the values are
131	the colors to make them. An example can be seen in the DEFAULT_STYLE. An ordered
132	dict can be used to ensure a priority coloring when pass falls into multiple
133	categories. Any values not included in the provided dict will be filled in from
134	the default dict
135	raw (Bool) : True if you want to save the raw Dot output not an image. The
136	default is False.
137	Returns:
138	PIL.Image or None: an in-memory representation of the pass manager. Or None if
139	no image was generated or PIL is not installed.
140	Raises:
141	MissingOptionalLibraryError: when nxpd or pydot not installed.
142	VisualizationError: If raw=True and filename=None.
143
144	Example:
145	.. code-block::
146
147	%matplotlib inline
148	from qiskit.providers.fake_provider import GenericBackendV2
149	from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager
150
151	pass_manager = generate_preset_pass_manager(3, GenericBackendV2(num_qubits=5))
152	pass_manager.draw()
153	"""
154	import pydot	×
155
156	# only include stages that have passes
157	stages = list(filter(lambda s: s is not None, pass_manager.expanded_stages))	×
158
159	if not style:	×
160	style = DEFAULT_STYLE	×
161
162	# create the overall graph
163	graph = pydot.Dot()	×
164
165	# identifiers for nodes need to be unique, so assign an id
166	# can't just use python's id in case the exact same pass was
167	# appended more than once
168	component_id = 0	×
169
170	# keep a running count of indexes across stages
171	idx = 0	×
172
173	prev_node = None	×
174
175	for st in stages:	×
176	stage = getattr(pass_manager, st)	×
177
178	if stage is not None:	×
NEW 179	stagegraph = pydot.Cluster(str(st), fontname="helvetica", label=str(st), labeljust="l")	×
180	for controller_group in stage.to_flow_controller().tasks:	×
181	subgraph, component_id, prev_node = draw_subgraph(	×
182	controller_group, component_id, style, prev_node, idx
183	)
184	stagegraph.add_subgraph(subgraph)	×
185	idx += 1	×
186	graph.add_subgraph(stagegraph)	×
187
188	output = make_output(graph, raw, filename)	×
189	return output	×
190
191
192	def draw_subgraph(controller_group, component_id, style, prev_node, idx):	1✔
193	"""Draw subgraph."""
194	import pydot	×
195
196	# label is the name of the flow controller parameter
197	label = f"[{idx}] "	×
198	if isinstance(controller_group, BaseController) and not isinstance(	×
199	controller_group, FlowControllerLinear
200	):
201	label += f"{controller_group.__class__.__name__}"	×
202
203	# create the subgraph for this controller
NEW 204	subgraph = pydot.Cluster(str(component_id), fontname="helvetica", label=label, labeljust="l")	×
205	component_id += 1	×
206
207	if isinstance(controller_group, BaseController):	×
208	# Assume linear pipeline
209	# TODO: support pipeline branching when such controller is introduced
210	tasks = getattr(controller_group, "tasks", [])	×
211	elif isinstance(controller_group, GenericPass):	×
212	tasks = [controller_group]	×
213	elif isinstance(controller_group, (list, tuple)):	×
214	tasks = controller_group	×
215	else:
216	# Invalid data
217	return subgraph, component_id, prev_node	×
218
219	flatten_tasks = []	×
220	for task in tasks:	×
221	# Flatten nested linear flow controller.
222	# This situation often occurs in the builtin pass managers because it constructs
223	# some stages by appending other pass manager instance converted into a linear controller.
224	# Flattening inner linear controller tasks doesn't change the execution.
225	if isinstance(task, FlowControllerLinear):	×
226	flatten_tasks.extend(task.tasks)	×
227	else:
228	flatten_tasks.append(task)	×
229
230	for task in flatten_tasks:	×
231	if isinstance(task, BaseController):	×
232	# Partly nested flow controller
233	# TODO recursively inject subgraph into subgraph
234	node = pydot.Node(	×
235	str(component_id),
236	color="k",
237	fontname="helvetica",
238	label="Nested flow controller",
239	shape="rectangle",
240	)
241	else:
242	# label is the name of the pass
243	node = pydot.Node(	×
244	str(component_id),
245	color=_get_node_color(task, style),
246	fontname="helvetica",
247	label=str(type(task).__name__),
248	shape="rectangle",
249	)
250
251	subgraph.add_node(node)	×
252	component_id += 1	×
253
254	# the arguments that were provided to the pass when it was created
255	arg_spec = inspect.getfullargspec(task.__init__)	×
256	# 0 is the args, 1: to remove the self arg
257	args = arg_spec[0][1:]	×
258
259	num_optional = len(arg_spec[3]) if arg_spec[3] else 0	×
260
261	# add in the inputs to the pass
262	for arg_index, arg in enumerate(args):	×
263	nd_style = "solid"	×
264	# any optional args are dashed
265	# the num of optional counts from the end towards the start of the list
266	if arg_index >= (len(args) - num_optional):	×
267	nd_style = "dashed"	×
268
269	input_node = pydot.Node(	×
270	component_id,
271	color="black",
272	fontname="helvetica",
273	fontsize=10,
274	label=arg,
275	shape="ellipse",
276	style=nd_style,
277	)
UNCOV 278	subgraph.add_node(input_node)	×
279	component_id += 1	×
280	subgraph.add_edge(pydot.Edge(input_node, node))	×
281
282	# if there is a previous node, add an edge between them
283	if prev_node:	×
284	subgraph.add_edge(pydot.Edge(prev_node, node))	×
285
286	prev_node = node	×
287
288	return subgraph, component_id, prev_node	×
289
290
291	def make_output(graph, raw, filename):	1✔
292	"""Produce output for pass_manager."""
293	if raw:	×
294	if filename:	×
295	graph.write(filename, format="raw")	×
296	return None	×
297	else:
298	raise VisualizationError("if format=raw, then a filename is required.")	×
299
300	if not _optionals.HAS_PIL and filename:	×
301	# pylint says this isn't a method - it is
302	graph.write_png(filename)	×
303	return None	×
304
305	_optionals.HAS_PIL.require_now("pass manager drawer")	×
306
307	with tempfile.TemporaryDirectory() as tmpdirname:	×
308	from PIL import Image	×
309
310	tmppath = os.path.join(tmpdirname, "pass_manager.png")	×
311
312	# pylint says this isn't a method - it is
313	graph.write_png(tmppath)	×
314
315	image = Image.open(tmppath)	×
316	os.remove(tmppath)	×
317	if filename:	×
318	image.save(filename, "PNG")	×
319	return image	×

Qiskit / qiskit / 9960299837

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