PyCharm 2025.3 Help

“编辑模板变量”对话框

如果 实时模板 包含 用户定义的变量 ,您可以使用 编辑模板变量 对话框来配置定义这些变量的表达式。

控件

描述

名称

在此字段中,以 $<variable_name>$ 格式查看或编辑变量名称。

表达式

在此字段中,指定表达式,以便自动计算相应模板输入字段的值。

该表达式可以包含以下结构:

  • 用双引号括起来的字符串常量

  • 实时模板中定义的其他变量的名称

  • 预定义函数 ,可包含参数

手动输入表达式,或从列表中选择预定义函数。 列表还会显示所选函数的参数数量和类型(如果有)。 可用函数按字母顺序列在 函数 表中。

默认值

在此字段中,指定默认字符串。当表达式计算后未产生任何结果时,该字符串将输入到展开模板的相应输入字段中。

请注意,变量的默认值是一个表达式,且可以引用其他实时模板变量。 要将默认值定义为字面量,请用引号将其括起来。

如果定义则跳过

选中此复选框后,如果当前输入字段的值已定义,PyCharm 将跳转到下一个输入字段。

上移 / 下移

使用这些按钮更改列表中变量的顺序。 表中变量的顺序决定了模板展开时 PyCharm 在相应输入字段之间切换的顺序。

用于实时模板变量的函数

描述

blockCommentEnd()

返回在当前语言环境中表示块注释结束的字符。

blockCommentStart()

返回在当前语言环境中表示块注释开始的字符。

camelCase(<String>)

将字符串转换为 camelCase

例如, camelCase("my-text-file")camelCase("my text file")camelCase("my_text_file") 都返回 myTextFile

capitalize(<String>)

将字符串的首字母大写。

例如, capitalize("name") 返回 Name。 或者,您可以将其组合为 capitalize(camelCase("my awesome class")) ,得到 MyAwesomeClass

capitalizeAndUnderscore(<String>)

将字符串的所有字母大写,并在各部分之间插入下划线。

例如, capitalizeAndUnderscore("FooBar")capitalizeAndUnderscore("foo bar")capitalizeAndUnderscore("foo-bar") 都返回 FOO_BAR

clipboard()

返回系统剪贴板的内容。

collectionElementName()

移除 _list 和复数词尾 s。

commentEnd()

返回在当前语言环境中表示注释结束的字符。 对于具有行注释的语言,返回值为空。

commentStart()

返回在当前语言环境中表示注释开始的字符。 对于具有行注释的语言,返回值为行注释起始符,与 lineCommentStart() 相同。

complete()

在变量位置调用 代码补全

completeSmart()

在变量位置调用 智能类型补全

concat(<String>, ...)

返回传递给该函数的所有字符串参数的连接结果。

例如, concat(date()," ",user()) 返回以空格分隔的当前系统日期和用户名。

date([format])

返回当前系统日期。

默认情况下,如果不提供参数,则返回当前系统格式的日期。 要使用其他格式,请根据 SimpleDateFormat 规范提供参数。 例如, date("Y-MM-d, E, H:m") 返回格式化为 2020-02-27, Thu, 16:11 的日期。

dbColumns()

返回表或视图的列列表。 该 dbColumns() 用于上下文实时模板(例如, ins)。 您可以右键点击对象并选择 SQL 脚本 来访问上下文实时模板。

dbObjectName()

返回表或视图的名称。 该 dbObjectName() 用于上下文实时模板(例如, top)。 您可以右键点击对象并选择 SQL 脚本 来访问上下文实时模板。

decapitalize(<String>)

将字符串的首字母替换为相应的小写字母。

例如, decapitalize("Name") 返回 name

defaultReturnValues

如果表达式用于 return 语句,则返回默认值。 如果表达式为错误类型,则使用 errorVariableName 参数。

djangoBlock

显示可用 Django 块的补全弹出窗口。

djangoFilter

显示可用 Django 过滤器的补全弹出窗口。

djangoTemplateTags

显示可用 Django 模板标签的补全弹出窗口。

djangoVariable

显示可用 Django 变量的补全弹出窗口。

enum(<String>, ...)

返回模板展开时用于补全的字符串列表。

例如, enum("Foo","Bar","Baz") 会显示一个列表,您可以从中选择其中一个指定字符串。

escapeString(<String>)

转义特殊字符,以便结果可用于 Java 字符串。

例如,它会将制表符替换为 \t ,将换行符替换为 \n ,将反斜杠转义为 \\ 、引号转义为 \" ,等等。

expectedType()

返回模板展开位置的表达式的预期类型(在赋值的右侧、 return 之后、作为方法参数等)。

仅在 Java 上下文中可用。

fileName()

返回当前文件的名称(包含扩展名)。

fileNameWithoutExtension()

返回当前文件的名称(不含扩展名)。

filePath()

返回当前文件的绝对路径。

fileRelativePath()

返回当前文件相对于当前项目的路径。 要检查某个文件的相对路径,右键点击它并选择 复制引用 ,或按 Ctrl+Alt+Shift+C

firstWord(<String>)

返回作为参数传入的字符串的第一个单词。

例如, firstWord("one two three") 返回 one

groovyScript(<String>, [arg, ...])

执行以字符串形式传入的 Groovy 脚本。

