重命名control为formitem

Author: Chise1

fast_tmp/amis/control.py fast_tmp/amis/formitem.pyfast_tmp/amis/control.py renamed to fast_tmp/amis/formitem.py

@@ -14,10 +14,10 @@
 from pydantic import BaseModel
 
 from .column import Column, SelectOption
-from .style import FormWidgetSize, ItemModel
+from .style import FormWidgetSize, Mode
 
 
-class ControlEnum(str, Enum):
+class FormItemEnum(str, Enum):
     form = "form"  # 表单
     button_group_select = "button-group-select"  # 按钮点选
     chained_select = "chained-select"  # 链式下拉框
@@ -78,7 +78,7 @@ class AbstractControl(Column):
     pass
 
 
-class Control(AbstractControl):
+class FormItem(AbstractControl):
     """
     用户form表单等写入
     """
@@ -105,7 +105,7 @@ class Control(AbstractControl):
     className: Optional[str]  # 表单最外层类名
     inputClassName: Optional[str]  # 表单控制器类名
     labelClassName: Optional[str]  # label 的类名
-    mode: Optional[ItemModel]
+    mode: Optional[Mode]
     size: Optional[FormWidgetSize]
 
     class Config:
@@ -131,8 +131,8 @@ class ItemValidationError(BaseModel):
     pass
 
 
-class NumberItem(Control):
-    type: ControlEnum = ControlEnum.input_number
+class NumberItem(FormItem):
+    type: FormItemEnum = FormItemEnum.input_number
     min: Optional[int]
     max: Optional[int]
     precision: Optional[int]  # 小数点后几位
@@ -142,12 +142,12 @@ class NumberItem(Control):
     big: Optional[bool]
 
 
-class NativeNumber(Control):
-    type: ControlEnum = ControlEnum.native_number
+class NativeNumber(FormItem):
+    type: FormItemEnum = FormItemEnum.native_number
 
 
-class SelectItem(Control):
-    type: ControlEnum = ControlEnum.select
+class SelectItem(FormItem):
+    type: FormItemEnum = FormItemEnum.select
     options: Optional[Union[List[str], List[int], List[SelectOption]]]
     source: Optional[str]  # 通过数据源里面获取，也可以配置地址从远程获取，值格式为:options:[{label:..,value:...,}]
     # children: Optional[List[Union[SelectOption, str, int]]]  # 这个在树结构在考虑
@@ -189,8 +189,8 @@ class SelectItemCanModifyItem(SelectItem):
     deleteApi: Optional[str]  # 配置删除接口
 
 
-class ArrayItem(Control):
-    type: ControlEnum = ControlEnum.array
+class ArrayItem(FormItem):
+    type: FormItemEnum = FormItemEnum.array
     items: str = "text"  # 这个到时候改为枚举
     addable: bool = True  # 是否可新增
     removable: bool = True  # 是否可删除
@@ -202,8 +202,8 @@ class ArrayItem(Control):
     maxLength: Optional[int]  # 最长长度
 
 
-class DatetimeItem(Control):
-    type: ControlEnum = ControlEnum.input_datetime
+class DatetimeItem(FormItem):
+    type: FormItemEnum = FormItemEnum.input_datetime
     value: Optional[str]
     format: str = "YYYY-MM-DD HH:mm:ss"  # 'X'为时间戳格式,参考文档：
     # https://baidu.gitee.io/amis/zh-CN/docs/components/form/datetime
@@ -219,8 +219,8 @@ class Config:
         orm_mode = True
 
 
-class DateItem(Control):
-    type = ControlEnum.date
+class DateItem(FormItem):
+    type = FormItemEnum.date
     value: Optional[str]
     format: str = "YYYY-MM-DD"  # 格式请参考文档：https://baidu.gitee.io/amis/zh-CN/docs/components/form/date  # 'X'为时间戳格式
     inputFormat: str = "YYYY-MM-DD"  # 'X'为时间戳格式
@@ -232,44 +232,44 @@ class Config:
         orm_mode = True
 
 
-class SwitchItem(Control):
+class SwitchItem(FormItem):
     # Switch 开关
-    type = ControlEnum.switch
+    type = FormItemEnum.switch
     option: Optional[str]
     trueValue: Optional[int]
     falseValue: Optional[int]
     value: Optional[bool]
 
 
-class RichTextItem(Control):
+class RichTextItem(FormItem):
     # 目前富文本编辑器基于两个库：froala 和 tinymce，默认使用 tinymce。
-    type = ControlEnum.input_rich_text
+    type = FormItemEnum.input_rich_text
     body: Optional[Dict[str, Any]]
     options: Optional[Dict[str, Any]]
     receiver: Optional[str]
     videoReceiver: Optional[str]
     fileField: Optional[str]
 
 
-class TextItem(Control):
-    type = ControlEnum.input_text
+class TextItem(FormItem):
+    type = FormItemEnum.input_text
     body: Optional[Dict[str, Any]]
     trimContents: Optional[bool]  # 是否去除首尾空白文本。
     # resetValue: str = ""  # 清除后设置此配置项给定的值。
 
 
