Follow conventions

Author: classiqdor

.internal/pre_commit_tools/notebook_pre_commit_collection.py

@@ -15,16 +15,12 @@
 
 DEFAULT_TIMEOUT_SECONDS: float = 20
 
-IS_FILE_VALID = IS_FILE_INVALID = bool
-
 
 def main(full_file_paths: Iterable[str]) -> bool:
-    return validate_unique_names() and all(map(validate_notebook, full_file_paths))
+    return validate_unique_names() and all(map(is_valid_notebook, full_file_paths))
 
 
-def validate_notebook(
-    file_path: str, automatically_add_timeout: bool = True
-) -> IS_FILE_VALID:
+def is_valid_notebook(file_path: str, automatically_add_timeout: bool = True) -> bool:
     file_name = os.path.basename(file_path)
 
     errors = []
@@ -43,16 +39,16 @@ def validate_notebook(
 
     if errors:
         spacing = "\n\t"  # f-string cannot include backslash
-        print(f"file `{file_path}` has error:{spacing}{spacing.join(errors)}")
+        print(f"File `{file_path}` has error(s):{spacing}{spacing.join(errors)}")
 
     return not errors
 
 
-def _does_contain_dash_in_file_name(file_name: str) -> IS_FILE_INVALID:
+def _does_contain_dash_in_file_name(file_name: str) -> bool:
     return "-" in file_name
 
 
-def _is_file_in_timeouts(file_name: str) -> IS_FILE_VALID:
+def _is_file_in_timeouts(file_name: str) -> bool:
     with TIMEOUTS_FILE.open("r") as f:
         timeouts = yaml.safe_load(f)
 
@@ -76,7 +72,7 @@ def validate_unique_names() -> bool:
     duplicate_names = [name for name, count in Counter(base_names).items() if count > 1]
 
     if duplicate_names:
-        print(f"notebooks with duplicate names found: {duplicate_names}")
+        print(f"Notebooks with duplicate names found: {duplicate_names}")
 
     is_ok = not duplicate_names
     return is_ok

.internal/pre_commit_tools/qmod_pre_commit_collection.py

@@ -15,16 +15,12 @@
 
 DEFAULT_TIMEOUT_SECONDS: float = 10
 
-IS_FILE_VALID = IS_FILE_INVALID = bool
-
 
 def main(full_file_paths: Iterable[str]) -> bool:
-    return validate_unique_names() and all(map(validate_qmod, full_file_paths))
+    return validate_unique_names() and all(map(is_valid_qmod, full_file_paths))
 
 
-def validate_qmod(
-    file_path: str, automatically_add_timeout: bool = True
-) -> IS_FILE_VALID:
+def is_valid_qmod(file_path: str, automatically_add_timeout: bool = True) -> bool:
     file_name = os.path.basename(file_path)
 
     errors = []
@@ -43,16 +39,16 @@ def validate_qmod(
 
     if errors:
         spacing = "\n\t"  # f-string cannot include backslash
-        print(f"file `{file_path}` has error:{spacing}{spacing.join(errors)}")
+        print(f"File `{file_path}` has error(s):{spacing}{spacing.join(errors)}")
 
     return not errors
 
 
-def _does_contain_dash_in_file_name(file_name: str) -> IS_FILE_INVALID:
+def _does_contain_dash_in_file_name(file_name: str) -> bool:
     return "-" in file_name
 
 
-def _is_file_in_timeouts(file_name: str) -> IS_FILE_VALID:
+def _is_file_in_timeouts(file_name: str) -> bool:
     with TIMEOUTS_FILE.open("r") as f:
         timeouts = yaml.safe_load(f)
 
@@ -78,7 +74,7 @@ def validate_unique_names() -> bool:
     duplicate_names = [name for name, count in Counter(base_names).items() if count > 1]
 
     if duplicate_names:
-        print(f"qmods with duplicate names found: {duplicate_names}")
+        print(f"Qmods with duplicate names found: {duplicate_names}")
 
     is_ok = not duplicate_names
     return is_ok

tests/internal/test_pre_commit.py

@@ -25,7 +25,7 @@ def test_timeouts_missing_files():
 #
 @pytest.mark.parametrize("notebook_path", map(str, PROJECT_ROOT.rglob("*.ipynb")))
 def test_notebooks(notebook_path: str):
-    assert notebook_pre_commit_collection.validate_notebook(
+    assert notebook_pre_commit_collection.is_valid_notebook(
         notebook_path, automatically_add_timeout=False
     )
 
@@ -44,7 +44,7 @@ def test_notebooks(qmod_path: str):
     if "functions/open_library_definitions" in qmod_path:
         return  # skipped
 
-    assert qmod_pre_commit_collection.validate_qmod(
+    assert qmod_pre_commit_collection.is_valid_qmod(
         qmod_path, automatically_add_timeout=False
     )