🔧 chore(base.py): refactor TemplateFieldCreator class to improve code readability and maintainability
This commit is contained in:
parent
99ef7c728d
commit
49029d6cda
1 changed files with 35 additions and 1 deletions
|
|
@ -6,24 +6,58 @@ from pydantic import BaseModel
|
||||||
|
|
||||||
class TemplateFieldCreator(BaseModel, ABC):
|
class TemplateFieldCreator(BaseModel, ABC):
|
||||||
field_type: str = "str"
|
field_type: str = "str"
|
||||||
|
"""The type of field this is. Default is a string."""
|
||||||
|
|
||||||
required: bool = False
|
required: bool = False
|
||||||
|
"""Specifies if the field is required. Defaults to False."""
|
||||||
|
|
||||||
placeholder: str = ""
|
placeholder: str = ""
|
||||||
|
"""A placeholder string for the field. Default is an empty string."""
|
||||||
|
|
||||||
is_list: bool = False
|
is_list: bool = False
|
||||||
|
"""Defines if the field is a list. Default is False."""
|
||||||
|
|
||||||
show: bool = True
|
show: bool = True
|
||||||
|
"""Should the field be shown. Defaults to True."""
|
||||||
|
|
||||||
multiline: bool = False
|
multiline: bool = False
|
||||||
|
"""Defines if the field will allow the user to open a text editor. Default is False."""
|
||||||
|
|
||||||
value: Any = None
|
value: Any = None
|
||||||
|
"""The value of the field. Default is None."""
|
||||||
|
|
||||||
suffixes: list[str] = []
|
suffixes: list[str] = []
|
||||||
fileTypes: list[str] = []
|
"""List of suffixes for a file field. Default is an empty list."""
|
||||||
|
|
||||||
file_types: list[str] = []
|
file_types: list[str] = []
|
||||||
|
"""List of file types associated with the field. Default is an empty list. (duplicate)"""
|
||||||
|
|
||||||
file_path: Union[str, None] = None
|
file_path: Union[str, None] = None
|
||||||
|
"""The file path of the field if it is a file. Defaults to None."""
|
||||||
|
|
||||||
password: bool = False
|
password: bool = False
|
||||||
|
"""Specifies if the field is a password. Defaults to False."""
|
||||||
|
|
||||||
options: list[str] = []
|
options: list[str] = []
|
||||||
|
"""List of options for the field. Only used when is_list=True. Default is an empty list."""
|
||||||
|
|
||||||
name: str = ""
|
name: str = ""
|
||||||
|
"""Name of the field. Default is an empty string."""
|
||||||
|
|
||||||
display_name: Optional[str] = None
|
display_name: Optional[str] = None
|
||||||
|
"""Display name of the field. Defaults to None."""
|
||||||
|
|
||||||
advanced: bool = False
|
advanced: bool = False
|
||||||
|
"""Specifies if the field will an advanced parameter (hidden). Defaults to False."""
|
||||||
|
|
||||||
input_types: list[str] = []
|
input_types: list[str] = []
|
||||||
|
"""List of input types for the handle when the field has more than one type. Default is an empty list."""
|
||||||
|
|
||||||
dynamic: bool = False
|
dynamic: bool = False
|
||||||
|
"""Specifies if the field is dynamic. Defaults to False."""
|
||||||
|
|
||||||
info: Optional[str] = ""
|
info: Optional[str] = ""
|
||||||
|
"""Additional information about the field to be shown in the tooltip. Defaults to an empty string."""
|
||||||
|
|
||||||
def to_dict(self):
|
def to_dict(self):
|
||||||
result = self.dict()
|
result = self.dict()
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue