API 参考

版本

一般信息🔗

sublime 模块🔗

sublime.version() → str🔗

返回值：

版本号。

sublime.platform() → Literal['osx', 'linux', 'windows']🔗

返回值：

插件运行的平台。

sublime.arch() → Literal['x32', 'x64', 'arm64']🔗

返回值：

CPU 架构。

sublime.channel() → Literal['dev', 'stable']🔗

返回值：

Sublime Text 此版本的发布渠道。

sublime.executable_path() → str🔗

可以在导入时调用。

4081

返回值：

Sublime Text 主可执行文件的路径。

sublime.executable_hash() → tuple[str, str, str]🔗

可以在导入时调用。

4081

返回值：

一个元组，唯一标识 Sublime Text 的安装。

sublime.packages_path() → str🔗

可以在导入时调用。

4081

返回值：

“Packages” 文件夹的路径。

sublime.installed_packages_path() → str🔗

可以在导入时调用。

4081

返回值：

“Installed Packages” 文件夹的路径。

sublime.cache_path() → str🔗

可以在导入时调用。

4081

返回值：

Sublime Text 存储缓存文件的路径。

sublime.status_message(msg: str)🔗

在状态栏中显示一条消息。

sublime.error_message(msg: str)🔗

显示一个错误对话框。

sublime.message_dialog(msg: str)🔗

显示一个消息对话框。

sublime.ok_cancel_dialog(msg: str, ok_title='', title='') → bool🔗

显示一个确定/取消 询问对话框。

参数:

msg

要在对话框中显示的消息。

ok_title

要在确定按钮上显示的文本。

title

4099

对话框的标题。仅限 Windows。

返回值：

用户是否按下了确定按钮。

sublime.yes_no_cancel_dialog(msg: str, yes_title='', no_title='', title='') → DialogResult🔗

显示一个是/否/取消 询问对话框。

参数:

msg

要在对话框中显示的消息。

yes_title

要在是按钮上显示的文本。

no_title

要在否按钮上显示的文本。

title

4099

对话框的标题。仅限 Windows。

sublime.run_command(cmd: str, args: CommandArgs = None)🔗

运行命名的 ApplicationCommand。

sublime.get_clipboard(size_limit: int = 16777216) → str🔗

获取剪贴板的内容。

出于性能原因，如果剪贴板内容的大小超过 size_limit，则将返回空字符串。

已弃用:

请使用 get_clipboard_async 代替。

4075

sublime.set_clipboard(text: str)🔗

设置剪贴板的内容。

sublime.log_commands(flag: bool | None = None)🔗

控制运行时命令是否记录到控制台。

参数:

flag

是否记录。 传递 None 切换记录。 4099

sublime.log_input(flag: bool | None = None)🔗

控制所有按键是否记录到控制台。使用此功能查找键盘上某些键的名称。

参数:

flag

是否记录。 传递 None 切换记录。 4099

sublime.log_result_regex(flag: bool | None = None)🔗

控制结果正则表达式记录是否已启用。使用此功能调试构建系统中的 "file_regex" 和 "line_regex"。

参数:

flag

是否记录。 传递 None 切换记录。 4099

sublime.log_indexing(flag: bool | None = None)🔗

控制是否将索引日志打印到控制台。

参数:

flag

是否记录。 传递 None 切换记录。 4099

sublime.log_build_systems(flag: bool | None = None)🔗

控制是否将构建系统日志打印到控制台。

参数:

flag

是否记录。 传递 None 切换记录。 4099

sublime.score_selector(scope_name: str, selector: str) → int🔗

将 selector 与给定的 scope_name 进行匹配，返回一个匹配程度的分数。

分数为 0 表示不匹配，大于 0 表示匹配。不同的选择器可以与同一个范围进行比较：分数越高表示选择器与范围的匹配程度越高。

sublime.load_resource(name: str) → str🔗

加载给定的资源。名称应采用“Packages/Default/Main.sublime-menu”的格式。