第一个参数是一个字符串,其内容可以是脚本文本或包含该脚本的文件路径。 该函数将其他可选参数作为 _1_2_3、…、 _n 变量的值传递给脚本。 此外,您可以在脚本内部使用 _editor 变量访问当前编辑器。

下面的示例展示了一个 groovyScript() 函数,它将给定字符串(另一个变量 $MyVar$ 的值)转换为大写字母:

groovyScript("_1.toUpperCase()", MyVar)

下面的示例展示了一个 groovyScript() 函数,它将所选文本拆分为单词,并将其显示为编号列表:

groovyScript("def result = ''; _1.split().eachWithIndex { item, index -> result = result + index.next() + '. ' + item + System.lineSeparator() }; return result;", SELECTION)

最后一个示例使用 SELECTION 预定义变量,这意味着您需要先选择文本,然后按 Ctrl+Alt+T包围方式 )来应用它。

JsArrayVariable()

返回当前 JavaScript 数组的名称。

jsClassName()

返回当前 JavaScript 类的名称。

jsComponentTypeOf()

返回当前 JavaScript 组件的类型。

jsDefineParameter

根据模块名称,从 define(["module"], function (<parameter_in_question>>) {}) 返回参数。

jsMethodName()

返回当前 JavaScript 方法的名称。

jsQualifiedClassName()

返回当前 JavaScript 类的完整名称。

jsSuggestDefaultVariableKind(Boolean)

布尔参数用于确定在当前上下文中是否允许常量。 如果未指定参数,则允许常量。 当模板展开时,对于 TypeScript 和 ES6,会显示包含 varletconst 选项的列表;对于较早的 JavaScript 版本,仅显示一个 var 选项。

jsSuggestImportedEntityName()

根据文件名为 `import * as $ITEM$ from "$MODULE$"``import $ITEM$ from "$MODULE$"` 类型的 import 语句建议名称。

jsSuggestIndexName()

从最常用的名称中返回一个索引变量的建议名称: ijk 等。 优先显示当前作用域中尚未使用的名称。

jsSuggestVariableName()

根据代码风格设置中的变量命名规则,基于变量类型和初始化表达式返回变量的建议名称。 例如,如果它是一个在迭代中保存某个元素的变量,PyCharm 会结合正在迭代的容器名称,对最合理的名称进行猜测。

lineCommentStart()

返回在当前语言环境中表示行注释开始的字符。

lineNumber()

返回当前行号。

lowercaseAndDash(<String>)

将字符串转换为小写,并插入短横线作为分隔符。 例如, lowercaseAndDash("MyExampleName")lowercaseAndDash("my example name") 都返回 my-example-name

pyClassName()

返回当前 Python 类的名称(模板展开所在的类)。

pyFunctionName()

返回当前 Python 函数的名称。

pyIterableVariable()

为可迭代变量启用特定作用域的补全。

在实时模板中使用 pyIterableVariable()

regularExpression(<String>, <Pattern>, <Replacement>)

String 中查找所有出现的 Pattern ,并将其替换为 Replacement。 您可以将模式指定为正则表达式,以查找字符串中与其匹配的所有内容。

例如, regularExpression(NAME, "a", "b") 表达式会将 $NAME$ 模板变量中的任何字母 "a" 替换为字母 "b"。 您可以在模式部分使用正则表达式字符类;例如, regularExpression(NAME, "[a-z]", "b") 将替换变量中的任意字母。 如果希望诸如 \d\w 之类的模式被视为正则表达式字符类,您必须对斜杠进行转义,使您的模式看起来像 "\\d"

showParameterInfo()

返回在向函数或方法添加参数时的参数详细信息。

使用示例:

显示参数信息

snakeCase(<String>)

将字符串转换为 snake_case。 例如, snakeCase("fooBar")snakeCase("foo bar") 都返回 foo_bar

spaceSeparated(<String>)

返回指定字符串,使用空格作为分隔符。 例如, spaceSeparated("fooBar") 返回 foo BarspaceSeparated("Foo_BAR") 返回 Foo BAR

spacesToUnderscores(<String>)

将作为参数传入的字符串中的空格替换为下划线。 例如, spacesToUnderscores("foo bar BAZ") 返回 foo_bar_BAZ

substringBefore(<String>, <Delimeter>)

返回到指定分隔符为止的子字符串。 这有助于移除测试文件名中的扩展名。 例如,在名为 component-test.js 的文件中使用时, substringBefore(fileName(),".") 返回 component-test

time([format])

返回当前系统时间。

默认情况下,如果不提供参数,则返回当前系统格式的时间。 要使用其他格式,请根据 SimpleDateFormat 规范提供参数。 例如, time("H:m z") 返回格式化为 13:10 UTC 的时间。

typeOfVariable(<String>)

返回作为参数传入的变量的类型。

仅在 Java 上下文中可用。

underscoresToCamelCase(<String>)

将带下划线的字符串(如 snake_case )转换为 camelCase。 例如, underscoresToCamelCase(foo_bar_baz)underscoresToCamelCase(FOO_BaR_baZ) 都返回 fooBarBaz

underscoresToSpaces(<String>)

将字符串中的下划线转换为空格。 例如, underscoresToSpaces(foo_bar_baz) 返回 foo bar bazunderscoresToSpaces(FOO_BaR_baZ) 返回 FOO BaR baZ

user()

返回当前用户的名称。

最后修改日期: 2025年 12月 2日