מוסכמות שמות

שיעור 3 מתוך 28 בקורס קוד נקי – כתיבת קוד טוב יותר באמצעות Python של Coddy.

מתן שמות הוא חלק חשוב מכתיבת קוד. נותנים שמות למשתנים, לפונקציות, למחלקות ועוד...

Python מציגה כמה סגנונות מומלצים למתן שמות:

סוג	מוסכמה	דוגמה
משתנה	Snake case	`x`, `index`, `max_number`
פונקציה	Snake case	`calculate`, `convert_to_int`
מחלקה	Pascal case	`Person`, `JavaCompiler`
מתודה	Snake case	`print`, `make_sound`
קבוע	Snake case (אותיות גדולות בלבד)	`PI`, `MAX_TIMEOUT`, `MIN_AGE`
מודול	Snake case	`script.py`, `my_app.py`
חבילה	Snake case (ללא קווים תחתונים)	`package`, `mypackage`

Snake case (snake_case) — אותיות קטנות, מילים מופרדות בקווים תחתונים.
Pascal case (PascalCase) — מילים שמתחילות באות גדולה

דוגמה מפורטת יותר לשימוש בכולם יחד,

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

שימו לב לכל הסוגים השונים כאן!