lint.py

"""
Implementing linting script also used by CI

https://medium.com/analytics-vidhya/pylint-static-code-analysis-github-action-to-fail-below-a-score-threshold-58a124aafaa0
was used as a reference
"""
import sys
import logging
from pylint.lint import Run

__author__ = "Marco"
__date__ = "25.04.2020 (date of doc. creation)"

logging.getLogger().setLevel(logging.INFO)

path = ["view", "controller", "test", "util", "network", "assets"]
threshold = 9.5

results = Run(path, do_exit=False)

final_score = results.linter.stats['global_note']

if final_score < threshold:
    message = ('PyLint Failed | '
               'Score: {} | '
               'Threshold: {} '.format(final_score, threshold))
    logging.error(message)
    raise Exception(message)

message = ('PyLint Passed | '
           'Score: {} | '
           'Threshold: {} '.format(final_score, threshold))
logging.info(message)
sys.exit(0)