引发 FileNotFoundError:

如果找不到资源

sublime.load_binary_resource(name) → bytes🔗

加载给定的资源。名称应采用“Packages/Default/Main.sublime-menu”的格式。

引发 FileNotFoundError:

如果找不到资源

sublime.find_resources(pattern: str) → list[str]🔗

查找文件名与给定通配符模式匹配的资源。

sublime.encode_value(value: Value, pretty=False, update_text: str = None) → str🔗

将 JSON 兼容的 Value 编码为字符串表示形式。

参数:

pretty

结果是否应该包含换行符并缩进。

update_text

next

增量更新此文本中编码的值。尽最大努力保留 update_text 的内容 - 注释、缩进等。这与更改设置值所使用的算法相同。提供此参数将使 pretty 无效。

sublime.decode_value(data: str) → Value🔗

将 JSON 字符串解码为对象。请注意，允许使用注释和尾随逗号。

引发 ValueError:

如果字符串不是有效的 JSON。

sublime.expand_variables(value: Value, variables: dict[str, str]) → Value🔗

使用字典 variables 中定义的变量扩展 value 中的任何变量。value 也可以是列表或字典，在这种情况下，结构将被递归扩展。字符串应使用片段语法，例如：expand_variables("Hello, ${name}", {"name": "Foo"})。

sublime.load_settings(base_name: str) → Settings🔗

加载命名设置。名称应包含文件名和扩展名，但不包含路径。将搜索包以查找与 base_name 匹配的文件，并将结果合并到设置对象中。

对 load_settings() 使用 base_name 的后续调用将返回相同的对象，而不是再次从磁盘加载设置。

sublime.save_settings(base_name: str)🔗

将任何内存中的更改刷新到命名设置对象到磁盘。

sublime.set_timeout(callback: Callable, delay: int = 0)🔗

在给定的 delay（以毫秒为单位）之后，在主线程中运行 callback。具有相同延迟的回调将按照添加顺序运行。

sublime.set_timeout_async(callback: Callable, delay: int = 0)🔗

在给定的延迟（以毫秒为单位）之后，在另一个线程上运行回调。

sublime.active_window() → Window🔗

返回值：

最近使用的 Window。

sublime.windows() → list[sublime.Window]🔗

返回值：

所有打开的窗口列表。

sublime.get_macro() → list[dict]🔗

返回值：

当前录制宏的命令和参数列表。每个 dict 将包含键 "command" 和 "args"。

class sublime.Window🔗

Bases: object

id() → int🔗

返回值：

一个唯一标识此窗口的数字。

is_valid() → bool🔗

检查此窗口是否仍然有效。例如，对于已关闭的窗口，将返回 False。

hwnd() → int🔗

返回值：

平台特定的窗口句柄。仅限 Windows。

active_sheet() → Sheet | None🔗

返回值：

当前获得焦点的 Sheet。

active_view() → View | None🔗

返回值：

当前正在编辑的 View。

new_html_sheet(name: str, contents: str, flags=NewFileFlags.NONE, group=-1) → Sheet🔗

4065

使用 minihtml 参考 构建一个包含 HTML 内容的 sheet。

参数:

name

要在标签中显示的 sheet 的名称。

contents

sheet 的 HTML 内容。

flags

仅允许 NewFileFlags.TRANSIENT 和 NewFileFlags.ADD_TO_SELECTION。

group

要添加 sheet 的组。 -1 表示活动组。

run_command(cmd: str, args: CommandArgs = None)🔗

使用给定的参数（可选）运行命名的 WindowCommand。此方法能够运行任何类型的命令，通过输入焦点分发命令。

new_file(flags=NewFileFlags.NONE, syntax='') → View🔗

创建一个新的空文件。

参数:

flags

可以是 0、NewFileFlags.TRANSIENT 或 NewFileFlags.ADD_TO_SELECTION。

语法

要应用于文件的语法名称。

返回值：

文件的视图。

