Skip to main content
 首页 » 编程设计

python之PyCharm:函数参数的正则表达式字符串意图

2024年12月31日25freeliver54

我有一个函数,它接受一个将被编译成正则表达式的字符串参数,如下所示:

class Pattern: 
    def __init__(self, pattern, **kwargs) -> None: 
        self.re = re.compile(pattern) 
        self.extras = dict(**kwargs) 
 
    ... more methods ... 

当我初始化一个 Pattern 对象时,我喜欢 PyCharm(实际上,我正在使用带有 Python 插件的 IntelliJ IDEA,但我认为这本质上是相同的平台)知道我的pattern 参数字符串应该符合 Python 的正则表达式语法,并且可以语法高亮,就像使用 re.compile(pattern) 时一样:

# This won't be recognized as a regex intention: 
p1 = Pattern(r'^(?P<site>[A-Z]{4}).(?P<unit>\d{4})') 
# But this will: 
p2 = re.compile(r'^(?P<site>[A-Z]{4}).(?P<unit>\d{4})') 

这里有什么方法可以给 IDE 一个提示,无论作为 pattern 参数传递给 Pattern 的什么都应该有正则表达式语法?理想情况下,我可以在代码中添加某种提示注释或类型提示,这样它也适用于其他开发人员。

我确实知道:

  • 我可以为此创建一个插件 - 在我的情况下,这可能会大材小用。
  • 我可以在对 Pattern(...) 的任何特定调用的临时基础上执行“注入(inject)语言或引用” - 但这是暂时的,当有很多这样的事情时它会很乏味调用,它不会帮助其他开发人员更轻松地阅读代码。

编辑:

这个问题是“Can one automatically get Intellij's regex assistance for one's own regex parameters”的直接类比,但针对的是 Python 而不是 Java。 IntelliLang该答案中的解决方案似乎仅适用于编辑 Java 或 XML 文件。

请您参考如下方法:

我找到了一种方法,但效果不如我预期的那么顺利。

文件-设置-编辑器-语言注入(inject)-添加:

  • 通用 Python
  • ID:正则表达式
  • 地点模式:

+ pyLiteralExpression().and(pyMethodArgument("Pattern", 0, "foo.bar.Pattern"))

现在 RegExp 将被注入(inject)到 Pattern 的参数中。

下一步是分享这个注入(inject)。注入(inject)是使用 IDE 级范围创建的,它存储在无法共享的 IDE 设置中。

要将此注入(inject)放入项目设置中,您必须将注入(inject)移动到 Project 级范围(相应的按钮在添加注入(inject)的按钮下方),但随后它停止工作:(唯一的方法是Export-Import注入(inject)但是不方便:(

随时创建问题 here .