__init__.py 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. """Cron scheduler provider discovery: bundled ``plugins/cron_providers/<name>/`` then user
  2. ``$HERMES_HOME/plugins/<name>/`` (bundled wins on collision). The built-in InProcessCronScheduler
  3. is core, not discovered here, so the fallback can't be removed; one provider is active
  4. (``cron.provider`` in config.yaml, empty = built-in)."""
  5. from __future__ import annotations
  6. import logging
  7. from pathlib import Path
  8. from typing import List, Optional, Tuple
  9. from plugins import plugin_loader as _loader
  10. logger = logging.getLogger(__name__)
  11. _CRON_PLUGINS_DIR = Path(__file__).parent
  12. # Synthetic parent package for user-installed providers (keeps them out of the bundled namespace).
  13. _USER_NAMESPACE = "_hermes_user_cron"
  14. def _is_cron_provider_dir(path: Path) -> bool:
  15. """Cheap text heuristic: ``__init__.py`` mentions the cron scheduler contract."""
  16. init_file = path / "__init__.py"
  17. if not init_file.exists():
  18. return False
  19. try:
  20. source = init_file.read_text(errors="replace", encoding="utf-8-sig")[:8192]
  21. return "register_cron_scheduler" in source or "CronScheduler" in source
  22. except Exception:
  23. return False
  24. def _user_provider_dirs() -> list[Path]:
  25. """User-installed ``$HERMES_HOME/plugins/<name>/`` dirs that look like cron providers."""
  26. user_dir = _loader.user_plugins_dir()
  27. return [c for c in _loader.iter_plugin_dirs(user_dir) if _is_cron_provider_dir(c)] if user_dir else []
  28. def _iter_provider_dirs() -> list[tuple[str, Path]]:
  29. """``(name, path)`` for bundled then user providers; bundled wins on collisions."""
  30. dirs = [(child.name, child) for child in _loader.iter_plugin_dirs(_CRON_PLUGINS_DIR)]
  31. seen = {name for name, _ in dirs}
  32. dirs.extend((child.name, child) for child in _user_provider_dirs() if child.name not in seen)
  33. return dirs
  34. def find_provider_dir(name: str) -> Optional[Path]:
  35. """Resolve a provider name to its directory (bundled first, then user-installed)."""
  36. bundled = _CRON_PLUGINS_DIR / name
  37. if bundled.is_dir() and (bundled / "__init__.py").exists():
  38. return bundled
  39. user_dir = _loader.user_plugins_dir()
  40. user = user_dir / name if user_dir else None
  41. return user if user and user.is_dir() and _is_cron_provider_dir(user) else None
  42. def discover_cron_schedulers() -> list[tuple[str, str, bool]]:
  43. """Return ``[(name, description, is_available), ...]`` for all discovered providers."""
  44. return [(name, _loader.read_plugin_description(child),
  45. _loader.probe_availability(lambda c=child: _load_provider_from_dir(c)))
  46. for name, child in _iter_provider_dirs()]
  47. def load_cron_scheduler(name: str) -> Optional[CronScheduler]:
  48. """Load a CronScheduler instance by name; None if not found or it fails to load."""
  49. provider_dir = find_provider_dir(name)
  50. if not provider_dir:
  51. logger.debug("Cron provider '%s' not found in bundled or user plugins", name)
  52. return None
  53. return _loader.load_named(
  54. name, provider_dir, _load_provider_from_dir,
  55. kind="Cron provider", noun="provider", logger=logger)
  56. def _load_provider_from_dir(provider_dir: Path) -> Optional[CronScheduler]:
  57. """Import a provider module and extract its CronScheduler (register(ctx) or subclass)."""
  58. from cron.scheduler_provider import CronScheduler
  59. name = provider_dir.name
  60. is_bundled = _CRON_PLUGINS_DIR in provider_dir.parents or provider_dir.parent == _CRON_PLUGINS_DIR
  61. module_name = f"plugins.cron_providers.{name}" if is_bundled else f"{_USER_NAMESPACE}.{name}"
  62. from hermes_cli.plugin_isolation import user_plugin_host
  63. host = None if is_bundled else user_plugin_host()
  64. if host is not None:
  65. return host.load_instance(provider_dir, module_name=module_name, capture="register_cron_scheduler",
  66. base_ref="cron.scheduler_provider:CronScheduler")
  67. mod = _loader.load_plugin_module(
  68. module_name, provider_dir, parents=("plugins", "plugins.cron_providers"), logger=logger,
  69. synthetic_namespace=None if is_bundled else _USER_NAMESPACE)
  70. return mod and _loader.instance_from_module(
  71. mod, collector=_ProviderCollector(), collected_attr="provider",
  72. base_cls=CronScheduler, name=name, logger=logger)
  73. class _ProviderCollector(_loader.NoopPluginContext):
  74. """Fake plugin context that captures register_cron_scheduler calls."""
  75. def __init__(self):
  76. self.provider = None
  77. def register_cron_scheduler(self, provider):
  78. self.provider = provider