open_file(fname: str, flags=NewFileFlags.NONE, group=-1) → View🔗

打开指定的文件。如果文件已打开，则将其置于最前面。请注意，由于文件加载是异步的，因此在返回视图的 is_loading() 方法返回 False 之前，无法对返回视图进行操作。

参数:

fname

要打开的文件的路径。

flags

NewFileFlags

group

要添加 sheet 的组。 -1 表示活动组。

find_open_file(fname: str, group=-1) → View | None🔗

按文件名查找打开的文件。

参数:

fname

要打开的文件的路径。

group

要搜索文件的组。 -1 表示任何组。

返回值：

文件的 View，如果文件未打开，则为 None。

file_history() → list[str]🔗

获取之前打开的文件列表。这与“文件 > 最近打开”中的列表相同。

num_groups() → int🔗

返回值：

窗口中视图组的数量。

active_group() → int🔗

返回值：

当前选定组的索引。

focus_group(idx: int)🔗

将焦点设置到指定的组，使其成为活动组。

focus_sheet(sheet: Sheet)🔗

切换到给定的 Sheet.

focus_view(view: View)🔗

切换到给定的 View.

select_sheets(sheets: list[sublime.Sheet])🔗

4083

更改整个窗口的选定工作表。

bring_to_front()🔗

将窗口置于所有其他窗口的前面。

get_sheet_index(sheet: Sheet) → tuple[int, int]🔗

返回值：

给定的 Sheet 在组中的组和索引的元组。

get_view_index(view: View) → tuple[int, int]🔗

返回值：

给定的 View 在组中的组和索引的元组。

set_sheet_index(sheet: Sheet, group: int, index: int)🔗

将给定的 Sheet 移动到给定 group 的给定 index 位置。

set_view_index(view: View, group: int, index: int)🔗

将给定的 View 移动到给定 group 的给定 index 位置。

move_sheets_to_group(sheets: list[sublime.Sheet], group: int, insertion_idx=-1, select=True)🔗

4123

将所有提供的 sheet 移动到指定的 group，插入到提供的插入索引处。如果未提供索引，则默认插入到目标 group 的最后一个索引处。

参数:

sheets

要移动的 sheet。

group

要将 sheet 移动到的 group 的索引。

insertion_idx

在 group 中插入 sheet 的位置。

select

是否在移动 sheet 后选择它们。

sheets() → list[sublime.Sheet]🔗

返回值：

窗口中所有打开的 sheet。

views(*, include_transient=False) → list[sublime.View]🔗

参数:

include_transient

4081

是否包含瞬态工作表。

返回值：

窗口中所有打开的 sheet。

selected_sheets() → list[sublime.Sheet]🔗

4083

返回值：

窗口当前选定组中的所有选定工作表。

selected_sheets_in_group(group: int) → list[sublime.Sheet]🔗

4083

返回值：

指定组中的所有选定工作表。

active_sheet_in_group(group: int) → Sheet | None🔗

返回值：

给定组中当前聚焦的Sheet。

active_view_in_group(group: int) → View | None🔗

返回值：

给定组中当前聚焦的View。

sheets_in_group(group: int) → list[sublime.Sheet]🔗

返回值：

指定组中的所有工作表的列表。

views_in_group(group: int) → list[sublime.View]🔗

返回值：

指定组中的所有视图的列表。

num_sheets_in_group(group: int) → int🔗

返回值：

指定组中的工作区数量。

num_views_in_group(group: int) → int🔗

返回值：

指定组中的视图数量。

transient_sheet_in_group(group: int) → Sheet | None🔗

返回值：

指定组中的瞬时工作区。

transient_view_in_group(group: int) → View | None🔗

返回值：

指定组中的瞬时视图。

promote_sheet(sheet: Sheet)🔗

如果参数 ‘Sheet’ 是半瞬时或瞬时，则提升它。

自:

4135

layout() → dict[str, Value]🔗

获取窗口的组布局。

get_layout()🔗

已弃用:

