跳转至

pyguiadapter.windows.fnexec

FnExecuteWindowConfig dataclass

Bases: BaseWindowConfig

Source code in pyguiadapter\windows\fnexec\_base.py 
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
@dataclasses.dataclass(frozen=True)
class FnExecuteWindowConfig(BaseWindowConfig):
    title: Optional[str] = None
    """窗口标题。"""

    size: Union[Tuple[int, int], QSize] = (800, 600)
    """窗口大小。"""

    execute_button_text: str = "Execute"
    """执行按钮文本。"""

    cancel_button_text: str = "Cancel"
    """取消按钮文本。"""

    clear_button_text: str = "Clear"
    """清除按钮文本。"""

    clear_button_visible: bool = True
    """是否显示清除按钮。"""

    clear_checkbox_text: str = "clear output"
    """清除选项框文本。"""

    clear_checkbox_visible: bool = True
    """是否显示清除选项框。"""

    clear_checkbox_checked: bool = True
    """是否将清除选项框设置为选中状态。"""

    statusbar_visible: bool = False
    """是否显示窗口状态栏"""

    initial_docks_state: Literal["auto", "tabified"] = "auto"
    """停靠窗口的初始状态。可选`auto`或`tabified`。当指定为`tabified`时，停靠窗口将组合成一个`Tab`组件，每个停靠窗口都将以`Tab页`的形式出现。"""

    output_dock_visible: bool = True
    """是否显示`Output停靠窗口`。"""

    output_dock_title: str = "Output"
    """`Output停靠窗口`的标题。"""

    output_dock_floating: bool = False
    """是否使`Output停靠窗口`处于悬浮状态。"""

    output_dock_initial_area: DockWidgetArea = BottomDockWidgetArea
    """`Output停靠窗口`的初始停靠区域。"""

    output_dock_initial_size: Tuple[
        Union[int, float, None], Union[int, float, None]
    ] = (None, 0.25)
    """`Output停靠窗口`的初始大小，格式为`(width, height)`，可以只设置其中一个维度，另一个不需要设置的维度置为`None`即可。
    width和height可以为`int`或`float`, 为`int`时代表width或height的绝对值，为`float`时代表相对于窗口大小的百分比。
    """

    document_dock_visible: bool = True
    """是否显示`Document停靠窗口`。"""

    document_dock_title: str = "Document"
    """`Document停靠窗口`的标题。"""

    document_dock_floating: bool = False
    """是否使`Document停靠窗口`处于悬浮状态。"""

    document_dock_initial_area: DockWidgetArea = RightDockWidgetArea
    """`Document停靠窗口`的初始停靠区域。"""

    document_dock_initial_size: Tuple[
        Union[int, float, None], Union[int, float, None]
    ] = (0.56, None)
    """`Document停靠窗口`的初始大小，格式为`(width, height)`，可以只设置其中一个维度，另一个不需要设置的维度置为`None`即可。
    width和height可以为`int`或`float`, 为`int`时代表width或height的绝对值，为`float`时代表相对于窗口大小的百分比。
    """

    output_browser_config: Optional[OutputBrowserConfig] = dataclasses.field(
        default_factory=OutputBrowserConfig
    )
    """`输出浏览器`的配置。"""

    document_browser_config: Optional[DocumentBrowserConfig] = dataclasses.field(
        default_factory=DocumentBrowserConfig
    )
    """`文档浏览器`的配置。"""

    default_parameter_group_name: str = "Main Parameters"
    """默认函数参数分组的名称。"""

    default_parameter_group_icon: IconType = None
    """默认函数参数分组的图标。"""

    parameter_group_icons: Dict[str, IconType] = dataclasses.field(default_factory=dict)
    """除默认函数参数分组外其他函数参数分组的图标"""

    disable_widgets_on_execute: bool = False
    """是否在函数执行期间使参数控件处于不可输入状态。"""

    print_function_result: bool = True
    """是否在`输出浏览器`中打印函数调用结果。"""

    show_function_result: bool = False
    """是否弹窗显示函数调用结果。"""

    print_function_error: bool = True
    """是否在`输出浏览器`中打印函数执行过程中发生的异常和错误。"""

    show_function_error: bool = True
    """是否弹窗显示函数执行过程中发生的异常和错误。"""

    function_error_traceback: bool = True
    """在打印或弹窗显示函数执行过程中发生的异常时，是否显示异常的回溯信息。"""

    error_dialog_title: str = "Error"
    """错误信息弹窗的标题。"""

    result_dialog_title: str = "Result"
    """函数调用结果弹窗的标题。"""

    parameter_error_message: str = "{}: {}"
    """`ParameterError`类型异常的消息模板，模板第一个变量（`{}`）为`参数名称`，第二个变量(`{}`)为`异常的消息（message）`。"""

    function_result_message: str = "function result: {}\n"
    """函数调用结果的消息模板，模板变量（`{}`）为函数的返回值。"""

    function_error_message: str = "{}: {}\n"
    """函数异常或错误的消息模板，模板第一个变量（`{}`）为`异常的类型`，第二个变量(`{}`)为`异常的消息（message）`。"""

    function_executing_message: str = "A function is executing now!"
    """提示消息，用以提示“函数正在执行”。"""

    uncancelable_function_message: str = "The function is not cancelable!"
    """提示消息，用以提示“当前函数为不可取消的函数”。"""

    function_not_executing_message: str = "No function is executing now!"
    """提示消息，用以提示“当前函数未处于执行状态”。"""

