Bird
Raised Fist0
PythonHow-ToBeginner · 3 min read

How to Define Class Method in Python: Simple Guide

In Python, define a class method by adding the @classmethod decorator above a method inside a class. The method must take cls as the first parameter to refer to the class itself instead of an instance.
📐

Syntax

To define a class method, use the @classmethod decorator before the method. The method must accept cls as its first parameter, which represents the class, not an instance.

  • @classmethod: marks the method as a class method.
  • def method_name(cls, ...): defines the method with cls as the first argument.
python
class MyClass:
    @classmethod
    def my_class_method(cls, arg1):
        print(f"Called class method of {cls} with argument {arg1}")
💻

Example

This example shows a class method that prints the class name and a passed argument. It is called on the class itself, not on an instance.

python
class Dog:
    species = "Canis familiaris"

    @classmethod
    def describe_species(cls):
        print(f"All dogs belong to the species: {cls.species}")

Dog.describe_species()
Output
All dogs belong to the species: Canis familiaris
⚠️

Common Pitfalls

Common mistakes when defining class methods include:

  • Forgetting the @classmethod decorator, which makes the method a regular instance method.
  • Using self instead of cls as the first parameter, which is incorrect for class methods.
  • Trying to call class methods on instances without understanding they receive the class, not the instance.
python
class Example:
    # Wrong: missing @classmethod decorator
    def wrong_method(cls):
        print("This is not a class method")

    # Wrong: using self instead of cls
    @classmethod
    def wrong_param(cls):
        print("Should use cls, not self")

    # Correct way
    @classmethod
    def correct_method(cls):
        print("This is a proper class method")
📊

Quick Reference

ConceptDescription
@classmethodDecorator to define a class method
clsFirst parameter representing the class
Called on classClass methods are called on the class, not instances
Access class dataClass methods can access or modify class variables
✅

Key Takeaways

Use @classmethod decorator to define a class method in Python.
The first parameter must be cls to refer to the class itself.
Class methods can be called on the class without creating an instance.
Forgetting @classmethod or using self instead of cls are common errors.
Class methods are useful to access or modify class-level data.