[Schematic][Added] Support for private fields

Closes #812

Author: set-soft

CHANGELOG.md

@@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 ## [1.8.5] - UNRELEASED
+### Added
+- Schematic: Support for private fields (#812)
+
 ### Fixed
 - User.N layer numbering. I.e. pcb_print issues with their numbering (#808)
 

docs/source/Changelog.rst

@@ -16,6 +16,11 @@ Versioning <https://semver.org/spec/v2.0.0.html>`__.
 [1.8.5] - UNRELEASED
 --------------------
 
+Added
+~~~~~
+
+-  Schematic: Support for private fields (#812)
+
 Fixed
 ~~~~~
 
@@ -25,6 +30,8 @@ Fixed
 [1.8.4] - 2025-04-03
 --------------------
 
+.. _added-1:
+
 Added
 ~~~~~
 
@@ -59,7 +66,7 @@ Fixed
 [1.8.3] - 2025-03-18
 --------------------
 
-.. _added-1:
+.. _added-2:
 
 Added
 ~~~~~
@@ -271,7 +278,7 @@ Changed
 [1.8.2] - 2024-10-28
 --------------------
 
-.. _added-2:
+.. _added-3:
 
 Added
 ~~~~~
@@ -372,7 +379,7 @@ Fixed
 [1.8.0] - 2024-09-17
 --------------------
 
-.. _added-3:
+.. _added-4:
 
 Added
 ~~~~~
@@ -521,7 +528,7 @@ Changed:
 [1.7.0] - 2024-04-23
 --------------------
 
-.. _added-4:
+.. _added-5:
 
 Added
 ~~~~~
@@ -626,7 +633,7 @@ Changed
 [1.6.5] - 2024-03-31
 --------------------
 
-.. _added-5:
+.. _added-6:
 
 Added
 ~~~~~
@@ -686,7 +693,7 @@ Fixed
 [1.6.4] - 2024-02-02
 --------------------
 
-.. _added-6:
+.. _added-7:
 
 Added
 ~~~~~
@@ -967,7 +974,7 @@ Fixed
 [1.6.3] - 2023-06-26
 --------------------
 
-.. _added-7:
+.. _added-8:
 
 Added
 ~~~~~
@@ -1137,7 +1144,7 @@ Fixed
 [1.6.2] - 2023-04-24
 --------------------
 
-.. _added-8:
+.. _added-9:
 
 Added
 ~~~~~
@@ -1255,7 +1262,7 @@ Changed:
 [1.6.1] - 2023-03-16
 --------------------
 
-.. _added-9:
+.. _added-10:
 
 Added
 ~~~~~
@@ -1304,7 +1311,7 @@ Fixed
 [1.6.0] - 2023-02-06
 --------------------
 
-.. _added-10:
+.. _added-11:
 
 Added
 ~~~~~
@@ -1435,7 +1442,7 @@ Fixed
 [1.5.0] - 2022-12-16
 --------------------
 
-.. _added-11:
+.. _added-12:
 
 Added
 ~~~~~
@@ -1549,7 +1556,7 @@ Fixed
 [1.4.0] - 2022-10-12
 --------------------
 
-.. _added-12:
+.. _added-13:
 
 Added
 ~~~~~
@@ -1667,7 +1674,7 @@ Changed
 [1.3.0] - 2022-09-08
 --------------------
 
-.. _added-13:
+.. _added-14:
 
 Added
 ~~~~~
@@ -1767,7 +1774,7 @@ Changed
 [1.2.0] - 2022-06-15
 --------------------
 
-.. _added-14:
+.. _added-15:
 
 Added
 ~~~~~
@@ -1826,7 +1833,7 @@ Changed
 [1.1.0] - 2022-05-24
 --------------------
 
-.. _added-15:
+.. _added-16:
 
 Added
 ~~~~~
@@ -1857,7 +1864,7 @@ Fixed
 [1.0.0] - 2022-05-10
 --------------------
 
-.. _added-16:
+.. _added-17:
 
 Added
 ~~~~~
@@ -2035,7 +2042,7 @@ Fixed
 [0.11.0] - 2021-04-25
 ---------------------
 
-.. _added-17:
+.. _added-18:
 
 Added
 ~~~~~
@@ -2091,7 +2098,7 @@ Fixed
 [0.10.1] - 2021-02-22
 ---------------------
 
-.. _added-18:
+.. _added-19:
 
 Added
 ~~~~~
@@ -2140,7 +2147,7 @@ Fixed
 [0.10.0] - 2021-02-12
 ---------------------
 
-.. _added-19:
+.. _added-20:
 
 Added
 ~~~~~
@@ -2203,7 +2210,7 @@ Fixed
 [0.9.0] - 2021-01-04
 --------------------
 
-.. _added-20:
+.. _added-21:
 
 Added
 ~~~~~
@@ -2241,7 +2248,7 @@ Fixed
 [0.8.1] - 2020-12-09
 --------------------
 
-.. _added-21:
+.. _added-22:
 
 Added
 ~~~~~
@@ -2262,7 +2269,7 @@ Fixed
 [0.8.0] - 2020-11-06
 --------------------
 
-.. _added-22:
+.. _added-23:
 
 Added
 ~~~~~
@@ -2293,7 +2300,7 @@ Fixed
 [0.7.0] - 2020-09-11
 --------------------
 
-.. _added-23:
+.. _added-24:
 
 Added
 ~~~~~
@@ -2357,7 +2364,7 @@ Fixed
 [0.6.1] - 2020-08-20
 --------------------
 
-.. _added-24:
+.. _added-25:
 
 Added
 ~~~~~
@@ -2384,7 +2391,7 @@ Fixed
 [0.6.0] - 2020-08-18
 --------------------
 
-.. _added-25:
+.. _added-26:
 
 Added
 ~~~~~
@@ -2452,7 +2459,7 @@ Changed
 -  Now we test the PCB and/or SCH only when we are doing something that
    needs them.
 
-.. _added-26:
+.. _added-27:
 
 Added
 ~~~~~
@@ -2521,7 +2528,7 @@ Fixed
 [0.4.0] - 2020-06-17
 --------------------
 
-.. _added-27:
+.. _added-28:
 
 Added
 ~~~~~
@@ -2534,7 +2541,7 @@ Added
 [0.3.0] - 2020-06-14
 --------------------
 
-.. _added-28:
+.. _added-29:
 
 Added
 ~~~~~
@@ -2563,7 +2570,7 @@ Fixed
 [0.2.5] - 2020-06-11
 --------------------
 
-.. _added-29:
+.. _added-30:
 
 Added
 ~~~~~
@@ -2604,7 +2611,7 @@ Fixed
 [0.2.3] - 2020-04-23
 --------------------
 
-.. _added-30:
+.. _added-31:
 
 Added
 ~~~~~
@@ -2642,7 +2649,7 @@ Fixed
 [0.2.0] - 2020-03-28
 --------------------
 
-.. _added-31:
+.. _added-32:
 
 Added
 ~~~~~
@@ -2672,7 +2679,7 @@ Fixed
 [0.1.1] - 2020-03-13
 --------------------
 
-.. _added-32:
+.. _added-33:
 
 Added
 ~~~~~

kibot/kicad/v6_sch.py

@@ -665,6 +665,7 @@ def __init__(self, name='', value='', id=0, x=0, y=0, ang=0):
         self.effects = FontEffects()
         self.do_not_autoplace = False
         self.show_name = False
+        self.private = False
 
     def visible(self, v):
         self.effects.hide = not v
@@ -689,16 +690,23 @@ def set_xy(self, x, y, hjustify=None):
     def parse(items, number):
         field = SchematicFieldV6()
         name = 'field'
-        field.name = _check_str(items, 1, name+' name')
-        field.value = _check_str(items, 2, name+' value')
+        offset = 0
+        # KiCad 9 and the never ending story: tons of things went from loose symbols to real attributes,
+        # but here a new one is introduced ... and before the important data. OMG!!!
+        if isinstance(items[1], Symbol):
+            assert items[1].value() == 'private', items[1].value()
+            offset = 1
+            field.private = True
+        field.name = _check_str(items, offset+1, name+' name')
+        field.value = _check_str(items, offset+2, name+' value')
         # Default values
         field.number = number
         field.effects = None
         found_at = False
-        for c, i in enumerate(items[3:]):
+        for c, i in enumerate(items[offset+3:]):
             i_type = _check_is_symbol_list(i)
             if i_type == 'at':
-                field.x, field.y, field.ang = _get_at(items, c+3, name)
+                field.x, field.y, field.ang = _get_at(items, c+offset+3, name)
                 found_at = True
             elif i_type == 'effects':
                 field.effects = FontEffects.parse(i)
@@ -717,7 +725,11 @@ def parse(items, number):
     def write(self):
         if self.number < 0:
             return None
-        data = [self.name, self.value]
+        data = []
+        if self.private:
+            data.append(Symbol('private'))
+        data.append(self.name)
+        data.append(self.value)
         if version < KICAD_7_VER:
             # Removed in KiCad 7
             data.append(_symbol('id', [self.number]))

tests/board_samples/kicad_9/deeper.kicad_sch

@@ -1,5 +1,5 @@
 (kicad_sch
-	(version 20241209)
+	(version 20250114)
 	(generator "eeschema")
 	(generator_version "9.0")
 	(uuid "3b838d52-596d-4e4d-a6ac-e4c8e7621137")

tests/board_samples/kicad_9/sub-sheet.kicad_sch

@@ -1,5 +1,5 @@
 (kicad_sch
-	(version 20241209)
+	(version 20250114)
 	(generator "eeschema")
 	(generator_version "9.0")
 	(uuid "5b2b5c7d-f943-4634-9f0a-e9561705c49d")