cancel_button_text: str = 'Cancel' class-attribute instance-attribute

取消按钮文本。

clear_button_text: str = 'Clear' class-attribute instance-attribute

清除按钮文本。

clear_button_visible: bool = True class-attribute instance-attribute

是否显示清除按钮。

clear_checkbox_checked: bool = True class-attribute instance-attribute

是否将清除选项框设置为选中状态。

clear_checkbox_text: str = 'clear output' class-attribute instance-attribute

清除选项框文本。

clear_checkbox_visible: bool = True class-attribute instance-attribute

是否显示清除选项框。

default_parameter_group_icon: IconType = None class-attribute instance-attribute

默认函数参数分组的图标。

default_parameter_group_name: str = 'Main Parameters' class-attribute instance-attribute

默认函数参数分组的名称。

disable_widgets_on_execute: bool = False class-attribute instance-attribute

是否在函数执行期间使参数控件处于不可输入状态。

document_browser_config: Optional[DocumentBrowserConfig] = dataclasses.field(default_factory=DocumentBrowserConfig) class-attribute instance-attribute

文档浏览器的配置。

document_dock_floating: bool = False class-attribute instance-attribute

是否使Document停靠窗口处于悬浮状态。

document_dock_initial_area: DockWidgetArea = RightDockWidgetArea class-attribute instance-attribute

Document停靠窗口的初始停靠区域。

document_dock_initial_size: Tuple[Union[int, float, None], Union[int, float, None]] = (0.56, None) class-attribute instance-attribute

Document停靠窗口的初始大小，格式为(width, height)，可以只设置其中一个维度，另一个不需要设置的维度置为None即可。 width和height可以为int或float, 为int时代表width或height的绝对值，为float时代表相对于窗口大小的百分比。

document_dock_title: str = 'Document' class-attribute instance-attribute

Document停靠窗口的标题。

document_dock_visible: bool = True class-attribute instance-attribute

是否显示Document停靠窗口。

error_dialog_title: str = 'Error' class-attribute instance-attribute

错误信息弹窗的标题。

execute_button_text: str = 'Execute' class-attribute instance-attribute

执行按钮文本。

function_error_message: str = '{}: {}\n' class-attribute instance-attribute

函数异常或错误的消息模板，模板第一个变量（{}）为异常的类型，第二个变量({})为异常的消息（message）。

