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

Updating doc and pyi files

This commit is contained in:
Matthias Koefferlein 2026-03-06 15:46:16 +01:00
parent a80d181cf1
commit f8646851e1
12 changed files with 333 additions and 269 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/doc/doc/about/drc_ref.xml
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE language SYSTEM "klayout_doc.dtd">
<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- DO NOT EDIT! -->
<doc>

2
src/doc/doc/about/drc_ref_drc.xml
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE language SYSTEM "klayout_doc.dtd">
<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- DO NOT EDIT! -->
<doc>

4
src/doc/doc/about/drc_ref_global.xml
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE language SYSTEM "klayout_doc.dtd">
<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- DO NOT EDIT! -->
<doc>
@ -1530,7 +1530,7 @@ is called on.
Turns profiling on or off (default). In profiling mode, the
system will collect statistics about rules executed, their execution time
and memory information. The argument specifies how many operations to
print at the end of the run. Without an argument, all operations are
print at the end of the run. Without an argument or when passing "true", all operations are
printed. Passing "false" for the argument will disable profiling. This is the
default.
</p>

2
src/doc/doc/about/drc_ref_layer.xml
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE language SYSTEM "klayout_doc.dtd">
<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- DO NOT EDIT! -->
<doc>

2
src/doc/doc/about/drc_ref_netter.xml
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE language SYSTEM "klayout_doc.dtd">
<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- DO NOT EDIT! -->
<doc>

2
src/doc/doc/about/drc_ref_source.xml
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE language SYSTEM "klayout_doc.dtd">
<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- DO NOT EDIT! -->
<doc>

2
src/doc/doc/about/lvs_ref.xml
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE language SYSTEM "klayout_doc.dtd">
<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- DO NOT EDIT! -->
<doc>

2
src/doc/doc/about/lvs_ref_global.xml
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE language SYSTEM "klayout_doc.dtd">
<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- DO NOT EDIT! -->
<doc>

2
src/doc/doc/about/lvs_ref_netter.xml
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE language SYSTEM "klayout_doc.dtd">
<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- DO NOT EDIT! -->
<doc>

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

