Add numpy dot checker

Author: Peter Hamfelt

pylint_ml/checkers/numpy/numpy_dot.py

@@ -0,0 +1,35 @@
+# Licensed under the MIT: https://mit-license.org/
+# For details: https://github.com/pylint-dev/pylint-ml/LICENSE
+# Copyright (c) https://github.com/pylint-dev/pylint-ml/CONTRIBUTORS.txt
+
+"""Check for the use of np.dot and recommend np.matmul for matrix multiplication."""
+
+from __future__ import annotations
+
+from astroid import nodes
+from pylint.checkers import BaseChecker
+from pylint.checkers.utils import only_required_for_messages
+from pylint.interfaces import HIGH
+
+
+class NumpyDotChecker(BaseChecker):
+    name = "numpy-dot-checker"
+    msgs = {
+        "W8122": (
+            "Consider using 'np.matmul()' instead of 'np.dot()' for matrix multiplication.",
+            "numpy-dot-usage",
+            "It's recommended to use 'np.matmul()' for matrix multiplication, which is more explicit and handles "
+            "higher-dimensional arrays more consistently. ",
+        ),
+    }
+
+    @only_required_for_messages("numpy-dot-usage")
+    def visit_call(self, node: nodes.Call) -> None:
+        # Check if the function being called is np.dot
+        if isinstance(node.func, nodes.Attribute):
+            func_name = node.func.attrname
+            module_name = getattr(node.func.expr, "name", None)
+
+            if func_name == "dot" and module_name == "np":
+                # Suggest using np.matmul() instead
+                self.add_message("numpy-dot-usage", node=node, confidence=HIGH)

pylint_ml/checkers/pandas/pandas_series_naming.py

@@ -24,7 +24,6 @@ class PandasSeriesNamingChecker(BaseChecker):
 
     @only_required_for_messages("pandas-series-naming")
     def visit_assign(self, node: nodes.Assign) -> None:
-        print(node)
         if isinstance(node.value, nodes.Call):
             func_name = getattr(node.value.func, "attrname", None)
             module_name = getattr(node.value.func.expr, "name", None)

tests/checkers/test_numpy/test_numpy_dot.py

@@ -0,0 +1,31 @@
+import astroid
+import pylint.testutils
+from pylint.interfaces import HIGH
+
+from pylint_ml.checkers.numpy.numpy_dot import NumpyDotChecker
+
+
+class TestNumpyDotChecker(pylint.testutils.CheckerTestCase):
+    CHECKER_CLASS = NumpyDotChecker
+
+    def test_warning_for_dot(self):
+        node = astroid.extract_node(
+            """
+            import numpy as np
+            a = np.array([1, 2])
+            b = np.array([3, 4])
+            result = np.dot(a, b)  # [numpy-dot-usage]
+            """
+        )
+
+        dot_call = node.value
+
+        with self.assertAddsMessages(
+            pylint.testutils.MessageTest(
+                msg_id="numpy-dot-usage",
+                confidence=HIGH,
+                node=dot_call,
+            ),
+            ignore_position=True,
+        ):
+            self.checker.visit_call(dot_call)