function_error_traceback: bool = True class-attribute instance-attribute

在打印或弹窗显示函数执行过程中发生的异常时，是否显示异常的回溯信息。

function_executing_message: str = 'A function is executing now!' class-attribute instance-attribute

提示消息，用以提示“函数正在执行”。

function_not_executing_message: str = 'No function is executing now!' class-attribute instance-attribute

提示消息，用以提示“当前函数未处于执行状态”。

function_result_message: str = 'function result: {}\n' class-attribute instance-attribute

函数调用结果的消息模板，模板变量（{}）为函数的返回值。

initial_docks_state: Literal['auto', 'tabified'] = 'auto' class-attribute instance-attribute

停靠窗口的初始状态。可选auto或tabified。当指定为tabified时，停靠窗口将组合成一个Tab组件，每个停靠窗口都将以Tab页的形式出现。

output_browser_config: Optional[OutputBrowserConfig] = dataclasses.field(default_factory=OutputBrowserConfig) class-attribute instance-attribute

输出浏览器的配置。

output_dock_floating: bool = False class-attribute instance-attribute

是否使Output停靠窗口处于悬浮状态。

output_dock_initial_area: DockWidgetArea = BottomDockWidgetArea class-attribute instance-attribute

Output停靠窗口的初始停靠区域。

output_dock_initial_size: Tuple[Union[int, float, None], Union[int, float, None]] = (None, 0.25) class-attribute instance-attribute

Output停靠窗口的初始大小，格式为(width, height)，可以只设置其中一个维度，另一个不需要设置的维度置为None即可。 width和height可以为int或float, 为int时代表width或height的绝对值，为float时代表相对于窗口大小的百分比。

output_dock_title: str = 'Output' class-attribute instance-attribute

Output停靠窗口的标题。

output_dock_visible: bool = True class-attribute instance-attribute

是否显示Output停靠窗口。

parameter_error_message: str = '{}: {}' class-attribute instance-attribute

ParameterError类型异常的消息模板，模板第一个变量（{}）为参数名称，第二个变量({})为异常的消息（message）。

parameter_group_icons: Dict[str, IconType] = dataclasses.field(default_factory=dict) class-attribute instance-attribute

除默认函数参数分组外其他函数参数分组的图标

print_function_error: bool = True class-attribute instance-attribute

是否在输出浏览器中打印函数执行过程中发生的异常和错误。

print_function_result: bool = True class-attribute instance-attribute

是否在输出浏览器中打印函数调用结果。

result_dialog_title: str = 'Result' class-attribute instance-attribute

函数调用结果弹窗的标题。

show_function_error: bool = True class-attribute instance-attribute

是否弹窗显示函数执行过程中发生的异常和错误。

show_function_result: bool = False class-attribute instance-attribute

是否弹窗显示函数调用结果。

size: Union[Tuple[int, int], QSize] = (800, 600) class-attribute instance-attribute

窗口大小。

statusbar_visible: bool = False class-attribute instance-attribute

是否显示窗口状态栏

title: Optional[str] = None class-attribute instance-attribute

窗口标题。

uncancelable_function_message: str = 'The function is not cancelable!' class-attribute instance-attribute

提示消息，用以提示“当前函数为不可取消的函数”。

OutputBrowserConfig dataclass

Bases: TextBrowserConfig

输出浏览器配置类。

Source code in pyguiadapter\windows\fnexec\_output_area\browser.py 
14
15
16
17
18
19
20
@dataclasses.dataclass
class OutputBrowserConfig(TextBrowserConfig):
    """输出浏览器配置类。"""

    text_color: str = COLOR_TERMINAL_TEXT_CLASSIC
    font_family: str = FONT_FAMILY
    background_color: str = COLOR_TERMINAL_BACKGROUND_CLASSIC

FnExecuteWindowEventListener

Bases: BaseWindowEventListener

