I have a class named SSLXMLRPCServer. Should it be that or SslXmlRpcServer?
views:
121answers:
7
+4
Q:
If my python class name has an acronym, should I keep it upper case, or only the first letter?
+1
A:
I normally uppercase acronyms. Twisted and a few other libraries do this as well.
aaronasterling
2010-09-10 22:17:34
+6
A:
This is a matter of personal preference, but I find the second format much easier to read. The fact that your first format has a typo in it (PRC instead or RPC) suggests that I am not the only one.
Dave Kirby
2010-09-10 22:18:28
.NET has an interesting take at it: 2-letter components are uppercased (most notably `IO`; I don't recall seeing any other one in 2 letters, actually), but everything else is Pascal-cased, so `Xml`, `Rpc`, `Ssl`, `Http` etc. Sounds weird, but I the people who wrote it originally just couldn't stand the pain looking at `Io`.
Pavel Minaev
2010-09-10 22:28:36
+1
A:
The PEP-8 mentions nothing about acronyms. You would be safest to keep the acronyms uppercased (it's what I see most).
ikanobori
2010-09-10 22:23:02
You mean, it doesn't mention it except for *Note: When using abbreviations in CapWords, capitalize all the letters of the abbreviation. Thus HTTPServerError is better than HttpServerError.* certainly... :) (It should be noted that I disagree with this recommendation.)
dash-tom-bang
2010-09-10 23:49:05
A:
I had this problemlots of time . I uppercase Acronym but I doesn't like it because when you chain them (as in your example) it doesn't feel right. However I think the best things to do is to make a choice and stick to hit, so at least don't you know when you need to reference something how it's written without having to check (which is one of the benefit of coding standard)
mb14
2010-09-10 22:25:57
It doesn't feel right until you decide to start doing it. Then you get really irritated by software that jams acronyms together making them impossible to parse.
dash-tom-bang
2010-09-10 23:50:14
Except in our case : SSLXMLRPCServer is just really hard to read, and so can't feel right (even if it's the best solution)
mb14
2010-09-11 08:23:37
+3
A:
The problem with uppercase acronyms in CamelCase names is that the word following the acronym looks like a part of it, since it begins with a capital letter. Also, when you have several in a row as in your example, it is not clear where each begins. For this reason, I would probably use your second choice.
kindall
2010-09-10 22:30:12
+3
A:
It should be SSLXMLRPCServer, to match the standard library classes like SimpleXMLRPCServer, CGIXMLRPCRequestHandler, etc.
Adopting a naming convention that differs from equivalents in the standard library is only going to confuse people.
Porculus
2010-09-10 23:03:53
A:
How about SSL_XML_RPC_Server for acronymity and readability?
It's what I often do when I want to avoid camel-case for some reason.
martineau
2010-09-10 23:38:10
I think mixing camel case and snake case, is the worth you can do. In my opinion, you should choose one way of naming stuff and stick to it, without exception.
mb14
2010-09-11 08:24:44