numbers-parser 4.11.4__tar.gz → 4.12.0__tar.gz

{numbers_parser-4.11.4 → numbers_parser-4.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: numbers-parser
-Version: 4.11.4
+Version: 4.12.0
 Summary: Read and write Apple Numbers spreadsheets
 Home-page: https://github.com/masaccio/numbers-parser
 License: MIT
@@ -15,6 +15,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Office/Business :: Financial :: Spreadsheet
+Requires-Dist: colorama (>=0.4.6,<0.5.0)
 Requires-Dist: compact-json (>=1.1.3,<2.0.0)
 Requires-Dist: enum-tools (>=0.11)
 Requires-Dist: importlib-resources (>=6.1)

{numbers_parser-4.11.4 → numbers_parser-4.12.0}/pyproject.toml

@@ -12,7 +12,7 @@ name = "numbers-parser"
 packages = [{include = "numbers_parser", from = "src"}]
 readme = "README.md"
 repository = "https://github.com/masaccio/numbers-parser"
-version = "4.11.4"
+version = "4.12.0"
 
 [tool.poetry.scripts]
 cat-numbers = "numbers_parser._cat_numbers:main"
@@ -30,6 +30,7 @@ sigfig = "^1.3.2"
 setuptools = ">=69.0.3"
 importlib-resources = ">=6.1"
 enum-tools = ">=0.11"
+colorama = "^0.4.6"
 
 [tool.poetry.group.dev.dependencies]
 black = "*"
@@ -44,7 +45,6 @@ pytest-cov = ">=4.0,>=5.0"
 pytest-profiling = "^1.7.0"
 pytest-xdist = "^3.3.1"
 ruff = "*"
-termcolor = ">=2.2"
 tox = "^4.11.4"
 python-magic = ">=0.4"
 tqdm = ">=4.66"

{numbers_parser-4.11.4 → numbers_parser-4.12.0}/src/numbers_parser/cell.py

@@ -993,7 +993,7 @@ class Cell(CellStorageFlags, Cacheable):
                 )
                 self._model.add_component_reference(
                     self._style._text_style_obj_id,
-                    parent_id=self._model._table_styles.id(self._table_id),
+                    component_id=self._model._table_styles.id(self._table_id),
                 )
 
             if self._style._cell_style_obj_id is not None:
@@ -1003,7 +1003,7 @@ class Cell(CellStorageFlags, Cacheable):
                 )
                 self._model.add_component_reference(
                     self._style._cell_style_obj_id,
-                    parent_id=self._model._table_styles.id(self._table_id),
+                    component_id=self._model._table_styles.id(self._table_id),
                 )
 
         length = 12

{numbers_parser-4.11.4 → numbers_parser-4.12.0}/src/numbers_parser/model.py

@@ -55,6 +55,7 @@ from numbers_parser.containers import ObjectStore
 from numbers_parser.exceptions import UnsupportedError
 from numbers_parser.formula import TableFormulas
 from numbers_parser.generated import TNArchives_pb2 as TNArchives
+from numbers_parser.generated import TSAArchives_pb2 as TSAArchives
 from numbers_parser.generated import TSCEArchives_pb2 as TSCEArchives
 from numbers_parser.generated import TSDArchives_pb2 as TSDArchives
 from numbers_parser.generated import TSKArchives_pb2 as TSKArchives
@@ -330,10 +331,140 @@ class _NumbersModel(Cacheable):
         else:
             return not table_info.super.caption_hidden
 
