lollms-client 1.1.3__py3-none-any.whl → 1.3.1__py3-none-any.whl

lollms_client/lollms_tti_binding.py

@@ -1,10 +1,10 @@
-# lollms_client/lollms_tti_binding.py
 from abc import ABC, abstractmethod
 import importlib
 from pathlib import Path
 from typing import Optional, List, Dict, Any, Union
 from ascii_colors import trace_exception
 import yaml
+
 class LollmsTTIBinding(ABC):
     """Abstract base class for all LOLLMS Text-to-Image bindings."""
 
@@ -44,34 +44,42 @@ class LollmsTTIBinding(ABC):
         pass
 
     @abstractmethod
-    def list_services(self, **kwargs) -> List[Dict[str, str]]:
+    def edit_image(self,
+                   images: Union[str, List[str]],
+                   prompt: str,
+                   negative_prompt: Optional[str] = "",
+                   mask: Optional[str] = None,
+                   width: Optional[int] = None,
+                   height: Optional[int] = None,
+                   **kwargs) -> bytes:
         """
-        Lists the available TTI services or models supported by the binding.
-        This might require authentication depending on the implementation.
+        Edits an image or a set of images based on the provided prompts.
 
         Args:
-            **kwargs: Additional binding-specific parameters (e.g., client_id).
+            images (Union[str, List[str]]): One or multiple images in URL or base64 format.
+            prompt (str): Positive prompt describing desired modifications.
+            negative_prompt (Optional[str]): Prompt describing elements to avoid.
+            mask (Optional[str]): A mask image (URL or base64). Only valid if a single image is provided.
+            width (Optional[int]): Desired width of the output. If None, binding decides.
+            height (Optional[int]): Desired height of the output. If None, binding decides.
+            **kwargs: Additional binding-specific parameters (e.g., seed, steps, cfg_scale).
 
         Returns:
-            List[Dict[str, str]]: A list of dictionaries, each describing a service
-                                  (e.g., {"name": "...", "caption": "...", "help": "..."}).
+            bytes: The edited/generated image data (e.g., in PNG or JPEG format).
+
+        Raises:
+            Exception: If image editing fails.
         """
         pass
 
+    @abstractmethod
+    def list_services(self, **kwargs) -> List[Dict[str, str]]:
+        """Lists the available TTI services or models supported by the binding."""
+        pass
 
     @abstractmethod
     def get_settings(self, **kwargs) -> Optional[Dict[str, Any]]:
-        """
-        Retrieves the current settings for the active TTI service/model.
-        This might require authentication depending on the implementation.
-
-        Args:
-            **kwargs: Additional binding-specific parameters (e.g., client_id).
-
-        Returns:
-            Optional[Dict[str, Any]]: A dictionary representing the settings structure
-                                     (often a list matching ConfigTemplate format) or None if not supported/failed.
-        """
+        """Retrieves the current settings for the active TTI service/model."""
         pass
 
     @abstractmethod
@@ -81,35 +89,18 @@ class LollmsTTIBinding(ABC):
 
     @abstractmethod
     def set_settings(self, settings: Dict[str, Any], **kwargs) -> bool:
-        """
-        Applies new settings to the active TTI service/model.
-        This might require authentication depending on the implementation.
-
-        Args:
-            settings (Dict[str, Any]): The new settings to apply (structure depends on the service).
-            **kwargs: Additional binding-specific parameters (e.g., client_id).
-
-        Returns:
-            bool: True if settings were applied successfully, False otherwise.
-        """
+        """Applies new settings to the active TTI service/model."""
         pass
 
+
 class LollmsTTIBindingManager:
     """Manages TTI binding discovery and instantiation."""
 
     def __init__(self, tti_bindings_dir: Union[str, Path] = Path(__file__).parent.parent / "tti_bindings"):
-        """
-        Initialize the LollmsTTIBindingManager.
-
-        Args:
-            tti_bindings_dir (Union[str, Path]): Directory containing TTI binding implementations.
-                                                 Defaults to the "tti_bindings" subdirectory.
-        """
         self.tti_bindings_dir = Path(tti_bindings_dir)
         self.available_bindings = {}
 
     def _load_binding(self, binding_name: str):
-        """Dynamically load a specific TTI binding implementation."""
         binding_dir = self.tti_bindings_dir / binding_name
         if binding_dir.is_dir() and (binding_dir / "__init__.py").exists():
             try:
@@ -123,16 +114,6 @@ class LollmsTTIBindingManager:
     def create_binding(self,
                       binding_name: str,
                       **kwargs) -> Optional[LollmsTTIBinding]:
-        """
-        Create an instance of a specific TTI binding.
-
-        Args:
-            binding_name (str): Name of the TTI binding to create.
-            **kwargs: Additional parameters specific to the binding's __init__.
-
-        Returns:
-            Optional[LollmsTTIBinding]: Binding instance or None if creation failed.
-        """
         if binding_name not in self.available_bindings:
             self._load_binding(binding_name)
 
@@ -145,10 +126,8 @@ class LollmsTTIBindingManager:
                 print(f"Failed to instantiate TTI binding {binding_name}: {str(e)}")
                 return None
         return None
+
     def _get_fallback_description(binding_name: str) -> Dict:
-        """
-        Generates a default description dictionary for a binding without a description.yaml file.
-        """
         return {
             "binding_name": binding_name,
             "title": binding_name.replace("_", " ").title(),
@@ -190,16 +169,6 @@ class LollmsTTIBindingManager:
 
     @staticmethod
     def get_bindings_list(llm_bindings_dir: Union[str, Path]) -> List[Dict]:
-        """
-        Lists all available LLM bindings by scanning a directory, loading their
-        description.yaml file if present, or providing a default description.
-
-        Args:
-            llm_bindings_dir (Union[str, Path]): The path to the directory containing LLM binding folders.
-
-        Returns:
-            List[Dict]: A list of dictionaries, each describing a binding.
-        """
         bindings_dir = Path(llm_bindings_dir)
         if not bindings_dir.is_dir():
             return []
@@ -225,32 +194,13 @@ class LollmsTTIBindingManager:
                 bindings_list.append(binding_info)
 
         return sorted(bindings_list, key=lambda b: b.get('title', b['binding_name']))
-    def get_available_bindings(self) -> list[str]:
-        """
-        Return list of available TTI binding names based on subdirectories.
 
-        Returns:
-            list[str]: List of binding names.
-        """
+    def get_available_bindings(self) -> list[str]:
         return [binding_dir.name for binding_dir in self.tti_bindings_dir.iterdir()
                 if binding_dir.is_dir() and (binding_dir / "__init__.py").exists()]
 
-def get_available_bindings(tti_bindings_dir: Union[str, Path] = None) -> List[Dict]:
-    """
-    Lists all available LLM bindings with their detailed descriptions.
-
-    This function serves as a primary entry point for discovering what bindings
-    are available and how to configure them.
-
-    Args:
-        llm_bindings_dir (Union[str, Path], optional): 
-            The path to the LLM bindings directory. If None, it defaults to the
-            'llm_bindings' subdirectory relative to this file. 
-            Defaults to None.
 
-    Returns:
-        List[Dict]: A list of dictionaries, each describing a binding.
-    """
+def get_available_bindings(tti_bindings_dir: Union[str, Path] = None) -> List[Dict]:
     if tti_bindings_dir is None:
         tti_bindings_dir = Path(__file__).parent / "tti_bindings"
-    return LollmsTTIBindingManager.get_bindings_list(tti_bindings_dir)
+    return LollmsTTIBindingManager.get_bindings_list(tti_bindings_dir)