Python:变量命名约定-文件,路径,文件路径,文件路径

6
我想知道在Python中以下变量的正确命名规范,但我无法从Google Style GuidePEP8中找到。假设我有以下Python代码:
output_file = open(output_file_path, 'w')
那么输出文件名的最佳变量名称是什么?
我认为可能的选项为:
output_file、outputfile、outfile、out_file、outfile 而路径变量可以是:
output_file_path、output_filepath、output_path、out_path...

我理解你问题中提到的下划线和非下划线的区别,但在最后一行中,你想将变量命名为 output_path 还是 output_filepath 完全取决于你自己。 - Arpit Solanki
1
无论你和其他人在代码中喜欢什么。 - Klaus D.
1
个人而言,我更喜欢使用 output_pathout_path。其他的变量名感觉有点冗长,特别是当你有多个变量定义不同的输出路径时。但如果你正在编辑别人的脚本,那么遵循他们的惯例保持一致性是非常重要的。 - Green Cell
2个回答

14
根据 PEP8 规范,在变量名中应该使用下划线_将每个有意义的单词连接起来,类名同样使用大写字母。通过查找单词filepath,我发现在英语中并没有这个词,它由两个独立的单词(file, path)组成。因此,使用file_path而不是“filepath”是正确的,尽管这两种方式都被开发人员使用。
关于包含单词output的部分,根据《Python之禅》的原则,我们已经知道:

可读性很重要。

明了胜过晦涩。

因此,在变量名前面加上output是更好的选择。所以我认为output_file_pathoutput_file是正确且最佳的选择。

1
引用自https://english.stackexchange.com/a/428231/289175
“filepath”和“file path”两种表达形式均可,但使用哪一种往往取决于语境。...作为一个无连字符的复合词,“filepath”通常在讨论它作为实体时使用(例如:“在写出任何数据之前,你需要设置filepath。”),而“file path”作为两个单独的单词,则通常在指文件的特定属性时使用。

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接