Python hat eine Reihe von Regeln und Konventionen, die wir beim Benennen unserer Klassen, Methoden und Attribute anwenden. Diese Konventionen sind wichtig, da sie für Einheitlichkeit im geschriebenen Code sorgen und das Lesen und Verstehen erleichtern. Es ist auch eine professionelle Best Practice, sich an diese Konventionen zu halten.
Klassennamen
In Python folgen Klassennamen der CapWords-Konvention, auch bekannt als PascalCase. Dabei wird der erste Buchstabe jedes Wortes großgeschrieben und es gibt keine Unterstriche (_) zwischen den Wörtern:
class MyClass: # Klassenname beginnt mit einem Großbuchstaben
pass # Wir verwenden "pass", wenn die Klasse nichts tun soll
Der Begriff PascalCase stammt aus der Programmiersprache Pascal und bezieht sich auf deren Groß-/Kleinschreibkonvention. CapWords ist der Begriff, der im offiziellen Python-Stilguide (PEP 8) verwendet wird und entspricht im Wesentlichen PascalCase.
Methodennamen
Methodennamen sollten komplett kleingeschrieben sein, wobei Wörter zur besseren Lesbarkeit durch Unterstriche getrennt werden. Dies wird auch als snake_case bezeichnet. Hier ein Beispiel:
class MyClass:
def my_method(self): # Methodenname ist komplett kleingeschrieben
pass # Wörter werden durch Unterstriche getrennt
Attributnamen
Attributnamen folgen der gleichen Konvention wie Methodennamen: Sie sollten komplett kleingeschrieben sein, wobei Wörter durch Unterstriche getrennt werden, um die Lesbarkeit zu verbessern.
class MyClass:
def __init__(self):
self.my_attribute = 'some value' # Attributname ist kleingeschrieben,
# Wörter durch Unterstriche getrennt
Im obigen Code haben wir ein Attribut my_attribute innerhalb der __init__-Methode definiert. Die __init__-Methode ist eine spezielle Methode in Python-Klassen, die automatisch aufgerufen wird, wenn eine neue Instanz der Klasse erstellt wird.
Schauen wir uns ein vollständiges Beispiel einer Klasse mit ihren Methoden und Attributen an:
class MyCar: # Klassenname verwendet CapWords
def __init__(self):
self.car_model = 'Tesla Model 3' # Attributname verwendet snake_case
def start_engine(self): # Methodenname verwendet snake_case
print('Engine started!')
Obwohl Python diese Benennungsrichtlinien nicht strikt erzwingt, macht die Einhaltung Ihren Code professioneller, lesbarer und konsistenter. Daher gilt es in der Python-Community als gute Praxis.