@ -1082,6 +1082,8 @@ class Cell:
To satisfy the references inside the layout, a dummy cell is created in this case
which has the "ghost cell" flag set to true.
A ghost cell is a real ghost cell only if the cell is empty. In that case, it is written as a ghost cell to GDS files for example. If a cell is not empty, this flag is ignored.
This method has been introduced in version 0.20.
Setter:
@ -2207,6 +2209,8 @@ class Cell:
To satisfy the references inside the layout, a dummy cell is created in this case
which has the "ghost cell" flag set to true.
A ghost cell is a real ghost cell only if the cell is empty. In that case, it is written as a ghost cell to GDS files for example. If a cell is not empty, this flag is ignored.
This method has been introduced in version 0.20.
"""
...
@ -15691,7 +15695,8 @@ class DText:
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: float
r"""
@ -35865,11 +35870,11 @@ class Instance:
Starting with version 0.25 the displacement is of vector type.
Setter:
@brief Sets the displacement vector for the 'b' axis
@brief Sets the displacement vector for the 'b' axis in micrometer units
If the instance was not an array instance before it is made one.
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.
This method has been introduced in version 0.23. Starting with version 0.25 the displacement is of vector type.
This method has been introduced in version 0.25.
"""
cell: Cell
r"""
@ -35912,9 +35917,10 @@ class Instance:
@brief Gets the complex transformation of the instance or the first instance in the array
This method is always valid compared to \trans, since simple transformations can be expressed as complex transformations as well.
Setter:
@brief Sets the complex transformation of the instance or the first instance in the array
@brief Sets the complex transformation of the instance or the first instance in the array (in micrometer units)
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.
This method has been introduced in version 0.23.
This method has been introduced in version 0.25.
"""
da: DVector
r"""
@ -45024,204 +45030,6 @@ class LoadLayoutOptions:
This method has been added in version 0.30.2.
"""
mebes_boundary_datatype: int
r"""
Getter:
@brief Gets the datatype number of the boundary layer to produce
See \mebes_produce_boundary= for a description of this attribute.
This property has been added in version 0.23.10.
Setter:
@brief Sets the datatype number of the boundary layer to produce
See \mebes_produce_boundary= for a description of this attribute.
This property has been added in version 0.23.10.
"""
mebes_boundary_layer: int
r"""
Getter:
@brief Gets the layer number of the boundary layer to produce
See \mebes_produce_boundary= for a description of this attribute.
This property has been added in version 0.23.10.
Setter:
@brief Sets the layer number of the boundary layer to produce
See \mebes_produce_boundary= for a description of this attribute.
This property has been added in version 0.23.10.
"""
mebes_boundary_name: str
r"""
Getter:
@brief Gets the name of the boundary layer to produce
See \mebes_produce_boundary= for a description of this attribute.
This property has been added in version 0.23.10.
Setter:
@brief Sets the name of the boundary layer to produce
See \mebes_produce_boundary= for a description of this attribute.
This property has been added in version 0.23.10.
"""
mebes_create_other_layers: bool
r"""
Getter:
@brief Gets a value indicating whether other layers shall be created
@return True, if other layers will be created.
This attribute acts together with a layer map (see \mebes_layer_map=). Layers not listed in this map are created as well when \mebes_create_other_layers? is true. Otherwise they are ignored.
This method has been added in version 0.25 and replaces the respective global option in \LoadLayoutOptions in a format-specific fashion.
Setter:
@brief Specifies whether other layers shall be created
@param create True, if other layers will be created.
See \mebes_create_other_layers? for a description of this attribute.
This method has been added in version 0.25 and replaces the respective global option in \LoadLayoutOptions in a format-specific fashion.
"""
mebes_data_datatype: int
r"""
Getter:
@brief Gets the datatype number of the data layer to produce
This property has been added in version 0.23.10.
Setter:
@brief Sets the datatype number of the data layer to produce
This property has been added in version 0.23.10.
"""
mebes_data_layer: int
r"""
Getter:
@brief Gets the layer number of the data layer to produce
This property has been added in version 0.23.10.
Setter:
@brief Sets the layer number of the data layer to produce
This property has been added in version 0.23.10.
"""
mebes_data_name: str
r"""
Getter:
@brief Gets the name of the data layer to produce
This property has been added in version 0.23.10.
Setter:
@brief Sets the name of the data layer to produce
This property has been added in version 0.23.10.
"""
mebes_invert: bool
r"""
Getter:
@brief Gets a value indicating whether to invert the MEBES pattern
If this property is set to true, the pattern will be inverted.
This property has been added in version 0.22.
Setter:
@brief Specify whether to invert the MEBES pattern
If this property is set to true, the pattern will be inverted.
This property has been added in version 0.22.
"""
mebes_layer_map: LayerMap
r"""
Getter:
@brief Gets the layer map
@return The layer map.
This method has been added in version 0.25 and replaces the respective global option in \LoadLayoutOptions in a format-specific fashion.
Setter:
@brief Sets the layer map
This sets a layer mapping for the reader. Unlike \mebes_set_layer_map, the 'create_other_layers' flag is not changed.
@param map The layer map to set.
This convenience method has been added in version 0.26.2.
"""
mebes_num_shapes_per_cell: int
r"""
Getter:
@brief Gets the number of stripes collected per cell
See \mebes_num_stripes_per_cell= for details about this property.
This property has been added in version 0.24.5.
Setter:
@brief Specify the number of stripes collected per cell
See \mebes_num_stripes_per_cell= for details about this property.
This property has been added in version 0.24.5.
"""
mebes_num_stripes_per_cell: int
r"""
Getter:
@brief Gets the number of stripes collected per cell
See \mebes_num_stripes_per_cell= for details about this property.
This property has been added in version 0.23.10.
Setter:
@brief Specify the number of stripes collected per cell
This property specifies how many stripes will be collected into one cell.
A smaller value means less but bigger cells. The default value is 64.
New cells will be formed whenever more than this number of stripes has been read
or a new segment is started and the number of shapes given by \mebes_num_shapes_per_cell
is exceeded.
This property has been added in version 0.23.10.
"""
mebes_produce_boundary: bool
r"""
Getter:
@brief Gets a value indicating whether a boundary layer will be produced
See \mebes_produce_boundary= for details about this property.
This property has been added in version 0.23.10.
Setter:
@brief Specify whether to produce a boundary layer
If this property is set to true, the pattern boundary will be written to the layer and datatype specified with \mebes_boundary_name, \mebes_boundary_layer and \mebes_boundary_datatype.
By default, the boundary layer is produced.
This property has been added in version 0.23.10.
"""
mebes_subresolution: bool
r"""
Getter:
@brief Gets a value indicating whether to invert the MEBES pattern
See \subresolution= for details about this property.
This property has been added in version 0.23.10.
Setter:
@brief Specify whether subresolution trapezoids are supported
If this property is set to true, subresolution trapezoid vertices are supported.
In order to implement support, the reader will create magnified instances with a magnification of 1/16.
By default this property is enabled.
This property has been added in version 0.23.10.
"""
mebes_top_cell_index: int
r"""
Getter:
@brief Gets the cell index for the top cell to use
See \mebes_top_cell_index= for a description of this property.
This property has been added in version 0.23.10.
Setter:
@brief Specify the cell index for the top cell to use
If this property is set to a valid cell index, the MEBES reader will put the subcells and shapes into this cell.
This property has been added in version 0.23.10.
"""
oasis_expect_strict_mode: int
r"""
Getter:
@ -45229,7 +45037,7 @@ class LoadLayoutOptions:
Setter:
@hide
"""
oasis_read_all_properties: int
oasis_read_all_properties: bool
r"""
Getter:
@hide
@ -45483,26 +45291,6 @@ class LoadLayoutOptions:
This method has been added in version 0.30.2.
"""
...
def mebes_select_all_layers(self) -> None:
r"""
@brief Selects all layers and disables the layer map
This disables any layer map and enables reading of all layers.
New layers will be created when required.
This method has been added in version 0.25 and replaces the respective global option in \LoadLayoutOptions in a format-specific fashion.
"""
...
def mebes_set_layer_map(self, map: LayerMap, create_other_layers: bool) -> None:
r"""
@brief Sets the layer map
This sets a layer mapping for the reader. The layer map allows selection and translation of the original layers.
@param map The layer map to set.
@param create_other_layers The flag indicating whether other layers will be created as well. Set to false to read only the layers in the layer map.
This method has been added in version 0.25 and replaces the respective global option in \LoadLayoutOptions in a format-specific fashion.
"""
...
def select_all_layers(self) -> None:
r"""
@brief Selects all layers and disables the layer map
@ -65327,8 +65115,9 @@ class Shape:
This method has been introduced in version 0.28.
Setter:
@brief Replaces the shape by the given point (in micrometer units)
This method replaces the shape by the given point, like \point= with a \Point argument does. This version translates the point from micrometer units to database units internally.
@brief Replaces the shape by the given point
This method replaces the shape by the given point. This method can only be called for editable layouts. It does not change the user properties of the shape.
Calling this method will invalidate any iterators. It should not be called inside a loop iterating over shapes.
This method has been introduced in version 0.28.
"""
@ -65398,11 +65187,10 @@ class Shape:
Starting with version 0.23, this method returns nil, if the shape does not represent a text.
Setter:
@brief Replaces the shape by the given text object
This method replaces the shape by the given text object. This method can only be called for editable layouts. It does not change the user properties of the shape.
Calling this method will invalidate any iterators. It should not be called inside a loop iterating over shapes.
@brief Replaces the shape by the given text (in micrometer units)
This method replaces the shape by the given text, like \text= with a \Text argument does. This version translates the text from micrometer units to database units internally.
This method has been introduced in version 0.22.
This method has been introduced in version 0.25.
"""
text_dpos: DVector
r"""
@ -69618,16 +69406,16 @@ class SubCircuit(NetlistObject):
@overload
def circuit_ref(self) -> Circuit:
r"""
@brief Gets the circuit referenced by the subcircuit.
@brief Gets the circuit referenced by the subcircuit (non-const version).
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 (non-const version).
This constness variant has been introduced in version 0.26.8
@brief Gets the circuit referenced by the subcircuit.
"""
...
@overload
@ -69673,17 +69461,17 @@ class SubCircuit(NetlistObject):
@overload
def net_for_pin(self, pin_id: int) -> Net:
r"""
@brief Gets the net connected to the specified pin of the subcircuit (non-const version).
@brief Gets the net connected to the specified pin of the subcircuit.
If the pin is not connected, nil is returned for the net.
This constness variant has been introduced in version 0.26.8
"""
...
@overload
def net_for_pin(self, pin_id: int) -> Net:
r"""
@brief Gets the net connected to the specified pin of the subcircuit.
@brief Gets the net connected to the specified pin of the subcircuit (non-const version).
If the pin is not connected, nil is returned for the net.
This constness variant has been introduced in version 0.26.8
"""
...
...
@ -70333,7 +70121,8 @@ class Text:
Setter:
@brief Sets the vertical 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.
"""
x: int
r"""

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

@ -2727,6 +2727,14 @@ class CellView:
@brief Gets the reference to the layout object addressed by this view
"""
...
def layout_handle(self) -> LayoutHandle:
r"""
@brief Gets the handle to the layout object addressed by this cell view
A layout handle is a reference-counted pointer to a layout object and allows sharing this resource among different views or objects. By holding a handle, the layout object is not destroyed when the view closes for example.
This method has been added in version 0.30.7.
"""
...
def reset_cell(self) -> None:
r"""
@brief Resets the cell
@ -3158,16 +3166,23 @@ class Dispatcher:
@param name The name of the configuration parameter to set
@param value The value to which to set the configuration parameter
The configuration parameter name needs to be a valid XML element name. Otherwise, a corrupt configuration file will be produced.
This method sets a configuration parameter with the given name to the given value. Values can only be strings. Numerical values have to be converted into strings first. Local configuration parameters override global configurations for this specific view. This allows for example to override global settings of background colors. Any local settings are not written to the configuration file.
"""
...
def write_config(self, file_name: str) -> bool:
def write_config(self, file_name: str, keep_backups: Optional[int] = ...) -> bool:
r"""
@brief Writes configuration to a file
@return A value indicating whether the operation was successful
If the configuration file cannot be written, false
is returned but no exception is thrown.
@param file_name The path to write the config file to.
@param keep_backups The number of backups to keep (0 for 'no backups').
The 'keep_backups' option was introduced in version 0.30.7.
"""
...
...
@ -6129,6 +6144,244 @@ class LayerPropertiesNodeRef(LayerPropertiesNode):
...
...
class LayoutHandle:
r"""
@brief A handle to a global layout object
Layout objects shown in layout views are stored in a global repository. The layout handle is a pointer into that repository. Handles are reference counted - when no handle points to a layout, the layout is discarded.
A handle stores some more information about the layout, i.e. whether it is 'dirty' (needs saving) and the options used for loading or saving the layout.
The layout handle object is useful to hold a separate reference to a layout. This way it is possible to close a layout view, but still have a reference to the layout:
You can use layout handles to move a layout to a different view for example:
@code
cellview = ... # the source cellview
new_view = ... # the new target view
h = cellview.handle
cellview.close
new_view.show_layout(h, true)
@/code
Handles are named. You can use \LayoutHandle#find the find a handle by name or to obtain the handle for a given layout object. You can use \LayoutHandle#names to get the names of all handles registered in the system.
This class has been introduced in version 0.30.7.
"""
name: str
r"""
Getter:
@brief Gets the name of the layout handle.
The name identifies a layout handle in the global context. Names should be unique. Handles can be retrieved by name using \find.
Setter:
@brief Sets the name of the layout handle.
The caller is responsible for selecting a unique name for the handle. Only uniquely named handles can be retrieved by \find.
"""
@overload
@classmethod
def find(cls, layout: db.Layout) -> LayoutHandle:
r"""
@brief Finds a layout handle for the given layout object.
If no handle for that layout exists, nil is returned.
"""
...
@overload
@classmethod
def find(cls, name: str) -> LayoutHandle:
r"""
@brief Finds a layout handle by name.
If no handle with that name exists, nil is returned.
"""
...
@classmethod
def names(cls) -> List[str]:
r"""
@brief Gets the names of all layout handles registered currently.
"""
...
@overload
@classmethod
def new(cls, filename: str, options: db.LoadLayoutOptions, technology: Optional[str] = ...) -> LayoutHandle:
r"""
@brief Creates a handle from a file.
Loads the layout and creates a handle from that layout. The name is derived from the file name initially. You can pass load options and assign a technology using 'options' and 'technology' respectively.
"""
...
@overload
@classmethod
def new(cls, layout: db.Layout) -> LayoutHandle:
r"""
@brief Creates a handle from an existing layout object.
Creates a layout handle for an existing layout object. The ownership over the layout object is transferred to the handle.
"""
...
def __copy__(self) -> LayoutHandle:
r"""
@brief Creates a copy of self
"""
...
def __deepcopy__(self) -> LayoutHandle:
r"""
@brief Creates a copy of self
"""
...
@overload
def __init__(self, filename: str, options: db.LoadLayoutOptions, technology: Optional[str] = ...) -> None:
r"""
@brief Creates a handle from a file.
Loads the layout and creates a handle from that layout. The name is derived from the file name initially. You can pass load options and assign a technology using 'options' and 'technology' respectively.
"""
...
@overload
def __init__(self, layout: db.Layout) -> None:
r"""
@brief Creates a handle from an existing layout object.
Creates a layout handle for an existing layout object. The ownership over the layout object is transferred to the handle.
"""
...
def _const_cast(self) -> LayoutHandle:
r"""
@brief Returns a non-const reference to self.
Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.
This method has been introduced in version 0.29.6.
"""
...
def _create(self) -> None:
r"""
@brief Ensures the C++ object is created
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.
"""
...
def _destroy(self) -> None:
r"""
@brief Explicitly destroys the object
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
If the object is not owned by the script, this method will do nothing.
"""
...
def _destroyed(self) -> bool:
r"""
@brief Returns a value indicating whether the object was already destroyed
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
The latter may happen, if the object is owned by a C++ object which got destroyed itself.
"""
...
def _is_const_object(self) -> bool:
r"""
@brief Returns a value indicating whether the reference is a const reference
This method returns true, if self is a const reference.
In that case, only const methods may be called on self.
"""
...
def _manage(self) -> None:
r"""
@brief Marks the object as managed by the script side.
After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.
Usually it's not required to call this method. It has been introduced in version 0.24.
"""
...
def _to_const_object(self) -> LayoutHandle:
r"""
@hide
"""
...
def _unmanage(self) -> None:
r"""
@brief Marks the object as no longer owned by the script side.
Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.
Usually it's not required to call this method. It has been introduced in version 0.24.
"""
...
def assign(self, other: LayoutHandle) -> None:
r"""
@brief Assigns another object to self
"""
...
def create(self) -> None:
r"""
@brief Ensures the C++ object is created
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.
"""
...
def destroy(self) -> None:
r"""
@brief Explicitly destroys the object
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
If the object is not owned by the script, this method will do nothing.
"""
...
def destroyed(self) -> bool:
r"""
@brief Returns a value indicating whether the object was already destroyed
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
The latter may happen, if the object is owned by a C++ object which got destroyed itself.
"""
...
def dup(self) -> LayoutHandle:
r"""
@brief Creates a copy of self
"""
...
def filename(self) -> str:
r"""
@brief Gets the file name the layout was loaded from.
If the handle was not constructed from a file, this attribute is an empty string.
"""
...
def is_const_object(self) -> bool:
r"""
@brief Returns a value indicating whether the reference is a const reference
This method returns true, if self is a const reference.
In that case, only const methods may be called on self.
"""
...
def is_dirty(self) -> bool:
r"""
@brief Gets a value indicating whether the layout needs saving.
"""
...
def is_valid(self) -> bool:
r"""
@brief Gets a value indicating whether the layout handle is valid.
Invalid layout handles cannot be used. Default-created layout handles are invalid for example.
"""
...
def layout(self) -> db.Layout:
r"""
@brief Gets the layout object kept by the handle.
"""
...
def load_options(self) -> db.LoadLayoutOptions:
r"""
@brief Gets the load options used when the layout was read.
Default options will be returned when the layout was not created from a file.
"""
...
def ref_count(self) -> int:
r"""
@brief Gets the reference count.
The reference count indicates how many references are present for the handle. If the reference count reaches zero, the layout object is destroyed. References are kept by layout views showing the layout, but can also be kept by separate handles.
"""
...
def save_as(self, filename: str, options: db.SaveLayoutOptions, keep_backups: Optional[int] = ...) -> None:
r"""
@brief Saves the layout to a file.
This method will save the layout kept by the handle to the given file. Calling this method will change the file name and reset the \is_dirty? flag and set \save_options to the options passed.
@param filename The path where to save the layout to
@param options The options used for saving the file
@param keep_backups The number of backup files to keep (0 for 'no backups')
"""
...
def save_options(self) -> Any:
r"""
@brief Gets the save options used most recently when saving the file or 'nil' if no save options are available.
"""
...
...
class LayoutView(LayoutViewBase):
r"""
@brief The view object presenting one or more layout objects
@ -8562,23 +8815,7 @@ class LayoutViewBase(Dispatcher):
"""
...
@overload
def show_layout(self, layout: db.Layout, tech: str, add_cellview: bool) -> int:
r"""
@brief Shows an existing layout in the view
Shows the given layout in the view. If add_cellview is true, the new layout is added to the list of cellviews in the view.
The technology to use for that layout can be specified as well with the 'tech' parameter. Depending on the definition of the technology, layer properties may be loaded for example.
The technology string can be empty for the default technology.
Note: once a layout is passed to the view with show_layout, it is owned by the view and must not be destroyed with the 'destroy' method.
@return The index of the cellview created.
This method has been introduced in version 0.22.
"""
...
@overload
def show_layout(self, layout: db.Layout, tech: str, add_cellview: bool, init_layers: bool) -> int:
def show_layout(self, layout: db.Layout, tech: str, add_cellview: bool, init_layers: Optional[bool] = ...) -> int:
r"""
@brief Shows an existing layout in the view
@ -8595,6 +8832,20 @@ class LayoutViewBase(Dispatcher):
This method has been introduced in version 0.22.
"""
...
@overload
def show_layout(self, layout_handle: LayoutHandle, add_cellview: bool, init_layers: Optional[bool] = ...) -> int:
r"""
@brief Shows an existing layout (from a handle) in the view
This variant of \show_layout takes a layout handle instead of the layout. Layout handles are reference-counted pointers
and can be used to hold a reference to a layout object. This way, ownership over the layout can be shared between different
objects.
@return The index of the cellview created.
This method has been introduced in version 0.30.7.
"""
...
def stop(self) -> None:
r"""
@brief Stops redraw thread and close any browsers
@ -10012,6 +10263,19 @@ class Marker:
@brief Sets the line width of the marker
This is the width of the line drawn for the outline of the marker.
"""
text_frame_enabled: bool
r"""
Getter:
@brief Gets a value indicating whether label frames are enabled
See \text_frame_enabled= for a description of this attribute.
This attribute has been introduced in version 0.30.7.
Setter:
@brief Enables or disables the label frame
With the value set to true (the default), texts (labels) are drawn with a frame indicating the label dimension.
To turn off that frame, set this attribute to false.
This attribute has been introduced in version 0.30.7.
"""
vertex_size: int
r"""
Getter:

11
src/pymod/distutils_src/klayout/rdbcore.pyi
View File

@ -1925,6 +1925,17 @@ class ReportDatabase:
The reader recognizes the format automatically and will choose the appropriate decoder. 'gzip' compressed files are uncompressed automatically.
"""
...
def merge(self, other: ReportDatabase) -> None:
r"""
@brief Merges the other database with this one
This method will merge the other database with this one. The other database needs to have the same top cell than
this database. In the merge step, identical cells and categories will be identified and missing cells or categories
will be created in this database. After that, all items will be transferred from the other database into this one
and will be associated with cells and categories from this database.
This method has been added in version 0.30.7.
"""
...
def name(self) -> str:
r"""
@brief Gets the database name