Merge pull request #9 from pylint-dev/8-add-scipy-import-checker

8 add scipy import checker

Author: PeterHamfelt

pylint_ml/checkers/scipy/import_scipy.py

@@ -0,0 +1,32 @@
+# 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 import of scipy library."""
+
+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 ScipyImportChecker(BaseChecker):
+    name = "scipy-import"
+    msgs = {
+        "W8401": (
+            "Direct or aliased Scipy import detected",
+            "scipy-import",
+            "Using `import scipy` or `import scipy as ...` is not recommended. For better clarity and consistency, "
+            "it is advisable to import specific submodules directly, using the `from scipy import ...` syntax. "
+            "This approach prevents confusion and aligns with common practices by explicitly stating which "
+            "components of Scipy are being used.",
+        ),
+    }
+
+    @only_required_for_messages("scipy-import")
+    def visit_import(self, node: nodes.Import) -> None:
+        for name, _ in node.names:
+            if name == "scipy":
+                self.add_message("scipy-import", node=node, confidence=HIGH)

pylint_ml/plugin.py

@@ -4,6 +4,7 @@
 
 from pylint_ml.checkers.numpy.import_numpy import NumpyImportChecker
 from pylint_ml.checkers.pandas.import_pandas import PandasImportChecker
+from pylint_ml.checkers.scipy.import_scipy import ScipyImportChecker
 from pylint_ml.checkers.tensorflow.import_tensorflow import TensorflowImportChecker
 from pylint_ml.checkers.torch.import_torch import TorchImportChecker
 
@@ -22,5 +23,10 @@ def register(linter: PyLinter) -> None:
     # Torch
     linter.register_checker(TorchImportChecker(linter))
 
-    # Sklearn
     # Scipy
+    linter.register_checker(ScipyImportChecker(linter))
+
+    # Sklearn
+
+    # Theano
+    # Matplotlib

tests/checkers/test_scipy/__init__.py

@@ -0,0 +1,36 @@
+import astroid
+import pylint.testutils
+from pylint.interfaces import HIGH
+
+from pylint_ml.checkers.scipy.import_scipy import ScipyImportChecker
+
+
+class TestScipyImport(pylint.testutils.CheckerTestCase):
+    CHECKER_CLASS = ScipyImportChecker
+
+    def test_correct_scipy_import(self):
+        scipy_import_node = astroid.extract_node(
+            """
+        from scipy.misc import imread, imsave, imresize
+        """
+        )
+
+        with self.assertNoMessages():
+            self.checker.visit_import(scipy_import_node)
+
+    def test_incorrect_scipy_import(self):
+        scipy_import_node = astroid.extract_node(
+            """
+        import scipy as spy
+        """
+        )
+
+        with self.assertAddsMessages(
+            pylint.testutils.MessageTest(
+                msg_id="scipy-import",
+                confidence=HIGH,
+                node=scipy_import_node,
+            ),
+            ignore_position=True,
+        ):
+            self.checker.visit_import(scipy_import_node)