Skip to content

Commit

Permalink
Make the ForeiginKey detection more accurate
Browse files Browse the repository at this point in the history
To handle this case: the project use tastypie and django.
tastypie has a `ForeignKey` field which has the same name
as django's `ForeignKey`.
The issue is the lint trys resolving the `ForeignKey` for the
tastypie `ForeignKey` which cause import error.

In this commit, add a check to ensure the current class of the
`ForeignKey` is a subclass of `Model` of django.

Tested manually
Test case added: func_noerror_foreign_key_in_non_django_class
  • Loading branch information
Tommy Wu committed Nov 9, 2021
1 parent f4f609e commit 492454d
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 1 deletion.
20 changes: 20 additions & 0 deletions pylint_django/tests/input/external_tastypie_noerror_foreign_key.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
"""
Checks that Pylint doesn't raise an error when a 'ForeignKey' appears in a
non-django class
The real case is described as follow:
The project use tastypie and django.
tastypie has a `ForeignKey` field which has the same name
as django's `ForeignKey`.
The issue is the lint trys resolving the `ForeignKey` for the
tastypie `ForeignKey` which cause import error.
"""
# pylint: disable=missing-docstring
from tastypie.resources import ModelResource
from tastypie import fields
from tastypie.fields import ForeignKey


class MyTestResource(ModelResource): # pylint: disable=too-few-public-methods
field1 = ForeignKey('myapp.api.resource', 'xxx')
field2 = fields.ForeignKey('myapp.api.resource', 'xxx')
9 changes: 9 additions & 0 deletions pylint_django/transforms/foreignkey.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,15 @@ def is_foreignkey_in_class(node):
if not isinstance(node.parent.parent, ClassDef):
return False

# Make sure the outfit class is the subclass of django.db.models.Model
is_in_django_model_class = node_is_subclass(
node.parent.parent,
'django.db.models.base.Model',
'.Model'
)
if not is_in_django_model_class:
return False

if isinstance(node.func, Attribute):
attr = node.func.attrname
elif isinstance(node.func, nodes.Name):
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
],
extras_require={
'with_django': ['Django'],
'for_tests': ['django_tables2', 'factory-boy', 'coverage', 'pytest'],
'for_tests': ['django_tables2', 'factory-boy', 'coverage', 'pytest', 'django-tastypie'],
},
license='GPLv2',
classifiers=[
Expand Down

0 comments on commit 492454d

Please sign in to comment.