请使用 layout() 代替

set_layout(layout: dict[str, Value])🔗

设置窗口的组布局。

create_output_panel(name: str, unlisted=False) → View🔗

查找与命名输出面板关联的视图，如果需要则创建它。输出面板可以通过运行 show_panel 窗口命令来显示，并将 panel 参数设置为带有 "output." 前缀的名称。

可选的 unlisted 参数是一个布尔值，用于控制输出面板是否应该在面板切换器中列出。

find_output_panel(name: str) → View | None🔗

返回值：

与命名输出面板关联的 View，如果输出面板不存在，则为 None。

destroy_output_panel(name: str)🔗

销毁命名输出面板，如果当前已打开，则将其隐藏。

active_panel() → str | None🔗

返回当前打开的面板的名称，如果未打开任何面板，则返回 None。除了输出面板之外，还会返回内置面板名称（例如 "console"、"find" 等）。

panels() → list[str]🔗

返回所有未被标记为未列出的面板的名称列表。除了输出面板之外，还包括某些内置面板。

get_output_panel(name: str)🔗

已弃用:

请使用 create_output_panel 代替。

show_input_panel(caption: str, initial_text: str, on_done: Callable[[str], None] | None, on_change: Callable[[str], None] | None, on_cancel: Callable[[], None] | None)🔗

显示输入面板，用于从用户收集一行输入。

参数:

caption

放在输入小部件旁边的标签。

initial_text

输入小部件中的初始文本。

on_done

当用户按下 enter 时，使用最终输入调用。

on_change

当输入发生变化时，使用输入调用。

on_cancel

当用户使用 esc 取消输入时调用。

返回值：

用于输入小部件的 View。

show_quick_panel(items: list[str] | list[list[str]] | list[sublime.QuickPanelItem], on_select: Callable[[int], None], flags=QuickPanelFlags.NONE, selected_index=-1, on_highlight: Callable[[int], None] | None = None, placeholder: str | None = None)🔗

在列表中显示一个快速面板来选择一个项目。on_select 将被调用一次，并带有所选项目的索引。如果快速面板被取消，on_select 将被调用，参数为 -1。

参数:

items

可以是字符串列表，也可以是字符串列表的列表，其中第一个项目是触发器，所有后续字符串是显示在下面的详细信息。

可以是 QuickPanelItem。

4083

on_select

在快速面板完成时，使用所选项目的索引调用。如果面板被取消，则使用 -1 调用。

当 QuickPanelFlags.WANT_EVENT 标志存在时，可以传递第二个 Event 参数。

4096

flags

QuickPanelFlags 控制行为。

selected_index

最初选定的项目。 -1 表示没有选择。

on_highlight

每次快速面板中突出显示的项目更改时都会调用。

placeholder

4081

在输入任何查询之前，在过滤器输入字段中显示的文本。

is_sidebar_visible() → bool🔗

返回值：

侧边栏是否可见。

set_sidebar_visible(flag: bool, animate=True)🔗

隐藏或显示侧边栏。

is_minimap_visible() → bool🔗

返回值：

迷你地图是否可见。

set_minimap_visible(flag: bool)🔗

隐藏或显示迷你地图。

is_status_bar_visible() → bool🔗

返回值：

状态栏是否可见。

set_status_bar_visible(flag: bool)🔗

隐藏或显示状态栏。

get_tabs_visible() → bool🔗

返回值：

标签页是否可见。

set_tabs_visible(flag: bool)🔗

隐藏或显示标签页。

is_menu_visible() → bool🔗

返回值：

菜单是否可见。

set_menu_visible(flag: bool)🔗

隐藏或显示菜单。

folders() → list[str]🔗

返回值：

此 Window 中当前打开的文件夹列表。

project_file_name() → str | None🔗

返回值：

当前打开的项目文件名称（如果有）。

workspace_file_name() → str | None🔗

4050

返回值：

当前打开的工作区文件名称（如果有）。

project_data() → Value🔗

