I have countless Python classes from various projects from SQLAlchemy (and a couple from Pygame as well), and I recently noticed a pattern in many of them: their constructors always went something like this:
class Foo(Base):
def __init__(self, first, last, email, mi=""):
self.first = first
self.last = last
self.email = email
self.mi = mi
... whereby the only thing the constructor did was to transfer a set of positional arguments into an exactly identically named set of data members, performing no calculation or other function calls whatsoever.
It seems to me that this repetition is unnecessary and prone to human error upon change.
This leads me to the question here: is it possible to automatically generate such an __init__(self, ...)
function, preferably without mucking around with CPython bytecode or using templates/macros to alter the source file itself?
For python >= 3.7, the proper way of handling this is through dataclasses
:
This module provides a decorator and functions for automatically adding generated special methods such as
__init__()
and__repr__()
to user-defined classes. It was originally described in PEP 557.
You can probably do this with Metaclasses. Here's an example of a metaclass which overrides __init__()
:
Python Class Decorator
You will need to somehow specify the field/argument names, of course - or used named arguments, if you prefer. Here's one way to do that:
# This is the mataclass-defined __init__
def auto_init(self, *args, **kwargs):
for arg_val, arg_name in zip(args, self.init_args):
setattr(self, arg_name, arg_val)
# This would allow the user to explicitly specify field values with named arguments
self.__dict__.update(kwargs)
class MetaBase(type):
def __new__(cls, name, bases, attrs):
attrs['__init__'] = auto_init
return super(MetaBase, cls).__new__(cls, name, bases, attrs)
class Base(object):
__metaclass__ = MetaBase
# No need to define __init__
class Foo(Base):
init_args = ['first', 'last', 'email', 'mi']
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With