Merge pull request #94 from AiDAPT-A/93-error-settings

Fix error when invokin settings from CLI

Author: manuGil

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "visarchpy"
-version = "1.0.3"
+version = "1.0.4"
 authors = [
     {name = "Manuel Garcia", email = "m.g.garciaalvarez@tudelft.nl"},
 ]
@@ -68,4 +68,3 @@ addopts = [
 
 [project.scripts]
 visarch = "visarchpy.cli.main:app"
-

src/visarchpy/cli/layout.py

@@ -7,7 +7,7 @@
 import json
 from visarchpy.utils import create_output_dir
 import shutil
-import visarchpy.cli.settings as settings
+import visarchpy.cli.settings as default_settings
 
 
 app = typer.Typer(help="Extract images from PDF files using layout \
@@ -20,12 +20,12 @@
 def from_file(
     pdf_file: str = typer.Argument(help="Path to directory containing PDF files."),
     output_directory: str = typer.Argument(help="Path to directory where results will be saved."),
-    settings: Annotated[str, typer.Option(help="Path to pipeline JSON setting file. If None default settings will be used. Use: [COMMAND] settings, to see current settings.")] = None,
+    settings: Annotated[str, typer.Option(help="Path to pipeline JSON setting file. If None default settings are used. Use: [COMMAND] settings, to see current settings.")] = None,
     mods: Annotated[str, typer.Option(help="Path to MODS file. If None, metadata extraction will be skiped.")] = None
     ) -> None:
 
     if settings is None:
-        settings = settings.init()
+        settings = default_settings.init()
     else:
         with open(settings, "r") as f:
             settings = json.load(f)
@@ -54,13 +54,13 @@ def from_file(
 def from_dir(
     data_directory: str = typer.Argument(help="Path to directory containing PDF files."),
     output_directory: str = typer.Argument(help="Path to directory where results will be saved."),
-    settings: Annotated[str, typer.Option(help="Path to pipeline JSON setting file. If None default settings will be used. Use: [COMMAND] settings, to see current settings.")] = None,
+    settings: Annotated[str, typer.Option(help="Path to pipeline JSON setting file. If None default settings are used. Use: [COMMAND] settings, to see current settings.")] = None,
     mods: Annotated[str, typer.Option(help="Path to MODS file. If None, metadata extraction will be skiped.")] = None,
     tmp: Annotated[str, typer.Option(help="If provided, PDF files in the data directory will be copied to this directory.")
     ] = None) -> None:
 
     if settings is None:
-        settings = settings.init()
+        settings = default_settings.init()
     else:
         with open(settings, "r") as f:
             settings = json.load(f)
@@ -76,7 +76,7 @@ def from_dir(
 @app.command(help="Show default settings for the pipeline.")
 def settings() -> None:
     """Show default settings for the pipeline."""
-    typer.echo(default_settings)
+    typer.echo(default_settings.init())
 
 
 if __name__ == "__main__":

src/visarchpy/cli/layout_ocr.py

@@ -7,7 +7,7 @@
 import json
 from visarchpy.utils import create_output_dir
 import shutil
-import visarchpy.cli.settings as settings
+import visarchpy.cli.settings as default_settings
 
 app = typer.Typer(help="Extract images from PDF files using layout and \
 OCR analysis.",
@@ -19,12 +19,12 @@
 def from_file(
     pdf_file: str = typer.Argument(help="Path to directory containing PDF files."),
     output_directory: str = typer.Argument(help="Path to directory where results will be saved."),
-    settings: Annotated[str, typer.Option(help="Path to pipeline JSON setting file. If None default settings will be used. Use: [COMMAND] settings, to see current settings.")] = None,
+    settings: Annotated[str, typer.Option(help="Path to pipeline JSON setting file. If None default settings are used. Use: [COMMAND] settings, to see current settings.")] = None,
     mods: Annotated[str, typer.Option(help="Path to MODS file. If None, metadata extraction will be skiped.")] = None
     ) -> None:
 
     if settings is None:
-        settings = settings.init()
+        settings = default_settings.init()
     else:
         with open(settings, "r") as f:
             settings = json.load(f)
@@ -53,13 +53,13 @@ def from_file(
 def from_dir(
     data_directory: str = typer.Argument(help="Path to directory containing PDF files."),
     output_directory: str = typer.Argument(help="Path to directory where results will be saved."),
-    settings: Annotated[str, typer.Option(help="Path to pipeline JSON setting file. If None default settings will be used. Use: [COMMAND] settings, to see current settings.")] = None,
+    settings: Annotated[str, typer.Option(help="Path to pipeline JSON setting file. If None default settings are used. Use: [COMMAND] settings, to see current settings.")] = None,
     mods: Annotated[str, typer.Option(help="Path to MODS file. If None, metadata extraction will be skiped.")] = None,
     tmp: Annotated[str, typer.Option(help="If provided, PDF files in the data directory will be copied to this directory.")
     ] = None) -> None:
 
     if settings is None:
-        settings = settings.init()
+        settings = default_settings.init()
     else:
         with open(settings, "r") as f:
             settings = json.load(f)
@@ -75,21 +75,21 @@ def from_dir(
 @app.command(help="Show default settings for the pipeline.")
 def settings() -> None:
     """Show default settings for the pipeline."""
-    typer.echo(default_settings)
+    typer.echo(default_settings.init())
 
 
 @app.command(help="batch processing for TU Delft's dataset.")
 def batch(entry_range: str = typer.Argument(help="Range of entries to process, e.g.: 1-10."),
           data_directory: str = typer.Argument(help="path to directory containing MODS and PDF files."),
           output_directory: str = typer.Argument(help="path to directory where results will be saved."),
-          settings: Annotated[str, typer.Option(help="path to pipeline JSON setting file. If None default settings will be used. Use: [COMMAND] settings, to see current settings.")] = None,
+          settings: Annotated[str, typer.Option(help="path to pipeline JSON setting file. If None default settings are used. Use: [COMMAND] settings, to see current settings.")] = None,
           tmp: Annotated[str, typer.Option(help="If provided, PDF files in the data directory will be copied to this directory.")
             ] = None) -> None:
     """Extracts metadata from MODS files and images from PDF files
       using layout and OCR pipeline"""
 
     if settings is None:
-        settings = default_settings
+        settings = default_settings.init()
     else:
         with open(settings, "r") as f:
             settings = json.load(f)

src/visarchpy/cli/ocr.py

@@ -7,7 +7,7 @@
 import json
 from visarchpy.utils import create_output_dir
 import shutil
-import visarchpy.cli.settings as settings
+import visarchpy.cli.settings as default_settings
 
 
 app = typer.Typer(help="Extract images from PDF files using OCR \
@@ -20,12 +20,12 @@
 def from_file(
     pdf_file: str = typer.Argument(help="Path to directory containing PDF files."),
     output_directory: str = typer.Argument(help="Path to directory where results will be saved."),
-    settings: Annotated[str, typer.Option(help="Path to pipeline JSON setting file. If None default settings will be used. Use: [COMMAND] settings, to see current settings.")] = None,
+    settings: Annotated[str, typer.Option(help="Path to pipeline JSON setting file. If None default settings are used. Use: [COMMAND] settings, to see current settings.")] = None,
     mods: Annotated[str, typer.Option(help="Path to MODS file. If None, metadata extraction will be skiped.")] = None
     ) -> None:
 
     if settings is None:
-        settings = settings.init()
+        settings = default_settings.init()
     else:
         with open(settings, "r") as f:
             settings = json.load(f)
@@ -54,13 +54,13 @@ def from_file(
 def from_dir(
     data_directory: str = typer.Argument(help="Path to directory containing PDF files."),
     output_directory: str = typer.Argument(help="Path to directory where results will be saved."),
-    settings: Annotated[str, typer.Option(help="Path to pipeline JSON setting file. If None default settings will be used. Use: [COMMAND] settings, to see current settings.")] = None,
+    settings: Annotated[str, typer.Option(help="Path to pipeline JSON setting file. If None default settings are used. Use: [COMMAND] settings, to see current settings.")] = None,
     mods: Annotated[str, typer.Option(help="Path to MODS file. If None, metadata extraction will be skiped.")] = None,
     tmp: Annotated[str, typer.Option(help="If provided, PDF files in the data directory will be copied to this directory.")
     ] = None) -> None:
 
     if settings is None:
-        settings = settings.init()
+        settings = default_settings.init()
     else:
         with open(settings, "r") as f:
             settings = json.load(f)
@@ -76,7 +76,7 @@ def from_dir(
 @app.command(help="Show default settings for the pipeline.")
 def settings() -> None:
     """Show default settings for the pipeline."""
-    typer.echo(default_settings)
+    typer.echo(default_settings.init())
 
 
 if __name__ == "__main__":

src/visarchpy/cli/settings.py

@@ -1,8 +1,10 @@
 import os
+import json
 
 def init():
-    default_settings_file = os.path.join(current_dir, "../default-settings.json")
     current_dir = os.path.dirname(os.path.realpath(__file__))
+    default_settings_file = os.path.join(current_dir, "../default-settings.json")
     with open(default_settings_file, "r") as f:
-        global default_settings 
-        dafault_settings = json.load(f)
+        default_settings = json.load(f)
+
+    return default_settings