block.py 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. """block.py — Block 相关 Schema"""
  2. from typing import Optional
  3. from pydantic import BaseModel, Field
  4. class BlockBase(BaseModel):
  5. """Block 基础信息"""
  6. id: str = Field(..., validation_alias="id", serialization_alias="id")
  7. block_order: int = Field(..., validation_alias="blockOrder", serialization_alias="blockOrder")
  8. type: str = Field(..., validation_alias="type", serialization_alias="type")
  9. level: int = Field(..., validation_alias="level", serialization_alias="level")
  10. index: int = Field(..., validation_alias="index", serialization_alias="index")
  11. content: str | dict | list = Field(..., validation_alias="content", serialization_alias="content")
  12. word_style: str = Field(..., validation_alias="wordStyle", serialization_alias="wordStyle")
  13. style: dict = Field(..., validation_alias="style", serialization_alias="style")
  14. metadata: dict = Field(..., validation_alias="metadata", serialization_alias="metadata")
  15. class Config:
  16. populate_by_name = True
  17. class BlockUpdate(BaseModel):
  18. """Block 更新请求"""
  19. content: Optional[str | dict | list] = None
  20. style: Optional[dict] = None
  21. word_style: Optional[str] = None
  22. metadata: Optional[dict] = None
  23. class BlockCreate(BaseModel):
  24. """Block 创建请求(id/index/block_order 自动生成,heading 需 level 1-6,其他类型 level=0)"""
  25. type: str
  26. level: int = 0 # heading 类型必填(1-6),其他类型默认 0
  27. content: str | dict | list
  28. word_style: str = ""
  29. style: dict = {}
  30. metadata: dict = {}
  31. after_block_id: Optional[str] = None # 在哪个 block 后插入(null = 末尾)
  32. class TOCContent(BaseModel):
  33. """TOC Block content 结构"""
  34. title: str = "目录"
  35. class TOCConfig(BaseModel):
  36. """TOC 配置"""
  37. levels: str = "1-1" # 包含的标题层级
  38. use_hyperlinks: bool = True
  39. use_page_numbers: bool = True
  40. hide_page_numbers_in_web: bool = True
  41. use_outline_levels: bool = True
  42. show_leader_dots: bool = True
  43. leader_char: str = "."
  44. class TOCMetadata(BaseModel):
  45. """TOC Block metadata 结构"""
  46. toc_config: TOCConfig
  47. is_auto_generated: bool = True
  48. readonly: bool = True
  49. deletable: bool = True
  50. class TOCBlock(BaseModel):
  51. """完整的 TOC Block"""
  52. id: str
  53. block_order: int = Field(..., serialization_alias="blockOrder")
  54. type: str = "toc"
  55. level: int = 0
  56. index: int = 0
  57. content: TOCContent
  58. word_style: str = "TOC"
  59. metadata: TOCMetadata
  60. class Config:
  61. populate_by_name = True
  62. class TOCItem(BaseModel):
  63. """目录树节点"""
  64. id: str
  65. level: int
  66. content: str
  67. children: list['TOCItem'] = []
  68. class BlockSearchResult(BaseModel):
  69. """Block 搜索结果"""
  70. blocks: list[BlockBase]
  71. total: int
  72. class BlockStats(BaseModel):
  73. """Block 统计信息"""
  74. total: int
  75. by_type: dict[str, int] = Field(..., alias="byType")
  76. class Config:
  77. populate_by_name = True