fix: fix circular import (#87)

Signed-off-by: Panos Vagenas <[email protected]>

Author: vagenas

docling_core/types/doc/document.py

@@ -37,8 +37,8 @@
 from docling_core.types.doc import BoundingBox, Size
 from docling_core.types.doc.base import ImageRefMode
 from docling_core.types.doc.labels import DocItemLabel, GroupLabel
+from docling_core.types.doc.utils import relative_path
 from docling_core.types.legacy_doc.tokens import DocumentToken
-from docling_core.utils.file import relative_path
 
 Uint64 = typing.Annotated[int, Field(ge=0, le=(2**64 - 1))]
 LevelNumber = typing.Annotated[int, Field(ge=1, le=100)]

docling_core/types/doc/utils.py

@@ -0,0 +1,48 @@
+#
+# Copyright IBM Corp. 2024 - 2024
+# SPDX-License-Identifier: MIT
+#
+
+"""Utils for document types."""
+
+from pathlib import Path
+
+
+def relative_path(src: Path, target: Path) -> Path:
+    """Compute the relative path from `src` to `target`.
+
+    Args:
+        src (str | Path): The source directory or file path (must be absolute).
+        target (str | Path): The target directory or file path (must be absolute).
+
+    Returns:
+        Path: The relative path from `src` to `target`.
+
+    Raises:
+        ValueError: If either `src` or `target` is not an absolute path.
+    """
+    src = Path(src).resolve()
+    target = Path(target).resolve()
+
+    # Ensure both paths are absolute
+    if not src.is_absolute():
+        raise ValueError(f"The source path must be absolute: {src}")
+    if not target.is_absolute():
+        raise ValueError(f"The target path must be absolute: {target}")
+
+    # Find the common ancestor
+    common_parts = []
+    for src_part, target_part in zip(src.parts, target.parts):
+        if src_part == target_part:
+            common_parts.append(src_part)
+        else:
+            break
+
+    # Determine the path to go up from src to the common ancestor
+    up_segments = [".."] * (len(src.parts) - len(common_parts))
+
+    # Add the path from the common ancestor to the target
+    down_segments = target.parts[len(common_parts) :]
+
+    # Combine and return the result
+    return Path(*up_segments, *down_segments)

docling_core/utils/file.py

@@ -15,6 +15,7 @@
 from pydantic import AnyHttpUrl, TypeAdapter, ValidationError
 from typing_extensions import deprecated
 
+from docling_core.types.doc.utils import relative_path  # noqa
 from docling_core.types.io import DocumentStream
 
 
@@ -168,43 +169,3 @@ def resolve_file_source(
         source=source,
         headers=headers,
     )
-
-
-def relative_path(src: Path, target: Path) -> Path:
-    """Compute the relative path from `src` to `target`.
-
-    Args:
-        src (str | Path): The source directory or file path (must be absolute).
-        target (str | Path): The target directory or file path (must be absolute).
-
-    Returns:
-        Path: The relative path from `src` to `target`.
-
-    Raises:
-        ValueError: If either `src` or `target` is not an absolute path.
-    """
-    src = Path(src).resolve()
-    target = Path(target).resolve()
-
-    # Ensure both paths are absolute
-    if not src.is_absolute():
-        raise ValueError(f"The source path must be absolute: {src}")
-    if not target.is_absolute():
-        raise ValueError(f"The target path must be absolute: {target}")
-
-    # Find the common ancestor
-    common_parts = []
-    for src_part, target_part in zip(src.parts, target.parts):
-        if src_part == target_part:
-            common_parts.append(src_part)
-        else:
-            break
-
-    # Determine the path to go up from src to the common ancestor
-    up_segments = [".."] * (len(src.parts) - len(common_parts))
-
-    # Add the path from the common ancestor to the target
-    down_segments = target.parts[len(common_parts) :]
-
-    # Combine and return the result
-    return Path(*up_segments, *down_segments)