on_execute_error(window: BaseFnExecuteWindow, error: Exception) -> bool

在函数执行失败（函数抛出异常）时回调。

Parameters:

Name Type Description Default
window BaseFnExecuteWindow

当前窗口实例

 required
error Exception

函数抛出的异常

 required

Returns:

Type Description
bool

如果返回True，则允许PyGUIAdapter执行默认的后续操作，比如打印函数异常或弹窗显示函数异常等，否则阻止执行默认操作。默认返回True。

on_execute_finish(window: BaseFnExecuteWindow) -> None

在函数执行结束时回调，无论函数执行是否成功，该回调函数都会被调用。

Parameters:

Name Type Description Default
window BaseFnExecuteWindow

当前窗口实例

 required

Returns:

Type Description
None

无返回值

on_execute_result(window: BaseFnExecuteWindow, result: Any) -> bool

在函数执行成功（函数返回）时回调。

Parameters:

Name Type Description Default
window BaseFnExecuteWindow

当前窗口实例

 required
result Any

函数的返回值

 required

Returns:

Type Description
bool

如果返回True，则允许PyGUIAdapter执行默认的后续操作，比如打印函数结果或弹窗显示函数结果等，否则阻止执行默认操作。默认返回True。

on_execute_start(window: BaseFnExecuteWindow) -> None

在函数执行开始时回调。

Parameters:

Name Type Description Default
window BaseFnExecuteWindow

当前窗口实例

 required

Returns:

Type Description
None

无返回值

SimpleFnExecuteWindowEventListener

Bases: FnExecuteWindowEventListener

一个简单的FnExecuteWindowEventListener实现，方便不喜欢子类化方式的开发者使用。

__init__(on_create: Callable[[BaseFnExecuteWindow], None] = None, on_show: Callable[[BaseFnExecuteWindow], None] = None, on_hide: Callable[[BaseFnExecuteWindow], None] = None, on_close: Callable[[BaseFnExecuteWindow], bool] = None, on_destroy: Callable[[BaseFnExecuteWindow], None] = None, on_execute_start: Callable[[BaseFnExecuteWindow], None] = None, on_execute_result: Callable[[BaseFnExecuteWindow, Any], bool] = None, on_execute_error: Callable[[BaseFnExecuteWindow, Exception], bool] = None, on_execute_finish: Callable[[BaseFnExecuteWindow], None] = None)

构造函数。

Parameters:

Name Type Description Default
on_create Callable[[BaseFnExecuteWindow], None]

on_create回调函数

 None
on_show Callable[[BaseFnExecuteWindow], None]

on_show回调函数

 None
on_hide Callable[[BaseFnExecuteWindow], None]

on_hide回调函数

 None
on_close Callable[[BaseFnExecuteWindow], bool]

on_close回调函数

 None
on_destroy Callable[[BaseFnExecuteWindow], None]

on_destroy回调函数

 None
on_execute_start Callable[[BaseFnExecuteWindow], None]

on_execute_start回调函数

 None
on_execute_result Callable[[BaseFnExecuteWindow, Any], bool]

on_execute_result回调函数

 None
on_execute_error Callable[[BaseFnExecuteWindow, Exception], bool]

on_execute_error回调函数

 None
on_execute_finish Callable[[BaseFnExecuteWindow], None]

on_execute_finish回调函数

 None

FnExecuteWindow

Bases: BaseFnExecuteWindow

activate_parameter_group(group_name: str) -> None

激活展开指定参数分组。

Parameters:

Name Type Description Default
group_name str

参数分组名称

 required

Returns:

Type Description
None

无返回值

add_parameter(parameter_name: str, config: Tuple[Type[BaseParameterWidget], BaseParameterWidgetConfig]) -> None

添加一个新的函数参数

Parameters:

Name Type Description Default
parameter_name str

要增加的函数参数名称

 required
config Tuple[Type[BaseParameterWidget], BaseParameterWidgetConfig]

