Code formatting and checks are moved to a single module. (#548)

* Code formatting and checks are moved to a single module.

* Added missing options in setup.cfg flake8.

* Typo correction.

* Excluding `scripts/` on setup.py.

* setup.cfg restored.
- Typo correction in README.md.

Author: devrimcavusoglu

.github/workflows/ci.yml

@@ -54,11 +54,10 @@ jobs:
         run: |
           pip install -e .[dev]
           # stop the build if there are Python syntax errors or undefined names
-          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-          black . --check --config pyproject.toml
-          isort -c .
+          python scripts/run_code_style.py check
+          
           # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+          flake8 . --exit-zero --max-complexity=10 --max-line-length=127
 
       - name: Install core dependencies
         run: >

.github/workflows/ci_torch1.10.yml

@@ -55,11 +55,10 @@ jobs:
         run: |
           pip install -e .[dev]
           # stop the build if there are Python syntax errors or undefined names
-          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-          black . --check --config pyproject.toml
-          isort -c .
+          python scripts/run_code_style.py check
+          
           # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+          flake8 . --exit-zero --max-complexity=10 --max-line-length=127
 
       - name: Install core dependencies
         run: >

README.md

@@ -210,8 +210,7 @@ pip install -e ."[dev]"
 - Reformat with black and isort:
 
 ```bash
-black . --config pyproject.toml
-isort .
+python scripts/run_code_style.py format
 ```
 
 ## <div align="center">Contributors</div>

scripts/run_code_style.py

@@ -0,0 +1,16 @@
+import sys
+
+from scripts.utils import shell, validate_and_exit
+
+if __name__ == "__main__":
+    arg = sys.argv[1]
+
+    if arg == "check":
+        sts_flake = shell("flake8 . --config setup.cfg --select=E9,F63,F7,F82")
+        sts_isort = shell("isort . --check --settings pyproject.toml")
+        sts_black = shell("black . --check --config pyproject.toml")
+        validate_and_exit(flake8=sts_flake, isort=sts_isort, black=sts_black)
+    elif arg == "format":
+        sts_isort = shell("isort . --settings pyproject.toml")
+        sts_black = shell("black . --config pyproject.toml")
+        validate_and_exit(isort=sts_isort, black=sts_black)

scripts/utils.py

@@ -0,0 +1,41 @@
+import os
+import shutil
+import sys
+
+
+def shell(command, exit_status=0):
+    """
+    Run command through shell and return exit status if exit status of command run match with given exit status.
+
+    Args:
+        command: (str) Command string which runs through system shell.
+        exit_status: (int) Expected exit status of given command run.
+
+    Returns: actual_exit_status
+
+    """
+    actual_exit_status = os.system(command)
+    if actual_exit_status == exit_status:
+        return 0
+    return actual_exit_status
+
+
+def validate_and_exit(expected_out_status=0, **kwargs):
+    if all([arg == expected_out_status for arg in kwargs.values()]):
+        # Expected status, OK
+        sys.exit(0)
+    else:
+        # Failure
+        print_console_centered("Summary Results")
+        fail_count = 0
+        for component, exit_status in kwargs.items():
+            if exit_status != expected_out_status:
+                print(f"{component} failed.")
+                fail_count += 1
+        print_console_centered(f"{len(kwargs)-fail_count} success, {fail_count} failure")
+        sys.exit(1)
+
+
+def print_console_centered(text: str, fill_char="="):
+    w, _ = shutil.get_terminal_size((80, 20))
+    print(f" {text} ".center(w, fill_char))

setup.cfg

@@ -4,6 +4,8 @@ max-complexity = 18
 exclude =.git,__pycache__,docs/source/conf.py,build,dist
 ignore = I101,I201,F401,F403,S001,D100,D101,D102,D103,D104,D105,D106,D107,D200,D205,D400,W504,D202,E203,E501,E722,W503,B006
 inline-quotes = "
+statistics = true
+count = true
 
 [mypy]
 ignore_missing_imports = True

setup.py

@@ -32,7 +32,7 @@ def get_version():
     long_description=get_long_description(),
     long_description_content_type="text/markdown",
     url="https://github.com/obss/sahi",
-    packages=setuptools.find_packages(exclude=["demo", "docs", "resources", "tests"]),
+    packages=setuptools.find_packages(exclude=["demo", "docs", "resources", "tests", "scripts"]),
     python_requires=">=3.6",
     install_requires=get_requirements(),
     extras_require={