September 11, 2024

Python Tutorials

Class Variable vs Instance Variable in Python

In Python, variables within a class can be classified into two main types: class variables and instance variables. Understanding the distinction between these two types of variables is crucial for effective class design and object-oriented programming. Here’s a detailed comparison:

1. Class Variables

Class variables are shared among all instances of a class. They are defined within a class but outside any methods. Class variables are useful for storing properties that are common to all instances of the class.

class MyClass:
    class_variable = 0  # This is a class variable

    def __init__(self, value):
        self.instance_variable = value  # This is an instance variable

    def increment_class_variable(self):
        MyClass.class_variable += 1

    def get_class_variable(self):
        return MyClass.class_variable

In this example, class_variable is a class variable. It is shared by all instances of MyClass, and changes to it affect all instances.

2. Instance Variables

Instance variables are unique to each instance of a class. They are defined within methods (usually the __init__ method) and are used to store data that is specific to each object.

class MyClass:
    def __init__(self, value):
        self.instance_variable = value  # This is an instance variable

    def get_instance_variable(self):
        return self.instance_variable

In this example, instance_variable is an instance variable. Each instance of MyClass has its own separate copy of this variable.

3. Key Differences

  • Scope: Class variables are shared across all instances, while instance variables are unique to each instance.
  • Access: Class variables are accessed using the class name or through an instance, whereas instance variables are accessed through instances only.
  • Modification: Changing a class variable affects all instances, while changing an instance variable affects only the specific instance.

4. Example Demonstrating Differences

Here’s an example showing how class and instance variables behave differently:

class MyClass:
    class_variable = 0

    def __init__(self, value):
        self.instance_variable = value

    def increment_class_variable(self):
        MyClass.class_variable += 1

# Create instances
obj1 = MyClass(10)
obj2 = MyClass(20)

# Modify class variable
obj1.increment_class_variable()

print(f"Class Variable (obj1): {obj1.class_variable}")  # Output: 1
print(f"Class Variable (obj2): {obj2.class_variable}")  # Output: 1

# Modify instance variables
print(f"Instance Variable (obj1): {obj1.instance_variable}")  # Output: 10
print(f"Instance Variable (obj2): {obj2.instance_variable}")  # Output: 20

5. Best Practices

  • Use Class Variables: When you need a property that should be the same for all instances, such as constants or shared counters.
  • Use Instance Variables: When you need to store data unique to each object, such as attributes specific to individual instances.

6. Summary

Class variables are shared among all instances of a class, making them suitable for data that should be common to all objects. Instance variables are specific to each object, providing a way to store data unique to each instance. Understanding these differences helps in designing classes with the appropriate scope and behavior for your data.

You May Like