deepdoctection 0.31__py3-none-any.whl → 0.33__py3-none-any.whl

deepdoctection/utils/metacfg.py

@@ -20,11 +20,11 @@ Class AttrDict for maintaining configs and some functions for generating and sav
 """
 
 import pprint
-from typing import Any, Dict, List
+from typing import Any
 
 import yaml
 
-from .detection_types import Pathlike
+from .types import PathLikeOrStr
 
 
 # Copyright (c) Tensorpack Contributors
@@ -67,13 +67,13 @@ class AttrDict:
 
     __repr__ = __str__
 
-    def to_dict(self) -> Dict[str, Any]:
+    def to_dict(self) -> dict[str, Any]:
         """Convert to a nested dict."""
         return {
             k: v.to_dict() if isinstance(v, AttrDict) else v for k, v in self.__dict__.items() if not k.startswith("_")
         }
 
-    def from_dict(self, d: Dict[str, Any]) -> None:  # pylint: disable=C0103
+    def from_dict(self, d: dict[str, Any]) -> None:  # pylint: disable=C0103
         """
         Generate an instance from a dict
         """
@@ -86,7 +86,7 @@ class AttrDict:
                 else:
                     setattr(self, k, v)
 
-    def update_args(self, args: List[str]) -> None:
+    def update_args(self, args: list[str]) -> None:
         """
         Update from command line args.
         """
@@ -122,7 +122,7 @@ class AttrDict:
         raise NotImplementedError()
 
 
-def set_config_by_yaml(path_yaml: Pathlike) -> AttrDict:
+def set_config_by_yaml(path_yaml: PathLikeOrStr) -> AttrDict:
     """
     Use to initialize the config class for tensorpack faster rcnn
 
@@ -139,7 +139,7 @@ def set_config_by_yaml(path_yaml: Pathlike) -> AttrDict:
     return config
 
 
-def save_config_to_yaml(config: AttrDict, path_yaml: Pathlike) -> None:
+def save_config_to_yaml(config: AttrDict, path_yaml: PathLikeOrStr) -> None:
     """
     :param config: The configuration instance as an AttrDict
     :param path_yaml: Save the config class for tensorpack faster rcnn

deepdoctection/utils/mocks.py

@@ -0,0 +1,93 @@
+# -*- coding: utf-8 -*-
+# File: mocks.py
+
+# Copyright 2024 Dr. Janis Meyer. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+Some classes with the purpose to mock the original classes from the Tensorpack library, if Tensorpack is not installed
+"""
+
+from deepdoctection.utils.error import DependencyError
+
+
+def layer_register(log_shape):  # pylint: disable=W0613
+    """Mock layer_register function from tensorpack."""
+
+    def inner(inputs):  # pylint: disable=W0613
+        pass
+
+    return inner
+
+
+def under_name_scope():
+    """Mock under_name_scope function from tensorpack."""
+
+    def inner(inputs):  # pylint: disable=W0613
+        pass
+
+    return inner
+
+
+def memoized(func):
+    """Mock memoized function from tensorpack."""
+    return func
+
+
+def memoized_method(func):
+    """Mock memoized_method function from tensorpack."""
+    return func
+
+
+def auto_reuse_variable_scope(inputs):  # pylint: disable=W0613
+    """Mock auto_reuse_variable_scope function from tensorpack."""
+
+
+class ModelDesc:  # pylint: disable=R0903
+    """Mock ModelDesc class from tensorpack."""
+
+    def __init__(self) -> None:
+        raise DependencyError("Tensorpack not found.")
+
+
+class ImageAugmentor:  # pylint: disable=R0903
+    """Mock ImageAugmentor class from tensorpack."""
+
+    def __init__(self) -> None:
+        raise DependencyError("Tensorpack not found.")
+
+
+class Callback:  # pylint: disable=R0903
+    """Mock Callback class from tensor"""
+
+    def __init__(self) -> None:
+        raise DependencyError("Tensorpack not found.")
+
+
+class Config:  # pylint: disable=R0903
+    """Mock class for Config"""
+
+    pass  # pylint: disable=W0107
+
+
+class Tree:  # pylint: disable=R0903
+    """Mock class for Tree"""
+
+    pass  # pylint: disable=W0107
+
+
+class IterableDataset:  # pylint: disable=R0903
+    """Mock class for IterableDataset"""
+
+    pass  # pylint: disable=W0107

