|
| 1 | +import inspect |
| 2 | +from pathlib import Path |
| 3 | +from typing import Any, Callable, List, get_type_hints |
| 4 | + |
| 5 | +from pipelex.core.memory.working_memory import WorkingMemory |
| 6 | +from pipelex.core.stuffs.stuff_content import StuffContent |
| 7 | +from pipelex.tools.func_registry import func_registry |
| 8 | +from pipelex.tools.typing.module_inspector import import_module_from_file |
| 9 | + |
| 10 | + |
| 11 | +class FuncRegistryUtils: |
| 12 | + @classmethod |
| 13 | + def register_funcs_in_folder( |
| 14 | + cls, |
| 15 | + folder_path: str, |
| 16 | + is_recursive: bool = True, |
| 17 | + ) -> None: |
| 18 | + """ |
| 19 | + Registers all functions in Python files within a folder that have: |
| 20 | + - Exactly 1 parameter named "working_memory" with type WorkingMemory |
| 21 | + - Return type that is a subclass of StuffContent |
| 22 | +
|
| 23 | + The function name is used as the registry key. |
| 24 | +
|
| 25 | + Args: |
| 26 | + folder_path: Path to folder containing Python files |
| 27 | + is_recursive: Whether to search recursively in subdirectories |
| 28 | + """ |
| 29 | + python_files = cls._find_files_in_dir( |
| 30 | + dir_path=folder_path, |
| 31 | + pattern="*.py", |
| 32 | + is_recursive=is_recursive, |
| 33 | + ) |
| 34 | + |
| 35 | + for python_file in python_files: |
| 36 | + cls._register_funcs_in_file(file_path=str(python_file)) |
| 37 | + |
| 38 | + @classmethod |
| 39 | + def _register_funcs_in_file(cls, file_path: str) -> None: |
| 40 | + """Processes a Python file to find and register eligible functions.""" |
| 41 | + try: |
| 42 | + module = import_module_from_file(file_path) |
| 43 | + |
| 44 | + # Find functions that match criteria |
| 45 | + functions_to_register = cls._find_functions_in_module(module) |
| 46 | + |
| 47 | + for func in functions_to_register: |
| 48 | + func_registry.register_function( |
| 49 | + func=func, |
| 50 | + name=func.__name__, |
| 51 | + should_warn_if_already_registered=True, |
| 52 | + ) |
| 53 | + except Exception as e: |
| 54 | + # Log error but continue processing other files |
| 55 | + print(f"Error processing file {file_path}: {e}") |
| 56 | + |
| 57 | + @classmethod |
| 58 | + def _find_functions_in_module(cls, module: Any) -> List[Callable[..., Any]]: |
| 59 | + """ |
| 60 | + Finds all functions in a module that match the criteria: |
| 61 | + - Exactly 1 parameter named "working_memory" with type WorkingMemory |
| 62 | + - Return type that is a subclass of StuffContent |
| 63 | + """ |
| 64 | + functions: List[Callable[..., Any]] = [] |
| 65 | + module_name = module.__name__ |
| 66 | + |
| 67 | + # Find all functions in the module (not imported ones) |
| 68 | + for _, obj in inspect.getmembers(module, inspect.isfunction): |
| 69 | + # Skip functions imported from other modules |
| 70 | + if obj.__module__ != module_name: |
| 71 | + continue |
| 72 | + |
| 73 | + if cls._is_eligible_function(obj): |
| 74 | + functions.append(obj) |
| 75 | + |
| 76 | + return functions |
| 77 | + |
| 78 | + @classmethod |
| 79 | + def _is_eligible_function(cls, func: Callable[..., Any]) -> bool: |
| 80 | + """ |
| 81 | + Checks if a function matches the criteria: |
| 82 | + - Exactly 1 parameter named "working_memory" with type WorkingMemory |
| 83 | + - Return type that is a subclass of StuffContent |
| 84 | + """ |
| 85 | + try: |
| 86 | + # Get function signature |
| 87 | + sig = inspect.signature(func) |
| 88 | + params = list(sig.parameters.values()) |
| 89 | + |
| 90 | + # Check parameter count and name |
| 91 | + if len(params) != 1: |
| 92 | + return False |
| 93 | + |
| 94 | + param = params[0] |
| 95 | + if param.name != "working_memory": |
| 96 | + return False |
| 97 | + |
| 98 | + # Get type hints |
| 99 | + type_hints = get_type_hints(func) |
| 100 | + |
| 101 | + # Check parameter type |
| 102 | + if "working_memory" not in type_hints: |
| 103 | + return False |
| 104 | + |
| 105 | + param_type = type_hints["working_memory"] |
| 106 | + if param_type != WorkingMemory: |
| 107 | + return False |
| 108 | + |
| 109 | + # Check return type |
| 110 | + if "return" not in type_hints: |
| 111 | + return False |
| 112 | + |
| 113 | + return_type = type_hints["return"] |
| 114 | + |
| 115 | + # Check if return type is a subclass of StuffContent |
| 116 | + try: |
| 117 | + if inspect.isclass(return_type) and issubclass(return_type, StuffContent): |
| 118 | + return True |
| 119 | + # Handle generic types like ListContent[SomeType] |
| 120 | + if hasattr(return_type, "__origin__"): |
| 121 | + origin = getattr(return_type, "__origin__") |
| 122 | + if inspect.isclass(origin) and issubclass(origin, StuffContent): |
| 123 | + return True |
| 124 | + except TypeError: |
| 125 | + # Handle cases where issubclass fails on generic types |
| 126 | + pass |
| 127 | + |
| 128 | + return False |
| 129 | + |
| 130 | + except Exception: |
| 131 | + # If we can't analyze the function, skip it |
| 132 | + return False |
| 133 | + |
| 134 | + @classmethod |
| 135 | + def _find_files_in_dir(cls, dir_path: str, pattern: str, is_recursive: bool) -> List[Path]: |
| 136 | + """ |
| 137 | + Find files matching a pattern in a directory. |
| 138 | +
|
| 139 | + Args: |
| 140 | + dir_path: Directory path to search in |
| 141 | + pattern: File pattern to match (e.g. "*.py") |
| 142 | + is_recursive: Whether to search recursively in subdirectories |
| 143 | +
|
| 144 | + Returns: |
| 145 | + List of matching Path objects |
| 146 | + """ |
| 147 | + path = Path(dir_path) |
| 148 | + if is_recursive: |
| 149 | + return list(path.rglob(pattern)) |
| 150 | + else: |
| 151 | + return list(path.glob(pattern)) |
0 commit comments