Source code for pdftools_toolbox.pdf.content.text

from __future__ import annotations
import io
from typing import List, Iterator, Tuple, Optional, Any, TYPE_CHECKING, Callable
from ctypes import *
from datetime import datetime
from numbers import Number
from pdftools_toolbox.internal import _lib
from pdftools_toolbox.internal.utils import _string_to_utf16, _utf16_to_string
from pdftools_toolbox.internal.streams import _StreamDescriptor, _NativeStream
from pdftools_toolbox.internal.native_base import _NativeBase
from pdftools_toolbox.internal.native_object import _NativeObject

import pdftools_toolbox.internal
import pdftools_toolbox.pdf.content.text_fragment

if TYPE_CHECKING:
    from pdftools_toolbox.pdf.document import Document
    from pdftools_toolbox.pdf.content.text_fragment import TextFragment

else:
    Document = "pdftools_toolbox.pdf.document.Document"
    TextFragment = "pdftools_toolbox.pdf.content.text_fragment.TextFragment"


[docs] class Text(_NativeObject, list): """ """
[docs] @staticmethod def create(target_document: Document) -> Text: """ Create a text The returned text object is not yet used on any page, but it is associated with the given target document. Args: targetDocument (pdftools_toolbox.pdf.document.Document): the output document with which the returned object is associated Returns: pdftools_toolbox.pdf.content.text.Text: the newly created text object Raises: ValueError: if the `targetDocument` argument has already been closed ValueError: if the `targetDocument` argument is read-only """ from pdftools_toolbox.pdf.document import Document if not isinstance(target_document, Document): raise TypeError(f"Expected type {Document.__name__}, but got {type(target_document).__name__}.") _lib.PtxPdfContent_Text_Create.argtypes = [c_void_p] _lib.PtxPdfContent_Text_Create.restype = c_void_p ret_val = _lib.PtxPdfContent_Text_Create(target_document._handle) if ret_val is None: _NativeBase._throw_last_error(False) return Text._create_dynamic_type(ret_val)
def __len__(self) -> int: _lib.PtxPdfContent_Text_GetCount.argtypes = [c_void_p] _lib.PtxPdfContent_Text_GetCount.restype = c_int ret_val = _lib.PtxPdfContent_Text_GetCount(self._handle) if ret_val == -1: _NativeBase._throw_last_error() return ret_val
[docs] def clear(self) -> None: _lib.PtxPdfContent_Text_Clear.argtypes = [c_void_p] _lib.PtxPdfContent_Text_Clear.restype = c_bool if not _lib.PtxPdfContent_Text_Clear(self._handle): _NativeBase._throw_last_error(False)
def __delitem__(self, index: int) -> None: if index < 0: # Handle negative indexing index += len(self) self.remove(index)
[docs] def remove(self, index: int) -> None: if not isinstance(index, int): raise TypeError(f"Expected type {int.__name__}, but got {type(index).__name__}.") _lib.PtxPdfContent_Text_Remove.argtypes = [c_void_p, c_int] _lib.PtxPdfContent_Text_Remove.restype = c_bool if not _lib.PtxPdfContent_Text_Remove(self._handle, index): _NativeBase._throw_last_error(False)
[docs] def extend(self, items: Text) -> None: if not isinstance(items, Text): raise TypeError(f"Expected type {Text.__name__}, but got {type(items).__name__}.") raise NotImplementedError("Extend method is not supported in Text.")
[docs] def insert(self, index: int, value: Any) -> None: raise NotImplementedError("Insert method is not supported in Text.")
[docs] def pop(self, index: int = -1) -> Any: raise NotImplementedError("Pop method is not supported in Text.")
[docs] def copy(self) -> Text: raise NotImplementedError("Copy method is not supported in Text.")
[docs] def sort(self, key=None, reverse=False) -> None: raise NotImplementedError("Sort method is not supported in Text.")
[docs] def reverse(self) -> None: raise NotImplementedError("Reverse method is not supported in Text.")
def __getitem__(self, index: Union[int, slice]) -> Union[Any, List[Any]]: from pdftools_toolbox.pdf.content.text_fragment import TextFragment if isinstance(index, slice): raise NotImplementedError("Slicing is not implemented.") if not isinstance(index, int): raise TypeError(f"Expected type {int.__name__}, but got {type(index).__name__}.") if index < 0: # Handle negative indexing index += len(self) _lib.PtxPdfContent_Text_Get.argtypes = [c_void_p, c_int] _lib.PtxPdfContent_Text_Get.restype = c_void_p ret_val = _lib.PtxPdfContent_Text_Get(self._handle, index) if ret_val is None: _NativeBase._throw_last_error(False) return TextFragment._create_dynamic_type(ret_val) def __setitem__(self, index: int, value: Any) -> None: raise NotImplementedError("Setting elements is not supported in Text.")
[docs] def append(self, value: TextFragment) -> None: raise NotImplementedError("Append method is not supported in Text.")
[docs] def index(self, value: TextFragment, start: int = 0, stop: Optional[int] = None) -> int: from pdftools_toolbox.pdf.content.text_fragment import TextFragment if not isinstance(value, TextFragment): raise TypeError(f"Expected type {TextFragment.__name__}, but got {type(value).__name__}.") if not isinstance(start, int): raise TypeError(f"Expected type {int.__name__}, but got {type(start).__name__}.") if stop is not None and not isinstance(stop, int): raise TypeError(f"Expected type {int.__name__} or None, but got {type(stop).__name__}.") length = len(self) if start < 0: start += length if stop is None: stop = length elif stop < 0: stop += length for i in range(max(start, 0), min(stop, length)): if self[i] == value: return i raise ValueError(f"{value} is not in the list.")
def __iter__(self): self._iter_index = 0 # Initialize the index for iteration return self def __next__(self): if self._iter_index < len(self): # Check if there are more items to iterate over item = self.__getitem__(self._iter_index) # Get the item at the current index self._iter_index += 1 # Move to the next index return item else: raise StopIteration # Signal that iteration is complete @staticmethod def _create_dynamic_type(handle): return Text._from_handle(handle) @classmethod def _from_handle(cls, handle): """ Internal factory method for constructing an instance using an internal handle. This method creates an instance of the class by bypassing the public constructor. """ instance = Text.__new__(cls) # Bypass __init__ instance._initialize(handle) return instance def _initialize(self, handle): super()._initialize(handle)