kicad-python 0.4.0__tar.gz → 0.6.0__tar.gz

{kicad_python-0.4.0 → kicad_python-0.6.0}/PKG-INFO

@@ -1,26 +1,22 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: kicad-python
-Version: 0.4.0
+Version: 0.6.0
 Summary: KiCad API Python Bindings
-License: MIT
+License-Expression: MIT
+License-File: LICENSE
 Author: The KiCad Development Team
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.9
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
 Classifier: Typing :: Typed
-Requires-Dist: protobuf (>=5.29,<6.0)
-Requires-Dist: pynng (>=0.8.0,<0.9.0)
-Requires-Dist: typing-extensions (>=4.13.2) ; python_version < "3.13"
+Requires-Dist: protobuf (>=5.29,<6)
+Requires-Dist: pynng (>=0.9.0,<0.10.0)
+Requires-Dist: typing_extensions (>=4.13.2) ; python_version < "3.13"
+Project-URL: Documentation, https://docs.kicad.org/kicad-python-main/
 Project-URL: Homepage, https://kicad.org/
 Project-URL: Repository, https://gitlab.com/kicad/code/kicad-python
+Project-URL: issues, https://gitlab.com/kicad/code/kicad-python/-/issues
 Description-Content-Type: text/markdown
 
 # KiCad API Python Bindings
@@ -102,6 +98,23 @@ plugins, copy or symlink them into the appropriate plugins path in order for KiC
 
 ## Release History
 
