feat: Prepare For Multi-Command CLI Interface (#121)

* put current command into subfolder

* update cli.py to new structure

* remove unused imports

* add module docstring

* streamline command

* update cli commands in README

---------

Co-authored-by: konstantin <[email protected]>

Author: hf-krechan

README.md

@@ -208,7 +208,7 @@ ORDER BY sort_path;
 <details>
 <summary>Finde heraus, welche Zeilen in einem Prüfidentifikator zwischen zwei Versionen hinzukommen</summary>
 <br>
-    
+
 ```sql
     with fv2504 as (SELECT *
                 FROM ahb_hierarchy_materialized
@@ -236,11 +236,11 @@ pip install fundamend[cli]
 ```
 Kann ein CLI-Tool in der entsprechenden venv installiert werden, das einzelne MIG- und AHB-XML-Dateien in entsprechende JSONs konvertiert:
 ```bash
-(myvenv): xml2json --xml-path path/to/mig.xml
+(myvenv): fundamend xml2json --xml-path path/to/mig.xml
 ```
 erzeugt `path/to/mig.json`. Und
 ```bash
-(myvenv): xml2json --xml-path path/to/my/directory
+(myvenv): fundamend xml2json --xml-path path/to/my/directory
 ```
 konvertiert alle XML-Dateien im entsprechenden Verzeichnis.
 

src/fundamend/cli.py

@@ -1,72 +1,20 @@
 """contains the entrypoint for the command line interface"""
 
-import json
-from pathlib import Path
-
 import typer
-from pydantic import RootModel
 from rich.console import Console
-from typing_extensions import Annotated
 
-from fundamend import AhbReader, Anwendungshandbuch, MessageImplementationGuide, MigReader
+from fundamend.commands import app as commands_app
 
-app = typer.Typer(name="xml2json", help="Convert XML(s) by BDEW to JSON(s)")
+app = typer.Typer(name="fundamend", help="CLI tool to work with XML files by BDEW", no_args_is_help=True)
 err_console = Console(stderr=True)  # https://typer.tiangolo.com/tutorial/printing/#printing-to-standard-error
 
 
-def _convert_to_json_file(xml_file_path: Path) -> Path:
-    """converts the given XML file to a JSON file and returns the path of the latter"""
-    if not xml_file_path.is_file():
-        raise ValueError(f"The given path {xml_file_path.absolute()} is not a file")
-    is_ahb = "ahb" in xml_file_path.stem.lower()
-    is_mig = "mig" in xml_file_path.stem.lower()
-    if is_ahb and is_mig:
-        raise ValueError(f"Cannot detect if {xml_file_path} is an AHB or MIG")
-    root_model: RootModel[Anwendungshandbuch] | RootModel[MessageImplementationGuide]
-    if is_ahb:
-        ahb_model = AhbReader(xml_file_path).read()
-        root_model = RootModel[Anwendungshandbuch](ahb_model)
-    elif is_mig:
-        mig_model = MigReader(xml_file_path).read()
-        root_model = RootModel[MessageImplementationGuide](mig_model)
-    else:
-        raise ValueError(f"Seems like {xml_file_path} is neither an AHB nor a MIG")
-    out_dict = root_model.model_dump(mode="json")
-    json_file_path = xml_file_path.with_suffix(".json")
-    with open(json_file_path, encoding="utf-8", mode="w") as outfile:
-        json.dump(out_dict, outfile, indent=True, ensure_ascii=False)
-    print(f"Successfully converted {xml_file_path} file to JSON {json_file_path}")
-    return json_file_path
-
-
-@app.command()
-def main(
-    xml_path: Annotated[
-        Path,
-        typer.Option(
-            exists=True,
-            file_okay=True,
-            dir_okay=True,
-            writable=True,
-            readable=True,
-            resolve_path=True,
-        ),
-    ],
-) -> None:
-    """
-    converts the xml file from xml_in_path to a json file next to the .xml
-    """
-    assert xml_path.exists()  # ensured by typer
-    if xml_path.is_dir():
-        for _xml_path in xml_path.rglob("*.xml"):
-            _convert_to_json_file(_xml_path)
-    else:
-        _convert_to_json_file(xml_path)
+app.add_typer(commands_app)
 
 
 def cli() -> None:
     """entry point of the script defined in pyproject.toml"""
-    typer.run(main)
+    typer.run(app)
 
 
 if __name__ == "__main__":

src/fundamend/commands/__init__.py

@@ -0,0 +1,11 @@
+"""
+Contains the commands for the CLI.
+"""
+
+import typer
+
+from fundamend.commands.xml2json import app as xml2json_app
+
+app = typer.Typer()
+
+app.add_typer(xml2json_app)

src/fundamend/commands/xml2json.py

@@ -0,0 +1,64 @@
+"""
+Contains the command to convert XML files to JSON files.
+"""
+
+import json
+from pathlib import Path
+
+import typer
+from pydantic import RootModel
+from typing_extensions import Annotated
+
+from fundamend import AhbReader, Anwendungshandbuch, MessageImplementationGuide, MigReader
+
+app = typer.Typer()
+
+
+def _convert_to_json_file(xml_file_path: Path) -> Path:
+    """converts the given XML file to a JSON file and returns the path of the latter"""
+    if not xml_file_path.is_file():
+        raise ValueError(f"The given path {xml_file_path.absolute()} is not a file")
+    is_ahb = "ahb" in xml_file_path.stem.lower()
+    is_mig = "mig" in xml_file_path.stem.lower()
+    if is_ahb and is_mig:
+        raise ValueError(f"Cannot detect if {xml_file_path} is an AHB or MIG")
+    root_model: RootModel[Anwendungshandbuch] | RootModel[MessageImplementationGuide]
+    if is_ahb:
+        ahb_model = AhbReader(xml_file_path).read()
+        root_model = RootModel[Anwendungshandbuch](ahb_model)
+    elif is_mig:
+        mig_model = MigReader(xml_file_path).read()
+        root_model = RootModel[MessageImplementationGuide](mig_model)
+    else:
+        raise ValueError(f"Seems like {xml_file_path} is neither an AHB nor a MIG")
+    out_dict = root_model.model_dump(mode="json")
+    json_file_path = xml_file_path.with_suffix(".json")
+    with open(json_file_path, encoding="utf-8", mode="w") as outfile:
+        json.dump(out_dict, outfile, indent=True, ensure_ascii=False)
+    print(f"Successfully converted {xml_file_path} file to JSON {json_file_path}")
+    return json_file_path
+
+
+@app.command()
+def xml2json(
+    xml_path: Annotated[
+        Path,
+        typer.Option(
+            exists=True,
+            file_okay=True,
+            dir_okay=True,
+            writable=True,
+            readable=True,
+            resolve_path=True,
+        ),
+    ],
+) -> None:
+    """
+    converts the xml file from xml_in_path to a json file next to the .xml
+    """
+    assert xml_path.exists()  # ensured by typer
+    if xml_path.is_dir():
+        for _xml_path in xml_path.rglob("*.xml"):
+            _convert_to_json_file(_xml_path)
+    else:
+        _convert_to_json_file(xml_path)

unittests/test_cli.py

@@ -24,7 +24,7 @@ def test_cli_single_file_mig(tmp_path: Path) -> None:
     original_mig_file = Path(__file__).parent / "example_files" / "UTILTS_MIG_1.1c_Lesefassung_2023_12_12.xml"
     tmp_mig_path = tmp_path / "my_mig.xml"
     _copy_xml_file(original_mig_file, tmp_mig_path)
-    result = runner.invoke(app, ["--xml-path", str(tmp_mig_path.absolute())])
+    result = runner.invoke(app, ["xml2json", "--xml-path", str(tmp_mig_path.absolute())])
     assert result.exit_code == 0
     assert (tmp_path / "my_mig.json").exists()
 
@@ -35,7 +35,7 @@ def test_cli_single_file_ahb(tmp_path: Path) -> None:
     original_ahb_file = Path(__file__).parent / "example_files" / "UTILTS_AHB_1.1d_Konsultationsfassung_2024_04_02.xml"
     tmp_ahb_path = tmp_path / "my_ahb.xml"
     _copy_xml_file(original_ahb_file, tmp_ahb_path)
-    result = runner.invoke(app, ["--xml-path", str(tmp_ahb_path)])
+    result = runner.invoke(app, ["xml2json", "--xml-path", str(tmp_ahb_path.absolute())])
     assert result.exit_code == 0
     assert (tmp_path / "my_ahb.json").exists()
 
@@ -49,7 +49,7 @@ def test_cli_directory(tmp_path: Path) -> None:
     tmp_ahb_path = tmp_path / "my_ahb.xml"
     _copy_xml_file(original_ahb_file, tmp_ahb_path)
     _copy_xml_file(original_mig_file, tmp_mig_path)
-    result = runner.invoke(app, ["--xml-path", str(tmp_path)])
+    result = runner.invoke(app, ["xml2json", "--xml-path", str(tmp_path.absolute())])
     assert result.exit_code == 0
     assert (tmp_path / "my_mig.json").exists()
     assert (tmp_path / "my_ahb.json").exists()