fix(tests): add style testing

Added a new test to tools.sh for style checks using flake8 to ensure code quality. Added flake8 to pyproject dev dependencies.

Author: bjthres1

.flake8

@@ -1,5 +1,7 @@
 [flake8]
-ignore = E261
+# Notes:
+#     W503: https://peps.python.org/pep-0008/#should-a-line-break-before-or-after-a-binary-operator
+ignore = E261, W293, W503
 max-line-length = 200
 exclude = .git,.github,__pycache__,.pytest_cache,.venv,.venv_test,.vscode
 max-complexity = 10

.github/workflows/python-package.yml

@@ -31,10 +31,8 @@ jobs:
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
     - name: Lint with flake8
       run: |
-        # stop the build if th1ere are Python syntax errors or undefined names
-        # Notes:
-        #     W503: https://peps.python.org/pep-0008/#should-a-line-break-before-or-after-a-binary-operator
-        flake8 . --count --select=E9,F63,F7,F82 --ignore=E261,W293,W503 --show-source --statistics
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
         # 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
     - name: Install stat-log-db package (dev)

stat_log_db/pyproject.toml

@@ -14,7 +14,8 @@ dependencies = [
 [project.optional-dependencies]
 dev = [
     "pytest==8.4.1",
-    "pytest-cov==6.2.1"
+    "pytest-cov==6.2.1",
+    "flake8==7.3.0"
 ]
 
 [project.scripts]

stat_log_db/src/stat_log_db/cli.py

@@ -34,5 +34,6 @@ def main():
     if sl_db.is_file:
         os.remove(sl_db.file_name)
 
+
 if __name__ == "__main__":
     main()

stat_log_db/src/stat_log_db/db.py

@@ -296,7 +296,7 @@ def execute(self, query: str, parameters: tuple | None = None):
         if not isinstance(query, str):
             raise_auto_arg_type_error("query")
         if len(query) == 0:
-            raise ValueError(f"'query' argument of execute cannot be an empty string!")
+            raise ValueError("'query' argument of execute cannot be an empty string!")
         # Create a new space in memory that points to the same object that `parameters` points to
         params = parameters
         # If `params` points to None, update it to point to an empty tuple
@@ -381,7 +381,7 @@ def create_table(self, table_name: str, columns: list[tuple[str, str]], temp_tab
         if not isinstance(table_name, str):
             raise_auto_arg_type_error("table_name")
         if len(table_name) == 0:
-            raise ValueError(f"'table_name' argument of create_table cannot be an empty string!")
+            raise ValueError("'table_name' argument of create_table cannot be an empty string!")
 
         # Validate and sanitize table name
         validated_table_name = self._validate_sql_identifier(table_name, "table name")

tests/test_tools.py

@@ -70,8 +70,8 @@ def _find_bash_executable(): # TODO: Improve this
     # If we get here, bash was not found
     raise FileNotFoundError(
         "Git Bash not found. Please install Git for Windows from https://git-scm.com/download/win "
-        "or ensure bash.exe is in your PATH. Tried the following locations:\n" +
-        "\n".join(f"  - {path}" for path in common_paths)
+        "or ensure bash.exe is in your PATH. Tried the following locations:\n"
+        + "\n".join(f"  - {path}" for path in common_paths)
     )
 
 
@@ -121,7 +121,6 @@ def test_help():
     except AssertionError:
         assert out.strip() == readme_content.strip(), "Help output does not match README content (leading & trailing whitespace stripped)"
 
-
 @pytest.mark.skipif(GITHUB_ACTIONS, reason="Skipping test on GitHub Actions")
 def test_install_dev(test_venv):
     code, out = run_tools(["-id"], use_test_venv=True)
@@ -186,6 +185,14 @@ def test_test_invalid_arg():
     assert ("Unsupported argument" in out) or ("Invalid test mode" in out)
 
 
+@pytest.mark.skipif(GITHUB_ACTIONS, reason="Skipping test on GitHub Actions")
+def test_test_style():
+    code, out = run_tools(["-ts"])
+    assert code == 0
+    assert "Running style tests" in out
+    assert "flake8" in out
+
+
 @pytest.mark.skipif(GITHUB_ACTIONS, reason="Skipping test on GitHub Actions")
 def test_clean():
     code, out = run_tools(["-c"])

tools.sh

@@ -5,7 +5,7 @@ supported_installation_opts="d n"
 install=""
 uninstall=0
 clean=0
-supported_test_opts="p t a d"
+supported_test_opts="p t a d s"
 test=""
 
 while getopts ":i:t:chu" flag; do
@@ -68,6 +68,11 @@ if [ -n "$test" ]; then
             echo "Running all tests..."
             pytest
             ;;
+        s)
+            echo "Running style tests (flake8)..."
+            flake8 .
+            # flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+            ;;
         *)
             echo "Invalid test mode '$test'. Use one of: $supported_test_opts" >&2
             exit 1