Metaclasses in Python

·

muragz

Metaclasses are one of the ways to customize class creation in Python. They allow you to define how classes behave. They can be used to control the creation, modification, and behavior of classes. In fact, everytime you create a new class in Python you are using the default metaclass to define it i.e type.

A metaclass is the class of a class. It defines how a class behaves

One key benefits of using metaclasses is that they allow us to modify the class at runtime. We also have inheritance baked in i.e they will work for any future subclasses, in contrast to class decorators which only affect the specific class they’re applied to

Real-World Example: Enforcing Attribute Naming Conventions

Let’s assume our next gen framework is getting popular and we’d like to enforce coding standards by ensuring that all class attributes are written in uppercase.

1. Define the Metaclass

class UpperCaseAttributeNames(type):
    def __new__(cls, name, bases, dct):
        for attr_name in dct.keys():
            if not attr_name.isupper() and not attr_name.startswith('__'):
                raise ValueError(f"Attribute name '{attr_name}' is not uppercase")
        return super().__new__(cls, name, bases, dct)
  • The UpperCaseAttributeNames metaclass overrides the new method to check each attribute name in the class dictionary.
  • If any attribute name is not uppercase and does not start with double underscores (to ignore special methods and private variables), it raises a ValueError.

2. Using the Metaclass

class Config(metaclass=UpperCaseAttributeNames):
    DATABASE = 'postgresql://user:pass@localhost:5432/mydb'
    DEBUG = True
    __PRIVATE = 'This attr should not be checked because it starts with __'
  • The Config class uses the UpperCaseAttributeNames metaclass.
  • All attribute names in the Config class are uppercase, so no error is raised.

3. Invalid Attribute Names

class InvalidConfig(metaclass=UpperCaseAttributeNames):
    database = 'postgresql://user:pass@localhost:5432/mydb'  # This will raise a ValueError
    DEBUG = True
  • The InvalidConfig class defines an attribute database in lowercase, which violates the naming convention enforced by the metaclass.
  • This will raise a ValueError with the message “Attribute name ‘database’ is not uppercase”.

Use cases

  • Framework Development e.g. Django and SQLAlchemy to create declarative class structures.
  • May be used to implement the Singleton pattern, ensuring a class has only one instance.
  • Used to automatically register classes in a registry for plugins or components.
  • Used for the dynamic modification of classes at the time of creation, enabling advanced behaviors and optimizations.

Further Reading