Skip to content

文件目录选择框组件

文件目录选择框组件用于选择文件和目录路径,包括单文件选择框、多文件选择框、目录选择框和文件保存框。

单文件选择框 (FileChooser)

单文件选择框用于选择一个文件路径。

基本用法

python
gui_config.add_argument(
    "--Filepath",
    metavar="单文件选择框",
    help="选择文件夹路径",
    type=str,
    default="./xlsx",
    widget="FileChooser",
    gooey_options={
        "buttonText": "选择文件",  # 按钮文本
        "plain": True,  # 是否为朴素按钮
        "size": "large",  # 大小
        "buttonIcon": "Document",  # 按钮图标
        "disabled": False  # 是否禁用
    }
)

属性

属性名说明类型默认值
buttonText按钮文本string'选择文件'
plain是否为朴素按钮booleanfalse
size按钮大小string'default'
buttonIcon按钮图标string'Document'
disabled是否禁用booleanfalse

多文件选择框 (MultiFileChooser)

多文件选择框用于选择多个文件路径。

基本用法

python
gui_config.add_argument(
    "--allpath",
    metavar="多文件选择框",
    help="选择多个文件夹路径",
    nargs="+",
    widget="MultiFileChooser",
    gooey_options={
        "buttonText": "选择多个文件",  # 按钮文本
        "plain": True,  # 是否为朴素按钮
        "size": "large",  # 大小
        "buttonIcon": "Files",  # 按钮图标
        "disabled": False  # 是否禁用
    }
)

属性

属性名说明类型默认值
buttonText按钮文本string'选择多个文件'
plain是否为朴素按钮booleanfalse
size按钮大小string'default'
buttonIcon按钮图标string'Files'
disabled是否禁用booleanfalse

目录选择框 (DirChooser)

目录选择框用于选择一个目录路径。

基本用法

python
gui_config.add_argument(
    "--outputDirectory",
    metavar="目录选择框",
    help="选择文件夹路径",
    type=str,
    default="./output",
    widget="DirChooser",
    gooey_options={
        "buttonText": "选择目录",  # 按钮文本
        "plain": True,  # 是否为朴素按钮
        "size": "large",  # 大小
        "buttonIcon": "Folder",  # 按钮图标
        "disabled": False  # 是否禁用
    }
)

属性

属性名说明类型默认值
buttonText按钮文本string'选择目录'
plain是否为朴素按钮booleanfalse
size按钮大小string'default'
buttonIcon按钮图标string'Folder'
disabled是否禁用booleanfalse

文件保存框 (FileSaver)

文件保存框用于选择文件的保存路径。

基本用法

python
gui_config.add_argument(
    "--saveFile",
    metavar="文件保存框",
    help="选择保存文件位置",
    type=str,
    default="./output.txt",
    widget="FileSaver",
    gooey_options={
        "buttonText": "选择保存位置",  # 按钮文本
        "plain": True,  # 是否为朴素按钮
        "size": "large",  # 大小
        "buttonIcon": "Save",  # 按钮图标
        "disabled": False  # 是否禁用
    }
)

属性

属性名说明类型默认值
buttonText按钮文本string'选择保存位置'
plain是否为朴素按钮booleanfalse
size按钮大小string'default'
buttonIcon按钮图标string'Save'
disabled是否禁用booleanfalse

使用场景

单文件选择框

适用于:

  • 选择配置文件
  • 选择导入的数据文件
  • 选择图片或其他媒体文件

多文件选择框

适用于:

  • 批量导入文件
  • 选择多个图片进行处理
  • 选择多个文档进行合并

目录选择框

适用于:

  • 选择输出目录
  • 选择扫描目录
  • 选择工作目录

文件保存框

适用于:

  • 导出数据到文件
  • 保存配置
  • 保存处理结果

最佳实践

  1. 始终为文件选择框设置合理的默认值,避免用户困惑
  2. 在帮助提示中明确说明期望的文件类型或格式
  3. 在处理用户选择的路径时,确保进行路径验证和错误处理
  4. 对于多文件选择,记得使用 nargs="+" 参数来接收多个值

基于MIT许可证发布