qiskit 2.0.3__cp39-abi3-macosx_11_0_arm64.whl → 2.1.0__cp39-abi3-macosx_11_0_arm64.whl

qiskit/visualization/circuit/latex.py

@@ -27,7 +27,8 @@ from qiskit.circuit.measure import Measure
 from qiskit.circuit.tools.pi_check import pi_check
 
 
-from .qcstyle import load_style
+from qiskit.visualization.style import load_style
+from qiskit.visualization.circuit.qcstyle import MPLDefaultStyle, MPLStyleDict
 from ._utils import (
     get_gate_ctrl_text,
     get_param_str,
@@ -151,7 +152,13 @@ class QCircuitImage:
         self._wire_map = get_wire_map(circuit, qubits + clbits, self._cregbundle)
         self._img_width = len(self._wire_map)
 
-        self._style, _ = load_style(style)
+        self._style, _ = load_style(
+            style,
+            style_dict=MPLStyleDict,
+            default_style=MPLDefaultStyle(),
+            user_config_opt="circuit_mpl_style",
+            user_config_path_opt="circuit_mpl_style_path",
+        )
 
     def latex(self):
         """Return LaTeX string representation of circuit."""

qiskit/visualization/circuit/matplotlib.py

@@ -55,7 +55,8 @@ from qiskit.qasm3.printer import BasicPrinter
 from qiskit.circuit.tools.pi_check import pi_check
 from qiskit.utils import optionals as _optionals
 
-from .qcstyle import load_style
+from qiskit.visualization.style import load_style
+from qiskit.visualization.circuit.qcstyle import MPLDefaultStyle, MPLStyleDict
 from ._utils import (
     get_gate_ctrl_text,
     get_param_str,
@@ -266,7 +267,13 @@ class MatplotlibDrawer:
         glob_data["patches_mod"] = patches
         plt_mod = plt
 
-        self._style, def_font_ratio = load_style(self._style)
+        self._style, def_font_ratio = load_style(
+            self._style,
+            style_dict=MPLStyleDict,
+            default_style=MPLDefaultStyle(),
+            user_config_opt="circuit_mpl_style",
+            user_config_path_opt="circuit_mpl_style_path",
+        )
 
         # If font/subfont ratio changes from default, have to scale width calculations for
         # subfont. Font change is auto scaled in the mpl_figure.set_size_inches call in draw()
@@ -608,6 +615,10 @@ class MatplotlibDrawer:
                         for width, layer_num, flow_parent in flow_widths.values():
                             if layer_num != -1 and flow_parent == flow_drawer._flow_parent:
                                 raw_gate_width += width
+                                # This is necessary to prevent 1 being added to the width of a
+                                # BoxOp in layer_widths at the end of this method
+                                if isinstance(node.op, BoxOp):
+                                    raw_gate_width -= 0.001
 
                         # Need extra incr of 1.0 for else and case boxes
                         gate_width += raw_gate_width + (1.0 if circ_num > 0 else 0.0)
@@ -740,7 +751,13 @@ class MatplotlibDrawer:
                 # increment by if/switch width. If more cases increment by width of previous cases.
                 if flow_parent is not None:
                     node_data[node].inside_flow = True
-                    node_data[node].x_index = node_data[flow_parent].x_index + curr_x_index + 1
+                    # front_space provides a space for 'If', 'While', etc. which is not
+                    # necessary for a BoxOp
+                    front_space = 0 if isinstance(flow_parent.op, BoxOp) else 1
+                    node_data[node].x_index = (
+                        node_data[flow_parent].x_index + curr_x_index + front_space
+                    )
+
                     # If an else or case
                     if node_data[node].circ_num > 0:
                         for width in node_data[flow_parent].width[: node_data[node].circ_num]:
@@ -1548,7 +1565,9 @@ class MatplotlibDrawer:
         ypos = min(y[1] for y in xy)
         ypos_max = max(y[1] for y in xy)
 
-        if_width = node_data[node].width[0] + WID
+        # If a BoxOp, bring the right side back tight against the gates to allow for
+        # better spacing
+        if_width = node_data[node].width[0] + (WID if not isinstance(node.op, BoxOp) else -0.19)
         box_width = if_width
         # Add the else and case widths to the if_width
         for ewidth in node_data[node].width[1:]:
@@ -1598,6 +1617,9 @@ class MatplotlibDrawer:
                 expr_spacer = 0.0
                 empty_default_spacer = 0.3 if len(node.op.blocks[-1]) == 0 else 0.0
             elif isinstance(node.op, BoxOp):
+                # Move the X start position back for a BoxOp, since there is no
+                # leading text. This tightens the BoxOp with other ops.
+                xpos -= 0.15
                 op_spacer = 0.0
                 expr_spacer = 0.0
                 empty_default_spacer = 0.0

qiskit/visualization/circuit/qcstyle.py

@@ -15,15 +15,12 @@
 from __future__ import annotations
 
 import json
-import os
-from typing import Any
 from pathlib import Path
-from warnings import warn
 
-from qiskit import user_config
+from qiskit.visualization.style import StyleDict, DefaultStyle
 
 
-class StyleDict(dict):
+class MPLStyleDict(StyleDict):
     """A dictionary for matplotlib styles.
 
     Defines additional abbreviations for key accesses, such as allowing
@@ -70,40 +67,10 @@ class StyleDict(dict):
         "dispcol": "displaycolor",
     }
 
-    def __setitem__(self, key: Any, value: Any) -> None:
-        # allow using field abbreviations
-        if key in self.ABBREVIATIONS:
-            key = self.ABBREVIATIONS[key]
+    NESTED_ATTRS = {"displaycolor", "displaytext"}
 
-        if key not in self.VALID_FIELDS:
-            warn(
-                f"style option ({key}) is not supported",
-                UserWarning,
-                2,
-            )
-        return super().__setitem__(key, value)
 
-    def __getitem__(self, key: Any) -> Any:
-        # allow using field abbreviations
-        if key in self.ABBREVIATIONS:
-            key = self.ABBREVIATIONS[key]
-
-        return super().__getitem__(key)
-
-    def update(self, other):
-        # the attributes "displaycolor" and "displaytext" are dictionaries
-        # themselves, therefore we need to propagate the update down to them
-        nested_attrs = {"displaycolor", "displaytext"}
-        for attr in nested_attrs.intersection(other.keys()):
-            if attr in self.keys():
-                self[attr].update(other[attr])
-            else:
-                self[attr] = other[attr]
-
-        super().update((key, value) for key, value in other.items() if key not in nested_attrs)
-
-
-class DefaultStyle:
+class MPLDefaultStyle(DefaultStyle):
     """Creates a Default Style dictionary
 
     The style dict contains numerous options that define the style of the
@@ -150,129 +117,14 @@ class DefaultStyle:
             which allows for custom colors for user-created gates.
     """
 
+    DEFAULT_STYLE_NAME = "iqp"
+    DEFAULT_STYLE_PATH = Path(__file__).parent / "styles"
+
     def __init__(self):
-        default_style_dict = "iqp.json"
-        path = Path(__file__).parent / "styles" / default_style_dict
+        path = self.DEFAULT_STYLE_PATH / Path(self.DEFAULT_STYLE_NAME).with_suffix(".json")
 
         with open(path, "r") as infile:
             default_style = json.load(infile)
 
         # set shortcuts, such as "ec" for "edgecolor"
-        self.style = StyleDict(**default_style)
-
-
-def load_style(style: dict | str | None) -> tuple[StyleDict, float]:
-    """Utility function to load style from json files.
-
-    Args:
-        style: Depending on the type, this acts differently:
-
-            * If a string, it can specify a supported style name (such
-              as "iqp" or "clifford"). It can also specify the name of
-              a custom color scheme stored as JSON file. This JSON file
-              _must_ specify a complete set of colors.
-            * If a dictionary, it may specify the style name via a
-              ``{"name": "<desired style>"}`` entry. If this is not given,
-              the default style will be used. The remaining entries in the
-              dictionary can be used to override certain specs.
-              E.g. ``{"name": "iqp", "ec": "#FF0000"}`` will use the ``"iqp"``
-              color scheme but set the edgecolor to red.
-
-    Returns:
-        A tuple containing the style as dictionary and the default font ratio.
-    """
-
-    # if the style is not given, try to load the configured default (if set),
-    # or use the default style
-    config = user_config.get_config()
-    if style is None:
-        if config:
-            style = config.get("circuit_mpl_style", "default")
-        else:
-            style = "default"
-
-    # determine the style name which could also be inside a dictionary, like
-    # style={"name": "clifford", <other settings...>}
-    if isinstance(style, dict):
-        style_name = style.get("name", "default")
-    elif isinstance(style, str):
-        if style.endswith(".json"):
-            style_name = style[:-5]
-        else:
-            style_name = style
-    else:
-        warn(
-            f'Unsupported style parameter "{style}" of type {type(style)}. '
-            "Will use the default style.",
-            UserWarning,
-            2,
-        )
-        style_name = "default"
-
-    if style_name in ["iqp", "default"]:
-        current_style = DefaultStyle().style
-    else:
-        # Search for file in 'styles' dir, then config_path, and finally the current directory
-        style_name = style_name + ".json"
-        style_paths = []
-
-        default_path = Path(__file__).parent / "styles" / style_name
-        style_paths.append(default_path)
-
-        # check configured paths, if there are any
-        if config:
-            config_path = config.get("circuit_mpl_style_path", "")
-            if config_path:
-                for path in config_path:
-                    style_paths.append(Path(path) / style_name)
-
-        # check current directory
-        cwd_path = Path("") / style_name
-        style_paths.append(cwd_path)
-
-        for path in style_paths:
-            # expand ~ to the user directory and check if the file exists
-            exp_user = path.expanduser()
-            if os.path.isfile(exp_user):
-                try:
-                    with open(exp_user) as infile:
-                        json_style = json.load(infile)
-
-                    current_style = StyleDict(json_style)
-                    break
-                except json.JSONDecodeError as err:
-                    warn(
-                        f"Could not decode JSON in file '{path}': {str(err)}. "
-                        "Will use default style.",
-                        UserWarning,
-                        2,
-                    )
-                    break
-                except (OSError, FileNotFoundError):
-                    warn(
-                        f"Error loading JSON file '{path}'. Will use default style.",
-                        UserWarning,
-                        2,
-                    )
-                    break
-        else:
-            warn(
-                f"Style JSON file '{style_name}' not found in any of these locations: "
-                f"{', '.join(map(str, style_paths))}. "
-                "Will use default style.",
-                UserWarning,
-                2,
-            )
-            current_style = DefaultStyle().style
-
-    # if the style is a dictionary, update the defaults with the new values
-    # this _needs_ to happen after loading by name to cover cases like
-    #   style = {"name": "bw", "edgecolor": "#FF0000"}
-    if isinstance(style, dict):
-        current_style.update(style)
-
-    # this is the default font ratio
-    # if the font- or subfont-sizes are changed, the new size is based on this ratio
-    def_font_ratio = 13 / 8
-
-    return current_style, def_font_ratio
+        self.style = MPLStyleDict(**default_style)

qiskit/visualization/dag/__init__.py

@@ -0,0 +1,13 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2025.
+#
+# 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.
+
+"""Empty init for data directory."""

qiskit/visualization/dag/dagstyle.py

@@ -0,0 +1,103 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2025.
+#
+# 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.
+
+"""Matplotlib circuit visualization style."""
+
+from __future__ import annotations
+
+import json
+from pathlib import Path
+from qiskit.visualization.circuit.qcstyle import StyleDict, DefaultStyle
+
+
+class DAGStyleDict(StyleDict):
+    """A dictionary for graphviz styles.
+
+    Defines additional abbreviations for key accesses, such as allowing
+    ``"ec"`` instead of writing ``"edgecolor"``.
+    """
+
+    VALID_FIELDS = {
+        "name",
+        "fontsize",
+        "bgcolor",
+        "dpi",
+        "pad",
+        "nodecolor",
+        "inputnodecolor",
+        "inputnodefontcolor",
+        "outputnodecolor",
+        "outputnodefontcolor",
+        "opnodecolor",
+        "opnodefontcolor",
+        "edgecolor",
+        "qubitedgecolor",
+        "clbitedgecolor",
+    }
+
+    ABBREVIATIONS = {
+        "nc": "nodecolor",
+        "ic": "inputnodecolor",
+        "if": "inputnodefontcolor",
+        "oc": "outputnodecolor",
+        "of": "outputnodefontcolor",
+        "opc": "opnodecolor",
+        "opf": "opnodefontcolor",
+        "ec": "edgecolor",
+        "qec": "qubitedgecolor",
+        "clc": "clbitedgecolor",
+    }
+
+
+class DAGDefaultStyle(DefaultStyle):
+    """Creates a Default Style dictionary
+
+    The style dict contains numerous options that define the style of the
+    output circuit visualization. The style dict is used by the `graphviz`
+    output. The options available in the style dict are defined below:
+
+    Attributes:
+        name (str): The name of the style.
+        fontsize (str): The font size to use for text.
+        bgcolor (str): The color name to use for the background ('red', 'green', etc.).
+        nodecolor (str): The color to use for all nodes.
+        dpi (int): The DPI to use for the output image.
+        pad (int): A number to adjust padding around output
+            graph.
+        inputnodecolor (str): The color to use for incoming wire nodes. Overrides
+            nodecolor for those nodes.
+        inputnodefontcolor (str): The font color to use for incoming wire nodes.
+            Overrides nodecolor for those nodes.
+        outputnodecolor (str): The color to use for output wire nodes. Overrides
+            nodecolor for those nodes.
+        outputnodefontcolor (str): The font color to use for output wire nodes.
+            Overrides nodecolor for those nodes.
+        opnodecolor (str): The color to use for Instruction nodes. Overrides
+            nodecolor for those nodes.
+        opnodefontcolor (str): The font color to use for Instruction nodes.
+            Overrides nodecolor for those nodes.
+
+        qubitedgecolor (str): The edge color for qubits. Overrides edgecolor for these edges.
+        clbitedgecolor (str): The edge color for clbits. Overrides edgecolor for these edges.
+    """
+
+    DEFAULT_STYLE_NAME = "plain"
+    DEFAULT_STYLE_PATH = Path(__file__).parent / "styles"
+
+    def __init__(self):
+        path = self.DEFAULT_STYLE_PATH / Path(self.DEFAULT_STYLE_NAME).with_suffix(".json")
+
+        with open(path, "r") as infile:
+            default_style = json.load(infile)
+
+        # set shortcuts, such as "ec" for "edgecolor"
+        self.style = DAGStyleDict(**default_style)

qiskit/visualization/dag/styles/__init__.py

@@ -0,0 +1,13 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2025.
+#
+# 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.
+
+"""Empty init for data directory."""

qiskit/visualization/dag/styles/color.json

@@ -0,0 +1,10 @@
+{
+  "name": "color",
+  "inputnodecolor": "green",
+  "outputnodecolor": "red",
+  "opnodecolor": "lightblue",
+  "barriercolor": "grey",
+  "directivecolor": "red",
+  "conditioncolor": "green",
+  "measurecolor": "white"
+}

qiskit/visualization/dag/styles/plain.json

@@ -0,0 +1,5 @@
+{
+  "name": "plain",
+  "nodecolor": "white",
+  "edgecolor": "black"
+}