Rule N806 and Django

[aqeelat]

In django, you can access a model by importing it or by getting it from the registry (i.e. calling apps.get_model). The convention is to name the variable in title case to match the model's name.
Example from the docs: https://docs.djangoproject.com/en/4.2/ref/applications/#django.apps.AppConfig.ready

However, this clashes with rule N806.

Is there a way to make this work?

[aqeelat]

I think this could a setting for N806 that allows(\w*) = .*\.get_model\(.*,"(\w*)"\) if $1 and $2 match.

[charliermarsh]

I'm open to supporting this, although I think it should just be enabled and not behind a setting. I think we need to support both apps.get_model("core", "Activation") and (e.g.) the MyModel = self.get_model("MyModel") form.

[q0w]

Also import_string

[tylerlaprade]

This fix is great! We had previously turned this rule off in our migrations/ folder for exactly this reason. However, if we remove that override, we have a few cases where we need to dynamically set the model, so $1 and $2 don't match:

[charliermarsh]

I suppose we could extend this to allow any apps.get_model-like assignments, and not limit it to matches on the left- and right-hand side...

[tylerlaprade]

After going through and renaming our violations, I don't feel as strongly that the rule should change. Perhaps the restriction should only be relaxed when the right-hand side is a variable? I know this would still cause my third screenshot to be broken, but I think there's more value in ensuring you didn't typo your model name than there is in allowing this one-off rare case.

[charliermarsh]

That seems reasonable to me. I added it in: #9065.