Skip to content

Commit 92134ed

Browse files
committed
Added docstrings
1 parent 8a9ca96 commit 92134ed

File tree

3 files changed

+20
-8
lines changed

3 files changed

+20
-8
lines changed

pylint_django/checkers/modelfilter_forloop.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66

77

88
class ModelFilterForLoopChecker(checkers.BaseChecker):
9+
"""
10+
Checks for usage of "Model.manager.filter() inside of for loops
11+
"""
912
__implements__ = (interfaces.IAstroidChecker)
1013

1114
name = "model-filter-forloop-checker"
@@ -14,9 +17,9 @@ class ModelFilterForLoopChecker(checkers.BaseChecker):
1417
f"R{BASE_ID}06": (
1518
"Consider using '__in' queries",
1619
"consider-using-in-queries",
17-
"Using 'Model.filter()' or 'Model.get() inside a for loop may "
18-
"impact performance. Consider using a single query with as '__in' "
19-
"filter instead, outside of the loop."
20+
"Using 'Model.manager.filter()' or 'Model.manager.get() inside a "
21+
"for loop may negatively impact performance. Consider using a "
22+
"single query with as '__in' filter instead, outside of the loop."
2023
),
2124
}
2225

pylint_django/checkers/modelsave_forloop.py

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77

88

99
class ModelSaveForLoopChecker(checkers.BaseChecker):
10+
"""
11+
Checks for usage of Model.manager.create() or Model.save() inside of for
12+
loops
13+
"""
1014
__implements__ = (interfaces.IAstroidChecker)
1115

1216
name = "model-save-forloop-checker"
@@ -15,15 +19,16 @@ class ModelSaveForLoopChecker(checkers.BaseChecker):
1519
f"R{BASE_ID}04": (
1620
"Consider using 'Model.bulk_create()'",
1721
"consider-using-bulk-create",
18-
"Using 'Model.create()' inside a for loop may impact performance. "
19-
"Consider using 'Model.bulk_create()' instead."
22+
"Using 'Model.manager.create()' inside a for loop may negatively "
23+
"impact performance. Consider using 'Model.manager.bulk_create()' "
24+
"instead."
2025
),
2126
f"R{BASE_ID}05": (
2227
"Consider using 'Model.bulk_*()",
2328
"consider-using-bulk-create-save",
24-
"Using 'Model.save()' inside a for loop may impact performance. "
25-
"Consider using 'Model.bulk_update()' or "
26-
"'Model.bulk_create()' instead."
29+
"Using 'Model.save()' inside a for loop may negatively impact "
30+
"performance. Consider using 'Model.manager.bulk_update()' or "
31+
"'Model.manager.bulk_create()' instead."
2732
),
2833
}
2934

pylint_django/checkers/queryset_iterator.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77

88

99
class QuerysetIteratorForLoopChecker(checkers.BaseChecker):
10+
"""
11+
Checks for usage of "QuerySet.all()" in the head of a for loop,
12+
eventually suggesting the usage of ".iterator()"
13+
"""
1014
__implements__ = (interfaces.IAstroidChecker)
1115

1216
name = "queryset-iterator-forloop-checker"

0 commit comments

Comments
 (0)