+    def captions_style_id(self):
+        stylesheet = self.objects[self.find_refs("StylesheetArchive")[0]]
+        caption_styles = [
+            x for x in stylesheet.identifier_to_style_map if "Caption" in x.identifier
+        ]
+        return caption_styles[0].style.identifier
+
+    def caption_paragraph_style_id(self):
+        style_map = {
+            id: self.objects[id]
+            for id in self.find_refs("ParagraphStyleArchive")
+            if "Caption" in self.objects[id].super.name
+        }
+        return list(style_map.keys())[0]
+
+    @cache(num_args=0)
+    def stylesheet_id(self):
+        return self.find_refs("StylesheetArchive")[0]
+
+    def set_reference(self, obj: object, id: int):
+        obj.MergeFrom(TSPMessages.Reference(identifier=id))
+
+    def create_path_source_archive(self, table_id):
+        return TSDArchives.PathSourceArchive(
+            horizontalFlip=False,
+            verticalFlip=False,
+            bezier_path_source=TSDArchives.BezierPathSourceArchive(
+                naturalSize=TSPMessages.Size(width=self.table_width(table_id), height=0.0),
+                path=TSPMessages.Path(
+                    elements=[
+                        TSPMessages.Path.Element(
+                            type=TSPMessages.Path.ElementType.moveTo,
+                            points=[TSPMessages.Point(x=0.0, y=0.0)],
+                        ),
+                        TSPMessages.Path.Element(
+                            type=TSPMessages.Path.ElementType.lineTo,
+                            points=[TSPMessages.Point(x=100.0, y=0.0)],
+                        ),
+                        TSPMessages.Path.Element(
+                            type=TSPMessages.Path.ElementType.lineTo,
+                            points=[TSPMessages.Point(x=100.0, y=100.0)],
+                        ),
+                        TSPMessages.Path.Element(
+                            type=TSPMessages.Path.ElementType.lineTo,
+                            points=[TSPMessages.Point(x=0.0, y=100.0)],
+                        ),
+                        TSPMessages.Path.Element(
+                            type=TSPMessages.Path.ElementType.closeSubpath,
+                        ),
+                        TSPMessages.Path.Element(
+                            type=TSPMessages.Path.ElementType.moveTo,
+                            points=[TSPMessages.Point(x=0.0, y=0.0)],
+                        ),
+                    ]
+                ),
+            ),
+        )
+
+    def create_caption_archive(self, table_id):
+        table_info_id = self.table_info_id(table_id)
+        table_info = self.objects[table_info_id]
+        caption_placement_id, _ = self.objects.create_object_from_dict(
+            "CalculationEngine",
+            {
+                "caption_anchor_location": 1,
+                "drawable_anchor_location": 7,
+            },
+            TSAArchives.CaptionPlacementArchive,
+        )
+        caption_info_id, caption_info = self.objects.create_object_from_dict(
+            "CalculationEngine",
+            {"childInfoKind": "Caption", "placement": {"identifier": caption_placement_id}},
+            TSAArchives.CaptionInfoArchive,
+        )
+        storage_id, storage = self.objects.create_object_from_dict(
+            "CalculationEngine",
+            {
+                "text": ["Caption"],
+                "in_document": True,
+                "style_sheet": {"identifier": self.stylesheet_id()},
+                "table_para_style": {
+                    "entries": [
+                        {
+                            "character_index": 0,
+                            "object": {"identifier": self.caption_paragraph_style_id()},
+                        }
+                    ]
+                },
+                "table_para_starts": {"entries": [{"character_index": 0, "first": 0, "second": 0}]},
+                "table_para_bidi": {"entries": [{"character_index": 0, "first": 0, "second": 0}]},
+                "table_drop_cap_style": {"entries": [{"character_index": 0}]},
+            },
+            TSWPArchives.StorageArchive,
+        )
+        for object_id in [storage_id, self.captions_style_id(), self.caption_paragraph_style_id()]:
+            self.add_component_reference(
+                object_id, location="CalculationEngine", component_id=self.stylesheet_id()
+            )
+        caption_info.super.MergeFrom(
+            TSWPArchives.ShapeInfoArchive(
+                is_text_box=True,
+                owned_storage=TSPMessages.Reference(identifier=storage_id),
+                deprecated_storage=TSPMessages.Reference(identifier=storage_id),
+                super=TSDArchives.ShapeArchive(
+                    super=self.create_drawable(table_info_id, 0, 0, flags=1),
+                    style={"identifier": self.captions_style_id()},
+                    strokePatternOffsetDistance=0.0,
+                    pathsource=self.create_path_source_archive(table_id),
+                ),
+            )
+        )
+
+        self.set_reference(table_info.super.caption, caption_info_id)
+        component = self.metadata_component(self.calc_engine_id())
+        component.object_uuid_map_entries.append(
+            TSPArchiveMessages.ObjectUUIDMapEntry(
+                identifier=caption_info_id, uuid=NumbersUUID().protobuf2
+            )
+        )
+
     def caption_text(self, table_id: int, caption: str = None) -> str:
         table_info = self.objects[self.table_info_id(table_id)]
         caption_info_id = table_info.super.caption.identifier