+### 0.6.0 (March 15, 2026)
+
+- Fix missing conversion of rectangles into polygons when rotating by non-cardinal amounts (#86)
+- Move to `pynng` 0.9.0 (John Hagen, !37)
+- Add `locked` properties to `Track` and `ArcTrack` (Anton Lazarev, !34)
+- Add `Board.get_layer_name` (KiCad 9.0.8) (#94)
+- Ensure `PolygonWithHoles` outline and holes are closed shapes (#73)
+- Fix `Project` taking over the document passed into it (#78)
+- Fix missing setter on `Field.name` (#87)
+
+### 0.5.0 (October 13, 2025)
+
+- Add `Pad.pad_to_die_length` (KiCad 9.0.4)
+- Add `Board.get_enabled_layers`, `Board.set_enabled_layers`, and `Board.get_copper_layer_count` (KiCad 9.0.5)
+- Autodetect default Flatpak socket path (Johannes Maibaum, !32)
+- Add support for `BoardCircle.rotate` (@modbw, !33)
+
 ### 0.4.0 (July 8, 2025)
 
 - Fix ability to move and rotate footprints

{kicad_python-0.4.0 → kicad_python-0.6.0}/README.md

@@ -77,6 +77,23 @@ plugins, copy or symlink them into the appropriate plugins path in order for KiC
 
 ## Release History
 
+### 0.6.0 (March 15, 2026)
+
+- Fix missing conversion of rectangles into polygons when rotating by non-cardinal amounts (#86)
+- Move to `pynng` 0.9.0 (John Hagen, !37)
+- Add `locked` properties to `Track` and `ArcTrack` (Anton Lazarev, !34)
+- Add `Board.get_layer_name` (KiCad 9.0.8) (#94)
+- Ensure `PolygonWithHoles` outline and holes are closed shapes (#73)
+- Fix `Project` taking over the document passed into it (#78)
+- Fix missing setter on `Field.name` (#87)
+
+### 0.5.0 (October 13, 2025)
+
+- Add `Pad.pad_to_die_length` (KiCad 9.0.4)
+- Add `Board.get_enabled_layers`, `Board.set_enabled_layers`, and `Board.get_copper_layer_count` (KiCad 9.0.5)
+- Autodetect default Flatpak socket path (Johannes Maibaum, !32)
+- Add support for `BoardCircle.rotate` (@modbw, !33)
+
 ### 0.4.0 (July 8, 2025)
 
 - Fix ability to move and rotate footprints

{kicad_python-0.4.0 → kicad_python-0.6.0}/build/lib/kipy/board.py

@@ -615,6 +615,53 @@ class Board:
             self._kicad.send(command, board_commands_pb2.BoardStackupResponse).stackup
         )
 
+    def get_copper_layer_count(self) -> int:
+        """
+        :return: The number of copper layers on the current board
+
+        .. versionadded:: 0.5.0 (with KiCad 9.0.5)
+        """
+        cmd = board_commands_pb2.GetBoardEnabledLayers()
+        cmd.board.CopyFrom(self._doc)
+        response = self._kicad.send(cmd, board_commands_pb2.BoardEnabledLayersResponse)
+        return response.copper_layer_count
+
+    def get_enabled_layers(self) -> List[board_types_pb2.BoardLayer.ValueType]:
+        """
+        Retrieves the list of all enabled layers in the board, including copper and non-copper layers.
+
+        :return: A list of enabled BoardLayer enums.
+
+        .. versionadded:: 0.5.0 (with KiCad 9.0.5)
+        """
+        cmd = board_commands_pb2.GetBoardEnabledLayers()
+        cmd.board.CopyFrom(self._doc)
+        response = self._kicad.send(cmd, board_commands_pb2.BoardEnabledLayersResponse)
+        return list(response.layers)
+
+    def set_enabled_layers(
+        self,
+        copper_layer_count: int,
+        layers: Sequence[board_types_pb2.BoardLayer.ValueType],
+    ) -> List[board_types_pb2.BoardLayer.ValueType]:
+        """
+        Sets the copper layer count and enabled non-copper layers for the board.
+
+        WARNING: Any existing content on layers that are removed by this call is deleted. This operation cannot be undone.
+
+        :param copper_layer_count: The number of copper layers to enable (must be even and >= 2).
+        :param layers: The non-copper layers to enable.
+        :return: The updated list of enabled BoardLayer enums.
+
+        .. versionadded:: 0.5.0 (with KiCad 9.0.5)
+        """
+        cmd = board_commands_pb2.SetBoardEnabledLayers()
+        cmd.board.CopyFrom(self._doc)
+        cmd.copper_layer_count = copper_layer_count
+        cmd.layers.extend(layers)
+        response = self._kicad.send(cmd, board_commands_pb2.BoardEnabledLayersResponse)
+        return list(response.layers)
+
     def get_graphics_defaults(self) -> Dict[int, BoardLayerGraphicsDefaults]:
         """Retrieves the default graphics properties for each layer class on the board"""
         cmd = board_commands_pb2.GetGraphicsDefaults()
@@ -655,6 +702,16 @@ class Board:
         cmd.origin.CopyFrom(origin.proto)
         self._kicad.send(cmd, Empty)
 
+    def get_layer_name(self, layer: board_types_pb2.BoardLayer.ValueType) -> str:
+        """Retrieves the user-visible name of a given layer, which may be a default value like "F.Cu"
+        or may have been customized by the user.  This method does not apply to dielectric layers.
+
+        .. versionadded:: 0.6.0 (KiCad 9.0.8)"""
+        cmd = board_commands_pb2.GetBoardLayerName()
+        cmd.board.CopyFrom(self._doc)
+        cmd.layer = layer
+        return self._kicad.send(cmd, board_commands_pb2.BoardLayerNameResponse).name
+
     @overload
     def expand_text_variables(self, text: str) -> str:
         ...

{kicad_python-0.4.0 → kicad_python-0.6.0}/build/lib/kipy/board_types.py

@@ -47,6 +47,7 @@ from kipy.geometry import (
     Vector2,
     Vector3D,
     PolygonWithHoles,
+    PolyLineNode,
     arc_angle,
     arc_center,
     arc_radius,
@@ -92,6 +93,11 @@ if sys.version_info >= (3, 13):
 else:
     from typing_extensions import deprecated
 
+if sys.version_info >= (3, 11):
+    from typing import Self
+else:
+    from typing_extensions import Self
+
 
 class BoardItem(Item):
     @property
@@ -147,6 +153,20 @@ class Track(BoardItem):
             f"net={self.net.name})"
         )
 
+    @property
+    def locked(self) -> bool:
+        """
+        .. versionadded:: 0.6.0
+        """
+        return self._proto.locked == LockedState.LS_LOCKED
+
+    @locked.setter
+    def locked(self, locked: bool):
+        self._proto.locked = {
+            True: LockedState.LS_LOCKED,
+            False: LockedState.LS_UNLOCKED,
+        }.get(locked, LockedState.LS_UNLOCKED)
+
     @property
     def net(self) -> Net:
         return Net(self._proto.net)
@@ -208,6 +228,20 @@ class ArcTrack(BoardItem):
             f"layer={BoardLayer.Name(self.layer)}, net={self.net.name})"
         )
 
+    @property
+    def locked(self) -> bool:
+        """
+        .. versionadded:: 0.6.0
+        """
+        return self._proto.locked == LockedState.LS_LOCKED
+
+    @locked.setter
+    def locked(self, locked: bool):
+        self._proto.locked = {
+            True: LockedState.LS_LOCKED,
+            False: LockedState.LS_UNLOCKED,
+        }.get(locked, LockedState.LS_UNLOCKED)
+
     @property
     def net(self) -> Net:
         return Net(self._proto.net)
@@ -476,7 +510,12 @@ class BoardCircle(BoardShape, Circle):
         self.radius_point += delta
 
     def rotate(self, angle: Angle, center: Vector2):
-        pass
+        """Rotates the circle around the given center point by the given angle
+
+        .. versionadded:: 0.5.0
+        """
+        self.center = self.center.rotate(angle, center)
+        self.radius_point = self.radius_point.rotate(angle, center)
 
 class BoardRectangle(BoardShape, Rectangle):
     """Represents a graphic rectangle on a board or footprint"""
@@ -512,6 +551,8 @@ class BoardRectangle(BoardShape, Rectangle):
 
     def rotate(self, angle: Angle, center: Vector2):
         """Rotates the rectangle around the given center point by the given angle"""
+        if angle.normalize().degrees % 90 != 0:
+            raise ValueError("Can only rotate rectangles by multiples of 90 degrees.  Convert to a polygon instead.")
         self.top_left = self.top_left.rotate(angle, center)
         self.bottom_right = self.bottom_right.rotate(angle, center)
 
@@ -552,6 +593,34 @@ class BoardPolygon(BoardShape, Polygon):
         for polygon in self.polygons:
             polygon.rotate(angle, center)
 
+    @classmethod
+    def from_rectangle(cls, rectangle: BoardRectangle) -> Self:
+        """Converts a BoardRectangle into a BoardPolygon with matching corners.
+
+        Other properties of the rectangle, including UUID, are preserved."""
+        obj = cls()
+        obj.proto.CopyFrom(rectangle._proto)
+        obj.proto.shape.ClearField("rectangle")
+        obj.proto.shape.polygon.SetInParent()
+        Polygon.__init__(obj, proto_ref=obj._proto.shape)
+
+        polygon = PolygonWithHoles()
+        polygon.outline.append(PolyLineNode.from_point(rectangle.top_left))
+        polygon.outline.append(
+            PolyLineNode.from_point(
+                Vector2.from_xy(rectangle.top_left.x, rectangle.bottom_right.y)
+            )
+        )
+        polygon.outline.append(PolyLineNode.from_point(rectangle.bottom_right))
+        polygon.outline.append(
+            PolyLineNode.from_point(
+                Vector2.from_xy(rectangle.bottom_right.x, rectangle.top_left.y)
+            )
+        )
+        polygon.outline.closed = True
+        obj.polygons.append(polygon)
+        return obj
+
 class BoardBezier(BoardShape, Bezier):
     """Represents a graphic bezier curve on a board or footprint"""
 
@@ -769,6 +838,10 @@ class Field(BoardItem):
     def name(self) -> str:
         return self._proto.name
 
+    @name.setter
+    def name(self, name: str):
+        self._proto.name = name
+
     @property
     def layer(self) -> BoardLayer.ValueType:
         return self._proto.text.layer
@@ -1307,6 +1380,17 @@ class Pad(BoardItem):
     def padstack(self) -> PadStack:
         return PadStack(proto_ref=self._proto.pad_stack)
 
+    @property
+    def pad_to_die_length(self) -> int:
+        """
+        .. versionadded:: 0.5.0 (with KiCad 9.0.4)
+        """
+        return self._proto.pad_to_die_length.value_nm
+
+    @pad_to_die_length.setter
+    def pad_to_die_length(self, length: int):
+        self._proto.pad_to_die_length.value_nm = length
+
 
 class Via(BoardItem):
     def __init__(self, proto: Optional[board_types_pb2.Via] = None,
@@ -1579,6 +1663,10 @@ class Footprint(Wrapper):
     def items(self) -> Sequence[Wrapper]:
         return self._unwrapped_items
 
+    @items.setter
+    def items(self, items: Sequence[Wrapper]):
+        self._unwrapped_items = list(items)
+
     @property
     def pads(self) -> Sequence[Pad]:
         """Returns all pads in the footprint"""
@@ -1691,22 +1779,33 @@ class FootprintInstance(BoardItem):
             field.text.position = field.text.position.rotate(delta, self.position)
             field.text.attributes.angle += delta.degrees
 
+        updated_items = []
         for item in self.definition.items:
             if isinstance(item, Field):
                 item.text.position = item.text.position.rotate(delta, self.position)
                 item.text.attributes.angle += delta.degrees
+                updated_items.append(item)
             elif isinstance(item, Pad):
                 item.position = item.position.rotate(delta, self.position)
                 item.padstack.angle += delta
+                updated_items.append(item)
             elif isinstance(item, BoardText):
                 item.position = item.position.rotate(delta, self.position)
                 item.attributes.angle += delta.degrees
+                updated_items.append(item)
             elif isinstance(item, Zone):
                 item.rotate(delta, self.position)
+                updated_items.append(item)
             elif isinstance(item, BoardShape):
                 shape = to_concrete_board_shape(item)
                 assert shape
+                if isinstance(shape, BoardRectangle) and delta.normalize().degrees % 90 != 0:
+                    shape = BoardPolygon.from_rectangle(shape)
+
                 shape.rotate(delta, self.position)
+                updated_items.append(shape)
+
+        self.definition.items = updated_items
 
     @property
     def layer(self) -> BoardLayer.ValueType:

{kicad_python-0.4.0 → kicad_python-0.6.0}/build/lib/kipy/geometry.py

@@ -581,12 +581,16 @@ class PolygonWithHoles(Wrapper):
     @outline.setter
     def outline(self, outline: PolyLine):
         self._proto.outline.CopyFrom(outline._proto)
+        # Outline must be a closed shape
+        self._proto.outline.closed = True
 
     @property
     def holes(self) -> list[PolyLine]:
         return [PolyLine(proto_ref=hole) for hole in self._proto.holes]
 
     def add_hole(self, hole: PolyLine):
+        # Holes must be a closed shape
+        hole.closed = True
         self._proto.holes.append(hole._proto)
 
     def remove_hole(self, hole: PolyLine):

{kicad_python-0.4.0 → kicad_python-0.6.0}/build/lib/kipy/kicad.py

@@ -44,7 +44,17 @@ def _default_socket_path() -> str:
     path = os.environ.get('KICAD_API_SOCKET')
     if path is not None:
         return path
-    return f'ipc://{gettempdir()}\\kicad\\api.sock' if platform.system() == 'Windows' else 'ipc:///tmp/kicad/api.sock'
+    if platform.system() == 'Windows':
+        return f'ipc://{gettempdir()}\\kicad\\api.sock'
+    else:
+        # Check for default socket path of KiCad flatpak on flathub
+        home = os.environ.get('HOME')
+        if home is not None:
+            flatpak_socket_path = f'{home}/.var/app/org.kicad.KiCad/cache/tmp/kicad/api.sock'
+            if os.path.exists(flatpak_socket_path):
+                return f'ipc://{flatpak_socket_path}'
+
+        return 'ipc:///tmp/kicad/api.sock'
 
 def _random_client_name() -> str:
     return 'anonymous-'+''.join(random.choices(string.ascii_lowercase + string.digits, k=8))

{kicad_python-0.4.0 → kicad_python-0.6.0}/build/lib/kipy/kicad_api_version.py

@@ -1,2 +1,2 @@
 # This file is automatically generated, do not modify it
-KICAD_API_VERSION = "9.0.3-0-g21b6198547"
+KICAD_API_VERSION = "9.0.7-328-g3514d130cb"

{kicad_python-0.4.0 → kicad_python-0.6.0/build/lib}/kipy/project.py

@@ -31,12 +31,16 @@ from google.protobuf.empty_pb2 import Empty
 class Project:
     def __init__(self, kicad: KiCadClient, document: DocumentSpecifier):
         self._kicad = kicad
-        self._doc = document
+        self._doc = DocumentSpecifier()
+        self._doc.CopyFrom(document)
 
         # TODO clean this up; no identifier for project right now
         if self._doc.type != DocumentType.DOCTYPE_PROJECT:
             self._doc.type = DocumentType.DOCTYPE_PROJECT
 
+    def __repr__(self) -> str:
+        return f"Project(name={self.name!r}, path={self.path!r})"
+
     @property
     def document(self) -> DocumentSpecifier:
         return self._doc

{kicad_python-0.4.0 → kicad_python-0.6.0/build/lib}/kipy/project_types.py

@@ -28,7 +28,9 @@ from kipy.wrapper import Wrapper
 class NetClass(Wrapper):
     def __init__(self, proto: project_settings_pb2.NetClass = project_settings_pb2.NetClass()):
         self._proto = proto
-        self.proto.type = project_settings_pb2.NetClassType.NCT_EXPLICIT
+
+        if proto.type == project_settings_pb2.NetClassType.NCT_UNKNOWN:
+            self._proto.type = project_settings_pb2.NetClassType.NCT_EXPLICIT
 
     def __repr__(self) -> str:
         return (

kicad_python-0.6.0/build/lib/kipy/proto/board/board_commands_pb2.py

@@ -0,0 +1,103 @@
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import runtime_version as _runtime_version
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+_runtime_version.ValidateProtobufRuntimeVersion(_runtime_version.Domain.PUBLIC, 5, 29, 1, '', 'board/board_commands.proto')
+_sym_db = _symbol_database.Default()
+from ..common.types import base_types_pb2 as common_dot_types_dot_base__types__pb2
+from ..common.types import enums_pb2 as common_dot_types_dot_enums__pb2
+from ..common.types import project_settings_pb2 as common_dot_types_dot_project__settings__pb2
+from ..board import board_pb2 as board_dot_board__pb2
+from ..board import board_types_pb2 as board_dot_board__types__pb2
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1aboard/board_commands.proto\x12\x14kiapi.board.commands\x1a\x1dcommon/types/base_types.proto\x1a\x18common/types/enums.proto\x1a#common/types/project_settings.proto\x1a\x11board/board.proto\x1a\x17board/board_types.proto"G\n\x0fGetBoardStackup\x124\n\x05board\x18\x01 \x01(\x0b2%.kiapi.common.types.DocumentSpecifier"B\n\x14BoardStackupResponse\x12*\n\x07stackup\x18\x01 \x01(\x0b2\x19.kiapi.board.BoardStackup"v\n\x12UpdateBoardStackup\x124\n\x05board\x18\x01 \x01(\x0b2%.kiapi.common.types.DocumentSpecifier\x12*\n\x07stackup\x18\x02 \x01(\x0b2\x19.kiapi.board.BoardStackup"M\n\x15GetBoardEnabledLayers\x124\n\x05board\x18\x01 \x01(\x0b2%.kiapi.common.types.DocumentSpecifier"g\n\x1aBoardEnabledLayersResponse\x12\x1a\n\x12copper_layer_count\x18\x01 \x01(\r\x12-\n\x06layers\x18\x02 \x03(\x0e2\x1d.kiapi.board.types.BoardLayer"\x98\x01\n\x15SetBoardEnabledLayers\x124\n\x05board\x18\x01 \x01(\x0b2%.kiapi.common.types.DocumentSpecifier\x12\x1a\n\x12copper_layer_count\x18\x02 \x01(\r\x12-\n\x06layers\x18\x03 \x03(\x0e2\x1d.kiapi.board.types.BoardLayer"K\n\x13GetGraphicsDefaults\x124\n\x05board\x18\x01 \x01(\x0b2%.kiapi.common.types.DocumentSpecifier"K\n\x18GraphicsDefaultsResponse\x12/\n\x08defaults\x18\x01 \x01(\x0b2\x1d.kiapi.board.GraphicsDefaults"{\n\x0eGetBoardOrigin\x124\n\x05board\x18\x01 \x01(\x0b2%.kiapi.common.types.DocumentSpecifier\x123\n\x04type\x18\x02 \x01(\x0e2%.kiapi.board.commands.BoardOriginType"\xa8\x01\n\x0eSetBoardOrigin\x124\n\x05board\x18\x01 \x01(\x0b2%.kiapi.common.types.DocumentSpecifier\x123\n\x04type\x18\x02 \x01(\x0e2%.kiapi.board.commands.BoardOriginType\x12+\n\x06origin\x18\x03 \x01(\x0b2\x1b.kiapi.common.types.Vector2"w\n\x11GetBoardLayerName\x124\n\x05board\x18\x01 \x01(\x0b2%.kiapi.common.types.DocumentSpecifier\x12,\n\x05layer\x18\x02 \x01(\x0e2\x1d.kiapi.board.types.BoardLayer"&\n\x16BoardLayerNameResponse\x12\x0c\n\x04name\x18\x01 \x01(\t"X\n\x07GetNets\x124\n\x05board\x18\x01 \x01(\x0b2%.kiapi.common.types.DocumentSpecifier\x12\x17\n\x0fnetclass_filter\x18\x02 \x03(\t"4\n\x0cNetsResponse\x12$\n\x04nets\x18\x01 \x03(\x0b2\x16.kiapi.board.types.Net"\xa2\x01\n\rGetItemsByNet\x12.\n\x06header\x18\x01 \x01(\x0b2\x1e.kiapi.common.types.ItemHeader\x122\n\x05types\x18\x02 \x03(\x0e2#.kiapi.common.types.KiCadObjectType\x12-\n\tnet_codes\x18\x03 \x03(\x0b2\x1a.kiapi.board.types.NetCode"\x8d\x01\n\x12GetItemsByNetClass\x12.\n\x06header\x18\x01 \x01(\x0b2\x1e.kiapi.common.types.ItemHeader\x122\n\x05types\x18\x02 \x03(\x0e2#.kiapi.common.types.KiCadObjectType\x12\x13\n\x0bnet_classes\x18\x03 \x03(\t"9\n\x12GetNetClassForNets\x12#\n\x03net\x18\x01 \x03(\x0b2\x16.kiapi.board.types.Net"\xb6\x01\n\x17NetClassForNetsResponse\x12K\n\x07classes\x18\x01 \x03(\x0b2:.kiapi.board.commands.NetClassForNetsResponse.ClassesEntry\x1aN\n\x0cClassesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12-\n\x05value\x18\x02 \x01(\x0b2\x1e.kiapi.common.project.NetClass:\x028\x01"l\n\x0bRefillZones\x124\n\x05board\x18\x01 \x01(\x0b2%.kiapi.common.types.DocumentSpecifier\x12\'\n\x05zones\x18\x02 \x03(\x0b2\x18.kiapi.common.types.KIID"\xa2\x01\n\x14GetPadShapeAsPolygon\x124\n\x05board\x18\x01 \x01(\x0b2%.kiapi.common.types.DocumentSpecifier\x12&\n\x04pads\x18\x02 \x03(\x0b2\x18.kiapi.common.types.KIID\x12,\n\x05layer\x18\x03 \x01(\x0e2\x1d.kiapi.board.types.BoardLayer"{\n\x19PadShapeAsPolygonResponse\x12&\n\x04pads\x18\x01 \x03(\x0b2\x18.kiapi.common.types.KIID\x126\n\x08polygons\x18\x02 \x03(\x0b2$.kiapi.common.types.PolygonWithHoles"\xad\x01\n\x1dCheckPadstackPresenceOnLayers\x124\n\x05board\x18\x01 \x01(\x0b2%.kiapi.common.types.DocumentSpecifier\x12\'\n\x05items\x18\x02 \x03(\x0b2\x18.kiapi.common.types.KIID\x12-\n\x06layers\x18\x03 \x03(\x0e2\x1d.kiapi.board.types.BoardLayer"\xa7\x01\n\x15PadstackPresenceEntry\x12&\n\x04item\x18\x01 \x01(\x0b2\x18.kiapi.common.types.KIID\x12,\n\x05layer\x18\x02 \x01(\x0e2\x1d.kiapi.board.types.BoardLayer\x128\n\x08presence\x18\x03 \x01(\x0e2&.kiapi.board.commands.PadstackPresence"X\n\x18PadstackPresenceResponse\x12<\n\x07entries\x18\x01 \x03(\x0b2+.kiapi.board.commands.PadstackPresenceEntry"H\n\x10GetVisibleLayers\x124\n\x05board\x18\x01 \x01(\x0b2%.kiapi.common.types.DocumentSpecifier"B\n\x12BoardLayerResponse\x12,\n\x05layer\x18\x01 \x01(\x0e2\x1d.kiapi.board.types.BoardLayer"<\n\x0bBoardLayers\x12-\n\x06layers\x18\x01 \x03(\x0e2\x1d.kiapi.board.types.BoardLayer"w\n\x10SetVisibleLayers\x124\n\x05board\x18\x01 \x01(\x0b2%.kiapi.common.types.DocumentSpecifier\x12-\n\x06layers\x18\x02 \x03(\x0e2\x1d.kiapi.board.types.BoardLayer"F\n\x0eGetActiveLayer\x124\n\x05board\x18\x01 \x01(\x0b2%.kiapi.common.types.DocumentSpecifier"t\n\x0eSetActiveLayer\x124\n\x05board\x18\x01 \x01(\x0b2%.kiapi.common.types.DocumentSpecifier\x12,\n\x05layer\x18\x02 \x01(\x0e2\x1d.kiapi.board.types.BoardLayer"\xb3\x02\n\x1dBoardEditorAppearanceSettings\x12N\n\x16inactive_layer_display\x18\x01 \x01(\x0e2..kiapi.board.commands.InactiveLayerDisplayMode\x12D\n\x11net_color_display\x18\x02 \x01(\x0e2).kiapi.board.commands.NetColorDisplayMode\x127\n\nboard_flip\x18\x03 \x01(\x0e2#.kiapi.board.commands.BoardFlipMode\x12C\n\x10ratsnest_display\x18\x04 \x01(\x0e2).kiapi.board.commands.RatsnestDisplayMode""\n GetBoardEditorAppearanceSettings"i\n SetBoardEditorAppearanceSettings\x12E\n\x08settings\x18\x01 \x01(\x0b23.kiapi.board.commands.BoardEditorAppearanceSettings"u\n\x14InteractiveMoveItems\x124\n\x05board\x18\x01 \x01(\x0b2%.kiapi.common.types.DocumentSpecifier\x12\'\n\x05items\x18\x02 \x03(\x0b2\x18.kiapi.common.types.KIID*?\n\x0fBoardOriginType\x12\x0f\n\x0bBOT_UNKNOWN\x10\x00\x12\x0c\n\x08BOT_GRID\x10\x01\x12\r\n\tBOT_DRILL\x10\x02*I\n\x10PadstackPresence\x12\x0f\n\x0bPSP_UNKNOWN\x10\x00\x12\x0f\n\x0bPSP_PRESENT\x10\x01\x12\x13\n\x0fPSP_NOT_PRESENT\x10\x02*_\n\x18InactiveLayerDisplayMode\x12\x10\n\x0cILDM_UNKNOWN\x10\x00\x12\x0f\n\x0bILDM_NORMAL\x10\x01\x12\x0f\n\x0bILDM_DIMMED\x10\x02\x12\x0f\n\x0bILDM_HIDDEN\x10\x03*V\n\x13NetColorDisplayMode\x12\x10\n\x0cNCDM_UNKNOWN\x10\x00\x12\x0c\n\x08NCDM_ALL\x10\x01\x12\x11\n\rNCDM_RATSNEST\x10\x02\x12\x0c\n\x08NCDM_OFF\x10\x03*C\n\rBoardFlipMode\x12\x0f\n\x0bBFM_UNKNOWN\x10\x00\x12\x0e\n\nBFM_NORMAL\x10\x01\x12\x11\n\rBFM_FLIPPED_X\x10\x02*R\n\x13RatsnestDisplayMode\x12\x0f\n\x0bRDM_UNKNOWN\x10\x00\x12\x12\n\x0eRDM_ALL_LAYERS\x10\x01\x12\x16\n\x12RDM_VISIBLE_LAYERS\x10\x02b\x06proto3')
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'board.board_commands_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+    DESCRIPTOR._loaded_options = None
+    _globals['_NETCLASSFORNETSRESPONSE_CLASSESENTRY']._loaded_options = None
+    _globals['_NETCLASSFORNETSRESPONSE_CLASSESENTRY']._serialized_options = b'8\x01'
+    _globals['_BOARDORIGINTYPE']._serialized_start = 4021
+    _globals['_BOARDORIGINTYPE']._serialized_end = 4084
+    _globals['_PADSTACKPRESENCE']._serialized_start = 4086
+    _globals['_PADSTACKPRESENCE']._serialized_end = 4159
+    _globals['_INACTIVELAYERDISPLAYMODE']._serialized_start = 4161
+    _globals['_INACTIVELAYERDISPLAYMODE']._serialized_end = 4256
+    _globals['_NETCOLORDISPLAYMODE']._serialized_start = 4258
+    _globals['_NETCOLORDISPLAYMODE']._serialized_end = 4344
+    _globals['_BOARDFLIPMODE']._serialized_start = 4346
+    _globals['_BOARDFLIPMODE']._serialized_end = 4413
+    _globals['_RATSNESTDISPLAYMODE']._serialized_start = 4415
+    _globals['_RATSNESTDISPLAYMODE']._serialized_end = 4497
+    _globals['_GETBOARDSTACKUP']._serialized_start = 190
+    _globals['_GETBOARDSTACKUP']._serialized_end = 261
+    _globals['_BOARDSTACKUPRESPONSE']._serialized_start = 263
+    _globals['_BOARDSTACKUPRESPONSE']._serialized_end = 329
+    _globals['_UPDATEBOARDSTACKUP']._serialized_start = 331
+    _globals['_UPDATEBOARDSTACKUP']._serialized_end = 449
+    _globals['_GETBOARDENABLEDLAYERS']._serialized_start = 451
+    _globals['_GETBOARDENABLEDLAYERS']._serialized_end = 528
+    _globals['_BOARDENABLEDLAYERSRESPONSE']._serialized_start = 530
+    _globals['_BOARDENABLEDLAYERSRESPONSE']._serialized_end = 633
+    _globals['_SETBOARDENABLEDLAYERS']._serialized_start = 636
+    _globals['_SETBOARDENABLEDLAYERS']._serialized_end = 788
+    _globals['_GETGRAPHICSDEFAULTS']._serialized_start = 790
+    _globals['_GETGRAPHICSDEFAULTS']._serialized_end = 865
+    _globals['_GRAPHICSDEFAULTSRESPONSE']._serialized_start = 867
+    _globals['_GRAPHICSDEFAULTSRESPONSE']._serialized_end = 942
+    _globals['_GETBOARDORIGIN']._serialized_start = 944
+    _globals['_GETBOARDORIGIN']._serialized_end = 1067
+    _globals['_SETBOARDORIGIN']._serialized_start = 1070
+    _globals['_SETBOARDORIGIN']._serialized_end = 1238
+    _globals['_GETBOARDLAYERNAME']._serialized_start = 1240
+    _globals['_GETBOARDLAYERNAME']._serialized_end = 1359
+    _globals['_BOARDLAYERNAMERESPONSE']._serialized_start = 1361
+    _globals['_BOARDLAYERNAMERESPONSE']._serialized_end = 1399
+    _globals['_GETNETS']._serialized_start = 1401
+    _globals['_GETNETS']._serialized_end = 1489
+    _globals['_NETSRESPONSE']._serialized_start = 1491
+    _globals['_NETSRESPONSE']._serialized_end = 1543
+    _globals['_GETITEMSBYNET']._serialized_start = 1546
+    _globals['_GETITEMSBYNET']._serialized_end = 1708
+    _globals['_GETITEMSBYNETCLASS']._serialized_start = 1711
+    _globals['_GETITEMSBYNETCLASS']._serialized_end = 1852
+    _globals['_GETNETCLASSFORNETS']._serialized_start = 1854
+    _globals['_GETNETCLASSFORNETS']._serialized_end = 1911
+    _globals['_NETCLASSFORNETSRESPONSE']._serialized_start = 1914
+    _globals['_NETCLASSFORNETSRESPONSE']._serialized_end = 2096
+    _globals['_NETCLASSFORNETSRESPONSE_CLASSESENTRY']._serialized_start = 2018
+    _globals['_NETCLASSFORNETSRESPONSE_CLASSESENTRY']._serialized_end = 2096
+    _globals['_REFILLZONES']._serialized_start = 2098
+    _globals['_REFILLZONES']._serialized_end = 2206
+    _globals['_GETPADSHAPEASPOLYGON']._serialized_start = 2209
+    _globals['_GETPADSHAPEASPOLYGON']._serialized_end = 2371
+    _globals['_PADSHAPEASPOLYGONRESPONSE']._serialized_start = 2373
+    _globals['_PADSHAPEASPOLYGONRESPONSE']._serialized_end = 2496
+    _globals['_CHECKPADSTACKPRESENCEONLAYERS']._serialized_start = 2499
+    _globals['_CHECKPADSTACKPRESENCEONLAYERS']._serialized_end = 2672
+    _globals['_PADSTACKPRESENCEENTRY']._serialized_start = 2675
+    _globals['_PADSTACKPRESENCEENTRY']._serialized_end = 2842
+    _globals['_PADSTACKPRESENCERESPONSE']._serialized_start = 2844
+    _globals['_PADSTACKPRESENCERESPONSE']._serialized_end = 2932
+    _globals['_GETVISIBLELAYERS']._serialized_start = 2934
+    _globals['_GETVISIBLELAYERS']._serialized_end = 3006
+    _globals['_BOARDLAYERRESPONSE']._serialized_start = 3008
+    _globals['_BOARDLAYERRESPONSE']._serialized_end = 3074
+    _globals['_BOARDLAYERS']._serialized_start = 3076
+    _globals['_BOARDLAYERS']._serialized_end = 3136
+    _globals['_SETVISIBLELAYERS']._serialized_start = 3138
+    _globals['_SETVISIBLELAYERS']._serialized_end = 3257
+    _globals['_GETACTIVELAYER']._serialized_start = 3259
+    _globals['_GETACTIVELAYER']._serialized_end = 3329
+    _globals['_SETACTIVELAYER']._serialized_start = 3331
+    _globals['_SETACTIVELAYER']._serialized_end = 3447
+    _globals['_BOARDEDITORAPPEARANCESETTINGS']._serialized_start = 3450
+    _globals['_BOARDEDITORAPPEARANCESETTINGS']._serialized_end = 3757
+    _globals['_GETBOARDEDITORAPPEARANCESETTINGS']._serialized_start = 3759
+    _globals['_GETBOARDEDITORAPPEARANCESETTINGS']._serialized_end = 3793
+    _globals['_SETBOARDEDITORAPPEARANCESETTINGS']._serialized_start = 3795
+    _globals['_SETBOARDEDITORAPPEARANCESETTINGS']._serialized_end = 3900
+    _globals['_INTERACTIVEMOVEITEMS']._serialized_start = 3902
+    _globals['_INTERACTIVEMOVEITEMS']._serialized_end = 4019

{kicad_python-0.4.0 → kicad_python-0.6.0}/build/lib/kipy/proto/board/board_commands_pb2.pyi

@@ -209,6 +209,10 @@ global___BoardStackupResponse = BoardStackupResponse
 
 @typing.final
 class UpdateBoardStackup(google.protobuf.message.Message):
+    """Changes the stackup for the given board according to the contents of the message (**not yet implemented**)
+    WARNING: any existing content on layers that are removed by this call is deleted.  This operation cannot be undone.
+    Returns BoardStackupResponse with the updated stackup, in normalized form
+    """
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
     BOARD_FIELD_NUMBER: builtins.int
     STACKUP_FIELD_NUMBER: builtins.int
@@ -231,6 +235,78 @@ class UpdateBoardStackup(google.protobuf.message.Message):
         ...
 global___UpdateBoardStackup = UpdateBoardStackup
 
+@typing.final
+class GetBoardEnabledLayers(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    BOARD_FIELD_NUMBER: builtins.int
+
+    @property
+    def board(self) -> common.types.base_types_pb2.DocumentSpecifier:
+        ...
+
+    def __init__(self, *, board: common.types.base_types_pb2.DocumentSpecifier | None=...) -> None:
+        ...
+
+    def HasField(self, field_name: typing.Literal['board', b'board']) -> builtins.bool:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['board', b'board']) -> None:
+        ...
+global___GetBoardEnabledLayers = GetBoardEnabledLayers
+
+@typing.final
+class BoardEnabledLayersResponse(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    COPPER_LAYER_COUNT_FIELD_NUMBER: builtins.int
+    LAYERS_FIELD_NUMBER: builtins.int
+    copper_layer_count: builtins.int
+    'The number of copper layers enabled in this board.'
+
+    @property
+    def layers(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[board.board_types_pb2.BoardLayer.ValueType]:
+        """A list of all layers enabled in this board, including copper layers and ones which cannot be disabled."""
+
+    def __init__(self, *, copper_layer_count: builtins.int=..., layers: collections.abc.Iterable[board.board_types_pb2.BoardLayer.ValueType] | None=...) -> None:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['copper_layer_count', b'copper_layer_count', 'layers', b'layers']) -> None:
+        ...
+global___BoardEnabledLayersResponse = BoardEnabledLayersResponse
+
+@typing.final
+class SetBoardEnabledLayers(google.protobuf.message.Message):
+    """Changes which layers are enabled in the board stackup
+    WARNING: any existing content on layers that are removed by this call is deleted.  This operation cannot be undone.
+    Returns BoardEnabledLayersResponse with the updated layer set.
+    """
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    BOARD_FIELD_NUMBER: builtins.int
+    COPPER_LAYER_COUNT_FIELD_NUMBER: builtins.int
+    LAYERS_FIELD_NUMBER: builtins.int
+    copper_layer_count: builtins.int
+    'The number of copper layers to enable in the board.  Currently, this must be an even number >= 2.'
+
+    @property
+    def board(self) -> common.types.base_types_pb2.DocumentSpecifier:
+        ...
+
+    @property
+    def layers(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[board.board_types_pb2.BoardLayer.ValueType]:
+        """The non-copper layers to enable.  Note that any copper layers in this list are ignored; copper layers are enabled
+        by setting copper_layer_count.  Note that the F/B.Courtyard, Edge.Cuts, and Margin layers cannot be disabled and
+        will be present in the board even if they are omitted from this list.
+        """
+
+    def __init__(self, *, board: common.types.base_types_pb2.DocumentSpecifier | None=..., copper_layer_count: builtins.int=..., layers: collections.abc.Iterable[board.board_types_pb2.BoardLayer.ValueType] | None=...) -> None:
+        ...
+
+    def HasField(self, field_name: typing.Literal['board', b'board']) -> builtins.bool:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['board', b'board', 'copper_layer_count', b'copper_layer_count', 'layers', b'layers']) -> None:
+        ...
+global___SetBoardEnabledLayers = SetBoardEnabledLayers
+
 @typing.final
 class GetGraphicsDefaults(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
@@ -317,6 +393,41 @@ class SetBoardOrigin(google.protobuf.message.Message):
         ...
 global___SetBoardOrigin = SetBoardOrigin
 
+@typing.final
+class GetBoardLayerName(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    BOARD_FIELD_NUMBER: builtins.int
+    LAYER_FIELD_NUMBER: builtins.int
+    layer: board.board_types_pb2.BoardLayer.ValueType
+
+    @property
+    def board(self) -> common.types.base_types_pb2.DocumentSpecifier:
+        ...
+
+    def __init__(self, *, board: common.types.base_types_pb2.DocumentSpecifier | None=..., layer: board.board_types_pb2.BoardLayer.ValueType=...) -> None:
+        ...
+
+    def HasField(self, field_name: typing.Literal['board', b'board']) -> builtins.bool:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['board', b'board', 'layer', b'layer']) -> None:
+        ...
+global___GetBoardLayerName = GetBoardLayerName
+
+@typing.final
+class BoardLayerNameResponse(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    NAME_FIELD_NUMBER: builtins.int
+    name: builtins.str
+    'The name of the layer shown in the KiCad GUI, which may be a default value like "F.Cu" or may\n    have been customized by the user.\n    '
+
+    def __init__(self, *, name: builtins.str=...) -> None:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['name', b'name']) -> None:
+        ...
+global___BoardLayerNameResponse = BoardLayerNameResponse
+
 @typing.final
 class GetNets(google.protobuf.message.Message):
     """