Convenções de Nomenclatura
Lição 3 de 28 do curso Clean Code - Escreva códigos melhores com Python da Coddy.
A nomeação é uma parte crucial da escrita de código. Você dá nomes a variáveis, funções, classes e muito mais...
O Python introduz alguns estilos de nomeação sugeridos:
| Tipo | Convenção | Exemplo |
|---|---|---|
| Variável | Snake case | x, index, max_number |
| Função | Snake case | calculate, convert_to_int |
| Classe | Pascal case | Person, JavaCompiler |
| Método | Snake case | print, make_sound |
| Constante | Snake case (todas maiúsculas) | PI, MAX_TIMEOUT, MIN_AGE |
| Módulo | Snake case | script.py, my_app.py |
| Pacote | Snake case (sem sublinhados) | package, mypackage |
- Snake case (snake_case) - Letras minúsculas, palavras separadas por sublinhados.
- Pascal case (PascalCase) - Palavras iniciadas com maiúsculas.
Exemplo mais detalhado de como usar tudo isso junto,
import my_module
class ImportantClass:
MY_CONSTANT = 3.14
def good_function(self, variable):
return variable
def better_function(self):
return MY_CONSTANT
def __name__ == '__main__':
var = my_module.secret()
important_class = ImportantClass()
important_class.good_function(var)
print(important_class.better_function())
Observe todos os diferentes tipos aqui!
Você sabia? A diferença entre função e método é que o método é uma função associada a um objeto/classe.
Experimente você mesmo
Esta lição não inclui um desafio de código.