Skip to content

Commit 62b5eb1

Browse files
ceberamCesar Berrospi
authored and
Cesar Berrospi
committed
chore: change the 'parent' arg type of DoclingDocument functions
Change the 'parent' argument type of the functions in DoclingDocument that allow adding text items, to enable all type of parent items instead of only group items. Signed-off-by: Cesar Berrospi Ramis <[email protected]>
1 parent 047a196 commit 62b5eb1

File tree

1 file changed

+24
-12
lines changed

1 file changed

+24
-12
lines changed

docling_core/types/doc/document.py

+24-12
Original file line numberDiff line numberDiff line change
@@ -1408,13 +1408,13 @@ def add_group(
14081408
self,
14091409
label: Optional[GroupLabel] = None,
14101410
name: Optional[str] = None,
1411-
parent: Optional[GroupItem] = None,
1411+
parent: Optional[NodeItem] = None,
14121412
) -> GroupItem:
14131413
"""add_group.
14141414
14151415
:param label: Optional[GroupLabel]: (Default value = None)
14161416
:param name: Optional[str]: (Default value = None)
1417-
:param parent: Optional[GroupItem]: (Default value = None)
1417+
:param parent: Optional[NodeItem]: (Default value = None)
14181418
14191419
"""
14201420
if not parent:
@@ -1441,15 +1441,15 @@ def add_list_item(
14411441
marker: Optional[str] = None,
14421442
orig: Optional[str] = None,
14431443
prov: Optional[ProvenanceItem] = None,
1444-
parent: Optional[GroupItem] = None,
1444+
parent: Optional[NodeItem] = None,
14451445
):
14461446
"""add_list_item.
14471447
14481448
:param label: str:
14491449
:param text: str:
14501450
:param orig: Optional[str]: (Default value = None)
14511451
:param prov: Optional[ProvenanceItem]: (Default value = None)
1452-
:param parent: Optional[GroupItem]: (Default value = None)
1452+
:param parent: Optional[NodeItem]: (Default value = None)
14531453
14541454
"""
14551455
if not parent:
@@ -1484,15 +1484,15 @@ def add_text(
14841484
text: str,
14851485
orig: Optional[str] = None,
14861486
prov: Optional[ProvenanceItem] = None,
1487-
parent: Optional[GroupItem] = None,
1487+
parent: Optional[NodeItem] = None,
14881488
):
14891489
"""add_text.
14901490
14911491
:param label: str:
14921492
:param text: str:
14931493
:param orig: Optional[str]: (Default value = None)
14941494
:param prov: Optional[ProvenanceItem]: (Default value = None)
1495-
:param parent: Optional[GroupItem]: (Default value = None)
1495+
:param parent: Optional[NodeItem]: (Default value = None)
14961496
14971497
"""
14981498
# Catch a few cases that are in principle allowed
@@ -1536,6 +1536,7 @@ def add_table(
15361536
data: TableData,
15371537
caption: Optional[Union[TextItem, RefItem]] = None, # This is not cool yet.
15381538
prov: Optional[ProvenanceItem] = None,
1539+
<<<<<<< HEAD
15391540
parent: Optional[GroupItem] = None,
15401541
label: DocItemLabel = DocItemLabel.TABLE,
15411542
):
@@ -1546,6 +1547,17 @@ def add_table(
15461547
:param prov: Optional[ProvenanceItem]: (Default value = None)
15471548
:param parent: Optional[GroupItem]: (Default value = None)
15481549
:param label: DocItemLabel: (Default value = DocItemLabel.TABLE)
1550+
=======
1551+
parent: Optional[NodeItem] = None,
1552+
):
1553+
"""add_table.
1554+
1555+
:param data: BaseTableData:
1556+
:param caption: Optional[Union[TextItem:
1557+
:param RefItem]]: (Default value = None)
1558+
:param # This is not cool yet.prov: Optional[ProvenanceItem]
1559+
:param parent: Optional[NodeItem]: (Default value = None)
1560+
>>>>>>> 833e24d (chore: change the 'parent' arg type of DoclingDocument functions)
15491561

15501562
"""
15511563
if not parent:
@@ -1573,15 +1585,15 @@ def add_picture(
15731585
image: Optional[ImageRef] = None,
15741586
caption: Optional[Union[TextItem, RefItem]] = None,
15751587
prov: Optional[ProvenanceItem] = None,
1576-
parent: Optional[GroupItem] = None,
1588+
parent: Optional[NodeItem] = None,
15771589
):
15781590
"""add_picture.
15791591

15801592
:param data: List[PictureData]: (Default value = [])
15811593
:param caption: Optional[Union[TextItem:
15821594
:param RefItem]]: (Default value = None)
15831595
:param prov: Optional[ProvenanceItem]: (Default value = None)
1584-
:param parent: Optional[GroupItem]: (Default value = None)
1596+
:param parent: Optional[NodeItem]: (Default value = None)
15851597
"""
15861598
if not parent:
15871599
parent = self.body
@@ -1611,14 +1623,14 @@ def add_title(
16111623
text: str,
16121624
orig: Optional[str] = None,
16131625
prov: Optional[ProvenanceItem] = None,
1614-
parent: Optional[GroupItem] = None,
1626+
parent: Optional[NodeItem] = None,
16151627
):
16161628
"""add_title.
16171629

16181630
:param text: str:
16191631
:param orig: Optional[str]: (Default value = None)
16201632
:param prov: Optional[ProvenanceItem]: (Default value = None)
1621-
:param parent: Optional[GroupItem]: (Default value = None)
1633+
:param parent: Optional[NodeItem]: (Default value = None)
16221634
"""
16231635
if not parent:
16241636
parent = self.body
@@ -1649,7 +1661,7 @@ def add_heading(
16491661
orig: Optional[str] = None,
16501662
level: LevelNumber = 1,
16511663
prov: Optional[ProvenanceItem] = None,
1652-
parent: Optional[GroupItem] = None,
1664+
parent: Optional[NodeItem] = None,
16531665
):
16541666
"""add_heading.
16551667

@@ -1658,7 +1670,7 @@ def add_heading(
16581670
:param orig: Optional[str]: (Default value = None)
16591671
:param level: LevelNumber: (Default value = 1)
16601672
:param prov: Optional[ProvenanceItem]: (Default value = None)
1661-
:param parent: Optional[GroupItem]: (Default value = None)
1673+
:param parent: Optional[NodeItem]: (Default value = None)
16621674
"""
16631675
if not parent:
16641676
parent = self.body

0 commit comments

Comments
 (0)