kicad-python 0.1.0a0__py3-none-any.whl

kipy/proto/common/types/project_settings_pb2.py

@@ -0,0 +1,15 @@
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+_sym_db = _symbol_database.Default()
+from ...common.types import base_types_pb2 as common_dot_types_dot_base__types__pb2
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n#common/types/project_settings.proto\x12\x14kiapi.common.project\x1a\x1dcommon/types/base_types.proto"\x18\n\x08NetClass\x12\x0c\n\x04name\x18\x01 \x01(\tb\x06proto3')
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'common.types.project_settings_pb2', _globals)
+if _descriptor._USE_C_DESCRIPTORS == False:
+    DESCRIPTOR._options = None
+    _globals['_NETCLASS']._serialized_start = 92
+    _globals['_NETCLASS']._serialized_end = 116

kipy/proto/common/types/project_settings_pb2.pyi

@@ -0,0 +1,30 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+
+project_settings.proto
+Messages that describes project settings shared between schematics and boards
+"""
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.message
+import sys
+if sys.version_info >= (3, 8):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing_extensions.final
+class NetClass(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    NAME_FIELD_NUMBER: builtins.int
+    name: builtins.str
+    'The name of the netclass (the literal string "Default" for the default netclass)'
+
+    def __init__(self, *, name: builtins.str=...) -> None:
+        ...
+
+    def ClearField(self, field_name: typing_extensions.Literal['name', b'name']) -> None:
+        ...
+global___NetClass = NetClass

kipy/proto/schematic/schematic_commands_pb2.py

@@ -0,0 +1,13 @@
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+_sym_db = _symbol_database.Default()
+from ..common.types import base_types_pb2 as common_dot_types_dot_base__types__pb2
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n"schematic/schematic_commands.proto\x12\x15kiapi.schematic.types\x1a\x1dcommon/types/base_types.protob\x06proto3')
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'schematic.schematic_commands_pb2', _globals)
+if _descriptor._USE_C_DESCRIPTORS == False:
+    DESCRIPTOR._options = None

kipy/proto/schematic/schematic_commands_pb2.pyi

@@ -0,0 +1,23 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+
+This program source code file is part of KiCad, a free EDA CAD application.
+
+Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
+
+This program is free software: you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation, either version 3 of the License, or (at your
+option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
+import google.protobuf.descriptor
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

kipy/proto/schematic/schematic_types_pb2.py

@@ -0,0 +1,25 @@
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+_sym_db = _symbol_database.Default()
+from ..common.types import base_types_pb2 as common_dot_types_dot_base__types__pb2
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1fschematic/schematic_types.proto\x12\x15kiapi.schematic.types\x1a\x1dcommon/types/base_types.proto"\xac\x01\n\x04Line\x12$\n\x02id\x18\x01 \x01(\x0b2\x18.kiapi.common.types.KIID\x12*\n\x05start\x18\x02 \x01(\x0b2\x1b.kiapi.common.types.Vector2\x12(\n\x03end\x18\x03 \x01(\x0b2\x1b.kiapi.common.types.Vector2\x12(\n\x05layer\x18\x04 \x01(\x0b2\x19.kiapi.common.types.Layer".\n\x04Text\x12&\n\x04text\x18\x01 \x01(\x0b2\x18.kiapi.common.types.Text"\x8c\x01\n\nLocalLabel\x12$\n\x02id\x18\x01 \x01(\x0b2\x18.kiapi.common.types.KIID\x12-\n\x08position\x18\x02 \x01(\x0b2\x1b.kiapi.common.types.Vector2\x12)\n\x04text\x18\x03 \x01(\x0b2\x1b.kiapi.schematic.types.Text"\x8d\x01\n\x0bGlobalLabel\x12$\n\x02id\x18\x01 \x01(\x0b2\x18.kiapi.common.types.KIID\x12-\n\x08position\x18\x02 \x01(\x0b2\x1b.kiapi.common.types.Vector2\x12)\n\x04text\x18\x03 \x01(\x0b2\x1b.kiapi.schematic.types.Text"\x93\x01\n\x11HierarchicalLabel\x12$\n\x02id\x18\x01 \x01(\x0b2\x18.kiapi.common.types.KIID\x12-\n\x08position\x18\x02 \x01(\x0b2\x1b.kiapi.common.types.Vector2\x12)\n\x04text\x18\x03 \x01(\x0b2\x1b.kiapi.schematic.types.Text"\x90\x01\n\x0eDirectiveLabel\x12$\n\x02id\x18\x01 \x01(\x0b2\x18.kiapi.common.types.KIID\x12-\n\x08position\x18\x02 \x01(\x0b2\x1b.kiapi.common.types.Vector2\x12)\n\x04text\x18\x03 \x01(\x0b2\x1b.kiapi.schematic.types.Textb\x06proto3')
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'schematic.schematic_types_pb2', _globals)
+if _descriptor._USE_C_DESCRIPTORS == False:
+    DESCRIPTOR._options = None
+    _globals['_LINE']._serialized_start = 90
+    _globals['_LINE']._serialized_end = 262
+    _globals['_TEXT']._serialized_start = 264
+    _globals['_TEXT']._serialized_end = 310
+    _globals['_LOCALLABEL']._serialized_start = 313
+    _globals['_LOCALLABEL']._serialized_end = 453
+    _globals['_GLOBALLABEL']._serialized_start = 456
+    _globals['_GLOBALLABEL']._serialized_end = 597
+    _globals['_HIERARCHICALLABEL']._serialized_start = 600
+    _globals['_HIERARCHICALLABEL']._serialized_end = 747
+    _globals['_DIRECTIVELABEL']._serialized_start = 750
+    _globals['_DIRECTIVELABEL']._serialized_end = 894

kipy/proto/schematic/schematic_types_pb2.pyi

@@ -0,0 +1,203 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+
+This program source code file is part of KiCad, a free EDA CAD application.
+
+Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
+
+This program is free software: you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation, either version 3 of the License, or (at your
+option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
+import builtins
+from .. import common
+import google.protobuf.descriptor
+import google.protobuf.message
+import sys
+if sys.version_info >= (3, 8):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing_extensions.final
+class Line(google.protobuf.message.Message):
+    """/ Represents a schematic line segment, which may be a wire, bus, or graphical line"""
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    ID_FIELD_NUMBER: builtins.int
+    START_FIELD_NUMBER: builtins.int
+    END_FIELD_NUMBER: builtins.int
+    LAYER_FIELD_NUMBER: builtins.int
+
+    @property
+    def id(self) -> common.types.base_types_pb2.KIID:
+        ...
+
+    @property
+    def start(self) -> common.types.base_types_pb2.Vector2:
+        ...
+
+    @property
+    def end(self) -> common.types.base_types_pb2.Vector2:
+        ...
+
+    @property
+    def layer(self) -> common.types.base_types_pb2.Layer:
+        """*
+        One of: LAYER_BUS, LAYER_WIRE, LAYER_NOTES
+        """
+
+    def __init__(self, *, id: common.types.base_types_pb2.KIID | None=..., start: common.types.base_types_pb2.Vector2 | None=..., end: common.types.base_types_pb2.Vector2 | None=..., layer: common.types.base_types_pb2.Layer | None=...) -> None:
+        ...
+
+    def HasField(self, field_name: typing_extensions.Literal['end', b'end', 'id', b'id', 'layer', b'layer', 'start', b'start']) -> builtins.bool:
+        ...
+
+    def ClearField(self, field_name: typing_extensions.Literal['end', b'end', 'id', b'id', 'layer', b'layer', 'start', b'start']) -> None:
+        ...
+global___Line = Line
+
+@typing_extensions.final
+class Text(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    TEXT_FIELD_NUMBER: builtins.int
+
+    @property
+    def text(self) -> common.types.base_types_pb2.Text:
+        ...
+
+    def __init__(self, *, text: common.types.base_types_pb2.Text | None=...) -> None:
+        ...
+
+    def HasField(self, field_name: typing_extensions.Literal['text', b'text']) -> builtins.bool:
+        ...
+
+    def ClearField(self, field_name: typing_extensions.Literal['text', b'text']) -> None:
+        ...
+global___Text = Text
+
+@typing_extensions.final
+class LocalLabel(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    ID_FIELD_NUMBER: builtins.int
+    POSITION_FIELD_NUMBER: builtins.int
+    TEXT_FIELD_NUMBER: builtins.int
+
+    @property
+    def id(self) -> common.types.base_types_pb2.KIID:
+        ...
+
+    @property
+    def position(self) -> common.types.base_types_pb2.Vector2:
+        ...
+
+    @property
+    def text(self) -> global___Text:
+        ...
+
+    def __init__(self, *, id: common.types.base_types_pb2.KIID | None=..., position: common.types.base_types_pb2.Vector2 | None=..., text: global___Text | None=...) -> None:
+        ...
+
+    def HasField(self, field_name: typing_extensions.Literal['id', b'id', 'position', b'position', 'text', b'text']) -> builtins.bool:
+        ...
+
+    def ClearField(self, field_name: typing_extensions.Literal['id', b'id', 'position', b'position', 'text', b'text']) -> None:
+        ...
+global___LocalLabel = LocalLabel
+
+@typing_extensions.final
+class GlobalLabel(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    ID_FIELD_NUMBER: builtins.int
+    POSITION_FIELD_NUMBER: builtins.int
+    TEXT_FIELD_NUMBER: builtins.int
+
+    @property
+    def id(self) -> common.types.base_types_pb2.KIID:
+        ...
+
+    @property
+    def position(self) -> common.types.base_types_pb2.Vector2:
+        ...
+
+    @property
+    def text(self) -> global___Text:
+        ...
+
+    def __init__(self, *, id: common.types.base_types_pb2.KIID | None=..., position: common.types.base_types_pb2.Vector2 | None=..., text: global___Text | None=...) -> None:
+        ...
+
+    def HasField(self, field_name: typing_extensions.Literal['id', b'id', 'position', b'position', 'text', b'text']) -> builtins.bool:
+        ...
+
+    def ClearField(self, field_name: typing_extensions.Literal['id', b'id', 'position', b'position', 'text', b'text']) -> None:
+        ...
+global___GlobalLabel = GlobalLabel
+
+@typing_extensions.final
+class HierarchicalLabel(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    ID_FIELD_NUMBER: builtins.int
+    POSITION_FIELD_NUMBER: builtins.int
+    TEXT_FIELD_NUMBER: builtins.int
+
+    @property
+    def id(self) -> common.types.base_types_pb2.KIID:
+        ...
+
+    @property
+    def position(self) -> common.types.base_types_pb2.Vector2:
+        ...
+
+    @property
+    def text(self) -> global___Text:
+        ...
+
+    def __init__(self, *, id: common.types.base_types_pb2.KIID | None=..., position: common.types.base_types_pb2.Vector2 | None=..., text: global___Text | None=...) -> None:
+        ...
+
+    def HasField(self, field_name: typing_extensions.Literal['id', b'id', 'position', b'position', 'text', b'text']) -> builtins.bool:
+        ...
+
+    def ClearField(self, field_name: typing_extensions.Literal['id', b'id', 'position', b'position', 'text', b'text']) -> None:
+        ...
+global___HierarchicalLabel = HierarchicalLabel
+
+@typing_extensions.final
+class DirectiveLabel(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    ID_FIELD_NUMBER: builtins.int
+    POSITION_FIELD_NUMBER: builtins.int
+    TEXT_FIELD_NUMBER: builtins.int
+
+    @property
+    def id(self) -> common.types.base_types_pb2.KIID:
+        ...
+
+    @property
+    def position(self) -> common.types.base_types_pb2.Vector2:
+        ...
+
+    @property
+    def text(self) -> global___Text:
+        ...
+
+    def __init__(self, *, id: common.types.base_types_pb2.KIID | None=..., position: common.types.base_types_pb2.Vector2 | None=..., text: global___Text | None=...) -> None:
+        ...
+
+    def HasField(self, field_name: typing_extensions.Literal['id', b'id', 'position', b'position', 'text', b'text']) -> builtins.bool:
+        ...
+
+    def ClearField(self, field_name: typing_extensions.Literal['id', b'id', 'position', b'position', 'text', b'text']) -> None:
+        ...
+global___DirectiveLabel = DirectiveLabel

kipy/util/__init__.py

@@ -0,0 +1,21 @@
+# This program source code file is part of KiCad, a free EDA CAD application.
+#
+# Copyright (C) 2024 KiCad Developers
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# flake8: noqa
+
+from .units import from_mm, to_mm
+from .proto import pack_any, unpack_any, make_item_type

kipy/util/proto.py

@@ -0,0 +1,61 @@
+# This program source code file is part of KiCad, a free EDA CAD application.
+#
+# Copyright (C) 2024 KiCad Developers
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+from google.protobuf.any_pb2 import Any
+from google.protobuf.message import Message
+
+from kipy.enums import KICAD_T
+from kipy.proto.common.types import ItemType
+from kipy.proto.board import board_types_pb2
+
+def pack_any(object: Message) -> Any:
+    a = Any()
+    a.Pack(object)
+    return a
+
+_any_urls = {
+    "type.googleapis.com/kiapi.board.types.Track": board_types_pb2.Track,
+    "type.googleapis.com/kiapi.board.types.Arc": board_types_pb2.Arc,
+    "type.googleapis.com/kiapi.board.types.Via": board_types_pb2.Via,
+    "type.googleapis.com/kiapi.board.types.Text": board_types_pb2.Text,
+    #"type.googleapis.com/kiapi.board.types.TextBox": board_types_pb2.TextBox,
+    "type.googleapis.com/kiapi.board.types.GraphicShape": board_types_pb2.GraphicShape,
+    "type.googleapis.com/kiapi.board.types.Pad": board_types_pb2.Pad,
+    "type.googleapis.com/kiapi.board.types.Zone": board_types_pb2.Zone,
+    "type.googleapis.com/kiapi.board.types.Dimension": board_types_pb2.Dimension,
+    "type.googleapis.com/kiapi.board.types.ReferenceImage": board_types_pb2.ReferenceImage,
+    "type.googleapis.com/kiapi.board.types.Group": board_types_pb2.Group,
+    "type.googleapis.com/kiapi.board.types.Field": board_types_pb2.Field,
+    "type.googleapis.com/kiapi.board.types.FootprintInstance": board_types_pb2.FootprintInstance
+}
+
+def unpack_any(object: Any) -> Message:
+    if len(object.type_url) == 0:
+        raise ValueError("Can't unpack empty Any protobuf message")
+    
+    type = _any_urls.get(object.type_url, None)
+    if type is None:
+        raise NotImplementedError(f"{object.type_url} can't be unpacked")
+  
+    concrete = type()
+    object.Unpack(concrete)
+    return concrete
+    
+def make_item_type(type: KICAD_T) -> ItemType:
+    t = ItemType()
+    t.type = type.value
+    return t

kipy/util/units.py

@@ -0,0 +1,31 @@
+# This program source code file is part of KiCad, a free EDA CAD application.
+#
+# Copyright (C) 2024 KiCad Developers
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+def from_mm(value_mm: float) -> int:
+    """
+    KiCad uses several internal unit systems, but for the IPC API, all distance units are defined as
+    64-bit nanometers
+    :param value_mm: a quantity in millimeters
+    :return: the quantity in KiCad API units
+    """
+    return int(value_mm * 1_000_000)
+
+def to_mm(value_nm: int) -> float:
+    """
+    Converts a KiCad API length/distance value (in nanometers) to millimeters
+    """
+    return float(value_nm) / 1_000_000

kipy/wrapper.py

@@ -0,0 +1,23 @@
+# This program source code file is part of KiCad, a free EDA CAD application.
+#
+# Copyright (C) 2024 KiCad Developers
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+from abc import ABC
+
+class Wrapper(ABC):
+    @property
+    def proto(self):
+        return self.__dict__['_proto']