-class TextareaItem(Control):
+class TextareaItem(FormItem):
     # Textarea 多行文本输入框
-    type = ControlEnum.textarea
+    type = FormItemEnum.textarea
     body: Optional[Dict[str, Any]]
     minRows: Optional[int]  # 最小行数
     maxRows: Optional[int]  # 最大行数
     trimContents: Optional[bool]  # 是否去除首尾空白文本。
 
 
-class TimeItem(Control):
+class TimeItem(FormItem):
     # Time 时间
-    type = ControlEnum.time
+    type = FormItemEnum.time
     body: Optional[Dict[str, Any]]
     value: Optional[datetime.time]  # 默认值
     timeFormat: str = "HH:mm:ss"  # 时间选择器值格式，更多格式类型请参考 moment
@@ -282,19 +282,19 @@ class Config:
         orm_mode = True
 
 
-class UUIDItem(Control):
+class UUIDItem(FormItem):
     # 随机生成一个 id，可以用于防止表单重复提交。
-    type = ControlEnum.uuid
+    type = FormItemEnum.uuid
     name: Optional[str]  # type: ignore
     length: Optional[int]
 
 
-class CheckboxesItem(Control):
+class CheckboxesItem(FormItem):
     """
     复选框
     """
 
-    type = ControlEnum.checkboxes
+    type = FormItemEnum.checkboxes
     optional: Optional[Union[List[Dict[str, str]]]]  # 选项组
     source: str  # 动态选项组
     delimeter: bool = False  # 拼接符
@@ -323,9 +323,9 @@ class DynaticCheckboxesItem(CheckboxesItem):
     deleteApi: Optional[str]  # 配置删除选项接口
 
 
-class TransferItem(Control):
+class TransferItem(FormItem):
     # Transfer 穿梭器
-    type = ControlEnum.transfer
+    type = FormItemEnum.transfer
     options: Optional[List[Union[dict, str]]]  # 选项组
     source: Optional[str]  # 动态选项组
     delimeter: Optional[str]  # 拼接符
@@ -358,9 +358,9 @@ class PickerSchema(BaseModel):
     columns: Optional[List[Column]]
 
 
-class PickerItem(Control):
+class PickerItem(FormItem):
     # 列表选取，在功能上和 Select 类似，但它能显示更复杂的信息。默认和 Select 很像，但请看后面的 pickerSchema 设置。
-    type = ControlEnum.picker
+    type = FormItemEnum.picker
     options: Optional[List[Dict[str, str]]]  # 动态选项组
     source: Optional[str]
     multiple: bool = False
@@ -375,14 +375,14 @@ class PickerItem(Control):
     embed: Optional[bool]  # 是否使用内嵌模式
 
 
-class FileItem(Control):
-    type = ControlEnum.input_file
+class FileItem(FormItem):
+    type = FormItemEnum.input_file
     receiver: str
     asBase64: bool = True
 
 
-class ImageItem(Control):
-    type = ControlEnum.input_image
+class ImageItem(FormItem):
+    type = FormItemEnum.input_image
 
     receiver: str
 

fast_tmp/amis/forms/__init__.py

@@ -1,7 +1,7 @@
 from typing import List, Optional
 
 from fast_tmp.amis.base import BaseAmisModel
-from fast_tmp.amis.control import AbstractControl
+from fast_tmp.amis.formitem import AbstractControl
 
 
 class Form(BaseAmisModel):

fast_tmp/amis/style.py