deepdoctection/utils/pdf_utils.py

@@ -25,23 +25,23 @@ import sys
 from errno import ENOENT
 from io import BytesIO
 from shutil import copyfile
-from typing import Generator, List, Optional, Tuple
+from typing import Generator, Optional
 
 from numpy import uint8
 from pypdf import PdfReader, PdfWriter, errors
 
 from .context import save_tmp_file, timeout_manager
-from .detection_types import ImageType, Pathlike
 from .error import DependencyError, FileExtensionError
 from .file_utils import pdf_to_cairo_available, pdf_to_ppm_available, qpdf_available
 from .logger import LoggingRecord, logger
+from .types import PathLikeOrStr, PixelValues
 from .utils import is_file_extension
 from .viz import viz_handler
 
 __all__ = ["decrypt_pdf_document", "get_pdf_file_reader", "get_pdf_file_writer", "PDFStreamer", "pdf_to_np_array"]
 
 
-def decrypt_pdf_document(path: Pathlike) -> bool:
+def decrypt_pdf_document(path: PathLikeOrStr) -> bool:
     """
     Decrypting a pdf. As copying a pdf document removes the password that protects pdf, this method
     generates a copy and decrypts the copy using qpdf. The result is saved as the original
@@ -73,7 +73,7 @@ def decrypt_pdf_document(path: Pathlike) -> bool:
     return False
 
 
-def get_pdf_file_reader(path: Pathlike) -> PdfReader:
+def get_pdf_file_reader(path: PathLikeOrStr) -> PdfReader:
     """
     Creates a file reader object from a pdf document. Will try to decrypt the document if it is
     encrypted. (See `decrypt_pdf_document` to understand what is meant with "decrypt").
@@ -133,7 +133,7 @@ class PDFStreamer:
 
     """
 
-    def __init__(self, path: Pathlike) -> None:
+    def __init__(self, path: PathLikeOrStr) -> None:
         """
         :param path: to a pdf.
         """
@@ -143,7 +143,7 @@ class PDFStreamer:
     def __len__(self) -> int:
         return len(self.file_reader.pages)
 
-    def __iter__(self) -> Generator[Tuple[bytes, int], None, None]:
+    def __iter__(self) -> Generator[tuple[bytes, int], None, None]:
         for k in range(len(self)):
             buffer = BytesIO()
             writer = get_pdf_file_writer()
@@ -157,9 +157,9 @@ class PDFStreamer:
 
 
 def _input_to_cli_str(
-    input_file_name: Pathlike, output_file_name: Pathlike, dpi: int, size: Optional[Tuple[int, int]] = None
-) -> List[str]:
-    cmd_args: List[str] = []
+    input_file_name: PathLikeOrStr, output_file_name: PathLikeOrStr, dpi: int, size: Optional[tuple[int, int]] = None
+) -> list[str]:
+    cmd_args: list[str] = []
 
     if pdf_to_ppm_available():
         command = "pdftoppm"
@@ -196,7 +196,7 @@ class PopplerError(RuntimeError):
         self.args = (status, message)
 
 
-def _run_poppler(poppler_args: List[str]) -> None:
+def _run_poppler(poppler_args: list[str]) -> None:
     try:
         proc = subprocess.Popen(poppler_args)  # pylint: disable=R1732
     except OSError as error:
@@ -209,7 +209,7 @@ def _run_poppler(poppler_args: List[str]) -> None:
             raise PopplerError(status=proc.returncode, message="Syntax Error: PDF cannot be read with Poppler")
 
 
-def pdf_to_np_array(pdf_bytes: bytes, size: Optional[Tuple[int, int]] = None, dpi: int = 200) -> ImageType:
+def pdf_to_np_array(pdf_bytes: bytes, size: Optional[tuple[int, int]] = None, dpi: int = 200) -> PixelValues:
     """
     Convert a single pdf page from its byte representation to a numpy array. This function will save the pdf as to a tmp
     file and then call poppler via `pdftoppm` resp. `pdftocairo` if the former is not available.