Merge pull request #886 from rexdivakar/main

Pylinter

Author: pawangeek

pylinter/init.sh

@@ -0,0 +1,6 @@
+#!/bin/bash -xe
+
+pycodestyle .
+python ./run-pyflakes.py
+python ./run-mccabe.py 10
+pylint ./test.py

pylinter/output.png

@@ -0,0 +1,53 @@
+# Pylinter
+
+Pylint is a static code analysis tool for the Python programming language
+
+## Prerequisites
+
+- Make sure Python 3 is installed in your system
+
+## Setup instructions
+
+- Kindly install the system dependencies using the below command,
+
+```shell
+pip install -r requirements.txt
+```
+
+## Running pylinter
+
+```shell
+# before
+$ python -m mccabe foo/bar.py -m 10
+4:0: 'complex_fun' 12
+
+# after
+$ ./ci/init.sh
+$ bad.py:4:0 complex_fun 12
+```
+
+For simplified execution, kindly update the init.sh file with the python script name and start the ./init.sh
+
+```shell
+#!/bin/bash -xe
+
+pycodestyle .
+python ./run-pyflakes.py
+python ./run-mccabe.py 10
+pylint ./test.py
+```
+
+### To run,
+
+```shell
+sh ./init.sh
+```
+
+## Output
+
+![image](https://user-images.githubusercontent.com/15235122/194733562-68167398-238d-49eb-a310-29812427c01d.png)
+
+
+## Author(s)
+
+Divakar R

pylinter/readme.md

@@ -0,0 +1,4 @@
+mccabe==0.7.0
+path.py==12.5.0
+pylint==2.15.3
+pycodestyle==2.9.1

pylinter/requirements.txt

@@ -0,0 +1,32 @@
+import ast
+import sys
+import mccabe
+from .utils import collect_sources
+
+
+def process(py_source, max_complexity):
+    code = py_source.text()
+    tree = compile(code, py_source, "exec", ast.PyCF_ONLY_AST)
+    visitor = mccabe.PathGraphingAstVisitor()
+    visitor.preorder(tree, visitor)
+    for graph in visitor.graphs.values():
+        if graph.complexity() > max_complexity:
+            text = "{}:{}:{} {} {}"
+            return text.format(py_source, graph.lineno, graph.column, graph.entity,
+                               graph.complexity())
+
+
+def main():
+    max_complexity = int(sys.argv[1])
+    ok = True
+    for py_source in collect_sources():
+        error = process(py_source, max_complexity)
+        if error:
+            ok = False
+            print(error)
+    if not ok:
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

pylinter/run-mccabe.py

@@ -0,0 +1,25 @@
+import sys
+import subprocess
+
+from .utils import collect_sources
+
+
+def ignore(p):
+    """ Ignore hidden and test files """
+    parts = p.splitall()
+    if any(x.startswith(".") for x in parts):
+        return True
+    if 'test' in parts:
+        return True
+    return False
+
+
+def run_pyflakes():
+    cmd = ["pyflakes"]
+    cmd.extend(collect_sources(ignore_func=ignore))
+    return subprocess.call(cmd)
+
+
+if __name__ == "__main__":
+    rc = run_pyflakes()
+    sys.exit(rc)

pylinter/run-pyflakes.py

@@ -0,0 +1,2 @@
+[pycodestyle]
+exclude=/

pylinter/tox.ini

@@ -0,0 +1,9 @@
+import path
+
+
+def collect_sources(ignore_func):
+    top_path = path.Path(".")
+    for py_path in top_path.walkfiles("*.py"):
+        py_path = py_path.normpath()  # get rid of the leading '.'
+        if not ignore_func(py_path):
+            yield py_path