Skip to content

Commit 44038ce

Browse files
author
Matthias Koefferlein
committed
Updating .pyi files
1 parent 3034fb9 commit 44038ce

File tree

2 files changed

+72
-26
lines changed

2 files changed

+72
-26
lines changed

src/pymod/distutils_src/klayout/dbcore.pyi

Lines changed: 62 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -832,6 +832,27 @@ class Cell:
832832

833833
This method has been introduced in version 0.20.
834834
"""
835+
locked: bool
836+
r"""
837+
Getter:
838+
@brief Gets a value indicating whether the cell is locked
839+
840+
Locked cells cannot be modified in terms of instances (children) and shapes. Locked cells can still be renamed, but cannot be deleted or cleared.
841+
Among other things, these features are disabled too: layer operations, copy of instances or shapes, flattening or pruning.
842+
843+
However, wiping the layout entirely with \Layout#clear is always possible, even if cells are locked.
844+
845+
Use \locked= to set the locked state of the cell.
846+
847+
The lock feature has been introduced in version 0.29.11.
848+
Setter:
849+
@brief Locks or unlocks the cell
850+
851+
Set this predicate to 'true' to lock the cell and to 'false' to unlock it.
852+
See \is_locked? for details about the lock feature.
853+
854+
The lock feature has been introduced in version 0.29.11.
855+
"""
835856
name: str
836857
r"""
837858
Getter:
@@ -1912,6 +1933,20 @@ class Cell:
19121933
This method has been introduced in version 0.22.
19131934
"""
19141935
...
1936+
def is_locked(self) -> bool:
1937+
r"""
1938+
@brief Gets a value indicating whether the cell is locked
1939+
1940+
Locked cells cannot be modified in terms of instances (children) and shapes. Locked cells can still be renamed, but cannot be deleted or cleared.
1941+
Among other things, these features are disabled too: layer operations, copy of instances or shapes, flattening or pruning.
1942+
1943+
However, wiping the layout entirely with \Layout#clear is always possible, even if cells are locked.
1944+
1945+
Use \locked= to set the locked state of the cell.
1946+
1947+
The lock feature has been introduced in version 0.29.11.
1948+
"""
1949+
...
19151950
@overload
19161951
def is_pcell_variant(self) -> bool:
19171952
r"""
@@ -30230,11 +30265,11 @@ class Instance:
3023030265

3023130266
Starting with version 0.25 the displacement is of vector type.
3023230267
Setter:
30233-
@brief Sets the displacement vector for the 'b' axis
30268+
@brief Sets the displacement vector for the 'b' axis in micrometer units
3023430269

30235-
If the instance was not an array instance before it is made one.
30270+
Like \b= with an integer displacement, this method will set the displacement vector but it accepts a vector in micrometer units that is of \DVector type. The vector will be translated to database units internally.
3023630271

30237-
This method has been introduced in version 0.23. Starting with version 0.25 the displacement is of vector type.
30272+
This method has been introduced in version 0.25.
3023830273
"""
3023930274
cell: Cell
3024030275
r"""
@@ -30408,9 +30443,10 @@ class Instance:
3040830443
@brief Gets the transformation of the instance or the first instance in the array
3040930444
The transformation returned is only valid if the array does not represent a complex transformation array
3041030445
Setter:
30411-
@brief Sets the transformation of the instance or the first instance in the array
30446+
@brief Sets the transformation of the instance or the first instance in the array (in micrometer units)
30447+
This method sets the transformation the same way as \cplx_trans=, but the displacement of this transformation is given in micrometer units. It is internally translated into database units.
3041230448

