Class methods and cls usage in Python

Introduction

Class methods let you work with the class itself, not just one object. Using cls helps you change or use class-wide information easily.

When you want to create alternative ways to make objects.

When you need to change or check something that belongs to the whole class, not just one object.

When you want a method that works with the class but doesn't need a specific object.

When you want to keep track of how many objects of a class have been made.

Syntax

Python

class ClassName:
    @classmethod
    def method_name(cls, parameters):
        # code using cls to access class variables or methods

The @classmethod decorator marks the method as a class method.

cls is like self, but it points to the class, not an object.

Examples

This class method returns the species name shared by all dogs.

Python

class Dog:
    species = 'Canis familiaris'

    @classmethod
    def get_species(cls):
        return cls.species

This class method tells how many Dog objects have been created.

Python

class Dog:
    count = 0

    def __init__(self, name):
        self.name = name
        Dog.count += 1

    @classmethod
    def how_many(cls):
        return cls.count

This class method creates a Person object using birth year instead of age.

Python

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age

    @classmethod
    def from_birth_year(cls, name, birth_year):
        current_year = 2024
        age = current_year - birth_year
        return cls(name, age)

Sample Program

This program shows how class methods can read and change a class variable shared by all objects. Changing wheels affects all cars.

Python

class Car:
    wheels = 4

    def __init__(self, brand):
        self.brand = brand

    @classmethod
    def number_of_wheels(cls):
        return cls.wheels

    @classmethod
    def change_wheels(cls, new_count):
        cls.wheels = new_count

# Check wheels before change
print(Car.number_of_wheels())

# Change wheels for all cars
Car.change_wheels(6)

# Check wheels after change
print(Car.number_of_wheels())

# Create a car and check wheels
my_car = Car('Toyota')
print(my_car.number_of_wheels())

Important Notes

Class methods can be called on the class itself or on an instance.

Using cls inside class methods helps keep code flexible if the class name changes.

Class methods cannot access instance variables directly because they don't get self.

Summary

Class methods work with the class, not individual objects.

cls is used inside class methods to refer to the class.

Use class methods to manage or change class-wide data or create alternative constructors.

Practice

1. What does the cls keyword represent inside a class method in Python?

easy

A. A global variable

B. The class itself

C. A local variable

D. An instance of the class

Solution

1. Step 1: Understand the role of cls in class methods

   Inside a class method, cls refers to the class, not an instance.

2. Step 2: Differentiate cls from self

   self refers to an instance, while cls refers to the class itself.

3. Final Answer:

   The class itself -> Option B

4. Quick Check:

   cls = class [OK]

Hint: Remember: cls means class, self means instance [OK]

Common Mistakes:

• Confusing cls with self
• Thinking cls is a local variable
• Assuming cls is an instance

2. Which of the following is the correct way to define a class method in Python?

easy

A. def method(cls):

B. def method(self):

C. @staticmethod\ndef method():

D. @classmethod\ndef method(cls):

Solution

1. Step 1: Identify the decorator for class methods

   Class methods require the @classmethod decorator above the method.

2. Step 2: Check the method parameter

   Class methods take cls as the first parameter, not self.

3. Final Answer:

   @classmethod\ndef method(cls): -> Option D

4. Quick Check:

   Class method = @classmethod + cls parameter [OK]

Hint: Class methods always use @classmethod and cls parameter [OK]

Common Mistakes:

• Forgetting the @classmethod decorator
• Using self instead of cls
• Defining without any decorator

3. What will be the output of the following code?

class Dog:
    species = 'Canine'

    @classmethod
    def get_species(cls):
        return cls.species

print(Dog.get_species())

medium

A. 'Canine'

B. None

C. 'Dog'

D. Error

Solution

1. Step 1: Understand class attribute access via cls

   The class method get_species returns cls.species, which is 'Canine'.

2. Step 2: Check the print statement output

   Calling Dog.get_species() returns 'Canine', which is printed.

3. Final Answer:

   'Canine' -> Option A

4. Quick Check:

   cls.species = 'Canine' [OK]

Hint: Class methods access class variables via cls [OK]

Common Mistakes:

• Expecting instance name instead of class attribute
• Confusing output with class name string
• Thinking it returns None

4. Find the error in this code snippet:

class Cat:
    count = 0

    @classmethod
    def increment(cls):
        count += 1

Cat.increment()

medium

A. Using count without cls prefix inside method

B. Missing @staticmethod decorator

C. Method should have self parameter

D. Class attribute count is not defined

Solution

1. Step 1: Identify variable usage inside class method

   The method tries to increment count without cls., causing an error.

2. Step 2: Correct usage of class attribute inside class method

   It should be cls.count += 1 to modify the class attribute.

3. Final Answer:

   Using count without cls prefix inside method -> Option A

4. Quick Check:

   Use cls.count to access class variable [OK]

Hint: Always prefix class vars with cls inside class methods [OK]

Common Mistakes:

• Forgetting cls. before class variable
• Using self in class method
• Missing decorator

5. How can you use a class method to create an alternative constructor that creates an object from a string?
Example: Person.from_string('John-25') creates Person('John', 25).
Which code snippet correctly implements this?

hard

A. class Person:
def __init__(self, name, age):
self.name = name
self.age = age

@staticmethod
def from_string(data):
name, age = data.split('-')
return cls(name, int(age))

B. class Person:
def __init__(self, name, age):
self.name = name
self.age = age

def from_string(self, data):
name, age = self.split('-')
return Person(name, int(age))

C. class Person:
def __init__(self, name, age):
self.name = name
self.age = age

@classmethod
def from_string(cls, data):
name, age = data.split('-')
return cls(name, int(age))

D. class Person:
def __init__(self, name, age):
self.name = name
self.age = age

@classmethod
def from_string(self, data):
name, age = data.split('-')
return cls(name, int(age))

Solution

1. Step 1: Recognize the use of class method as alternative constructor

   The method should be decorated with @classmethod and take cls as first parameter.

2. Step 2: Parse string and return new instance

   Split the string, convert age to int, and return cls(name, int(age)) to create a new object.

3. Final Answer:

   @classmethod with cls parameter returning cls instance -> Option C

4. Quick Check:

   Alternative constructor = @classmethod + cls + return cls(...) [OK]

Hint: Use @classmethod and cls to build alternative constructors [OK]

Common Mistakes:

• Using @staticmethod instead of @classmethod
• Missing cls parameter or using self
• Not returning cls instance