Skip to content

Commit b742081

Browse files
authored
chore: change the 'parent' arg type of DoclingDocument functions (#103)
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 b31e0a3 commit b742081

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

docling_core/types/doc/document.py

+14-14
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,15 +1536,15 @@ def add_table(
15361536
data: TableData,
15371537
caption: Optional[Union[TextItem, RefItem]] = None, # This is not cool yet.
15381538
prov: Optional[ProvenanceItem] = None,
1539-
parent: Optional[GroupItem] = None,
1539+
parent: Optional[NodeItem] = None,
15401540
label: DocItemLabel = DocItemLabel.TABLE,
15411541
):
15421542
"""add_table.
15431543
15441544
:param data: TableData:
15451545
:param caption: Optional[Union[TextItem, RefItem]]: (Default value = None)
15461546
:param prov: Optional[ProvenanceItem]: (Default value = None)
1547-
:param parent: Optional[GroupItem]: (Default value = None)
1547+
:param parent: Optional[NodeItem]: (Default value = None)
15481548
:param label: DocItemLabel: (Default value = DocItemLabel.TABLE)
15491549
15501550
"""
@@ -1573,15 +1573,15 @@ def add_picture(
15731573
image: Optional[ImageRef] = None,
15741574
caption: Optional[Union[TextItem, RefItem]] = None,
15751575
prov: Optional[ProvenanceItem] = None,
1576-
parent: Optional[GroupItem] = None,
1576+
parent: Optional[NodeItem] = None,
15771577
):
15781578
"""add_picture.
15791579
15801580
:param data: List[PictureData]: (Default value = [])
15811581
:param caption: Optional[Union[TextItem:
15821582
:param RefItem]]: (Default value = None)
15831583
:param prov: Optional[ProvenanceItem]: (Default value = None)
1584-
:param parent: Optional[GroupItem]: (Default value = None)
1584+
:param parent: Optional[NodeItem]: (Default value = None)
15851585
"""
15861586
if not parent:
15871587
parent = self.body
@@ -1611,14 +1611,14 @@ def add_title(
16111611
text: str,
16121612
orig: Optional[str] = None,
16131613
prov: Optional[ProvenanceItem] = None,
1614-
parent: Optional[GroupItem] = None,
1614+
parent: Optional[NodeItem] = None,
16151615
):
16161616
"""add_title.
16171617
16181618
:param text: str:
16191619
:param orig: Optional[str]: (Default value = None)
16201620
:param prov: Optional[ProvenanceItem]: (Default value = None)
1621-
:param parent: Optional[GroupItem]: (Default value = None)
1621+
:param parent: Optional[NodeItem]: (Default value = None)
16221622
"""
16231623
if not parent:
16241624
parent = self.body
@@ -1649,7 +1649,7 @@ def add_heading(
16491649
orig: Optional[str] = None,
16501650
level: LevelNumber = 1,
16511651
prov: Optional[ProvenanceItem] = None,
1652-
parent: Optional[GroupItem] = None,
1652+
parent: Optional[NodeItem] = None,
16531653
):
16541654
"""add_heading.
16551655
@@ -1658,7 +1658,7 @@ def add_heading(
16581658
:param orig: Optional[str]: (Default value = None)
16591659
:param level: LevelNumber: (Default value = 1)
16601660
:param prov: Optional[ProvenanceItem]: (Default value = None)
1661-
:param parent: Optional[GroupItem]: (Default value = None)
1661+
:param parent: Optional[NodeItem]: (Default value = None)
16621662
"""
16631663
if not parent:
16641664
parent = self.body

0 commit comments

Comments
 (0)