Merge pull request #62 from sbrunner/prospector

Add Prospector check

.github/workflows/main.yaml

@@ -24,6 +24,9 @@ jobs:
       - name: Checks
         run: c2cciutils-checks
 
+      - run: pipenv sync --dev
+      - run: pipenv run prospector --output=pylint bashcolor
+
       - name: Init pypi
         run: |
           echo "[pypi]" > ~/.pypirc

.prettierignore

@@ -0,0 +1 @@
+Pipfile.lock

.prospector.yaml

@@ -0,0 +1,22 @@
+---
+strictness: veryhigh
+
+max-line-length: 110
+
+pylint:
+  disable:
+    - too-many-arguments
+
+pep8:
+  disable:
+    - E203 # Whitespace before ':'
+    - E722 # Do not use bare 'except'
+
+bandit:
+  run: true
+
+mypy:
+  run: true
+
+mccabe:
+  run: false

Pipfile

@@ -0,0 +1,11 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[dev-packages]
+prospector = {version = "==1.3.1", extras = ["with_bandit", "with_mypy"]}
+flake8 = "==3.8.4"
+
+[requires]
+python_version = "3.8"

bashcolor/__init__.py

@@ -1,6 +1,8 @@
 # see also: http://misc.flogisoft.com/bash/tip_colors_and_formatting
 
 
+from typing import List, Optional
+
 RESET = 0
 BLACK = 30
 RED = 31
@@ -35,8 +37,14 @@
 
 
 def colorize(
-    text, color=None, background=None, effects=None, color_256=None, background_256=None, with_end=True
-):
+    text: str,
+    color: Optional[int] = None,
+    background: Optional[int] = None,
+    effects: Optional[List[int]] = None,
+    color_256: Optional[int] = None,
+    background_256: Optional[int] = None,
+    with_end: bool = True,
+) -> str:
     if effects is None:
         effects = []
     start = []
@@ -60,25 +68,25 @@ def colorize(
         start.append(effect)
         end.append(effect + _RESET_EFFECT)
 
-    start_code = f"{_ESC!s}[{';'.join([str(s) for s in start])!s}m" if text != "" else ""
-    end_code = f"{_ESC!s}[{';'.join([str(e) for e in end])!s}m" if with_end else ""
-    return f"{start_code!s}{text!s}{end_code!s}"
+    start_code = f"{_ESC}[{';'.join([str(s) for s in start])}m" if text != "" else ""
+    end_code = f"{_ESC}[{';'.join([str(e) for e in end])}m" if with_end else ""
+    return f"{start_code}{text}{end_code}"
 
 
-def print_colors():
+def print_colors() -> None:
     color_pivot = [0]
     color_pivot += [e * 6 + 16 for e in range(37)]
     color_pivot.append(256)
     color_pivot_start = color_pivot[:-1]
     color_pivot_end = color_pivot[1:]
-    color_table = [range(cs, ce) for cs, ce in zip(color_pivot_start, color_pivot_end)]
+    color_table_list = [range(cs, ce) for cs, ce in zip(color_pivot_start, color_pivot_end)]
 
-    for ct in color_table:
+    for color_table in color_table_list:
         text = ""
-        for c in ct:
-            cs = str(c)
-            padding = "".join([" " for e in range(3 - len(cs))])
-            text += colorize(f" {padding!s}{cs!s} ", background_256=c, with_end=False)
+        for color in color_table:
+            color_string = str(color)
+            padding = "".join([" " for e in range(3 - len(color_string))])
+            text += colorize(f" {padding}{color_string} ", background_256=color, with_end=False)
         print(text + colorize("", background=DEFAULT))
 
 

setup.cfg

@@ -0,0 +1,6 @@
+[mypy]
+python_version = 3.8
+warn_redundant_casts = True
+warn_unused_ignores = True
+ignore_missing_imports = True
+strict = True