Qual é a convenção de nomenclatura no Python para nomes de variáveis ​​e funções?

Vindo de um plano de fundo em C #, a convenção de nomenclatura para nomes de variáveis ​​e métodos geralmente é camelCase ou PascalCase:

// C# example
string thisIsMyVariable = "a"
public void ThisIsMyMethod()

No Python, vi o acima, mas também vi sublinhados sendo usados:

# python example
this_is_my_variable = 'a'
def this_is_my_function():

Existe um estilo de codificação definitivo mais preferível para Python?

Consulte Python PEP 8: nomes de funções e variáveis :

Os nomes das funções devem estar em minúsculas, com palavras separadas por sublinhados, conforme necessário, para melhorar a legibilidade.

Os nomes de variáveis ​​seguem a mesma convenção que os nomes de funções.

O mixedCase é permitido apenas em contextos onde esse já é o estilo predominante (por exemplo, threading.py ), para manter a compatibilidade com versões anteriores.

O Guia de estilos do Google Python possui a seguinte convenção:

module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_CONSTANT_NAME, global_var_name, instance_var_name, function_parameter_name, local_var_name.

Um esquema de nomeação semelhante deve ser aplicado a um CLASS_CONSTANT_NAME

David Goodger (em "Code Like a Pythonista" aqui ) descreve as recomendações do PEP 8 da seguinte maneira:

• joined_lower para funções, métodos, atributos, variáveis

• joined_lowerou ALL_CAPSpara constantes

• StudlyCaps para aulas

• camelCase apenas para estar em conformidade com convenções pré-existentes

Como o Guia de estilo do código Python admite,

As convenções de nomenclatura da biblioteca do Python são um pouco complicadas, portanto nunca conseguiremos isso completamente consistente

Observe que isso se refere apenas à biblioteca padrão do Python . Se eles não conseguem ser tão consistentes, dificilmente há muita esperança de ter uma convenção geralmente aderida a todos os códigos Python, existe?

A partir daí, e a discussão aqui, eu deduzir que é não um pecado horrível se alguém continua usando por exemplo, C # 's (clara e bem estabelecida) do Java ou convenções de nomenclatura para variáveis e funções quando atravessar para Python. Tendo em mente, é claro, que é melhor respeitar o estilo predominante de uma base de código / projeto / equipe. Como o Python Style Guide aponta, a consistência interna é mais importante.

^{Sinta-se livre para me rejeitar como herege. :-) Como o OP, eu não sou um "Pythonista", ainda não.}

Existe o PEP 8 , como mostram outras respostas, mas o PEP 8 é apenas o guia de estilo para a biblioteca padrão e é considerado como evangelho nela. Um dos desvios mais freqüentes do PEP 8 para outros trechos de código é a nomeação de variáveis, especificamente para métodos. Não existe um estilo predominante, embora, considerando o volume de código que usa mixedCase, se alguém fizesse um censo estrito, provavelmente terminaria com uma versão do PEP 8 com mixedCase. Há pouco outro desvio do PEP 8 que é tão comum.

Como mencionado, o PEP 8 diz para usar lower_case_with_underscorespara variáveis, métodos e funções.

Prefiro usar lower_case_with_underscorespara variáveis ​​e mixedCasemétodos e funções para tornar o código mais explícito e legível. Assim, seguindo o Zen do Python, "explícito é melhor que implícito" e "Legibilidade conta"

além do que @JohnTESlade respondeu. O guia de estilo python do Google tem algumas recomendações bem legais,

Nomes a evitar

• nomes de caracteres únicos, exceto contadores ou iteradores
• traços (-) em qualquer nome de pacote / módulo
• \__double_leading_and_trailing_underscore__ names (reservado por Python)

Convenção de nomes

• "Interno" significa interno de um módulo ou protegido ou privado dentro de uma classe.
• A adição de um único sublinhado (_) tem algum suporte para proteger variáveis ​​e funções do módulo (não incluídas na importação * de). A adição antecipada de um sublinhado duplo (__) a uma variável ou método de instância serve efetivamente para tornar a variável ou o método privado para sua classe (usando a manipulação de nome).
• Coloque classes relacionadas e funções de nível superior juntas em um módulo. Ao contrário do Java, não há necessidade de se limitar a uma classe por módulo.
• Use CapWordspara nomes de classes, mas lower_with_under.pypara nomes de módulos. Embora existam muitos módulos nomeados CapWords.py, isso agora é desencorajado porque é confuso quando o módulo recebe o nome de uma classe. ("espera - eu escrevi import StringIOou from StringIO import StringIO?")

Diretrizes derivadas das recomendações de Guido

A maioria das pessoas python prefere sublinhados, mas mesmo que eu esteja usando python há mais de 5 anos, ainda não gosto deles. Eles só parecem feios para mim, mas talvez isso seja todo o Java na minha cabeça.

Eu simplesmente gosto mais do CamelCase, pois ele se encaixa melhor na maneira como as classes são nomeadas. Parece mais lógico SomeClass.doSomething()que isso SomeClass.do_something(). Se você procurar no índice global do módulo em python, encontrará os dois, devido ao fato de ser uma coleção de bibliotecas de várias fontes que aumentaram horas extras e não algo que foi desenvolvido por uma empresa como a Sun com regras estritas de codificação . Eu diria que o essencial é: use o que quiser melhor, é apenas uma questão de gosto pessoal.

Pessoalmente, tento usar o CamelCase para classes, métodos e funções mixedCase. As variáveis ​​geralmente são separadas por sublinhado (quando me lembro). Dessa forma, posso dizer rapidamente o que exatamente estou chamando, em vez de tudo parecer o mesmo.

Há um artigo sobre isso: http://www.cs.kent.edu/~jmaletic/papers/ICPC2010-CamelCaseUnderScoreClouds.pdf

TL; DR Diz que snake_case é mais legível que camelCase. É por isso que as línguas modernas usam (ou deveriam usar) cobra sempre que podem.

O estilo de codificação geralmente faz parte dos padrões de política / convenção internos de uma organização, mas acho que, em geral, o estilo all_lower_case_underscore_separator (também chamado snake_case) é mais comum em python.

Pessoalmente, uso as convenções de nomenclatura do Java ao desenvolver em outras linguagens de programação, pois é consistente e fácil de seguir. Dessa forma, não estou lutando continuamente sobre quais convenções usar e que não devem ser a parte mais difícil do meu projeto!

Normalmente, segue-se as convenções usadas na biblioteca padrão do idioma.