fractal-task-tools 0.0.6__py3-none-any.whl → 0.0.7__py3-none-any.whl

fractal_task_tools/__init__.py

@@ -2,4 +2,4 @@ import logging
 
 logging.basicConfig(level=logging.INFO)
 
-__VERSION__ = "0.0.6"
+__VERSION__ = "0.0.7"

fractal_task_tools/_cli.py

@@ -1,9 +1,9 @@
 import argparse as ap
 import sys
 
-from fractal_task_tools._create_manifest import check_manifest
+from fractal_task_tools._cli_tools import check_manifest
+from fractal_task_tools._cli_tools import write_manifest_to_file
 from fractal_task_tools._create_manifest import create_manifest
-from fractal_task_tools._create_manifest import write_manifest_to_file
 
 
 main_parser = ap.ArgumentParser(
@@ -47,6 +47,16 @@ for subparser in (create_manifest_parser, check_manifest_parser):
         default="dev.task_list",
         required=False,
     )
+check_manifest_parser.add_argument(
+    "--ignore-keys-order",
+    type=bool,
+    help=(
+        "Ignore the order of dictionary keys when comparing manifests "
+        "(default value: False)."
+    ),
+    default=False,
+    required=False,
+)
 
 
 def main():
@@ -69,4 +79,5 @@ def main():
         check_manifest(
             raw_package_name=args.package,
             manifest=manifest,
+            ignore_keys_order=args.ignore_keys_order,
         )

fractal_task_tools/_cli_tools.py

@@ -0,0 +1,86 @@
+import json
+import logging
+import os
+import sys
+from importlib import import_module
+from pathlib import Path
+
+from fractal_task_tools._create_manifest import MANIFEST_FILENAME
+from fractal_task_tools._deepdiff import deepdiff
+from fractal_task_tools._package_name_tools import normalize_package_name
+
+
+def write_manifest_to_file(
+    *,
+    raw_package_name: str,
+    manifest: str,
+) -> None:
+    """
+    Write manifest to file.
+
+    Arguments:
+        raw_package_name:
+        manifest: The manifest object
+    """
+    logging.info("[write_manifest_to_file] START")
+
+    package_name = normalize_package_name(raw_package_name)
+    logging.info(f"[write_manifest_to_file] {package_name=}")
+
+    imported_package = import_module(package_name)
+    package_root_dir = Path(imported_package.__file__).parent
+    manifest_path = (package_root_dir / MANIFEST_FILENAME).as_posix()
+    logging.info(f"[write_manifest_to_file] {os.getcwd()=}")
+    logging.info(f"[write_manifest_to_file] {package_root_dir=}")
+    logging.info(f"[write_manifest_to_file] {manifest_path=}")
+
+    with open(manifest_path, "w") as f:
+        json.dump(manifest, f, indent=2)
+        f.write("\n")
+
+    logging.info("[write_manifest_to_file] END")
+
+
+def check_manifest(
+    *,
+    raw_package_name: str,
+    manifest: str,
+    ignore_keys_order: bool,
+) -> None:
+    """
+    Write manifest to file.
+
+    Arguments:
+        raw_package_name:
+        manifest: The manifest object
+        ignore_keys_order: Whether to ignore keys order.
+    """
+
+    package_name = normalize_package_name(raw_package_name)
+    logging.info(f"[check_manifest] {package_name=}")
+
+    imported_package = import_module(package_name)
+    package_root_dir = Path(imported_package.__file__).parent
+    manifest_path = (package_root_dir / MANIFEST_FILENAME).as_posix()
+    logging.info(f"[check_manifest] {os.getcwd()=}")
+    logging.info(f"[check_manifest] {package_root_dir=}")
+    logging.info(f"[check_manifest] {manifest_path=}")
+
+    with open(manifest_path, "r") as f:
+        old_manifest = json.load(f)
+    if manifest == old_manifest:
+        logging.info("[check_manifest] On-disk manifest is up to date.")
+    else:
+        logging.error("[check_manifest] On-disk manifest is not up to date.")
+        try:
+            deepdiff(
+                old_object=old_manifest,
+                new_object=manifest,
+                path="manifest",
+                ignore_keys_order=ignore_keys_order,
+            )
+        except ValueError as e:
+            logging.error(str(e))
+            sys.exit("New/old manifests differ")
+
+    logging.info("[check_manifest] END")

fractal_task_tools/_create_manifest.py

@@ -1,12 +1,8 @@
 """
 Generate JSON schemas for task arguments and combine them into a manifest.
 """
-import json
 import logging
-import os
-import sys
 from importlib import import_module
-from pathlib import Path
 from typing import Any
 
 from ._args_schemas import create_schema_for_single_task
