Merge pull request #2 from pylint-dev/1-add-project-config-setup

1 add project config setup

Author: PeterHamfelt

.gitignore

@@ -157,4 +157,12 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+.idea
+env.txt
+poetry.lock

.pre-commit-config.yaml

@@ -0,0 +1,37 @@
+ci:
+  skip: [pylint]
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+        args: [--fix=lf]
+      - id: debug-statements
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: "v0.1.4"
+    hooks:
+      - id: ruff
+        args: ["--fix"]
+        exclude: "tests/input/"
+  - repo: https://github.com/psf/black
+    rev: 23.10.1
+    hooks:
+      - id: black
+        args: [--safe, --line-length=120]
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.0.3
+    hooks:
+      - id: prettier
+        args: [--prose-wrap=always, --print-width=88]
+  - repo: local
+    hooks:
+      - id: pylint
+        name: pylint
+        entry: py -m poetry run pylint
+        language: system
+        types: [python]
+        args: ["-rn", "-sn", "--fail-on=I"]
+        exclude: "tests/input/"

CONTRIBUTORS.txt

@@ -0,0 +1,6 @@
+Maintainers
+-----------
+- Peter Hamfelt <[email protected]>
+
+Contributors
+------------

README.md

@@ -0,0 +1,6 @@
+pylint-ml
+=============
+
+About
+-----
+``pylint-ml`` is a pylint plugin for enhancing code analysis for machine learning and data science

README.rst

@@ -0,0 +1,44 @@
+# 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 numpy 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 NumpyImportChecker(BaseChecker):
+    name = "numpy-import"
+    msgs = {
+        "W8001": (
+            "Numpy imported with incorrect alias",
+            "numpy-import",
+            "Numpy should be imported with the alias `np` to maintain consistency with common practices. "
+            "Importing numpy with any other alias can lead to confusion. "
+            "Consider using `import numpy as np` for clarity and adherence to the convention.",
+        ),
+        "W8002": (
+            "Direct import from Numpy discouraged",
+            "numpy-importfrom",
+            "Direct imports from Numpy using `from numpy import ...` are discouraged to maintain code clarity and "
+            "prevent potential conflicts. Numpy should be imported with the alias `np` following common practices. "
+            "Using any other alias or direct import method can lead to confusion. "
+            "Consider using `import numpy as np` to adhere to the convention and ensure consistency.",
+        ),
+    }
+
+    @only_required_for_messages("numpy-import")
+    def visit_import(self, node: nodes.Import) -> None:
+        for name, alias in node.names:
+            if name == "numpy" and alias != "np":
+                self.add_message("numpy-import", node=node, confidence=HIGH)
+
+    @only_required_for_messages("numpy-importfrom")
+    def visit_importfrom(self, node: nodes.ImportFrom) -> None:
+        if node.modname == "numpy":
+            self.add_message("numpy-importfrom", node=node, confidence=HIGH)