Merge pull request #17 from sqoshi/16-ci-linters

Added CI linter check.

.flake8

@@ -0,0 +1,21 @@
+[flake8]
+ignore =
+    F401,
+    W503
+
+max-complexity = 10
+min-similarity-lines = 300
+max-line-length = 99
+exclude =
+    .tox,
+    .git,
+    __pycache__,
+    build,
+    dist,
+    tests/fixtures/*,
+    *.pyc,
+    *.egg-info,
+    .cache,
+    .mypy_cache,
+    .pytest_cache,
+    .eggs

.github/workflows/lint.yml

@@ -0,0 +1,17 @@
+name: Python Lint
+
+on: [ pull_request ]
+
+jobs:
+  lint:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      - uses: ricardochaves/python-lint@v1.4.0
+        with:
+          python-root-list: 'mask_imposer tests'
+          use-black: false
+          use-isort: false
+          extra-pycodestyle-options: "--max-line-length=99"

.pylintrc

@@ -0,0 +1,15 @@
+[FORMAT]
+max-line-length = 99
+max-args = 6
+extension-pkg-whitelist =
+    cv2,
+    dlib,
+    _dlib_pybind11
+
+[MESSAGES CONTROL]
+disable =
+    missing-docstring,
+    invalid-name,
+    import-error,
+    inconsistent-return-statements,
+    binary-op-exception

mask_imposer/collector/coords_collector.py

@@ -1,8 +1,9 @@
 from logging import Logger
-from typing import List, Dict, Optional, Any
-from termcolor import colored
+from typing import Any, Dict, List, Optional
 
 import cv2
+from termcolor import colored
+
 from mask_imposer.imposer.mask_pointers import Pointer
 
 
@@ -51,7 +52,7 @@ def collect(self) -> Optional[Dict[int, Pointer]]:
         cv2.destroyAllWindows()
         if not confirmed:
             return self.reset()
-        self._logger.info(f"Coordinates accepted by user.")
+        self._logger.info("Coordinates accepted by user.")
         return self.mask_coords
 
     def _assign_mask_coords(self) -> None:

mask_imposer/definitions/images.py

@@ -10,7 +10,7 @@ class ImageFormat(Enum):
     webp = "webp"
 
     def __str__(self) -> str:
-        return self.value
+        return str(self.value)
 
     @staticmethod
     def is_image(f: str) -> bool:

mask_imposer/input_inspector.py

@@ -20,7 +20,10 @@ def __init__(self, logger: ColoredLogger):
         self._images: List[str] = []
 
     def _find_images(self, path: str) -> List[str]:
-        """Find images in given path recognized by their extensions [filename.extension]."""
+        """Find images in given path.
+
+        File is classified as img by extension [x.extension].
+        """
         all_files = listdir(path)
         if not all_files:
             self._logger.critical(f"{path} is empty.")

mypy.ini

@@ -0,0 +1,8 @@
+[mypy]
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+no_implicit_optional = true
+warn_unused_ignores = false
+ignore_missing_imports = true

tests/test_mask_image_read.py

@@ -1,13 +1,13 @@
-from logging import getLogger
-from unittest import TestCase
-
-from mask_imposer.imposer.mask_imposer import Imposer
-
-
-class MaskImageReadTestCase(TestCase):
-    @classmethod
-    def setUp(cls) -> None:
-        cls.imposer = Imposer({}, getLogger("test"))
-
-    # def test_should_read_mask_image(self):
-    #     self.imposer._read_mask_image()
+# from logging import getLogger
+# from unittest import TestCase
+#
+# from mask_imposer.imposer.mask_imposer import Imposer
+#
+#
+# class MaskImageReadTestCase(TestCase):
+#     @classmethod
+#     def setUp(cls) -> None:
+#         cls.imposer = Imposer({}, getLogger("test"))
+#
+#     # def test_should_read_mask_image(self):
+#     #     self.imposer._read_mask_image()

tox.ini

@@ -7,16 +7,14 @@ envlist =
 deps =
     -rrequirements.txt
     pytest
-commands = pytest {posargs}
+commands =
+    pytest {posargs}
 
 [testenv:flake8]
 skip_install = true
 deps =
     flake8
-;    flake8-bugbear
-;    flake8-docstrings>=1.3.1
-;    flake8-typing-imports>=1.1
-;    pep8-naming
+
 commands =
     flake8 mask_imposer
 
@@ -52,25 +50,3 @@ deps =
     isort
 commands =
     isort mask_imposer tests
-
-[flake8]
-ignore =
-    F401,
-    W503
-
-max-complexity = 10
-min-similarity-lines = 300
-max-line-length = 99
-exclude =
-    .tox,
-    .git,
-    __pycache__,
-    build,
-    dist,
-    tests/fixtures/*,
-    *.pyc,
-    *.egg-info,
-    .cache,
-    .mypy_cache,
-    .pytest_cache,
-    .eggs