Konwencje nazewnictwa

Lekcja 3 z 28 w kursie Czysty kod — pisz lepszy kod w Pythonie w Coddy.

Nazewnictwo jest kluczową częścią pisania kodu. Nadajesz nazwy zmiennym, funkcjom, klasom i wielu innym elementom...

Python przedstawia kilka sugerowanych stylów nazewnictwa:

Typ	Konwencja	Przykład
Zmienna	Snake case	`x`, `index`, `max_number`
Funkcja	Snake case	`calculate`, `convert_to_int`
Klasa	Pascal case	`Person`, `JavaCompiler`
Metoda	Snake case	`print`, `make_sound`
Stała	Snake case (wielkie litery)	`PI`, `MAX_TIMEOUT`, `MIN_AGE`
Moduł	Snake case	`script.py`, `my_app.py`
Pakiet	Snake case (bez podkreśleń)	`package`, `mypackage`

Snake case (snake_case) — małe litery, słowa oddzielone podkreśleniami.
Pascal case (PascalCase) — słowa zaczynające się wielką literą

Bardziej szczegółowy przykład zastosowania tych konwencji:

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())

Zwróć uwagę na wszystkie różne typy!