diodiogod
f267739aab
Fix dependency checker false missing-package warnings Technical details: - Stop using eager module imports as the primary dependency probe - Check module specs and installed distributions before fallback import - Reduce false negatives for heavy packages like diffusers during background checks
247 lines
9.3 KiB
Python
247 lines
9.3 KiB
Python
"""
|
||
Dependency checker for TTS Audio Suite initialization.
|
||
Warns users about missing dependencies based on enabled engines.
|
||
Supports both synchronous and asynchronous background checking.
|
||
"""
|
||
|
||
import importlib
|
||
import importlib.util
|
||
import sys
|
||
import threading
|
||
import time
|
||
from typing import List, Dict, Tuple, Optional, Callable
|
||
|
||
|
||
class DependencyChecker:
|
||
"""Check for missing dependencies and provide helpful warnings."""
|
||
|
||
# Core dependencies that should always be available
|
||
CORE_DEPENDENCIES = [
|
||
('torch', 'torch'),
|
||
('numpy', 'numpy'),
|
||
('soundfile', 'soundfile'),
|
||
('librosa', 'librosa'),
|
||
]
|
||
|
||
# Engine-specific dependencies
|
||
ENGINE_DEPENDENCIES = {
|
||
'chatterbox': [
|
||
('s3tokenizer', 's3tokenizer'),
|
||
('transformers', 'transformers'),
|
||
('diffusers', 'diffusers'),
|
||
],
|
||
'f5tts': [
|
||
('f5_tts', 'f5-tts'),
|
||
('cached_path', 'cached-path'),
|
||
],
|
||
'higgs_audio': [
|
||
('dac', 'descript-audio-codec'),
|
||
('vector_quantize_pytorch', 'vector-quantize-pytorch'),
|
||
('dacite', 'dacite'),
|
||
],
|
||
'rvc': [
|
||
('faiss', 'faiss-cpu'),
|
||
('onnxruntime', 'onnxruntime-gpu'),
|
||
('torchcrepe', 'torchcrepe'), # Installed with --no-deps but checked via importlib.metadata
|
||
]
|
||
}
|
||
|
||
@staticmethod
|
||
def check_dependency(module_name: str, package_name: Optional[str] = None) -> bool:
|
||
"""Check if a dependency is installed without eagerly importing it."""
|
||
try:
|
||
if importlib.util.find_spec(module_name) is not None:
|
||
return True
|
||
except (ImportError, ModuleNotFoundError, ValueError, AttributeError):
|
||
pass
|
||
|
||
distribution_names = []
|
||
if package_name:
|
||
distribution_names.append(package_name)
|
||
if module_name not in distribution_names:
|
||
distribution_names.append(module_name)
|
||
|
||
try:
|
||
from importlib.metadata import PackageNotFoundError, version
|
||
|
||
for dist_name in distribution_names:
|
||
try:
|
||
version(dist_name)
|
||
return True
|
||
except PackageNotFoundError:
|
||
continue
|
||
except Exception:
|
||
pass
|
||
|
||
# Last-resort import check for odd packages that hide their module spec.
|
||
try:
|
||
importlib.import_module(module_name)
|
||
return True
|
||
except Exception:
|
||
return False
|
||
|
||
@staticmethod
|
||
def check_core_dependencies() -> List[Tuple[str, str]]:
|
||
"""Check core dependencies that are always needed."""
|
||
missing = []
|
||
for module_name, package_name in DependencyChecker.CORE_DEPENDENCIES:
|
||
if not DependencyChecker.check_dependency(module_name, package_name):
|
||
missing.append((module_name, package_name))
|
||
return missing
|
||
|
||
@staticmethod
|
||
def check_engine_dependencies(engine: str) -> List[Tuple[str, str]]:
|
||
"""Check dependencies for a specific engine."""
|
||
if engine not in DependencyChecker.ENGINE_DEPENDENCIES:
|
||
return []
|
||
|
||
missing = []
|
||
for module_name, package_name in DependencyChecker.ENGINE_DEPENDENCIES[engine]:
|
||
if not DependencyChecker.check_dependency(module_name, package_name):
|
||
missing.append((module_name, package_name))
|
||
return missing
|
||
|
||
@staticmethod
|
||
def get_missing_dependencies_report() -> str:
|
||
"""Generate a comprehensive missing dependencies report."""
|
||
report_lines = []
|
||
|
||
# Check core dependencies
|
||
core_missing = DependencyChecker.check_core_dependencies()
|
||
if core_missing:
|
||
report_lines.append("⚠️ CRITICAL: Missing core dependencies:")
|
||
for module_name, package_name in core_missing:
|
||
report_lines.append(f" • {package_name} (import: {module_name})")
|
||
report_lines.append("")
|
||
|
||
# Check engine-specific dependencies
|
||
engine_issues = {}
|
||
for engine in DependencyChecker.ENGINE_DEPENDENCIES:
|
||
missing = DependencyChecker.check_engine_dependencies(engine)
|
||
if missing:
|
||
engine_issues[engine] = missing
|
||
|
||
if engine_issues:
|
||
report_lines.append("⚠️ Engine-specific missing dependencies:")
|
||
for engine, missing_deps in engine_issues.items():
|
||
engine_display = {
|
||
'chatterbox': 'ChatterBox TTS',
|
||
'f5tts': 'F5-TTS',
|
||
'higgs_audio': 'Higgs Audio 2',
|
||
'rvc': 'RVC Voice Conversion'
|
||
}.get(engine, engine)
|
||
|
||
report_lines.append(f" {engine_display}:")
|
||
for module_name, package_name in missing_deps:
|
||
report_lines.append(f" • {package_name} (import: {module_name})")
|
||
report_lines.append("")
|
||
|
||
if core_missing or engine_issues:
|
||
report_lines.append("🔧 To fix: pip install -r requirements.txt")
|
||
report_lines.append(" Or install specific packages: pip install <package_name>")
|
||
|
||
if engine_issues:
|
||
report_lines.append("")
|
||
report_lines.append("ℹ️ Note: Engine nodes will fail to load without their dependencies")
|
||
|
||
return "\n".join(report_lines) if report_lines else ""
|
||
|
||
@staticmethod
|
||
def get_startup_warnings() -> List[str]:
|
||
"""Get dependency warnings in ComfyUI startup format (list of strings)."""
|
||
warnings = []
|
||
|
||
# Check core dependencies
|
||
core_missing = DependencyChecker.check_core_dependencies()
|
||
if core_missing:
|
||
warnings.append("⚠️ Critical dependencies missing:")
|
||
for module_name, package_name in core_missing:
|
||
warnings.append(f" • {package_name} (import: {module_name})")
|
||
|
||
# Check engine-specific dependencies
|
||
engine_issues = {}
|
||
for engine in DependencyChecker.ENGINE_DEPENDENCIES:
|
||
missing = DependencyChecker.check_engine_dependencies(engine)
|
||
if missing:
|
||
engine_issues[engine] = missing
|
||
|
||
if engine_issues:
|
||
warnings.append("⚠️ Engine dependencies missing:")
|
||
for engine, missing_deps in engine_issues.items():
|
||
engine_display = {
|
||
'chatterbox': 'ChatterBox TTS',
|
||
'f5tts': 'F5-TTS',
|
||
'higgs_audio': 'Higgs Audio 2',
|
||
'rvc': 'RVC Voice Conversion'
|
||
}.get(engine, engine)
|
||
|
||
warnings.append(f" {engine_display}:")
|
||
for module_name, package_name in missing_deps:
|
||
warnings.append(f" • {package_name} (import: {module_name})")
|
||
|
||
if core_missing or engine_issues:
|
||
warnings.append("🔧 Fix: pip install -r requirements.txt")
|
||
warnings.append("ℹ️ Engine nodes will fail without dependencies")
|
||
|
||
return warnings
|
||
|
||
|
||
class AsyncDependencyChecker:
|
||
"""Background dependency checker that runs after ComfyUI loads."""
|
||
|
||
def __init__(self):
|
||
"""Initialize async checker."""
|
||
self._check_thread = None
|
||
self._stop_check = False
|
||
self._results_callback = None
|
||
self._lock = threading.Lock()
|
||
|
||
def start_background_check(self, callback: Optional[Callable[[List[str]], None]] = None):
|
||
"""
|
||
Start background dependency check.
|
||
|
||
Args:
|
||
callback: Optional callback function to call with results (or print if None)
|
||
"""
|
||
if self._check_thread is not None and self._check_thread.is_alive():
|
||
return # Already running
|
||
|
||
self._results_callback = callback
|
||
self._stop_check = False
|
||
self._check_thread = threading.Thread(target=self._check_worker, daemon=True)
|
||
self._check_thread.start()
|
||
|
||
def _check_worker(self):
|
||
"""Background worker thread - performs dependency check."""
|
||
try:
|
||
# Give ComfyUI time to fully load before checking
|
||
time.sleep(2)
|
||
|
||
if self._stop_check:
|
||
return
|
||
|
||
# Get warnings (this may take a moment)
|
||
warnings = DependencyChecker.get_startup_warnings()
|
||
|
||
if self._stop_check:
|
||
return
|
||
|
||
# Report results
|
||
if warnings:
|
||
with self._lock:
|
||
if self._results_callback:
|
||
self._results_callback(warnings)
|
||
else:
|
||
# Default: print to console
|
||
print("📋 System Dependencies (background check):")
|
||
for warning in warnings:
|
||
print(f" {warning}")
|
||
except Exception:
|
||
pass # Silently fail - dependency check is optional
|
||
|
||
def stop(self):
|
||
"""Stop the background check thread."""
|
||
self._stop_check = True
|
||
if self._check_thread and self._check_thread.is_alive():
|
||
self._check_thread.join(timeout=1)
|