More detailed error messages

Author: jazzhaiku

invokeai/app/invocations/metadata.py

@@ -287,14 +287,16 @@ class MetadataFieldExtractorInvocation(BaseInvocation):
     key: str = InputField(description="The key in the image's metadata to extract the value from")
 
     def invoke(self, context: InvocationContext) -> StringOutput:
-        metadata = context.images.get_metadata(image_name=self.image.image_name)
+        image_name = self.image.image_name
+
+        metadata = context.images.get_metadata(image_name=image_name)
         if not metadata:
-            raise ValueError("No metadata found on image")
+            raise ValueError(f"No metadata found on image {image_name}")
 
         try:
             val = metadata.root[self.key]
             if not isinstance(val, str):
                 raise ValueError(f"Metadata at key '{self.key}' must be a string")
             return StringOutput(value=val)
         except KeyError as e:
-            raise ValueError(f"No key {self.key} found in metadata") from e
+            raise ValueError(f"No key '{self.key}' found in the metadata for {image_name}") from e

nodes/README.md

@@ -0,0 +1,51 @@
+# Custom Nodes / Node Packs
+
+Copy your node packs to this directory.
+
+When nodes are added or changed, you must restart the app to see the changes.
+
+## Directory Structure
+
+For a node pack to be loaded, it must be placed in a directory alongside this
+file. Here's an example structure:
+
+```py
+.
+├── __init__.py # Invoke-managed custom node loader
+│
+├── cool_node
+│   ├── __init__.py # see example below
+│   └── cool_node.py
+│
+└── my_node_pack
+    ├── __init__.py # see example below
+    ├── tasty_node.py
+    ├── bodacious_node.py
+    ├── utils.py
+    └── extra_nodes
+        └── fancy_node.py
+```
+
+## Node Pack `__init__.py`
+
+Each node pack must have an `__init__.py` file that imports its nodes.
+
+The structure of each node or node pack is otherwise not important.
+
+Here are examples, based on the example directory structure.
+
+### `cool_node/__init__.py`
+
+```py
+from .cool_node import CoolInvocation
+```
+
+### `my_node_pack/__init__.py`
+
+```py
+from .tasty_node import TastyInvocation
+from .bodacious_node import BodaciousInvocation
+from .extra_nodes.fancy_node import FancyInvocation
+```
+
+Only nodes imported in the `__init__.py` file are loaded.

nodes/__init__.py

@@ -0,0 +1,58 @@
+"""
+Invoke-managed custom node loader. See README.md for more information.
+"""
+
+import sys
+import traceback
+from importlib.util import module_from_spec, spec_from_file_location
+from pathlib import Path
+
+from invokeai.backend.util.logging import InvokeAILogger
+
+logger = InvokeAILogger.get_logger()
+loaded_count = 0
+
+
+for d in Path(__file__).parent.iterdir():
+    # skip files
+    if not d.is_dir():
+        continue
+
+    # skip hidden directories
+    if d.name.startswith("_") or d.name.startswith("."):
+        continue
+
+    # skip directories without an `__init__.py`
+    init = d / "__init__.py"
+    if not init.exists():
+        continue
+
+    module_name = init.parent.stem
+
+    # skip if already imported
+    if module_name in globals():
+        continue
+
+    # load the module, appending adding a suffix to identify it as a custom node pack
+    spec = spec_from_file_location(module_name, init.absolute())
+
+    if spec is None or spec.loader is None:
+        logger.warn(f"Could not load {init}")
+        continue
+
+    logger.info(f"Loading node pack {module_name}")
+
+    try:
+        module = module_from_spec(spec)
+        sys.modules[spec.name] = module
+        spec.loader.exec_module(module)
+
+        loaded_count += 1
+    except Exception:
+        full_error = traceback.format_exc()
+        logger.error(f"Failed to load node pack {module_name}:\n{full_error}")
+
+    del init, module_name
+
+if loaded_count > 0:
+    logger.info(f"Loaded {loaded_count} node packs from {Path(__file__).parent}")