Convenções de nomes para variáveis e funções no Python? – python python-2.7 python-3.x

Pergunta:


No R, existe muita liberdade e variedade nos nomes de funções entre os pacotes. Nomes com ponto (get.this), nomes com camelCase (getThis), nomes com underline (get_this). Isso tem seus prós e contras: mas o fato é que não parece haver uma padronização muito grande.

Tenho começado a estudar mais Python e me parece que a preocupação com readability e padronização da comunidade é maior do que no R. Quais as convenções de nomes para funções, variáveis, constantes etc em Python?

Autor da pergunta Carlos Cinelli

Guilherme Agostinelli

Segundo as convenções de nomenclatura do próprio Python Enhancement Proposal 8, algumas preocupações incluem:

Evitar certos nomes

Nunca usar os caracteres ‘l’, ‘O’, ou ‘I’ como nomes de variáveis pois, em algumas fontes, eles são indistinguíveis dos números um e zero.

Pacote e nomes de módulos

Os módulos devem ter nomes pequenos, sendo estes escritos em minúsculo por completo.

Ex: package

Nomes de classes

Os nomes de classes têm a primeira letra de cada palavra maiúscula (CamelCase).

Ex: NomeDeUmaClasse

Nomes de funções e métodos

Nomes de funções e métodos devem estar em letras minúsculas, com palavras separadas por underscores conforme seja útil para a legibilidade.

Ex: nome_de_uma_funcao

Obs: o caso misto (todas as iniciais maiúsculas, com exceção da primeira) é permitido apenas em contextos onde isso já é o estilo predominante, para manter compatibilidade com versões anteriores.

Constantes

Constantes são geralmente definidas em um nível de módulo e escritas em letras maiúsculas com underscores separando as palavras. Exemplos incluem MAX_OVERFLOW e TOTAL.

Nomes de variáveis e parâmetros de funções e métodos

Geralmente seguem a mesma regra das funções, devendo estar em letras minúsculas, com palavras separadas por underscores conforme seja útil para a legibilidade.

Obs: Usar self como primeiro parâmetro de um método.

Ex: nome_de_um_metodo(self):

Identação

A identação deve ser feita usando quatro espaços por nível.

Linhas em branco

Linhas em branco são recomendadas para separar funções e definições de classes (duas linhas), além de definições de métodos (uma linha).

Espaços em branco

O espaço em branco deve ser usado para separar operadores matemáticos, binários, de comparação e de atribuição de outros elementos.

Ex:

if variavel == False:
    print 2 * 3

Deve-se evitar o uso de espaços em branco entre parênteses e parâmetros na declaração de uma função, bem como entre uma chamada de função e o primeiro parêntese de sua lista de argumentos.

Ex: funcao(primeiro_parametro, segundo_parametro)

Fonte

Related Posts:

Qual a diferença entre AppCompatActivity e Activity? – android android-activity
Pergunta: Qual a diferença da AppCompatActivity para Activity ? A partir de qual versão a AppCompatActivity foi adicionada ao Android? Autor da pergunta Luhhh A diferença reside ...
Como abreviar palavras em PHP? – php string
Pergunta: Possuo informações comuns como nome de pessoas e endereços, e preciso que elas contenham no máximo 30 caracteres sem cortar palavras. Exemplo: 'Avenida Natalino João Brescansin' ...
Qual é a finalidade de um parêntese vazio numa declaração Lambda? – c# expressões-lambda característica-linguagem
Pergunta: Criei um exemplo de uma declaração Lambda sem argumentos, entretanto, estou com duvidas referente a omissão do parêntese vazio () na declaração. Veja o exemplo: class ...
Boas práticas para URI em API RESTful – api rest restful
Pergunta: Estou com dúvida em relação às URIs de alguns recursos da api que estou desenvolvendo. Tenho os recursos projetos e atividades com relação 1-N, ...
Dúvidas sobre a integração do MySQL com Java – java mysql netbeans
Pergunta: Estou criando um sistema no NetBeans, utilizando a linguagem Java e o banco de dados MySQL. Escrevi o seguinte código para realizar a conexão ...
Qual é a finalidade da pasta Model do framework Inphinit? – php inphinit
Pergunta: No Inphinit micro-framework existe a pasta Model que fica dentro da pasta application, e nela é onde ficam as classes, mas eu estou muito ...
Uso do ‘@’ em variáveis – javascript typescript coffeescript
Pergunta: Vejo em algumas linguagens que compilam para javascript, como TypeScript e CoffeeScript, o uso do @ em variáveis, como também, casos em que o ...
Qual tamanho máximo um arquivo JSON pode ter? – json arquivo
Pergunta: Vou dar um exemplo para conseguir explicar minha duvida: Preciso recuperar informação de imagens vindas de uma API, esse banco de imagens me retorna JSON's ...
O que é Teste de Regressão? – terminologia engenharia-de-software testes
Pergunta: Na matéria de Teste de Software o professor abordou um termo chamado Teste de Regressão, isto dentro da disciplina de teste de software. Sendo ...
O que é um construtor da linguagem? – php característica-linguagem
Pergunta: Em PHP, já li e ouvi várias vezes a respeito dos Construtores da Linguagem. Os casos que sempre ouvi falar deles foi em casos ...
Função intrínseca para converter numérico para string – cobol
Pergunta: Estou a tentar saber se existe alguma função intrínseca do COBOL para converter um data numérico para string sem precisar usar a cláusula REDEFINES: ( ...
Porque usar implements? – java android
Pergunta: Qual a diferença entre usar btn.setOnClickListener(new OnClickListener() { e public class MainActivity extends Activity implements OnClickListener{ Estive fazendo um curso de Android e meu professor falou que ...
O que é XHTML e quando deve ser usado? – html xml xhtml
Pergunta: O que eu sei é que o XHTML precisa ser XML válido. Isso implica, por exemplo, que todas as tags precisam ser fechadas. Por ...
Uma placa aceleradora de vídeo pode melhorar o desempenho não-gráfico? [fechada] – desempenho
Pergunta: Para desenvolver em Ruby on Rails, eu utilizo aqui uma máquina virtual do VirtualBox com Ubuntu Server 14.04 sem interface gráfica instalada. Recentemente descobri uma ...
Concat() VS Union() – c# .net
Pergunta: Qual a diferença entre Concat() e Union() ? Quando usar Concat() e quando usar Union() ? Somente pode ser usado em list ? ...

Deixe uma resposta

O seu endereço de email não será publicado. Campos obrigatórios marcados com *