如果我的python类名称有一个首字母缩略词,我应该保持大写,还是只保留第一个字母?

时间:2010-09-10 22:15:39

标签: python standards

我有一个名为SSLXMLRPCServer的类。应该是那个还是SslXmlRpcServer?

8 个答案:

答案 0 :(得分:10)

这是个人偏好的问题,但我发现第二种格式更容易阅读。您的第一种格式中包含拼写错误(PRC而非RPC)这一事实表明我不是唯一的格式。

答案 1 :(得分:6)

它应该是SSLXMLRPCServer,以匹配标准库类,如SimpleXMLRPCServer,CGIXMLRPCRequestHandler等。

采用与标准库中的等价物不同的命名约定只会让人感到困惑。

答案 2 :(得分:3)

CamelCase名称中大写首字母缩略词的问题在于首字母缩略词后面的单词看起来像是它的一部分,因为它以大写字母开头。此外,如果您的示例中有多个连续的,则不清楚每个开始的位置。出于这个原因,我可能会使用你的第二选择。

答案 3 :(得分:2)

PEP-8没有提及缩略词。你最安全的是保持缩写的缩写(这是我最常见的)。

答案 4 :(得分:1)

我通常用大写的缩写词。 Twisted和其他一些库也可以这样做。

答案 5 :(得分:1)

如前所述,PEP-8表示使用大写字母作为首字母缩略词。现在,python zen还说"可读性计数" (对我来说,zen优先于PEP:​​ - )。

我在这种不明确的情况下的意见是考虑编程环境中的标准,而不仅仅是语言。例如,某些xml-http-query类应该在servlet上下文中编写XMLHttpQuery(w.r.t XMLHttpRequest)。

我不了解您的背景信息,但似乎XMLRPCServer存在并且您想要将ssl附加到它上面。所以你可以选择:

SSL_XMLRPCServer

它会强调XMLRPCServer - 不改变它 - 。
此外,您仍然靠近PEP-8并遵循禅宗: - )

我的2美分

注意:如果XMLRPCServer与您的班级没有密切关系,并且实际上是该域名的标准,那么您需要选择其他名称,以免造成混淆。

答案 6 :(得分:0)

我有这个问题很多时间。我是大写的缩写词,但我不喜欢它,因为当你链接它们时(如你的例子)它感觉不对。但是我觉得最好的办法就是做出选择并坚持下去,所以至少你不知道什么时候你需要引用它的编写方式而不必检查(这是编码标准的好处之一)

答案 7 :(得分:0)

首字母缩略词的可读性SSL_XML_RPC_Server怎么样?

当我想出于某种原因想要避免骆驼案时,这就是我经常做的事情。