@@ -54,9 +50,10 @@ def create_manifest(
     # Prepare an empty manifest
     manifest = dict(
         manifest_version=MANIFEST_VERSION,
+        task_list=[],
         has_args_schemas=True,
         args_schema_version=ARGS_SCHEMA_VERSION,
-        task_list=[],
+        authors=None,
     )
 
     # Import the task-list module
@@ -143,72 +140,4 @@ def create_manifest(
 
         # Append task
         manifest["task_list"].append(task_dict)
-        print()
     return manifest
-
-
-def write_manifest_to_file(
-    *,
-    raw_package_name: str,
-    manifest: str,
-) -> None:
-    """
-    Write manifest to file.
-
-    Arguments:
-        raw_package_name:
-        manifest: The manifest object
-    """
-    logging.info("[write_manifest_to_file] START")
-
-    package_name = normalize_package_name(raw_package_name)
-    logging.info(f"[write_manifest_to_file] {package_name=}")
-
-    imported_package = import_module(package_name)
-    package_root_dir = Path(imported_package.__file__).parent
-    manifest_path = (package_root_dir / MANIFEST_FILENAME).as_posix()
-    logging.info(f"[write_manifest_to_file] {os.getcwd()=}")
-    logging.info(f"[write_manifest_to_file] {package_root_dir=}")
-    logging.info(f"[write_manifest_to_file] {manifest_path=}")
-
-    with open(manifest_path, "w") as f:
-        json.dump(manifest, f, indent=2)
-        f.write("\n")
-
-    logging.info("[write_manifest_to_file] END")
-
-
-def check_manifest(
-    *,
-    raw_package_name: str,
-    manifest: str,
-) -> None:
-    """
-    Write manifest to file.
-
-    Arguments:
-        raw_package_name:
-        manifest: The manifest object
-    """
-
-    package_name = normalize_package_name(raw_package_name)
-    logging.info(f"[check_manifest] {package_name=}")
-
-    imported_package = import_module(package_name)
-    package_root_dir = Path(imported_package.__file__).parent
-    manifest_path = (package_root_dir / MANIFEST_FILENAME).as_posix()
-    logging.info(f"[check_manifest] {os.getcwd()=}")
-    logging.info(f"[check_manifest] {package_root_dir=}")
-    logging.info(f"[check_manifest] {manifest_path=}")
-
-    with open(manifest_path, "r") as f:
-        old_manifest = json.load(f)
-    if manifest == old_manifest:
-        logging.info("[check_manifest] On-disk manifest is up to date.")
-    else:
-        logging.error("[check_manifest] On-disk manifest is not up to date.")
-        print(json.dumps(old_manifest, indent=2))
-        print(json.dumps(manifest, indent=2))
-        sys.exit("New/old manifests differ")
-
-    logging.info("[check_manifest] END")

fractal_task_tools/_deepdiff.py

@@ -0,0 +1,68 @@
+from typing import Union
+
+
+ValidType = Union[list, dict, str, int, float, bool, None]
+
+MAX_RECURSION_LEVEL = 20
+
+
+def deepdiff(
+    *,
+    old_object: ValidType,
+    new_object: ValidType,
+    path: str,
+    ignore_keys_order: bool,
+    recursion_level: int = 1,
+):
+    if type(old_object) is not type(new_object):
+        raise ValueError(
+            f"[{path}] Type difference:\n"
+            f"\tOld: {type(old_object)}\n\tNew:{type(new_object)}"
+        )
+
+    if type(old_object) not in [list, dict, str, int, float, bool, type(None)]:
+        raise ValueError(f"[{path}] Invalid type {type(old_object)}, exit.")
+
+    if recursion_level > MAX_RECURSION_LEVEL:
+        raise ValueError(f"Reached {MAX_RECURSION_LEVEL=}. Exit.")
+
+    if type(old_object) is dict:
+        old_keys = list(old_object.keys())
+        new_keys = list(new_object.keys())
+        if ignore_keys_order:
+            old_keys = sorted(old_keys)
+            new_keys = sorted(new_keys)
+        if old_keys != new_keys:
+            raise ValueError(
+                f"[{path}] Dictionaries have different keys:\n"
+                f"\tOld: {old_keys}\n\tNew: {new_keys}"
+            )
+
+        for key, value_a in old_object.items():
+            deepdiff(
+                old_object=value_a,
+                new_object=new_object[key],
+                path=f"{path}['{key}']",
+                ignore_keys_order=ignore_keys_order,
+                recursion_level=recursion_level + 1,
+            )
+    elif type(old_object) is list:
+        if len(old_object) != len(new_object):
+            raise ValueError(
+                f"{path} Lists have different lengths:\n"
+                f"\tOld:{len(old_object)}\n\tNew: {len(new_object)}"
+            )
+        for ind, item_a in enumerate(old_object):
+            deepdiff(
+                old_object=item_a,
+                new_object=new_object[ind],
+                path=f"{path}[{ind}]",
+                ignore_keys_order=ignore_keys_order,
+                recursion_level=recursion_level + 1,
+            )
+    else:
+        if old_object != new_object:
+            raise ValueError(
+                f"{path} Values are different:\n"
+                f"\tOld: '{old_object}'\n\tNew:'{new_object}'"
+            )

{fractal_task_tools-0.0.6.dist-info → fractal_task_tools-0.0.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: fractal-task-tools
-Version: 0.0.6
+Version: 0.0.7
 Summary: Shared tools for Fractal tasks
 Author-email: Tommaso Comparin <tommaso.comparin@exact-lab.it>
 License: BSD-3-Clause

{fractal_task_tools-0.0.6.dist-info → fractal_task_tools-0.0.7.dist-info}/RECORD

@@ -1,7 +1,9 @@
-fractal_task_tools/__init__.py,sha256=oGZGTQhcn6qF_IOVf03TzaT2AMmZYyMmeCQK7snnOLA,79
+fractal_task_tools/__init__.py,sha256=6mDzYc6ONWs6jFCx1ww0ZebQhqb6Sjw_rNkZFsdhupE,79
 fractal_task_tools/_args_schemas.py,sha256=Ka5IAAEdC7xg03ZHMl5jFbv4Sk8JR1QKbxFl7soevlQ,7829
-fractal_task_tools/_cli.py,sha256=6x2wWG6cFTw0m8HsxLmeboT3AMNf7ofhAI2kWEZMkx8,1849
-fractal_task_tools/_create_manifest.py,sha256=DTl1gV4XvQy_ArOAOSUzKLcTHYuE_un94dBvpfdkeeI,6922
+fractal_task_tools/_cli.py,sha256=OULWSnI4_ziNWYoZWAiPQu2PgeQwJJRIh3wLkX2H7wA,2134
+fractal_task_tools/_cli_tools.py,sha256=6G7zXvL6o5t7n4HvVAqP6an0o7qx5fEau5KjtoDXFuc,2622
+fractal_task_tools/_create_manifest.py,sha256=p5Z7ZZy8EkwWGPZHsqfNtkmLEAmHfL5QDfuvqXWwWEY,4821
+fractal_task_tools/_deepdiff.py,sha256=M3YZbAhZZx6iiAFvORZpxNENBpWmdEqkG29UJ7dFAcA,2239
 fractal_task_tools/_descriptions.py,sha256=n7WcoIBQ4FEd16BI26iL-Sh6bEQ76jlU32JfJBF4U0A,7566
 fractal_task_tools/_package_name_tools.py,sha256=_UT2cThh742V6M0XT9m0_aByhj5fXRSjATKt_MIXFVg,819
 fractal_task_tools/_pydantic_generatejsonschema.py,sha256=qZuID7YUXOdAcL8OqsWjNFNumOIAgdJillc1lA2cHIY,3136
@@ -10,9 +12,9 @@ fractal_task_tools/_task_docs.py,sha256=aEXozSKf3a7weOwJMHyTVJTvHlCKgDr1qoU-AAO3
 fractal_task_tools/_titles.py,sha256=GLWn-06fgQD6qzOM75H59EV0MMCXc8jVpHqGanYzNbw,3000
 fractal_task_tools/task_models.py,sha256=kgvEv5NQD8e8I9tyaFrnvxUxbKm6vH63r-cnID1jHE8,2269
 fractal_task_tools/task_wrapper.py,sha256=dhphKgxDm4EUxZnsrAy20hJPD6bGdqx7tNg9N_QzlCo,1878
-fractal_task_tools-0.0.6.dist-info/LICENSE,sha256=1SGAsQ3Jm_nIU7c2TgtTZe_IOKjm9BDsrcf2r98xrdk,1584
-fractal_task_tools-0.0.6.dist-info/METADATA,sha256=OCA3qxgE3rb_Yn3yUQz_qHT2PiHT4GybeJEtQhqu0SU,4208
-fractal_task_tools-0.0.6.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
-fractal_task_tools-0.0.6.dist-info/entry_points.txt,sha256=zE4qv7QhuiqN6DaPkmJV18X1xyYoUi0HIJ-uAg2M6TU,66
-fractal_task_tools-0.0.6.dist-info/top_level.txt,sha256=2VBpiMDIBMJGOEPiHHX3njYEZGLhr4L0nu8vfkcNVzw,19
-fractal_task_tools-0.0.6.dist-info/RECORD,,
+fractal_task_tools-0.0.7.dist-info/LICENSE,sha256=1SGAsQ3Jm_nIU7c2TgtTZe_IOKjm9BDsrcf2r98xrdk,1584
+fractal_task_tools-0.0.7.dist-info/METADATA,sha256=93L2GIU-i1gVuUE4IjAh-x1vgp-iHhWuIQRol1gucmk,4208
+fractal_task_tools-0.0.7.dist-info/WHEEL,sha256=beeZ86-EfXScwlR_HKu4SllMC9wUEj_8Z_4FJ3egI2w,91
+fractal_task_tools-0.0.7.dist-info/entry_points.txt,sha256=zE4qv7QhuiqN6DaPkmJV18X1xyYoUi0HIJ-uAg2M6TU,66
+fractal_task_tools-0.0.7.dist-info/top_level.txt,sha256=2VBpiMDIBMJGOEPiHHX3njYEZGLhr4L0nu8vfkcNVzw,19
+fractal_task_tools-0.0.7.dist-info/RECORD,,

{fractal_task_tools-0.0.6.dist-info → fractal_task_tools-0.0.7.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (76.0.0)
+Generator: setuptools (76.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any