函数参数配置，格式为: (参数控件类, 参数控件配置类实例)

 required

Returns:

Type Description
None

无返回值

Raises:

Type Description
ParameterError

当参数为空、参数名称重复时将引发此异常

add_parameters(configs: Dict[str, Tuple[Type[BaseParameterWidget], BaseParameterWidgetConfig]]) -> None

增加一组新的函数参数

Parameters:

Name Type Description Default
configs Dict[str, Tuple[Type[BaseParameterWidget], BaseParameterWidgetConfig]]

要增加的函数参数名称及其配置

 required

Returns:

Type Description
None

无返回值

Raises:

Type Description
ParameterError

当参数为空、参数名称重复时将引发此异常

append_output(text: str, html: bool = False, scroll_to_bottom: bool = True) -> None

把文本追加到输出浏览器中

Parameters:

Name Type Description Default
text str

带输出的文本

 required
html bool

是否为html格式

 False
scroll_to_bottom bool

完成后是否将输出浏览器滚动到底部

 True

Returns:

Type Description
None

无返回值

clear_output() -> None

清除输出浏览器内容

Returns:

Type Description
None

无返回值

clear_parameters() -> None

清除所有参数

Returns:

Type Description
None

无返回值

clear_statusbar_message() -> None

清除状态栏消息

Returns:

Type Description
None

无返回值

disable_parameter_widgets(disabled: bool) -> None

设置参数控件禁用/启用状态

Parameters:

Name Type Description Default
disabled bool

是否禁用

 required

Returns:

Type Description
None

无返回值

get_document_dock_area() -> DockWidgetArea

获取Document Dock停靠区域

Returns:

Type Description
DockWidgetArea

返回当前停靠区域

get_document_dock_size() -> Tuple[int, int]

获取Document Dock尺寸

Returns:

Type Description
Tuple[int, int]

返回当前尺寸

get_document_dock_title() -> str

获取Document Dock标题

Returns:

Type Description
str

返回当前标题

get_output_dock_area() -> DockWidgetArea

获取Output Dock停靠区域

Returns:

Type Description
DockWidgetArea

返回当前停靠区域

get_output_dock_size() -> Tuple[int, int]

获取Output Dock尺寸

Returns:

Type Description
Tuple[int, int]

返回当前尺寸

get_output_dock_title() -> str

获取Output Dock标题

Returns:

Type Description
str

返回当前标题

get_parameter_names() -> List[str]

获取所有参数名称

Returns:

Type Description
List[str]

返回当前所有参数名称

get_parameter_names_of(group_name: str) -> List[str]

获取指定分组下的所有参数名称

Parameters:

Name Type Description Default
group_name str

分组名称

 required

Returns:

Type Description
List[str]

返回指定分组下的所有参数名称

Raises:

Type Description
ParameterNotFoundError

当指定分组不存在时，引发此异常

get_parameter_value(parameter_name: str) -> Any

获取指定参数当前值

Parameters:

Name Type Description Default
parameter_name str

参数名称

 required

Returns:

Type Description
Any

返回当前值

Raises:

Type Description
ParameterNotFoundError

指定参数不存在时，将引发此异常
ParameterError

无法从对应控件获取当前值时，将引发此异常

get_parameter_values() -> Dict[str, Any]

获取所有参数的当前值

Returns:

Type Description
Dict[str, Any]

以字典形式返回当前所有参数的值

Raises:

Type Description
ParameterError

无法从对应控件获取某个参数的当前值时，将引发此异常

get_parameter_values_of(group_name: str) -> Dict[str, Any]

获取指定分组下所有参数当前值

Parameters:

Name Type Description Default
group_name str

指定分组的名称

 required

Returns:

Type Description
Dict[str, Any]

返回指定分组下所有参数的名称和值

Raises:

Type Description
ParameterNotFoundError

当指定分组不存在时，引发此异常
ParameterError

