将“Google”设为所有项目 PyCharm 的默认文档字符串样式

Mat*_* M. 9 docstring intellij-idea pycharm

我知道我可以转到设置 | 工具 | Python集成工具| 文档字符串 | 文档字符串格式 | 谷歌,但这只会设置当前项目的文档字符串格式(如窗口中的“当前项目”标题所示)。我正在寻找一种更改默认值的方法,以便我的所有项目默认使用 google docstring 格式。

据我所知,JetBrain自己的文档没有提到如何实现这一点。

Tah*_*lor 3

在撰写本文时,这是不可能的。在过去的几年里,已经提交了几张请求此功能的票,大概正在开发中。

https://youtrack.jetbrains.com/issue/PY-33833

https://youtrack.jetbrains.com/issue/PY-20243

在短期内,如果您需要将以前的项目从默认值转换为默认值,您可以找到存储在“.idea/MYPROJECT.iml”文件中的设置:

  <component name="PyDocumentationSettings">
    <option name="myDocStringFormat" value="Google" />
  </component>
Run Code Online (Sandbox Code Playgroud)

默认情况下,没有 PyDocumentationSettings 组件,因此您需要添加它。在 Linux 中,您可以在终端中运行以下(非常黑客的)代码来更改任何子目录中的所有项目:

new_docstring='  <component name="PyDocumentationSettings">\n    <option name="myDocStringFormat" value="Google" />\n  </component>\n</module>'
find . -type f -name '*.iml' -print0 | xargs -0 sed -i "s|</module>|$new_docstring|g"
Run Code Online (Sandbox Code Playgroud)

如果您只是想从 Numpy 转到 Google,您可以使用:

find . -type f -name '*.iml' -print0 | xargs -0 sed -i "s|Numpy|Google|g"
Run Code Online (Sandbox Code Playgroud)