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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: kicad-python
-Version: 0.3.0
+Version: 0.4.0
 Summary: KiCad API Python Bindings
 License: MIT
 Author: The KiCad Development Team
@@ -15,9 +15,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)
-Requires-Dist: deprecated (>=1.2,<2.0)
+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"
 Project-URL: Homepage, https://kicad.org/
 Project-URL: Repository, https://gitlab.com/kicad/code/kicad-python
 Description-Content-Type: text/markdown
@@ -31,7 +32,10 @@ The KiCad IPC API can be considered in "public beta" state with the release of K
 planned for on or around February 1, 2025).  The existing SWIG-based Python bindings for KiCad's
 PCB editor still exist in KiCad 9, but are in maintenance mode and will not be expanded.
 
-For more information about the IPC API, please see the [KiCad developer documentation](https://dev-docs.kicad.org/en/apis-and-binding/ipc-api/index.html).  Specific documentation for developing add-ons is [also available](https://dev-docs.kicad.org/en/apis-and-binding/ipc-api/for-addon-developers/index.html).
+For more information about the IPC API, please see the
+[KiCad developer documentation](https://dev-docs.kicad.org/en/apis-and-binding/ipc-api/index.html).
+Specific documentation for developing add-ons is
+[also available](https://dev-docs.kicad.org/en/apis-and-binding/ipc-api/for-addon-developers/index.html).
 
 > Note: Version 0.0.2 and prior of this package are an obsolete earlier effort and are unrelated to
 > this codebase.
@@ -98,6 +102,23 @@ plugins, copy or symlink them into the appropriate plugins path in order for KiC
 
 ## Release History
 
+### 0.4.0 (July 8, 2025)
+
+- Fix ability to move and rotate footprints
+- Fix ArcTrack length calculation (Quentin Freimanis, !13)
+- Make it possible to add new `BoardPolygon`s in a more ergonomic way
+- Add `FootprintInstance.sheet_path` property (#37)
+- Add `board.check_padstack_presence_on_layers`, replacing FlashLayer in SWIG
+- Allow setting `Net.name` so that new nets can be created
+- Deprecate `Net.code` (net codes are an internal KiCad detail and API clients should ignore them)
+- Add `py.typed` type hinting indicator file (John Hagen, !16)
+- Fix `Vector2.from_xy_mm` type annotations (John Hagen, !17)
+- Add `Arc.angle` and `ArcTrack.angle`; some arc angle utilities (Quentin Freimanis, !14)
+- Add `remove_items_by_id` (Anthonypark, !20)
+- Allow assigning nets to `Zone` (#62)
+- Allow changing `Pad.pad_type` (#63)
+- Allow changing `Field.layer` (#64)
+
 ### 0.3.0 (March 29, 2025)
 
 - Add support for footprint mounting style attribute (#19) (Thanh Duong, !10)

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

@@ -7,7 +7,10 @@ The KiCad IPC API can be considered in "public beta" state with the release of K
 planned for on or around February 1, 2025).  The existing SWIG-based Python bindings for KiCad's
 PCB editor still exist in KiCad 9, but are in maintenance mode and will not be expanded.
 
-For more information about the IPC API, please see the [KiCad developer documentation](https://dev-docs.kicad.org/en/apis-and-binding/ipc-api/index.html).  Specific documentation for developing add-ons is [also available](https://dev-docs.kicad.org/en/apis-and-binding/ipc-api/for-addon-developers/index.html).
+For more information about the IPC API, please see the
+[KiCad developer documentation](https://dev-docs.kicad.org/en/apis-and-binding/ipc-api/index.html).
+Specific documentation for developing add-ons is
+[also available](https://dev-docs.kicad.org/en/apis-and-binding/ipc-api/for-addon-developers/index.html).
 
 > Note: Version 0.0.2 and prior of this package are an obsolete earlier effort and are unrelated to
 > this codebase.
@@ -74,6 +77,23 @@ plugins, copy or symlink them into the appropriate plugins path in order for KiC
 
 ## Release History
 
+### 0.4.0 (July 8, 2025)
+
+- Fix ability to move and rotate footprints
+- Fix ArcTrack length calculation (Quentin Freimanis, !13)
+- Make it possible to add new `BoardPolygon`s in a more ergonomic way
+- Add `FootprintInstance.sheet_path` property (#37)
+- Add `board.check_padstack_presence_on_layers`, replacing FlashLayer in SWIG
+- Allow setting `Net.name` so that new nets can be created
+- Deprecate `Net.code` (net codes are an internal KiCad detail and API clients should ignore them)
+- Add `py.typed` type hinting indicator file (John Hagen, !16)
+- Fix `Vector2.from_xy_mm` type annotations (John Hagen, !17)
+- Add `Arc.angle` and `ArcTrack.angle`; some arc angle utilities (Quentin Freimanis, !14)
+- Add `remove_items_by_id` (Anthonypark, !20)
+- Allow assigning nets to `Zone` (#62)
+- Allow changing `Pad.pad_type` (#63)
+- Allow changing `Field.layer` (#64)
+
 ### 0.3.0 (March 29, 2025)
 
 - Add support for footprint mounting style attribute (#19) (Thanh Duong, !10)

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

@@ -489,6 +489,23 @@ class Board:
 
         self._kicad.send(command, DeleteItemsResponse)
 
+    def remove_items_by_id(self, items: Union[KIID, Sequence[KIID]]):
+        """Deletes one or more items from the board using their unique IDs
+
+        .. versionadded:: 0.4.0"""
+        command = DeleteItems()
+        command.header.document.CopyFrom(self._doc)
+
+        if isinstance(items, KIID):
+            command.item_ids.append(items)
+        else:
+            command.item_ids.extend(items)
+
+        if len(command.item_ids) == 0:
+            return
+
+        self._kicad.send(command, DeleteItemsResponse)
+
     def get_nets(
         self, netclass_filter: Optional[Union[str, Sequence[str]]] = None
     ) -> Sequence[Net]:
@@ -742,6 +759,55 @@ class Board:
             if p is not None
         ]
 
+    def check_padstack_presence_on_layers(
+        self,
+        items: Union[BoardItem, Iterable[BoardItem]],
+        layers: Union[board_types_pb2.BoardLayer.ValueType, Iterable[board_types_pb2.BoardLayer.ValueType]]
+    ) -> Dict[BoardItem, Dict[board_types_pb2.BoardLayer.ValueType, bool]]:
+        """Checks if the given items with padstacks (pads or vias) have content on the given layers.
+
+        :param items: The items to check (one or more pads or vias).
+        :param layers: The layer or layers to check for padstack presence.
+        :return: A dictionary mapping each item to a dictionary of layers and their presence on
+                 the given layer.
+
+        .. versionadded:: 0.4.0 with KiCad 9.0.3
+        """
+        cmd = board_commands_pb2.CheckPadstackPresenceOnLayers()
+        cmd.board.CopyFrom(self._doc)
+
+        items_map = {}
+
+        if isinstance(items, BoardItem):
+            cmd.items.append(items.id)
+            items_map[items.id.value] = items
+        else:
+            cmd.items.extend([item.id for item in items])
+            items_map.update({item.id.value: item for item in items})
+
+        if isinstance(layers, int):
+            cmd.layers.append(layers)
+        else:
+            cmd.layers.extend(layers)
+
+        response = self._kicad.send(cmd, board_commands_pb2.PadstackPresenceResponse)
+
+        result = {}
+        for entry in response.entries:
+            if entry.item.value not in items_map:
+                continue
+
+            item = items_map[entry.item.value]
+            layer = entry.layer
+            presence = entry.presence is board_commands_pb2.PadstackPresence.PSP_PRESENT
+
+            if item not in result:
+                result[item] = {}
+
+            result[item][layer] = presence
+
+        return result
+
     def interactive_move(self, items: Union[KIID, Iterable[KIID]]):
         """Initiates an interactive move operation on one or more items on the board.  The user
         will be able to move the items interactively in the KiCad editor.  This is a blocking