30413-
This method has been introduced in version 0.23.
30449+
This method has been introduced in version 0.25.
3041430450
"""
3041530451
@classmethod
3041630452
def new(cls) -> Instance:
@@ -41367,15 +41403,15 @@ class NetPinRef:
4136741403
@overload
4136841404
def net(self) -> Net:
4136941405
r"""
41370-
@brief Gets the net this pin reference is attached to.
41406+
@brief Gets the net this pin reference is attached to (non-const version).
41407+
41408+
This constness variant has been introduced in version 0.26.8
4137141409
"""
4137241410
...
4137341411
@overload
4137441412
def net(self) -> Net:
4137541413
r"""
41376-
@brief Gets the net this pin reference is attached to (non-const version).
41377-
41378-
This constness variant has been introduced in version 0.26.8
41414+
@brief Gets the net this pin reference is attached to.
4137941415
"""
4138041416
...
4138141417
def pin(self) -> Pin:
@@ -41665,17 +41701,17 @@ class NetTerminalRef:
4166541701
@overload
4166641702
def device(self) -> Device:
4166741703
r"""
41668-
@brief Gets the device reference (non-const version).
41704+
@brief Gets the device reference.
4166941705
Gets the device object that this connection is made to.
41670-
41671-
This constness variant has been introduced in version 0.26.8
4167241706
"""
4167341707
...
4167441708
@overload
4167541709
def device(self) -> Device:
4167641710
r"""
41677-
@brief Gets the device reference.
41711+
@brief Gets the device reference (non-const version).
4167841712
Gets the device object that this connection is made to.
41713+
41714+
This constness variant has been introduced in version 0.26.8
4167941715
"""
4168041716
...
4168141717
def device_class(self) -> DeviceClass:
@@ -42687,36 +42723,36 @@ class Netlist:
4268742723
@overload
4268842724
def circuit_by_name(self, name: str) -> Circuit:
4268942725
r"""
42690-
@brief Gets the circuit object for a given name.
42726+
@brief Gets the circuit object for a given name (const version).
4269142727
If the name is not a valid circuit name, nil is returned.
42728+
42729+
This constness variant has been introduced in version 0.26.8.
4269242730
"""
4269342731
...
4269442732
@overload
4269542733
def circuit_by_name(self, name: str) -> Circuit:
4269642734
r"""
42697-
@brief Gets the circuit object for a given name (const version).
42735+
@brief Gets the circuit object for a given name.
4269842736
If the name is not a valid circuit name, nil is returned.
42699-
42700-
This constness variant has been introduced in version 0.26.8.
4270142737
"""
4270242738
...
4270342739
@overload
4270442740
def circuits_by_name(self, name_pattern: str) -> List[Circuit]:
4270542741
r"""
42706-
@brief Gets the circuit objects for a given name filter (const version).
42742+
@brief Gets the circuit objects for a given name filter.
4270742743
The name filter is a glob pattern. This method will return all \Circuit objects matching the glob pattern.
4270842744

42709-
42710-
This constness variant has been introduced in version 0.26.8.
42745+
This method has been introduced in version 0.26.4.
4271142746
"""
4271242747
...
4271342748
@overload
4271442749
def circuits_by_name(self, name_pattern: str) -> List[Circuit]:
4271542750
r"""
42716-
@brief Gets the circuit objects for a given name filter.
42751+
@brief Gets the circuit objects for a given name filter (const version).
4271742752
The name filter is a glob pattern. This method will return all \Circuit objects matching the glob pattern.
4271842753

42719-
This method has been introduced in version 0.26.4.
42754+
42755+
This constness variant has been introduced in version 0.26.8.
4272042756
"""
4272142757
...
4272242758
def combine_devices(self) -> None:
@@ -60838,17 +60874,17 @@ class SubCircuit(NetlistObject):
6083860874
@overload
6083960875
def circuit(self) -> Circuit:
6084060876
r"""
60841-
@brief Gets the circuit the subcircuit lives in.
60877+
@brief Gets the circuit the subcircuit lives in (non-const version).
6084260878
This is NOT the circuit which is referenced. For getting the circuit that the subcircuit references, use \circuit_ref.
60879+
60880+
This constness variant has been introduced in version 0.26.8
6084360881
"""
6084460882
...
6084560883
@overload
6084660884
def circuit(self) -> Circuit:
6084760885
r"""
60848-
@brief Gets the circuit the subcircuit lives in (non-const version).
60886+
@brief Gets the circuit the subcircuit lives in.
6084960887
This is NOT the circuit which is referenced. For getting the circuit that the subcircuit references, use \circuit_ref.
60850-
60851-
This constness variant has been introduced in version 0.26.8
6085260888
"""
6085360889
...
6085460890
@overload

src/pymod/distutils_src/klayout/tlcore.pyi

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1673,6 +1673,16 @@ class Logger:
16731673
"""
16741674
...
16751675
@classmethod
1676+
def set_verbosity(cls, v: int) -> None:
1677+
r"""
1678+
@brief Sets the verbosity level for the application
1679+
1680+
See \verbosity for a definition of the verbosity levels. Please note that this method changes the verbosity level for the whole application.
1681+
1682+
The 'set_verbosity' alias has been introduced in version 0.29.11 as class attributes are not always available in Python.
1683+
"""
1684+
...
1685+
@classmethod
16761686
def warn(cls, msg: str) -> None:
16771687
r"""
16781688
@brief Writes the given string to the warning channel

0 commit comments

Comments
 (0)