Example plugin (to demonstrate Python binding at YUG 4)

example_plugin.py

#!/usr/bin/python3

import libyosys as ys

class VisitallPass(ys.Pass):
    def __init__(self):
        super().__init__("visitall", "visit all selected cells across all modules")

    def py_help(self):
        ys.log("Hello YUG! TODO: write an actual help message...\n")

    def py_execute(self, args, design):
        ys.log_header(design, "Running pass\n")

        for module in design.selected_modules():
            ys.log(f"Visiting module {module.name.str()}\n")
            for cell in module.selected_cells():
                ys.log(f"  Visiting cell {cell.name.str()} of type {cell.type.str()}\n")
                for portname, sig in cell.connections().items():
                    ys.log(f"    Visiting cell port {portname.str()} connected to {ys.log_signal(sig)}\n")
            ys.log(f"  Module has {len(module.selected_wires())} wires\n")

p = VisitallPass()