Incorrect value of kwargs in pre_init signal documentation.

[Pratyush Singh]

I was working on a follower-following system for users.

Model -

class Follower(models.Model):
    follower = models.ForeignKey(
        User, on_delete=models.CASCADE, related_name='following')
    following = models.ForeignKey(
        User, on_delete=models.CASCADE, related_name='followers')
    follow_time = models.DateTimeField(auto_now=True)

    class Meta:
        unique_together = ('follower', 'following')

I created this pre_init signal (to prevent a user from following self, but details excluded)-

@receiver(signals.pre_init, sender=user_models.Follower)
def prevent_user_following_self(sender, *args, **kwargs):
    print(kwargs)

After this, I tried the following in Django shell -

>>> import django
>>> django.__version__
'2.2.2'
>>> from django.contrib.auth.models import User
>>> from users.models import Follower
>>> a = User.objects.get(pk=1)
>>> Follower(follower=a, following=a)
{'signal': <django.db.models.signals.ModelSignal object at 0x7f431561dc88>, 'args': (), 'kwargs': {'follower': <User: admin>, 'following': <User: admin>}}

Here, kwargs contains the actual kwargs under a nested name. While according to the ​documentation, the print here should give

{'kwargs': {'follower': <User: admin>, 'following': <User: admin>}

[Mariusz Felisiak]

Thanks for the report. Yes it should be clarified in ​an example and kwargs description.

[Hasan Ramezani]

​PR

[Mariusz Felisiak]

Ahh, sorry but I just realized that everything works properly. If you will change your method signature, to the

@receiver(signals.pre_init, sender=user_models.Follower)
def prevent_user_following_self(sender, args, kwargs, **other):
    print(kwargs)
    print(args)

then you will get args and kwargs as described in ​documentation.