-        caption_storage_id = self.objects[caption_info_id].super.owned_storage.identifier
+        caption_archive = self.objects[caption_info_id]
+
+        if caption_archive.DESCRIPTOR.name == "StandinCaptionArchive":
+            if caption is None:
+                return "Caption"
+            else:
+                self.create_caption_archive(table_id)
+                caption_info_id = table_info.super.caption.identifier
+                caption_archive = self.objects[caption_info_id]
+
+        caption_storage_id = caption_archive.super.owned_storage.identifier
         caption_text = self.objects[caption_storage_id].text
         if caption is not None:
             caption_text[0] = caption
@@ -881,7 +1012,7 @@ class _NumbersModel(Cacheable):
             merge_map.cell_range.append(cell_range)
 
         base_data_store = self.objects[table_id].base_data_store
-        base_data_store.merge_region_map.CopyFrom(TSPMessages.Reference(identifier=merge_map_id))
+        self.set_reference(base_data_store.merge_region_map, merge_map_id)
 
     def recalculate_row_info(
         self,
@@ -942,19 +1073,19 @@ class _NumbersModel(Cacheable):
             save_token=1,
         )
         self.objects[PACKAGE_ID].components.append(component_info)
-        self.add_component_reference(object_id, parent)
+        self.add_component_reference(object_id, location=parent)
 
     def add_component_reference(
         self,
         object_id: int,
         location: Optional[str] = None,
-        parent_id: Optional[int] = None,
+        component_id: Optional[int] = None,
         is_weak: bool = False,
     ):
         """Add an external reference to an object in a metadata component."""
-        component = self.metadata_component(location or parent_id)
-        if parent_id is not None:
-            params = {"object_identifier": object_id, "component_identifier": parent_id}
+        component = self.metadata_component(location or component_id)
+        if component_id is not None:
+            params = {"object_identifier": object_id, "component_identifier": component_id}
         else:
             params = {"component_identifier": object_id}
         if is_weak:
@@ -1174,7 +1305,15 @@ class _NumbersModel(Cacheable):
 
         return self.table_height(table_id) + y_offset
 
-    def create_drawable(self, sheet_id: int, x: float, y: float) -> object:
+    def create_drawable(
+        self,
+        sheet_id: int,
+        x: float,
+        y: float,
+        flags: int = 3,
+        height: float = 231.0,
+        width: float = 494.0,
+    ) -> object:
         """Create a DrawableArchive for a new table in a sheet."""
         table_x = x if x is not None else 0.0
         table_y = y if y is not None else self.last_table_offset(sheet_id) + DEFAULT_TABLE_OFFSET
@@ -1182,9 +1321,9 @@ class _NumbersModel(Cacheable):
             parent=TSPMessages.Reference(identifier=sheet_id),
             geometry=TSDArchives.GeometryArchive(
                 angle=0.0,
-                flags=3,
+                flags=flags,
                 position=TSPMessages.Point(x=table_x, y=table_y),
-                size=TSPMessages.Size(height=231.0, width=494.0),
+                size=TSPMessages.Size(height=height, width=width),
             ),
         )
 
@@ -1238,43 +1377,30 @@ class _NumbersModel(Cacheable):
             "Tables/HeaderStorageBucket-{}",
         )
 
