Convenções de Nomenclatura

Lição 3 de 28 do curso Clean Code - Escreva códigos melhores com Python da Coddy.

Dar nomes é uma parte crucial da escrita de código. Você dá nomes a variable, função, classes e muito mais...

Python apresenta alguns estilos de nomenclatura sugeridos:

Tipo	Convenção	Exemplo
Variable	Snake case	`x`, `index`, `max_number`
Função	Snake case	`calculate`, `convert_to_int`
Class	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 letra maiúscula

Exemplo mais detalhado usando tudo em conjunto:

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!