无法从对应控件获取某个参数的当前值时，将引发此异常

has_parameter(parameter_name: str) -> bool

判断是否存在指定参数名称

Parameters:

Name Type Description Default
parameter_name str

带判断的参数名称

 required

Returns:

Type Description
bool

存在指定参数时返回True，否则返回False

hide_progressbar() -> None

隐藏进度条

Returns:

Type Description
None

无返回值

is_clear_checkbox_checked() -> bool

检查清除选项框是否选中

Returns:

Type Description
bool

返回当前状态

is_document_dock_floating() -> bool

检查Document Dock是否悬浮

Returns:

Type Description
bool

返回当前悬浮状态

is_document_dock_visible() -> bool

检查Document Dock是否显示

Returns:

Type Description
bool

返回当前显示状态

is_function_cancelable() -> bool

检查函数是否为可取消函数

Returns:

Type Description
bool

返回函数是否可取消

is_function_executing() -> bool

检查函数是否正在运行

Returns:

Type Description
bool

返回函数运行状态

is_output_dock_floating() -> bool

检查Output Dock是否悬浮

Returns:

Type Description
bool

返回当前悬浮状态

is_output_dock_visible() -> bool

检查Output Dock是否显示

Returns:

Type Description
bool

返回当前显示状态

is_statusbar_visible() -> bool

检查窗口状态栏是否可见

Returns:

Type Description
bool

返回状态栏当前状态

process_parameter_error(e: ParameterError) -> None

使用内置逻辑处理ParameterError类型的异常

Parameters:

Name Type Description Default
e ParameterError

异常对象

 required

Returns:

Type Description
None

无返回值

remove_parameter(parameter_name: str, ignore_unknown_parameter: bool = True) -> None

移除指定参数控件

Parameters:

Name Type Description Default
parameter_name str

要移除的指定参数名称

 required
ignore_unknown_parameter bool

是否忽略未知参数

 True

Returns:

Type Description
None

无返回值

Raises:

Type Description
ParameterNotFoundError

当参数parameter_name不存在且ignore_unknown_parameter为False时，将引发此异常

resize_document_dock(size: Tuple[Union[int, float, None], Union[int, float, None]]) -> None

调整Document Dock尺寸

注意：停靠窗口的尺寸受到多种因素的影响，无法保证实际的尺寸与开发者设置的尺寸保持一致，尤其时多个停靠窗口停靠在同一区域时具体而言：

  • 尺寸的调整受最小和最大尺寸的约束；
  • 尺寸调整不会影响主窗口的大小；
  • 在空间有限的情况下，将根据各个停靠窗口的相对大小占比进行可以利用空间的调整

Parameters:

Name Type Description Default
size Tuple[Union[int, float, None], Union[int, float, None]]

目标尺寸。格式为(width, height)，可以只设置其中一个维度，另一个不需要设置的维度置为None即可。width和height可以为int或float, 为int时代表width或height的绝对值，为float时代表相对于窗口大小的百分比。

 required

Returns:

Type Description
None

无返回值

resize_output_dock(size: Tuple[Union[int, float, None], Union[int, float, None]]) -> None

调整Output Dock尺寸

注意：停靠窗口的尺寸受到多种因素的影响，无法保证实际的尺寸与开发者设置的尺寸保持一致，尤其时多个停靠窗口停靠在同一区域时具体而言：

  • 尺寸的调整受最小和最大尺寸的约束；
  • 尺寸调整不会影响主窗口的大小；
  • 在空间有限的情况下，将根据各个停靠窗口的相对大小占比进行可以利用空间的调整

Parameters:

Name Type Description Default
size Tuple[Union[int, float, None], Union[int, float, None]]

目标尺寸。格式为(width, height)，可以只设置其中一个维度，另一个不需要设置的维度置为None即可。width和height可以为int或float, 为int时代表width或height的绝对值，为float时代表相对于窗口大小的百分比。

 required

Returns:

