TilingProcessor: ReportDatabase overload not available in Python

Open
  • Is something wrong?
#2,551 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
50/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
cpp, python
Domain
api

Research direction

Start by running the reproducer in the issue, which calls TilingProcessor.output with a ReportDatabase, and compare it with the output overload declared in the .pyi stub. The error lists the registered overloads, and none of them accepts a report database with cell and category ids, so the binding is missing. Done means the reproducer runs and writes the XOR result into the report database.

Written by the indexing model from the issue text.

Description

I was porting our XOR script from Ruby to Python, when I noticed something: this overload which is declared in the .pyi file:

    @overload
    def output(self, name: str, rdb: rdb.ReportDatabase, cell_id: int, category_id: int) -> None:

…doesn't seem to actually work.

from klayout.dbcore import Layout, TilingProcessor
from klayout.rdbcore import ReportDatabase

layout_a = Layout()
cell_a = layout_a.create_cell("a")

layout_b = Layout()
cell_b = layout_b.create_cell("b")

rdb = ReportDatabase("XOR")
rdb_cell = rdb.create_cell("a_xor_b")
layer_0_cat = rdb.create_category("layer_0")

tp = TilingProcessor()
tp.input("a", layout_a, cell_a.cell_index(), 0)
tp.input("b", layout_b, cell_b.cell_index(), 0)
tp.output("xor", rdb, rdb_cell.rdb_id(), layer_0_cat.rdb_id())

"""
Traceback (most recent call last):
  File "/Users/donn/Code/librelane/librelane-tree/python-tools/./klayout_issue.py", line 17, in <module>
    tp.output("xor", rdb, rdb_cell.rdb_id(), layer_0_cat.rdb_id())
    ~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: No overload with matching arguments. Variants are:
  void output(string name, Region region) [2 argument(s) expected, but 4 given]
  void output(string name, EdgePairs edge_pairs) [2 argument(s) expected, but 4 given]
  void output(string name, TileOutputReceiverBase ptr rec) [2 argument(s) expected, but 4 given]
  void output(string name, Edges edges) [2 argument(s) expected, but 4 given]
  void output(string name, Texts texts) [2 argument(s) expected, but 4 given]
  void output(string name, double ptr sum) [2 argument(s) expected, but 4 given]
  void output(string name, Layout layout, unsigned int cell, const LayerInfo lp) [match candidate]
  void output(string name, Layout layout, unsigned int cell, unsigned int layer_index) [match candidate]
 in TilingProcessor.output
"""

I was able to work around it by creating a new cell, see https://github.com/librelane/librelane/blob/cf49f0fcfdd7ddc284b9e703a8a9c353f8378004/librelane/scripts/klayout/xor.py for the full script, but needless to say that's a bit slower.

Dominant language
C++
Stars
1.2k
Forks
305
Avg merge
3d 2h
Merged PRs (30d)
11

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from KLayout/klayout

All issues in KLayout/klayout

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.