kicad-python 0.1.0a1__tar.gz → 0.1.1__tar.gz

{kicad_python-0.1.0a1 → kicad_python-0.1.1}/PKG-INFO

@@ -1,24 +1,25 @@
 Metadata-Version: 2.1
 Name: kicad-python
-Version: 0.1.0a1
+Version: 0.1.1
 Summary: KiCad API Python Bindings
 Home-page: https://kicad.org/
 License: GPL-3
 Author: The KiCad Development Team
-Requires-Python: >=3.8,<4.0
+Requires-Python: >=3.9,<3.13
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
 Classifier: License :: Other/Proprietary License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 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: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
-Requires-Dist: protobuf (>=4.21.12,<5.0.0)
-Requires-Dist: pynng (>=0.7.2,<0.8.0)
+Requires-Dist: furo (>=2024.8.6,<2025.0.0)
+Requires-Dist: protobuf (>=5.29,<6.0)
+Requires-Dist: pynng (>=0.8.0,<0.9.0)
+Requires-Dist: sphinx (==7.4)
 Project-URL: Repository, https://gitlab.com/kicad/code/kicad-python
 Description-Content-Type: text/markdown
 
@@ -27,10 +28,24 @@ Description-Content-Type: text/markdown
 `kicad-python` is the official Python bindings for the [KiCad](https://kicad.org) IPC API.  This
 library makes it possible to develop scripts and tools that interact with a running KiCad session.
 
+The KiCad IPC API can be considered in "public beta" state with the release of KiCad 9 (currently
+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).
 
-Note: Version 0.0.2 and prior of this package are an obsolete earlier effort and are unrelated to
-this codebase.
+> Note: Version 0.0.2 and prior of this package are an obsolete earlier effort and are unrelated to
+> this codebase.
+
+## Requirements
+
+Using the IPC API requires a suitable version of KiCad (9.0 or higher) and requires that KiCad be
+running with the API server enabled in Preferences > Plugins.  This package also depends on the
+`protobuf` and `pynng` packages for communication with KiCad.
+
+> Note: Unlike the SWIG-based Python bindings, the IPC API requires communication with a running
+> instance of KiCad.  It is not possible to use `kicad-python` to manipulate KiCad design files
+> without KiCad running.
 
 ## Contributing
 
@@ -49,10 +64,28 @@ See COMPILING.md
 
 ## API Documentation
 
-There is no documentation yet, sorry.  We expect things to be stable enough to begin documentation
-for general use in late 2024.
+There is no documentation separate from the code comments and examples yet, sorry!  This will be
+more of a priority once the KiCad 9 release is stable.
 
 ## Examples
 
 Check out the repository for some example scripts that may serve as a starting point.
 
+## Release History
+
+### 0.1.1 (December 24, 2024)
+
+- Bump dependency versions to fix compilation with newer protoc
+
+### 0.1.0 (December 21, 2024)
+
+*Corresponding KiCad version: 9.0.0-rc1*
+
+First formal release of the new IPC-API version of this package.  Contains support for most of the
+KiCad API functionality that is currently exposed, which is focused around the PCB editor to enable
+a transition path from existing SWIG-based plugins.
+
+Caveats / Known Issues:
+
+- Compatibility limited to Python 3.9 ~ 3.12 due to `pynng` not yet being updated for 3.13
+

kicad_python-0.1.1/README.md

@@ -0,0 +1,65 @@
+# KiCad API Python Bindings
+
+`kicad-python` is the official Python bindings for the [KiCad](https://kicad.org) IPC API.  This
+library makes it possible to develop scripts and tools that interact with a running KiCad session.
+
+The KiCad IPC API can be considered in "public beta" state with the release of KiCad 9 (currently
+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).
+
+> Note: Version 0.0.2 and prior of this package are an obsolete earlier effort and are unrelated to
+> this codebase.
+
+## Requirements
+
+Using the IPC API requires a suitable version of KiCad (9.0 or higher) and requires that KiCad be
+running with the API server enabled in Preferences > Plugins.  This package also depends on the
+`protobuf` and `pynng` packages for communication with KiCad.
+
+> Note: Unlike the SWIG-based Python bindings, the IPC API requires communication with a running
+> instance of KiCad.  It is not possible to use `kicad-python` to manipulate KiCad design files
+> without KiCad running.
+
+## Contributing
+
+At the moment, these bindings are being developed in parallel with the IPC API itself, and
+development is being coordinated by the KiCad team (main point of contact: Jon Evans / @craftyjon).
+Expect rapid change and instability during this development period, and please do not send merge
+requests without discussing your idea for changes with the team ahead of time.
+
+Once the initial stable API is released (planned for KiCad 9.0 in February 2025), this Python
+library will also have its first stable release and be considered fully supported.  Until that
+time, please consider this a development preview.
+
+## Building
+
+See COMPILING.md
+
+## API Documentation
+
+There is no documentation separate from the code comments and examples yet, sorry!  This will be
+more of a priority once the KiCad 9 release is stable.
+
+## Examples
+
+Check out the repository for some example scripts that may serve as a starting point.
+
+## Release History
+
+### 0.1.1 (December 24, 2024)
+
+- Bump dependency versions to fix compilation with newer protoc
+
+### 0.1.0 (December 21, 2024)
+
+*Corresponding KiCad version: 9.0.0-rc1*
+
+First formal release of the new IPC-API version of this package.  Contains support for most of the
+KiCad API functionality that is currently exposed, which is focused around the PCB editor to enable
+a transition path from existing SWIG-based plugins.
+
+Caveats / Known Issues:
+
+- Compatibility limited to Python 3.9 ~ 3.12 due to `pynng` not yet being updated for 3.13

{kicad_python-0.1.0a1 → kicad_python-0.1.1/build/lib}/kipy/kicad.py

@@ -48,6 +48,43 @@ def default_kicad_token() -> str:
         return token
     return ""
 
+class KiCadVersion:
+    def __init__(self, major: int, minor: int, patch: int, full_version: str):
+        self.major = major
+        self.minor = minor
+        self.patch = patch
+        self.full_version = full_version
+
+    @staticmethod
+    def from_proto(proto: base_types_pb2.KiCadVersion) -> 'KiCadVersion':
+        return KiCadVersion(proto.major, proto.minor, proto.patch, proto.full_version)
+
+    def __str__(self):
+        return self.full_version
+
+    def __eq__(self, other):
+        if not isinstance(other, KiCadVersion):
+            return NotImplemented
+
+        return (
+            (self.major, self.minor, self.patch) == (other.major, other.minor, other.patch)
+            and (self.full_version == other.full_version)
+            )
+
+    def __lt__(self, other):
+        if not isinstance(other, KiCadVersion):
+            return NotImplemented
+        return (self.major, self.minor, self.patch) < (other.major, other.minor, other.patch)
+
+    def __le__(self, other):
+        return self == other or self < other
+
+    def __gt__(self, other):
+        return not self <= other
+
+    def __ge__(self, other):
+        return not self < other
+
 class KiCad:
     def __init__(self, socket_path: str=default_socket_path(),
                  client_name: str=random_client_name(),
@@ -74,10 +111,10 @@ class KiCad:
         k._client = client
         return k
 
-    def get_version(self):
+    def get_version(self) -> KiCadVersion:
         """Returns the KiCad version as a string, including any package-specific info"""
         response = self._client.send(commands.GetVersion(), commands.GetVersionResponse)
-        return response.version.full_version
+        return KiCadVersion.from_proto(response.version)
 
     def ping(self):
         self._client.send(commands.Ping(), Empty)

{kicad_python-0.1.0a1 → kicad_python-0.1.1/build/lib}/kipy/proto/board/board_commands_pb2.py

@@ -1,8 +1,10 @@
 """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
@@ -12,8 +14,8 @@ DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1aboard/board_co
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'board.board_commands_pb2', _globals)
-if _descriptor._USE_C_DESCRIPTORS == False:
-    DESCRIPTOR._options = None
+if not _descriptor._USE_C_DESCRIPTORS:
+    DESCRIPTOR._loaded_options = None
     _globals['_GETBOARDSTACKUP']._serialized_start = 153
     _globals['_GETBOARDSTACKUP']._serialized_end = 224
     _globals['_BOARDSTACKUPRESPONSE']._serialized_start = 226

{kicad_python-0.1.0a1 → kicad_python-0.1.1/build/lib}/kipy/proto/board/board_commands_pb2.pyi

@@ -27,10 +27,14 @@ from .. import common
 import google.protobuf.descriptor
 import google.protobuf.internal.containers
 import google.protobuf.message
-import typing
+import sys
+if sys.version_info >= (3, 8):
+    import typing as typing_extensions
+else:
+    import typing_extensions
 DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
 
-@typing.final
+@typing_extensions.final
 class GetBoardStackup(google.protobuf.message.Message):
     """
     Board stackup and properties
@@ -45,14 +49,14 @@ class GetBoardStackup(google.protobuf.message.Message):
     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 HasField(self, field_name: typing_extensions.Literal['board', b'board']) -> builtins.bool:
         ...
 
-    def ClearField(self, field_name: typing.Literal['board', b'board']) -> None:
+    def ClearField(self, field_name: typing_extensions.Literal['board', b'board']) -> None:
         ...
 global___GetBoardStackup = GetBoardStackup
 
-@typing.final
+@typing_extensions.final
 class BoardStackupResponse(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
     STACKUP_FIELD_NUMBER: builtins.int
@@ -64,14 +68,14 @@ class BoardStackupResponse(google.protobuf.message.Message):
     def __init__(self, *, stackup: board.board_pb2.BoardStackup | None=...) -> None:
         ...
 
-    def HasField(self, field_name: typing.Literal['stackup', b'stackup']) -> builtins.bool:
+    def HasField(self, field_name: typing_extensions.Literal['stackup', b'stackup']) -> builtins.bool:
         ...
 
-    def ClearField(self, field_name: typing.Literal['stackup', b'stackup']) -> None:
+    def ClearField(self, field_name: typing_extensions.Literal['stackup', b'stackup']) -> None:
         ...
 global___BoardStackupResponse = BoardStackupResponse
 
-@typing.final
+@typing_extensions.final
 class UpdateBoardStackup(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
     BOARD_FIELD_NUMBER: builtins.int
@@ -88,14 +92,14 @@ class UpdateBoardStackup(google.protobuf.message.Message):
     def __init__(self, *, board: common.types.base_types_pb2.DocumentSpecifier | None=..., stackup: board.board_pb2.BoardStackup | None=...) -> None:
         ...
 
-    def HasField(self, field_name: typing.Literal['board', b'board', 'stackup', b'stackup']) -> builtins.bool:
+    def HasField(self, field_name: typing_extensions.Literal['board', b'board', 'stackup', b'stackup']) -> builtins.bool:
         ...
 
-    def ClearField(self, field_name: typing.Literal['board', b'board', 'stackup', b'stackup']) -> None:
+    def ClearField(self, field_name: typing_extensions.Literal['board', b'board', 'stackup', b'stackup']) -> None:
         ...
 global___UpdateBoardStackup = UpdateBoardStackup
 
-@typing.final
+@typing_extensions.final
 class GetGraphicsDefaults(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
     BOARD_FIELD_NUMBER: builtins.int
@@ -107,14 +111,14 @@ class GetGraphicsDefaults(google.protobuf.message.Message):
     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 HasField(self, field_name: typing_extensions.Literal['board', b'board']) -> builtins.bool:
         ...
 
-    def ClearField(self, field_name: typing.Literal['board', b'board']) -> None:
+    def ClearField(self, field_name: typing_extensions.Literal['board', b'board']) -> None:
         ...
 global___GetGraphicsDefaults = GetGraphicsDefaults
 
-@typing.final
+@typing_extensions.final
 class GraphicsDefaultsResponse(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
     DEFAULTS_FIELD_NUMBER: builtins.int
@@ -126,14 +130,14 @@ class GraphicsDefaultsResponse(google.protobuf.message.Message):
     def __init__(self, *, defaults: board.board_pb2.GraphicsDefaults | None=...) -> None:
         ...
 
-    def HasField(self, field_name: typing.Literal['defaults', b'defaults']) -> builtins.bool:
+    def HasField(self, field_name: typing_extensions.Literal['defaults', b'defaults']) -> builtins.bool:
         ...
 
-    def ClearField(self, field_name: typing.Literal['defaults', b'defaults']) -> None:
+    def ClearField(self, field_name: typing_extensions.Literal['defaults', b'defaults']) -> None:
         ...
 global___GraphicsDefaultsResponse = GraphicsDefaultsResponse
 
-@typing.final
+@typing_extensions.final
 class GetNets(google.protobuf.message.Message):
     """
     Net management
@@ -156,14 +160,14 @@ class GetNets(google.protobuf.message.Message):
     def __init__(self, *, board: common.types.base_types_pb2.DocumentSpecifier | None=..., netclass_filter: collections.abc.Iterable[builtins.str] | None=...) -> None:
         ...
 
-    def HasField(self, field_name: typing.Literal['board', b'board']) -> builtins.bool:
+    def HasField(self, field_name: typing_extensions.Literal['board', b'board']) -> builtins.bool:
         ...
 
-    def ClearField(self, field_name: typing.Literal['board', b'board', 'netclass_filter', b'netclass_filter']) -> None:
+    def ClearField(self, field_name: typing_extensions.Literal['board', b'board', 'netclass_filter', b'netclass_filter']) -> None:
         ...
 global___GetNets = GetNets
 
-@typing.final
+@typing_extensions.final
 class NetsResponse(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
     NETS_FIELD_NUMBER: builtins.int
@@ -175,11 +179,11 @@ class NetsResponse(google.protobuf.message.Message):
     def __init__(self, *, nets: collections.abc.Iterable[board.board_types_pb2.Net] | None=...) -> None:
         ...
 
-    def ClearField(self, field_name: typing.Literal['nets', b'nets']) -> None:
+    def ClearField(self, field_name: typing_extensions.Literal['nets', b'nets']) -> None:
         ...
 global___NetsResponse = NetsResponse
 
-@typing.final
+@typing_extensions.final
 class GetItemsByNet(google.protobuf.message.Message):
     """Retrieve all the copper items belonging to a certain net or set of nets
     returns kiapi.common.commands.GetItemsResponse
@@ -204,14 +208,14 @@ class GetItemsByNet(google.protobuf.message.Message):
     def __init__(self, *, header: common.types.base_types_pb2.ItemHeader | None=..., types: collections.abc.Iterable[common.types.enums_pb2.KiCadObjectType.ValueType] | None=..., net_codes: collections.abc.Iterable[board.board_types_pb2.NetCode] | None=...) -> None:
         ...
 
-    def HasField(self, field_name: typing.Literal['header', b'header']) -> builtins.bool:
+    def HasField(self, field_name: typing_extensions.Literal['header', b'header']) -> builtins.bool:
         ...
 
-    def ClearField(self, field_name: typing.Literal['header', b'header', 'net_codes', b'net_codes', 'types', b'types']) -> None:
+    def ClearField(self, field_name: typing_extensions.Literal['header', b'header', 'net_codes', b'net_codes', 'types', b'types']) -> None:
         ...
 global___GetItemsByNet = GetItemsByNet
 
-@typing.final
+@typing_extensions.final
 class GetItemsByNetClass(google.protobuf.message.Message):
     """Retrieve all the copper items belonging to a certain net class or set of net classes
     returns kiapi.common.commands.GetItemsResponse
@@ -236,14 +240,14 @@ class GetItemsByNetClass(google.protobuf.message.Message):
     def __init__(self, *, header: common.types.base_types_pb2.ItemHeader | None=..., types: collections.abc.Iterable[common.types.enums_pb2.KiCadObjectType.ValueType] | None=..., net_classes: collections.abc.Iterable[builtins.str] | None=...) -> None:
         ...
 
-    def HasField(self, field_name: typing.Literal['header', b'header']) -> builtins.bool:
+    def HasField(self, field_name: typing_extensions.Literal['header', b'header']) -> builtins.bool:
         ...
 
-    def ClearField(self, field_name: typing.Literal['header', b'header', 'net_classes', b'net_classes', 'types', b'types']) -> None:
+    def ClearField(self, field_name: typing_extensions.Literal['header', b'header', 'net_classes', b'net_classes', 'types', b'types']) -> None:
         ...
 global___GetItemsByNetClass = GetItemsByNetClass
 
-@typing.final
+@typing_extensions.final
 class RefillZones(google.protobuf.message.Message):
     """
     Blocking operations
@@ -267,14 +271,14 @@ class RefillZones(google.protobuf.message.Message):
     def __init__(self, *, board: common.types.base_types_pb2.DocumentSpecifier | None=..., zones: collections.abc.Iterable[common.types.base_types_pb2.KIID] | None=...) -> None:
         ...
 
-    def HasField(self, field_name: typing.Literal['board', b'board']) -> builtins.bool:
+    def HasField(self, field_name: typing_extensions.Literal['board', b'board']) -> builtins.bool:
         ...
 
-    def ClearField(self, field_name: typing.Literal['board', b'board', 'zones', b'zones']) -> None:
+    def ClearField(self, field_name: typing_extensions.Literal['board', b'board', 'zones', b'zones']) -> None:
         ...
 global___RefillZones = RefillZones
 
-@typing.final
+@typing_extensions.final
 class GetPadShapeAsPolygon(google.protobuf.message.Message):
     """
     Utilities
@@ -286,8 +290,6 @@ class GetPadShapeAsPolygon(google.protobuf.message.Message):
     BOARD_FIELD_NUMBER: builtins.int
     PADS_FIELD_NUMBER: builtins.int
     LAYER_FIELD_NUMBER: builtins.int
-    layer: board.board_types_pb2.BoardLayer.ValueType
-    'The layer to process'
 
     @property
     def board(self) -> common.types.base_types_pb2.DocumentSpecifier:
@@ -296,18 +298,20 @@ class GetPadShapeAsPolygon(google.protobuf.message.Message):
     @property
     def pads(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[common.types.base_types_pb2.KIID]:
         """A list of one or more pads to process"""
+    layer: board.board_types_pb2.BoardLayer.ValueType
+    'The layer to process'
 
     def __init__(self, *, board: common.types.base_types_pb2.DocumentSpecifier | None=..., pads: collections.abc.Iterable[common.types.base_types_pb2.KIID] | None=..., layer: board.board_types_pb2.BoardLayer.ValueType=...) -> None:
         ...
 
-    def HasField(self, field_name: typing.Literal['board', b'board']) -> builtins.bool:
+    def HasField(self, field_name: typing_extensions.Literal['board', b'board']) -> builtins.bool:
         ...
 
-    def ClearField(self, field_name: typing.Literal['board', b'board', 'layer', b'layer', 'pads', b'pads']) -> None:
+    def ClearField(self, field_name: typing_extensions.Literal['board', b'board', 'layer', b'layer', 'pads', b'pads']) -> None:
         ...
 global___GetPadShapeAsPolygon = GetPadShapeAsPolygon
 
-@typing.final
+@typing_extensions.final
 class PadShapeAsPolygonResponse(google.protobuf.message.Message):
     """Returned from GetPadShapeAsPolygon.  The pads and polygons repeated fields will have the same length
     and can be treated as a list of tuples.
@@ -327,11 +331,11 @@ class PadShapeAsPolygonResponse(google.protobuf.message.Message):
     def __init__(self, *, pads: collections.abc.Iterable[common.types.base_types_pb2.KIID] | None=..., polygons: collections.abc.Iterable[common.types.base_types_pb2.PolygonWithHoles] | None=...) -> None:
         ...
 
-    def ClearField(self, field_name: typing.Literal['pads', b'pads', 'polygons', b'polygons']) -> None:
+    def ClearField(self, field_name: typing_extensions.Literal['pads', b'pads', 'polygons', b'polygons']) -> None:
         ...
 global___PadShapeAsPolygonResponse = PadShapeAsPolygonResponse
 
-@typing.final
+@typing_extensions.final
 class GetVisibleLayers(google.protobuf.message.Message):
     """PCB editor commands
 
@@ -347,14 +351,14 @@ class GetVisibleLayers(google.protobuf.message.Message):
     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 HasField(self, field_name: typing_extensions.Literal['board', b'board']) -> builtins.bool:
         ...
 
-    def ClearField(self, field_name: typing.Literal['board', b'board']) -> None:
+    def ClearField(self, field_name: typing_extensions.Literal['board', b'board']) -> None:
         ...
 global___GetVisibleLayers = GetVisibleLayers
 
-@typing.final
+@typing_extensions.final
 class BoardLayerResponse(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
     LAYER_FIELD_NUMBER: builtins.int
@@ -363,11 +367,11 @@ class BoardLayerResponse(google.protobuf.message.Message):
     def __init__(self, *, layer: board.board_types_pb2.BoardLayer.ValueType=...) -> None:
         ...
 
-    def ClearField(self, field_name: typing.Literal['layer', b'layer']) -> None:
+    def ClearField(self, field_name: typing_extensions.Literal['layer', b'layer']) -> None:
         ...
 global___BoardLayerResponse = BoardLayerResponse
 
-@typing.final
+@typing_extensions.final
 class BoardLayers(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
     LAYERS_FIELD_NUMBER: builtins.int
@@ -379,11 +383,11 @@ class BoardLayers(google.protobuf.message.Message):
     def __init__(self, *, layers: collections.abc.Iterable[board.board_types_pb2.BoardLayer.ValueType] | None=...) -> None:
         ...
 
-    def ClearField(self, field_name: typing.Literal['layers', b'layers']) -> None:
+    def ClearField(self, field_name: typing_extensions.Literal['layers', b'layers']) -> None:
         ...
 global___BoardLayers = BoardLayers
 
-@typing.final
+@typing_extensions.final
 class SetVisibleLayers(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
     BOARD_FIELD_NUMBER: builtins.int
@@ -400,14 +404,14 @@ class SetVisibleLayers(google.protobuf.message.Message):
     def __init__(self, *, board: common.types.base_types_pb2.DocumentSpecifier | None=..., 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 HasField(self, field_name: typing_extensions.Literal['board', b'board']) -> builtins.bool:
         ...
 
-    def ClearField(self, field_name: typing.Literal['board', b'board', 'layers', b'layers']) -> None:
+    def ClearField(self, field_name: typing_extensions.Literal['board', b'board', 'layers', b'layers']) -> None:
         ...
 global___SetVisibleLayers = SetVisibleLayers
 
-@typing.final
+@typing_extensions.final
 class GetActiveLayer(google.protobuf.message.Message):
     """returns BoardLayerResponse"""
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
@@ -420,35 +424,35 @@ class GetActiveLayer(google.protobuf.message.Message):
     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 HasField(self, field_name: typing_extensions.Literal['board', b'board']) -> builtins.bool:
         ...
 
-    def ClearField(self, field_name: typing.Literal['board', b'board']) -> None:
+    def ClearField(self, field_name: typing_extensions.Literal['board', b'board']) -> None:
         ...
 global___GetActiveLayer = GetActiveLayer
 
-@typing.final
+@typing_extensions.final
 class SetActiveLayer(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:
         ...
+    layer: board.board_types_pb2.BoardLayer.ValueType
 
     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 HasField(self, field_name: typing_extensions.Literal['board', b'board']) -> builtins.bool:
         ...
 
-    def ClearField(self, field_name: typing.Literal['board', b'board', 'layer', b'layer']) -> None:
+    def ClearField(self, field_name: typing_extensions.Literal['board', b'board', 'layer', b'layer']) -> None:
         ...
 global___SetActiveLayer = SetActiveLayer
 
-@typing.final
+@typing_extensions.final
 class InteractiveMoveItems(google.protobuf.message.Message):
     """// Interactive commands ////
     These commands begin an interactive operation in the editor.
@@ -479,9 +483,9 @@ class InteractiveMoveItems(google.protobuf.message.Message):
     def __init__(self, *, board: common.types.base_types_pb2.DocumentSpecifier | None=..., items: collections.abc.Iterable[common.types.base_types_pb2.KIID] | None=...) -> None:
         ...
 
-    def HasField(self, field_name: typing.Literal['board', b'board']) -> builtins.bool:
+    def HasField(self, field_name: typing_extensions.Literal['board', b'board']) -> builtins.bool:
         ...
 
-    def ClearField(self, field_name: typing.Literal['board', b'board', 'items', b'items']) -> None:
+    def ClearField(self, field_name: typing_extensions.Literal['board', b'board', 'items', b'items']) -> None:
         ...
 global___InteractiveMoveItems = InteractiveMoveItems

{kicad_python-0.1.0a1 → kicad_python-0.1.1/build/lib}/kipy/proto/board/board_pb2.py

@@ -1,8 +1,10 @@
 """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.proto')
 _sym_db = _symbol_database.Default()
 from ..common.types import base_types_pb2 as common_dot_types_dot_base__types__pb2
 from ..board import board_types_pb2 as board_dot_board__types__pb2
@@ -10,8 +12,8 @@ DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x11board/board.pr
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'board.board_pb2', _globals)
-if _descriptor._USE_C_DESCRIPTORS == False:
-    DESCRIPTOR._options = None
+if not _descriptor._USE_C_DESCRIPTORS:
+    DESCRIPTOR._loaded_options = None
     _globals['_BOARDLAYERCLASS']._serialized_start = 1233
     _globals['_BOARDLAYERCLASS']._serialized_end = 1373
     _globals['_BOARDFINISH']._serialized_start = 90