Type Description
None

无返回值

scroll_to_parameter(parameter_name: str, x: int = 50, y: int = 50, highlight_effect: bool = True)

滚动到指定参数的位置。

Parameters:

Name Type Description Default
parameter_name str

参数名称

 required
x int

滚动的X坐标偏移值

 50
y int

滚动的Y坐标偏移值

 50
highlight_effect bool

是否对指定控件显示高亮效果

 True

Returns:

Type Description

无返回值

set_allowed_dock_areas(areas: Optional[DockWidgetAreas]) -> None

设置停靠窗口允许停靠的区域

Parameters:

Name Type Description Default
areas Optional[DockWidgetAreas]

允许停靠的区域

 required

Returns:

Type Description
None

无返回值

set_cancel_button_text(text: str) -> None

设置取消按钮文本

Parameters:

Name Type Description Default
text str

目标文本

 required

Returns:

Type Description
None

无返回值

set_clear_button_text(text: str) -> None

设置清除按钮文本

Parameters:

Name Type Description Default
text str

目标文本

 required

Returns:

Type Description
None

无返回值

set_clear_button_visible(visible: bool) -> None

设置清除按钮是否可见

Parameters:

Name Type Description Default
visible bool

目标状态

 required

Returns:

Type Description
None

无返回值

set_clear_checkbox_checked(checked: bool) -> None

设置清除选项框是否选中

Parameters:

Name Type Description Default
checked bool

目标状态

 required

Returns:

Type Description
None

无返回值

set_clear_checkbox_text(text: str) -> None

设置清除选项框文本

Parameters:

Name Type Description Default
text str

目标文本

 required

Returns:

Type Description
None

无返回值

set_clear_checkbox_visible(visible: bool) -> None

设置清除选项框是否可见

Parameters:

Name Type Description Default
visible bool

目标状态

 required

Returns:

Type Description
None

无返回值

set_document(document: str, document_format: Literal['markdown', 'html', 'plaintext']) -> None

设置函数说明文档

Parameters:

Name Type Description Default
document str

文档内容

 required
document_format Literal['markdown', 'html', 'plaintext']

文档格式

 required

Returns:

Type Description
None

无返回值

set_document_dock_area(area: DockWidgetArea) -> None

设置Document Dock停靠区域

Parameters:

Name Type Description Default
area DockWidgetArea

目标停靠区域

 required

Returns:

Type Description
None

无返回值

set_document_dock_floating(floating: bool) -> None

设置Document Dock是否悬浮

Parameters:

Name Type Description Default
floating bool

目标状态

 required

Returns:

Type Description
None

无返回值

set_document_dock_property(*, title: Optional[str] = None, visible: Optional[bool] = None, floating: Optional[bool] = None, area: Optional[DockWidgetArea] = None) -> None

设置Document Dock的属性

Parameters:

Name Type Description Default
title Optional[str]

标题

 None
visible Optional[bool]

是否显示

 None
floating Optional[bool]

是否悬浮

 None
area Optional[DockWidgetArea]

初始停靠区域

 None

Returns:

Type Description
None

无返回值

set_document_dock_title(title: str) -> None

设置Document Dock标题

Parameters:

Name Type Description Default
title str

标题

 required

Returns:

Type Description
None

无返回值

set_document_dock_visible(visible: bool) -> None

设置Document Dock是否显示

Parameters:

Name Type Description Default
visible bool

目标状态

 required

Returns:

Type Description
None

无返回值

set_execute_button_text(text: str) -> None

设置执行按钮文本

Parameters:

Name Type Description Default
text str

目标文本

 required

Returns:

Type Description
None

无返回值

set_output_dock_area(area: DockWidgetArea) -> None

设置Output Dock停靠区域

Parameters:

Name Type Description Default
area DockWidgetArea

目标停靠区域

 required

Returns:

Type Description
None

无返回值

set_output_dock_floating(floating: bool) -> None

