How to auto register a class when it’s defined

by

Yes, meta classes can do this. A meta class’ __new__ method returns the class, so just register that class before returning it.

class MetaClass(type):
    def __new__(cls, clsname, bases, attrs):
        newclass = super(MetaClass, cls).__new__(cls, clsname, bases, attrs)
        register(newclass)  # here is your register function
        return newclass

class MyClass(object):
    __metaclass__ = MetaClass

The previous example works in Python 2.x. In Python 3.x, the definition of MyClass is slightly different (while MetaClass is not shown because it is unchanged – except that super(MetaClass, cls) can become super() if you want):

#Python 3.x

class MyClass(metaclass=MetaClass):
    pass

As of Python 3.6 there is also a new __init_subclass__ method (see PEP 487) that can be used instead of a meta class (thanks to @matusko for his answer below):

class ParentClass:
    def __init_subclass__(cls, **kwargs):
        super().__init_subclass__(**kwargs)
        register(cls)

class MyClass(ParentClass):
    pass

[edit: fixed missing cls argument to super().__new__()]

[edit: added Python 3.x example]

[edit: corrected order of args to super(), and improved description of 3.x differences]

[edit: add Python 3.6 __init_subclass__ example]

More Related Contents:

  1. Auto-register class methods using decorator
  2. What are metaclasses in Python?
  3. Creating a singleton in Python
  4. Attaching a decorator to all functions within a class
  5. Using the __call__ method of a metaclass instead of __new__?
  6. Triple inheritance causes metaclass conflict… Sometimes
  7. Difference between @staticmethod and @classmethod
  8. How to make function decorators and chain them together?
  9. What are the differences between type() and isinstance()?
  10. Why is __init__() always called after __new__()?
  11. Meaning of @classmethod and @staticmethod for beginner? [duplicate]
  12. Spawning multiple instances of the same object concurrently in python
  13. Preserving signatures of decorated functions
  14. What is the __del__ method and how do I call it?
  15. Explaining Python’s ‘__enter__’ and ‘__exit__’
  16. How can one continuously generate and track several random objects with a time delay in pygame? [duplicate]
  17. Using the class as a type hint for arguments in its methods [duplicate]
  18. Can you use a string to instantiate a class?
  19. How can I separate the functions of a class into multiple files?
  20. Decorator execution order
  21. How do I access Class member variables in Python?
  22. Real world example about how to use property feature in python?
  23. Why can pandas DataFrames change each other?
  24. Resolving metaclass conflicts
  25. What is the best way to do automatic attribute assignment in Python, and is it a good idea?
  26. Adding a method to an existing object instance in Python
  27. Python object attributes – methodology for access
  28. Python functools.wraps equivalent for classes
  29. In Python, when are two objects the same?
  30. Type Hinting for objects of type that’s being defined [duplicate]

Leave a Comment