registry.py 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. from __future__ import annotations
  2. """页面注册表。"""
  3. import importlib
  4. from pathlib import Path
  5. from typing import TYPE_CHECKING
  6. if TYPE_CHECKING:
  7. from tasks.GameUi.page_definition import Page
  8. class PageRegistry:
  9. """进程级静态页面注册表。
  10. 该注册表只保存页面定义,不保存任务运行时状态。
  11. """
  12. # 所有静态页面定义,key 为页面唯一标识。
  13. _pages: dict[str, "Page"] = {}
  14. # 已加载过的页面模块,避免重复导入。
  15. _loaded_modules: set[str] = set()
  16. # 是否完成一次全量页面扫描。
  17. _page_modules_loaded = False
  18. @classmethod
  19. def register(cls, page: "Page") -> "Page":
  20. """注册一个静态页面定义。
  21. Args:
  22. page: 待注册的页面定义。
  23. Returns:
  24. 原始页面对象,便于链式使用。
  25. """
  26. cls._pages[page.key] = page
  27. return page
  28. @classmethod
  29. def get(cls, key: str) -> "Page | None":
  30. """按页面 key 获取页面定义。
  31. Args:
  32. key: 页面唯一标识。
  33. Returns:
  34. 页面定义;不存在时返回 `None`。
  35. """
  36. return cls._pages.get(key)
  37. @classmethod
  38. def all(cls, categories: set[str] = None) -> list["Page"]:
  39. """获取所有或指定分类的页面定义。
  40. Args:
  41. categories: 允许返回的页面分类集合;为空时返回全部页面。
  42. Returns:
  43. 页面定义列表。
  44. """
  45. pages = list(cls._pages.values())
  46. if not categories:
  47. return pages
  48. return [page for page in pages if page.category in categories]
  49. @classmethod
  50. def load_all_pages(cls) -> None:
  51. """扫描并导入 `tasks/*/page.py`
  52. 该方法只会执行一次,用于构建静态页面注册表。
  53. """
  54. if cls._page_modules_loaded:
  55. return
  56. base_dir = Path(__file__).resolve().parent.parent
  57. for task_dir in base_dir.iterdir():
  58. if not task_dir.is_dir():
  59. continue
  60. for module_name in ("page",):
  61. module_file = task_dir / f"{module_name}.py"
  62. if not module_file.exists():
  63. continue
  64. import_name = f"tasks.{task_dir.name}.{module_name}"
  65. if import_name in cls._loaded_modules:
  66. continue
  67. importlib.import_module(import_name)
  68. cls._loaded_modules.add(import_name)
  69. cls._page_modules_loaded = True