@@ -21,7 +21,7 @@ class FormWidgetSize(
     xs = "xs"  # 极小
 
 
-class ItemModel(str, Enum):
+class Mode(str, Enum):
     horizontal = "horizontal"
     inline = "inline"
     normal = "normal"

fast_tmp/amis/wizard.py

@@ -0,0 +1,46 @@
+from typing import List, Optional
+
+from pydantic import BaseModel
+
+from fast_tmp.amis.base import BaseAmisModel
+from fast_tmp.amis.formitem import FormItem
+
+
+class WizardStep(BaseModel):
+    type: Optional[str] = None
+    title: str  # 步骤标题
+    mode: Optional[str]  # 展示默认，跟 Form 中的模式一样，选择： normal、horizontal或者inline。
+    api: Optional[str]  # 最后一步保存的接口。
+    initApi: Optional[str]  # 初始化数据接口
+    initFetch: Optional[bool]  # 初始是否拉取数据。
+    initFetchOn: Optional[str]  # 初始是否拉取数据，通过表达式来配置
+    Body: List[FormItem]  # 当前步骤的表单项集合，请参考 FormItem。
+
+
+class Wizard(BaseAmisModel):
+    """
+    表单向导，能够配置多个步骤引导用户一步一步完成表单提交。
+    https://aisuda.bce.baidu.com/amis/zh-CN/components/wizard
+    """
+
+    type = "wizard"
+    mode: Optional[str]  # horizontal 或者 vertical
+    api: Optional[str]  # 最后一步保存的接口。
+    initApi: Optional[str]  # 初始化数据接口
+    initFetch: Optional[bool]  # 初始是否拉取数据。
+    initFetchOn: Optional[str]  # 初始是否拉取数据，通过表达式来配置
+    actionPrevLabel: Optional[str]  # 上一步按钮文本
+    actionNextLabel: Optional[str]  # 下一步按钮文本
+    actionNextSaveLabel: Optional[str]  # 保存并下一步按钮文本
+    actionFinishLabel: Optional[str]  # 完成按钮文本
+    className: Optional[str]  # 外层 CSS 类名
+    actionClassName: Optional[str]  # 按钮 CSS 类名
+    reload: Optional[str]  # 操作完后刷新目标对象。请填写目标组件设置的 name 值，如果填写为 window 则让当前页面整体刷新。
+    redirect: Optional[str]  # 操作完后跳转。
+    target: Optional[
+        str
+    ]  # 可以把数据提交给别的组件而不是自己保存。请填写目标组件设置的 name 值，如果填写为 window 则把数据同步到地址栏上，同时依赖这些数据的组件会自动重新刷新。
+    steps: List[WizardStep]  # Array < step > 数组，配置步骤信息
+    startStep: Optional[
+        int
+    ]  # 起始默认值，从第几步开始。可支持模版，但是只有在组件创建时渲染模版并设置当前步数，在之后组件被刷新时，当前 step 不会根据 startStep 改变

fast_tmp/site/__init__.py

@@ -84,18 +84,18 @@ def queryset_filter(self, request: Request, queryset: QuerySet):
         return queryset
 
     def get_create_fields(self) -> Dict[str, BaseAdminControl]:
-        return {i: self.get_control_field(i) for i in self.create_fields}
+        return {i: self.get_formitem_field(i) for i in self.create_fields}
 
     def get_update_fields(self) -> Dict[str, BaseAdminControl]:
-        return {i: self.get_control_field(i) for i in self.update_fields}
+        return {i: self.get_formitem_field(i) for i in self.update_fields}
 
     def get_update_fields_with_pk(self) -> Dict[str, BaseAdminControl]:
         ret = self.get_update_fields()
-        ret["pk"] = self.get_control_field("pk")
+        ret["pk"] = self.get_formitem_field("pk")
         return ret
 
     def get_create_dialogation_button(self, request: Request) -> List[_Action]:
-        controls = self.get_create_fields()
+        formitems = self.get_create_fields()
 
         return [
             DialogAction(
@@ -106,7 +106,7 @@ def get_create_dialogation_button(self, request: Request) -> List[_Action]:
                         name=f"新增{self.name}",
                         title=f"新增{self.name}",
                         # fixme 你的field字段传实例了吗？
-                        body=[(i.get_control(request)) for i in controls.values()],
+                        body=[(i.get_formItem(request)) for i in formitems.values()],
                         api=f"post:{self.prefix}/create",
                     ),
                 ),
@@ -132,7 +132,7 @@ def get_del_one_button(self):
         )
 
     def get_update_one_button(self, request: Request):
-        body = [i.get_control(request) for i in self.get_update_fields().values()]
+        body = [i.get_formItem(request) for i in self.get_update_fields().values()]
         return DialogAction(
             label="修改",
             level=ButtonLevelEnum.link,
@@ -188,14 +188,14 @@ def get_crud(self, request: Request, codenames: List[str]):
         return body
 
     def get_list_distplay(self) -> Dict[str, BaseAdminControl]:
-        return {i: self.get_control_field(i) for i in self.list_display}
+        return {i: self.get_formitem_field(i) for i in self.list_display}
 
     def get_list_display_with_pk(self) -> Dict[str, BaseAdminControl]:
         """
         去除多对多字段
         """
         ret = self.get_list_distplay()
-        ret["pk"] = self.get_control_field("pk")
+        ret["pk"] = self.get_formitem_field("pk")
         return ret
 
     async def get_app_page(self, request: Request) -> Page:
@@ -206,7 +206,7 @@ async def update(self, request: Request, pk: str, data: Dict[str, Any]) -> Model
         obj = await self.get_instance(request, pk)
         err_fields = {}
         for field_name in self.update_fields:
-            control = self.get_control_field(field_name)
+            control = self.get_formitem_field(field_name)
             try:
                 await control.set_value(request, obj, data[field_name])
             except ValidationError as e:
@@ -227,7 +227,7 @@ async def patch(self, request: Request, pk: str, data: Dict[str, Any]) -> Model:
         obj = await self.get_instance(request, pk)
         err_fields = {}
         for field_name in self.inline:
-            control = self.get_control_field(field_name)
+            control = self.get_formitem_field(field_name)
             try:
                 await control.set_value(request, obj, data[field_name])
             except ValidationError as e:
@@ -360,7 +360,7 @@ def make_fields(self):
                         continue
                     self.fields[field] = field_(name=field, field=field_type, prefix=self.prefix)
 
-    def get_control_field(self, name: str) -> BaseAdminControl:
+    def get_formitem_field(self, name: str) -> BaseAdminControl:
         ret = self.fields.get(name)
         if ret is None:
             raise NotFoundError("can not found field:" + name)