luke
/
klayout
mirror of https://github.com/KLayout/klayout.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update of Python stubs

This commit is contained in:
Matthias Koefferlein 2024-02-16 15:51:40 +01:00
parent 0e15fa0ed2
commit 250c23eb97
2 changed files with 94 additions and 93 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

175
src/pymod/distutils_src/klayout/dbcore.pyi
View File

@ -3941,12 +3941,12 @@ class CompoundRegionOperationNode:
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer value
@brief Compares two enums
"""
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares two enums
@brief Compares an enum with an integer value
"""
@overload
def __init__(self, i: int) -> None:
@ -3971,12 +3971,12 @@ class CompoundRegionOperationNode:
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer for inequality
@brief Compares two enums for inequality
"""
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares two enums for inequality
@brief Compares an enum with an integer for inequality
"""
def __repr__(self) -> str:
r"""
@ -4125,12 +4125,12 @@ class CompoundRegionOperationNode:
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares two enums
@brief Compares an enum with an integer value
"""
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer value
@brief Compares two enums
"""
@overload
def __init__(self, i: int) -> None:
@ -4215,12 +4215,12 @@ class CompoundRegionOperationNode:
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares two enums
@brief Compares an enum with an integer value
"""
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer value
@brief Compares two enums
"""
@overload
def __init__(self, i: int) -> None:
@ -4245,12 +4245,12 @@ class CompoundRegionOperationNode:
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares two enums for inequality
@brief Compares an enum with an integer for inequality
"""
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer for inequality
@brief Compares two enums for inequality
"""
def __repr__(self) -> str:
r"""
@ -4335,12 +4335,12 @@ class CompoundRegionOperationNode:
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares two enums for inequality
@brief Compares an enum with an integer for inequality
"""
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer for inequality
@brief Compares two enums for inequality
"""
def __repr__(self) -> str:
r"""
@ -21882,12 +21882,12 @@ class HAlign:
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares two enums for inequality
@brief Compares an enum with an integer for inequality
"""
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer for inequality
@brief Compares two enums for inequality
"""
def __repr__(self) -> str:
r"""
@ -23953,10 +23953,10 @@ class Instance:
Getter:
@brief Gets the basic \CellInstArray object associated with this instance reference.
Setter:
@brief Returns the basic cell instance array object by giving a micrometer unit object.
This method replaces the instance by the given CellInstArray object and it internally transformed into database units.
@brief Changes the \CellInstArray object to the given one.
This method replaces the instance by the given CellInstArray object.
This method has been introduced in version 0.25
This method has been introduced in version 0.22
"""
cplx_trans: ICplxTrans
r"""
@ -24395,14 +24395,14 @@ class Instance:
r"""
@brief Gets the layout this instance is contained in
This const version of the method has been introduced in version 0.25.
This method has been introduced in version 0.22.
"""
@overload
def layout(self) -> Layout:
r"""
@brief Gets the layout this instance is contained in
This method has been introduced in version 0.22.
This const version of the method has been introduced in version 0.25.
"""
def pcell_declaration(self) -> PCellDeclaration_Native:
r"""
@ -29205,12 +29205,12 @@ class LayoutToNetlist:
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer value
@brief Compares two enums
"""
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares two enums
@brief Compares an enum with an integer value
"""
@overload
def __init__(self, i: int) -> None:
@ -29235,12 +29235,12 @@ class LayoutToNetlist:
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares two enums for inequality
@brief Compares an enum with an integer for inequality
"""
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer for inequality
@brief Compares two enums for inequality
"""
def __repr__(self) -> str:
r"""
@ -30524,12 +30524,12 @@ class LoadLayoutOptions:
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer value
@brief Compares two enums
"""
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares two enums
@brief Compares an enum with an integer value
"""
@overload
def __init__(self, i: int) -> None:
@ -33260,14 +33260,14 @@ class NetPinRef:
@overload
def net(self) -> Net:
r"""
@brief Gets the net this pin reference is attached to.
@brief Gets the net this pin reference is attached to (non-const version).
This constness variant has been introduced in version 0.26.8
"""
@overload
def net(self) -> Net:
r"""
@brief Gets the net this pin reference is attached to (non-const version).
This constness variant has been introduced in version 0.26.8
@brief Gets the net this pin reference is attached to.
"""
def pin(self) -> Pin:
r"""
@ -33490,16 +33490,16 @@ class NetTerminalRef:
@overload
def device(self) -> Device:
r"""
@brief Gets the device reference (non-const version).
@brief Gets the device reference.
Gets the device object that this connection is made to.
This constness variant has been introduced in version 0.26.8
"""
@overload
def device(self) -> Device:
r"""
@brief Gets the device reference.
@brief Gets the device reference (non-const version).
Gets the device object that this connection is made to.
This constness variant has been introduced in version 0.26.8
"""
def device_class(self) -> DeviceClass:
r"""
@ -33518,14 +33518,14 @@ class NetTerminalRef:
@overload
def net(self) -> Net:
r"""
@brief Gets the net this terminal reference is attached to (non-const version).
This constness variant has been introduced in version 0.26.8
@brief Gets the net this terminal reference is attached to.
"""
@overload
def net(self) -> Net:
r"""
@brief Gets the net this terminal reference is attached to.
@brief Gets the net this terminal reference is attached to (non-const version).
This constness variant has been introduced in version 0.26.8
"""
def terminal_def(self) -> DeviceTerminalDefinition:
r"""
@ -34374,20 +34374,14 @@ class Netlist:
@overload
def each_circuit(self) -> Iterator[Circuit]:
r"""
@brief Iterates over the circuits of the netlist (const version)
This constness variant has been introduced in version 0.26.8.
@brief Iterates over the circuits of the netlist
"""
@overload
def each_circuit(self) -> Iterator[Circuit]:
r"""
@brief Iterates over the circuits of the netlist
"""
@overload
def each_circuit_bottom_up(self) -> Iterator[Circuit]:
r"""
@brief Iterates over the circuits bottom-up
Iterating bottom-up means the parent circuits come after the child circuits. This is the basically the reverse order as delivered by \each_circuit_top_down.
@brief Iterates over the circuits of the netlist (const version)
This constness variant has been introduced in version 0.26.8.
"""
@overload
def each_circuit_bottom_up(self) -> Iterator[Circuit]:
@ -34398,10 +34392,10 @@ class Netlist:
This constness variant has been introduced in version 0.26.8.
"""
@overload
def each_circuit_top_down(self) -> Iterator[Circuit]:
def each_circuit_bottom_up(self) -> Iterator[Circuit]:
r"""
@brief Iterates over the circuits top-down
Iterating top-down means the parent circuits come before the child circuits. The first \top_circuit_count circuits are top circuits - i.e. those which are not referenced by other circuits.
@brief Iterates over the circuits bottom-up
Iterating bottom-up means the parent circuits come after the child circuits. This is the basically the reverse order as delivered by \each_circuit_top_down.
"""
@overload
def each_circuit_top_down(self) -> Iterator[Circuit]:
@ -34412,6 +34406,12 @@ class Netlist:
This constness variant has been introduced in version 0.26.8.
"""
@overload
def each_circuit_top_down(self) -> Iterator[Circuit]:
r"""
@brief Iterates over the circuits top-down
Iterating top-down means the parent circuits come before the child circuits. The first \top_circuit_count circuits are top circuits - i.e. those which are not referenced by other circuits.
"""
@overload
def each_device_class(self) -> Iterator[DeviceClass]:
r"""
@brief Iterates over the device classes of the netlist
@ -34469,6 +34469,14 @@ class Netlist:
This method will turn all named nets of top-level circuits (such that are not referenced by subcircuits) into pins. This method can be used before purge to avoid that purge will remove nets which are directly connecting to subcircuits.
"""
@overload
def nets_by_name(self, name_pattern: str) -> List[Net]:
r"""
@brief Gets the net objects for a given name filter.
The name filter is a glob pattern. This method will return all \Net objects matching the glob pattern.
This method has been introduced in version 0.28.4.
"""
@overload
def nets_by_name(self, name_pattern: str) -> List[Net]:
r"""
@brief Gets the net objects for a given name filter (const version).
@ -34477,14 +34485,6 @@ class Netlist:
This constness variant has been introduced in version 0.28.4.
"""
@overload
def nets_by_name(self, name_pattern: str) -> List[Net]:
r"""
@brief Gets the net objects for a given name filter.
The name filter is a glob pattern. This method will return all \Net objects matching the glob pattern.
This method has been introduced in version 0.28.4.
"""
def purge(self) -> None:
r"""
@brief Purge unused nets, circuits and subcircuits.
@ -36860,12 +36860,12 @@ class PCellParameterState:
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer for inequality
@brief Compares two enums for inequality
"""
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares two enums for inequality
@brief Compares an enum with an integer for inequality
"""
def __repr__(self) -> str:
r"""
@ -39637,12 +39637,12 @@ class PropertyConstraint:
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer value
@brief Compares two enums
"""
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares two enums
@brief Compares an enum with an integer value
"""
@overload
def __init__(self, i: int) -> None:
@ -41105,12 +41105,12 @@ class Region(ShapeCollection):
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares two enums
@brief Compares an enum with an integer value
"""
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer value
@brief Compares two enums
"""
@overload
def __init__(self, i: int) -> None:
@ -41135,12 +41135,12 @@ class Region(ShapeCollection):
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares two enums for inequality
@brief Compares an enum with an integer for inequality
"""
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer for inequality
@brief Compares two enums for inequality
"""
def __repr__(self) -> str:
r"""
@ -41211,12 +41211,12 @@ class Region(ShapeCollection):
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares two enums
@brief Compares an enum with an integer value
"""
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer value
@brief Compares two enums
"""
@overload
def __init__(self, i: int) -> None:
@ -48839,23 +48839,18 @@ class SubCircuit(NetlistObject):
Usually it's not required to call this method. It has been introduced in version 0.24.
"""
@overload
def circuit(self) -> Circuit:
r"""
@brief Gets the circuit the subcircuit lives in (non-const version).
This is NOT the circuit which is referenced. For getting the circuit that the subcircuit references, use \circuit_ref.
This constness variant has been introduced in version 0.26.8
"""
@overload
def circuit(self) -> Circuit:
r"""
@brief Gets the circuit the subcircuit lives in.
This is NOT the circuit which is referenced. For getting the circuit that the subcircuit references, use \circuit_ref.
"""
@overload
def circuit_ref(self) -> Circuit:
def circuit(self) -> Circuit:
r"""
@brief Gets the circuit referenced by the subcircuit.
@brief Gets the circuit the subcircuit lives in (non-const version).
This is NOT the circuit which is referenced. For getting the circuit that the subcircuit references, use \circuit_ref.
This constness variant has been introduced in version 0.26.8
"""
@overload
def circuit_ref(self) -> Circuit:
@ -48866,6 +48861,11 @@ class SubCircuit(NetlistObject):
This constness variant has been introduced in version 0.26.8
"""
@overload
def circuit_ref(self) -> Circuit:
r"""
@brief Gets the circuit referenced by the subcircuit.
"""
@overload
def connect_pin(self, pin: Pin, net: Net) -> None:
r"""
@brief Connects the given pin to the specified net.
@ -49410,7 +49410,8 @@ class Text:
Setter:
@brief Sets the horizontal alignment
This is the version accepting integer values. It's provided for backward compatibility.
This property specifies how the text is aligned relative to the anchor point.
This property has been introduced in version 0.22 and extended to enums in 0.28.
"""
size: int
r"""
@ -52510,12 +52511,12 @@ class VAlign:
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer value
@brief Compares two enums
"""
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares two enums
@brief Compares an enum with an integer value
"""
@overload
def __init__(self, i: int) -> None:
@ -52540,12 +52541,12 @@ class VAlign:
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer for inequality
@brief Compares two enums for inequality
"""
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares two enums for inequality
@brief Compares an enum with an integer for inequality
"""
def __repr__(self) -> str:
r"""
@ -53953,12 +53954,12 @@ class ZeroDistanceMode:
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer value
@brief Compares two enums
"""
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares two enums
@brief Compares an enum with an integer value
"""
@overload
def __init__(self, i: int) -> None:
@ -53983,12 +53984,12 @@ class ZeroDistanceMode:
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares two enums for inequality
@brief Compares an enum with an integer for inequality
"""
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer for inequality
@brief Compares two enums for inequality
"""
def __repr__(self) -> str:
r"""

12
src/pymod/distutils_src/klayout/laycore.pyi
View File

@ -7204,12 +7204,12 @@ class Macro:
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer value
@brief Compares two enums
"""
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares two enums
@brief Compares an enum with an integer value
"""
@overload
def __init__(self, i: int) -> None:
@ -7234,12 +7234,12 @@ class Macro:
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer for inequality
@brief Compares two enums for inequality
"""
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares two enums for inequality
@brief Compares an enum with an integer for inequality
"""
def __repr__(self) -> str:
r"""
@ -7331,12 +7331,12 @@ class Macro:
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer for inequality
@brief Compares two enums for inequality
"""
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares two enums for inequality
@brief Compares an enum with an integer for inequality
"""
def __repr__(self) -> str:
r"""