使 'Google' 成为所有项目的默认文档字符串样式 PyCharm
Make 'Google' the default docstring style for ALL projects PyCharm
我知道我可以转到设置 |工具 | Python 集成工具 |文档字符串 |文档字符串格式 | Google,但这只会设置当前项目的文档字符串格式(如 window 中的标题 'for current project' 所示)。我正在寻找一种更改默认值的方法,以便我的所有项目默认使用 google 文档字符串格式。
据我所知,JetBrain 的 own documentation 没有提及如何完成此操作。
目前无法执行此操作。请将有关它的功能请求提交至 https://youtrack.jetbrains.com/issues/PY
编辑:
以下工单(如下所述)现在处于 进行中 状态 https://youtrack.jetbrains.com/issue/PY-20243。
根据Fix versions字段,应该在2019.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>
默认情况下,没有 PyDocumentationSettings 组件,因此您需要添加它。在 Linux 中,您可以 运行 在终端中使用以下(非常 hackish)代码来更改任何子目录中的所有项目:
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"
如果您只是想从例如Numpy 到 Google,你可能只需要使用:
find . -type f -name '*.iml' -print0 | xargs -0 sed -i "s|Numpy|Google|g"
我知道我可以转到设置 |工具 | Python 集成工具 |文档字符串 |文档字符串格式 | Google,但这只会设置当前项目的文档字符串格式(如 window 中的标题 'for current project' 所示)。我正在寻找一种更改默认值的方法,以便我的所有项目默认使用 google 文档字符串格式。
据我所知,JetBrain 的 own documentation 没有提及如何完成此操作。
目前无法执行此操作。请将有关它的功能请求提交至 https://youtrack.jetbrains.com/issues/PY
编辑: 以下工单(如下所述)现在处于 进行中 状态 https://youtrack.jetbrains.com/issue/PY-20243。 根据Fix versions字段,应该在2019.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>
默认情况下,没有 PyDocumentationSettings 组件,因此您需要添加它。在 Linux 中,您可以 运行 在终端中使用以下(非常 hackish)代码来更改任何子目录中的所有项目:
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"
如果您只是想从例如Numpy 到 Google,你可能只需要使用:
find . -type f -name '*.iml' -print0 | xargs -0 sed -i "s|Numpy|Google|g"