设置Output Dock是否悬浮

Parameters:

Name Type Description Default
floating bool

目标状态

 required

Returns:

Type Description
None

无返回值

set_output_dock_property(*, title: Optional[str] = None, visible: Optional[bool] = None, floating: Optional[bool] = None, area: Optional[DockWidgetArea] = None) -> None

设置Output Dock的属性

Parameters:

Name Type Description Default
title Optional[str]

标题

 None
visible Optional[bool]

是否显示

 None
floating Optional[bool]

是否悬浮

 None
area Optional[DockWidgetArea]

初始停靠区域

 None

Returns:

Type Description
None

无返回值

set_output_dock_title(title: str) -> None

设置Output Dock标题

Parameters:

Name Type Description Default
title str

标题

 required

Returns:

Type Description
None

无返回值

set_output_dock_visible(visible: bool) -> None

设置Output Dock是否显示

Parameters:

Name Type Description Default
visible bool

目标状态

 required

Returns:

Type Description
None

无返回值

set_parameter_value(parameter_name: str, value: Any) -> None

设置参数当前值

Parameters:

Name Type Description Default
parameter_name str

参数名称

 required
value Any

要设置的值

 required

Returns:

Type Description
None

无返回值

Raises:

Type Description
ParameterNotFoundError

若指定参数不存在，则引发此异常
ParameterError

若无法将值设置到对应的控件，那么将引发此异常

set_parameter_values(values: Dict[str, Any]) -> None

设置多个参数的当前值

Parameters:

Name Type Description Default
values Dict[str, Any]

要设置的参数名称和值

 required

Returns:

Type Description
None

无返回值

Raises:

Type Description
ParameterError

若无法将值设置到对应的控件，那么将引发此异常

set_statusbar_visible(visible: bool) -> None

设置窗口状态栏是否可见

Parameters:

Name Type Description Default
visible bool

目标状态

 required

Returns:

Type Description
None

无返回值

show_progressbar() -> None

显示进度条

Returns:

Type Description
None

无返回值

show_statusbar_message(message: str, timeout: int = 3000) -> None

设置状态栏消息

Parameters:

Name Type Description Default
message str

消息文本

 required
timeout int

显示的时长

 3000

Returns:

Type Description
None

无返回值

tabify_docks() -> None

使所有Dock窗口选项卡化

注意：当前已悬浮的窗口不受影响

Returns:

Type Description
None

无返回值

try_cancel_execution() -> None

尝试取消函数执行

Returns:

Type Description
None

无返回值

Raises:

Type Description
FunctionNotCancellableError

函数未被设置为可取消函数时，将引发此异常
FunctionNotExecutingError

函数未处于正在执行中时，将引发此异常

update_progress(current_value: int, message: Optional[str] = None) -> None

更新进度条进度

Parameters:

Name Type Description Default
current_value int

当前进度

 required
message Optional[str]

额外信息

 None

Returns:

update_progressbar_config(config: Union[ProgressBarConfig, dict, None]) -> None

更新进度条配置

Parameters:

Name Type Description Default
config Union[ProgressBarConfig, dict, None]

进度条配置

 required

Returns:

Type Description
None

无返回值

类型与常量

DockWidgetArea = Qt.DockWidgetArea module-attribute

NoDockWidgetArea = Qt.DockWidgetArea.NoDockWidgetArea module-attribute

BottomDockWidgetArea = Qt.DockWidgetArea.BottomDockWidgetArea module-attribute

TopDockWidgetArea = Qt.DockWidgetArea.TopDockWidgetArea module-attribute

LeftDockWidgetArea = Qt.DockWidgetArea.LeftDockWidgetArea module-attribute

RightDockWidgetArea = Qt.DockWidgetArea.RightDockWidgetArea module-attribute

DockWidgetAreas = Union[DockWidgetArea, int] module-attribute

AllDockWidgetAreas = Qt.AllDockWidgetAreas module-attribute