add model_field doc

Author: allmonday

requirement.txt

@@ -9,7 +9,7 @@ h11==0.14.0
 httptools==0.6.1
 idna==3.6
 pydantic==2.5.2
-pydantic2-resolve==1.1.0
+pydantic2-resolve==1.1.3
 pydantic_core==2.14.5
 python-dotenv==1.0.0
 PyYAML==6.0.1
@@ -22,4 +22,4 @@ uvloop==0.19.0
 watchfiles==0.21.0
 websockets==12.0
 pytest==7.4.4
-pytest-asyncio=0.23.3
+pytest-asyncio==0.23.3

src/router/sample_4/readme-cn.md

@@ -66,4 +66,31 @@ class Sample4TeamDetail(tms.Team):
         self.description = f'team: {self.name} has {self.task_count} tasks in total.' 
 ```
 
-利用这个功能, 我们在复用相同的数据时, 可以做很多定制化的修改.
+利用这个功能, 我们在复用相同的数据时, 可以做很多定制化的修改.
+
+
+## 隐藏/过滤字段
+
+在上个案例中, 可能会有一个疑问, 这些task_count 有一些层级, 如果我不像返回回去呢? 我想将它在返回中屏蔽掉该怎么做?
+
+对于这种对外隐藏字段的需求, 可以使用 model_config 装饰器来实现.
+
+```python
+@model_config()
+class Sample4StoryDetail(ss.Story):
+    tasks: list[Sample4TaskDetail] = []
+    def resolve_tasks(self, loader=LoaderDepend(tl.story_to_task_loader)):
+        return loader.load(self.id)
+    
+    task_count: int = Field(default=0, exclude=True)
+    def post_task_count(self):
+        return len(self.tasks)
+```
+
+两个改动, 一个是添加了 `model_config`装饰器, 另一个是用 `Field(exclude=True)` 来申明类型.
+
+在pydantic 中,如果exclude=True, 则会在输出中屏蔽该字段, 但是 schema 中依然能看到这个字段. 
+
+如果搭配了 `model_config` 就可以保证在 schema properties 中也屏蔽该字段.
+
+可以将代码中的注释移除后测试.

src/router/sample_4/schema.py

@@ -1,5 +1,6 @@
 from typing import List, Optional
-from pydantic2_resolve import LoaderDepend
+from pydantic import Field
+from pydantic2_resolve import LoaderDepend, model_config
 
 import src.services.task.loader as tl
 import src.services.user.loader as ul
@@ -17,21 +18,25 @@ class Sample4TaskDetail(ts.Task):
     def resolve_user(self, loader=LoaderDepend(ul.user_batch_loader)):
         return loader.load(self.owner_id)
 
+# @model_config()
 class Sample4StoryDetail(ss.Story):
     tasks: list[Sample4TaskDetail] = []
     def resolve_tasks(self, loader=LoaderDepend(tl.story_to_task_loader)):
         return loader.load(self.id)
 
     task_count: int = 0
+    # task_count: int = Field(default=0, exclude=True)
     def post_task_count(self):
         return len(self.tasks)
 
+# @model_config()
 class Sample4SprintDetail(sps.Sprint):
     stories: list[Sample4StoryDetail] = []
     def resolve_stories(self, loader=LoaderDepend(sl.sprint_to_story_loader)):
         return loader.load(self.id)
 
     task_count: int = 0
+    # task_count: int = Field(default=0, exclude=True)
     def post_task_count(self):
         return sum([s.task_count for s in self.stories])