返回值：

与当前窗口关联的项目数据。数据格式与 .sublime-project 文件的内容相同。

set_project_data(data: Value)🔗

更新与当前窗口关联的项目数据。如果窗口与 .sublime-project 文件关联，则项目文件将在磁盘上更新，否则窗口将在内部存储数据。

settings() → Settings🔗

返回值：

此 Window 的 Settings 对象。对该设置对象的任何更改都将特定于此窗口。

template_settings() → Settings🔗

返回值：

每个窗口的设置，这些设置在会话中持久化，并复制到新窗口中。

symbol_locations(sym: str, source=SymbolSource.ANY, type=SymbolType.ANY, kind_id=KindId.AMBIGUOUS, kind_letter='') → list[sublime.SymbolLocation]🔗

4085

查找符号 sym 所在的所有位置。

参数:

sym

符号的名称。

source

应该搜索符号的来源。

type

要查找的符号类型

kind_id

符号的 KindId。

kind_letter

表示符号类型的字母。参见 Kind。

返回值:

找到的符号位置。

lookup_symbol_in_index(symbol: str) → list[sublime.SymbolLocation]🔗

返回值：

当前项目中所有文件中定义符号的位置。

已弃用:

请使用 symbol_locations() 代替。

lookup_symbol_in_open_files(symbol: str) → list[sublime.SymbolLocation]🔗

返回值：

所有打开文件中定义符号的位置。

已弃用:

请使用 symbol_locations() 代替。

lookup_references_in_index(symbol: str) → list[sublime.SymbolLocation]🔗

返回值：

当前项目中所有文件中引用符号的位置。

已弃用:

请使用 symbol_locations() 代替。

lookup_references_in_open_files(symbol: str) → list[sublime.SymbolLocation]🔗

返回值：

所有打开文件中引用符号的位置。

已弃用:

请使用 symbol_locations() 代替。

extract_variables() → dict[str, str]🔗

获取窗口的上下文键的 dict。

可能包含：* "packages" * "platform" * "file" * "file_path" * "file_name" * "file_base_name" * "file_extension" * "folder" * "project" * "project_path" * "project_name" * "project_base_name" * "project_extension"

此 dict 适合与 expand_variables() 一起使用。

status_message(msg: str)🔗

在状态栏中显示一条消息。

class sublime.Edit🔗

Bases: object

一组缓冲区修改。

Edit 对象传递给 TextCommand，用户无法创建它们。使用无效的 Edit 对象或来自不同 View 的 Edit 对象会导致需要它们的函数失败。

class sublime.Region🔗

Bases: object

单个选择区域。此区域有顺序 - b 可能在 a 之前或在 a 处。

也常用于表示文本缓冲区区域，其中顺序和 xpos 通常被忽略。

a: Point🔗

区域的第一个端点。

b: Point🔗

区域的第二个端点。在选择中，这是光标的位置。可能小于 a。

xpos: DIP🔗

在选择中，这是区域的目标水平位置。这会影响按下向上或向下键时的行为。如果未定义，请使用 -1。

__len__() → int🔗

返回值：

区域的大小。

__contains__(v: Region | Point) → bool🔗

4023 3.8

返回值：

提供的 Region 或 Point 是否完全包含在此区域内。

to_tuple() → tuple[Point, Point]🔗

4075

返回值：

此区域作为元组 (a, b)。

empty() → bool🔗

返回值：

区域是否为空，即 a == b。

begin() → Point🔗

返回值：

a 和 b 中较小的那个。

end() → Point🔗

返回值：

a 和 b 中较大的那个。

size() → int🔗

等同于 __len__。

contains(x: Point) → bool🔗

等同于 __contains__。

cover(region: Region) → Region🔗

返回值：

一个跨越两个区域的 Region。

intersection(region: Region) → Region🔗

返回值：

一个被两个区域覆盖的 Region。

intersects(region: Region) → bool🔗

返回值：

提供的区域是否与当前区域相交。