我应该如何命名我的类和函数甚至字符串？

Question

你可能会说我是Python新手.我已阅读各种文档,但我仍然无法弄清楚,如果有一个"naming best practices"对字符串的函数,当然,类.

如果我想将类或函数命名为SiteMap,是否可以使用SiteMap？例如,它应该是Site_map还是其他任何东西？

谢谢!

PS.任何进一步的阅读资源都非常感谢!PS.我正在做网络应用程序开发(学习,更好的说!)

Answer 1

命名约定:

我使用了各种Python命名约定.这里的一致性肯定是好的,因为它有助于确定哪种对象名称指向.我认为我使用的约定基本上遵循PEP8.

1)模块名称应为小写,带下划线而不是空格.(并且应该是导入的有效模块名称.)

2)变量名称和函数/方法名称也应该是小写的,带有下划线以分隔单词.

3)类名应该是CamelCase(以大写字母开头,单词一起运行,每个以大写字母开头).

4)模块常量应全部为大写.

你通常会有module.ClassName.method_name.

5) CamelCase中具有与模块名称相同的主类名称的模块名称很烦人.(例如ConfigParser.ConfigParser,应始终拼写configobj.ConfigObj.)

6)此外,不属于您的公共API的变量,函数,方法和类应该以单个下划线开头.(使用双下划线使属性私有几乎总是错误 - 特别是对于可测试性.)

空白

最后,你应该总是在操作符和标点符号后面有空格.例外是方法和函数的默认参数.

例如def函数(默认=参数):和 x = a * b + c

Answer 2

PEP8指定了Python的推荐命名约定.在那里讨论的规则中,它提到underscore_names函数和变量(不论其类型)和CamelCase类.