-        # caption_storage_id, caption_storage = self.objects.create_object_from_dict(
-        #     "CalculationEngine",
-        #     {"text": ["TEST Caption"]},
-        #     TSWPArchives.StorageArchive,
-        # )
-        # caption_info_id, caption_info = self.objects.create_object_from_dict(
-        #     "CalculationEngine",
-        #     {},
-        #     TSAArchives.CaptionInfoArchive,
-        # )
-        # # caption_info.super.MergeFrom(TSWPArchives.ShapeInfoArchive())
-        # # caption_info.super.super.MergeFrom(TSDArchives.ShapeArchive())
-        # # caption_info.super.super.super.MergeFrom(TSDArchives.DrawableArchive())
-        # from_table_info = self.objects[self.table_info_id(from_table_id)]
-        # from_caption_info = self.objects[from_table_info.super.caption.identifier]
-        # caption_info.super.CopyFrom(from_caption_info.super)
-        # caption_info.super.super.CopyFrom(from_caption_info.super.super)
-        # caption_info.super.super.super.CopyFrom(from_caption_info.super.super.super)
-        # caption_info.super.deprecated_storage.MergeFrom(
-        #     TSPMessages.Reference(identifier=caption_storage_id)
-        # )
-        # caption_info.super.owned_storage.MergeFrom(
-        #     TSPMessages.Reference(identifier=caption_storage_id)
-        # )
-
-        # TST.TableModelArchive.stroke_sidecar -> TST.StrokeSidecarArchive
-        # TST.StrokeSidecarArchive
-        #    top_row_stroke_layers -> [TST.StrokeLayerArchive]
-        #    left_row_stroke_layers -> [TST.StrokeLayerArchive]
-        #    right_row_stroke_layers -> [TST.StrokeLayerArchive]
-        #    bottom_row_stroke_layers -> [TST.StrokeLayerArchive]
+        from_table_info = self.objects[self.table_info_id(from_table_id)]
+        from_caption_info = self.objects[from_table_info.super.caption.identifier]
+        caption_storage_id, caption_storage = self.objects.create_object_from_dict(
+            "CalculationEngine",
+            {"text": ["Caption"]},
+            TSWPArchives.StorageArchive,
+        )
+        caption_storage.MergeFrom(self.objects[from_caption_info.super.owned_storage.identifier])
+        caption_info_id, caption_info = self.objects.create_object_from_dict(
+            "CalculationEngine",
+            {},
+            TSAArchives.CaptionInfoArchive,
+        )
+        caption_info.super.CopyFrom(from_caption_info.super)
+        caption_info.super.super.CopyFrom(from_caption_info.super.super)
+        caption_info.super.super.super.CopyFrom(from_caption_info.super.super.super)
+        self.set_reference(caption_info.super.deprecated_storage, caption_storage_id)
+        self.set_reference(caption_info.super.owned_storage, caption_storage_id)
         sidecar_id, _ = self.objects.create_object_from_dict(
             "CalculationEngine",
             {"max_order": 1, "column_count": 0, "row_count": 0},
             TSTArchives.StrokeSidecarArchive,
         )
-        table_model.stroke_sidecar.MergeFrom(TSPMessages.Reference(identifier=sidecar_id))
+        self.set_reference(table_model.stroke_sidecar, sidecar_id)
 
         style_table_id, _ = self.objects.create_object_from_dict(
             "Index/Tables/DataList-{}",
@@ -1354,11 +1480,13 @@ class _NumbersModel(Cacheable):
         )
         table_info.tableModel.MergeFrom(TSPMessages.Reference(identifier=table_model_id))
         table_info.super.MergeFrom(self.create_drawable(sheet_id, x, y))
-        # caption_info.super.super.super.parent.MergeFrom(
-        #     TSPMessages.Reference(identifier=table_info_id)
-        # )
-        # table_info.super.caption.MergeFrom(TSPMessages.Reference(identifier=caption_info_id))
-        self.add_component_reference(table_info_id, "Document", self.calc_engine_id())
+        caption_info.super.super.super.parent.MergeFrom(
+            TSPMessages.Reference(identifier=table_info_id)
+        )
+        table_info.super.caption.MergeFrom(TSPMessages.Reference(identifier=caption_info_id))
+        self.add_component_reference(
+            table_info_id, location="Document", component_id=self.calc_engine_id()
+        )
 
         self.add_formula_owner(
             table_info_id,
@@ -1459,7 +1587,9 @@ class _NumbersModel(Cacheable):
             TNArchives.SheetArchive,
         )
 
-        self.add_component_reference(sheet_id, "CalculationEngine", DOCUMENT_ID, is_weak=True)
+        self.add_component_reference(
+            sheet_id, location="CalculationEngine", component_id=DOCUMENT_ID, is_weak=True
+        )
 
         self.objects[DOCUMENT_ID].sheets.append(TSPMessages.Reference(identifier=sheet_id))