Source code for kqcircuits.util.error_on_cell

# This code is part of KQCircuits
# Copyright (C) 2025 IQM Finland Oy
#
# This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public
# License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with this program. If not, see
# https://www.gnu.org/licenses/gpl-3.0.html.
#
# The software distribution should follow IQM trademark policy for open-source software
# (meetiqm.com/iqm-open-source-trademark-policy). IQM welcomes contributions to the code.
# Please see our contribution agreements for individuals (meetiqm.com/iqm-individual-contributor-license-agreement)
# and organizations (meetiqm.com/iqm-organization-contributor-license-agreement).

from kqcircuits.pya_resolver import pya
from kqcircuits.util.instance_hierarchy_helpers import formatted_cell_instance_hierarchy, get_cell_instance_hierarchy



[docs]
def find_cells_with_error(layout: pya.Layout) -> list[tuple[int, str, pya.DPoint]]:
    """Find cell indices and error messages for all cells in the layout that have called the ``raise_error_on_cell``
    method.

    Args:
        layout (pya.Layout): The layout.

    Returns: List of (cell_index, error_message, error_position) tuples.
    """
    # Cells with errors have a TEXT cell instance inside them, which has the error message set as instance property.
    result = []
    for cell in layout.each_cell():
        for inst in cell.each_inst():
            error_message = inst.property("error_on_cell")
            if error_message is not None:
                error_position = inst.property("error_on_cell_position")
                if error_position is not None:
                    x, y = map(float, error_position.split(","))
                else:
                    x, y = 0.0, 0.0
                position = pya.DPoint(x, y)
                result.append((cell.cell_index(), error_message, position))
                continue  # No need to search any remaining instances
    return result




[docs]
def formatted_errors_on_cells(layout: pya.Layout) -> str:
    """Generate a formatted string describing all errors raised on cells and where in the cell hierarchy these appear.

    Args:
        layout (pya.Layout): The layout

    Returns: Formatted multiline string
    """
    result = ""
    for cell_index, error_message, error_position in find_cells_with_error(layout):
        instance_data = get_cell_instance_hierarchy(layout, cell_index)
        result += f"{error_message}\n"
        for inst_data in instance_data:
            result += f"Error instance at {str(inst_data.trans * error_position)}:\n"
            result += formatted_cell_instance_hierarchy(inst_data) + "\n"
    return result