Merge pull request #765 from UTDNebula/python-packages

Update validator packages

Author: TyHil

.github/workflows/validator_format.yml

@@ -0,0 +1,32 @@
+name: Format Validator
+
+on:
+  push:
+    paths:
+      - 'validator/**'
+
+jobs:
+  main:
+    name: Run Black
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        working-directory: validator
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          pip3 install -r requirements.txt
+
+      - name: Run Black
+        run: |
+          black --check .

.github/workflows/validator_test.yml

@@ -17,7 +17,8 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - uses: actions/setup-python@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
         with:
           python-version: '3.11'
 

README.md

@@ -146,6 +146,7 @@ npm install
     cd validator
     python3.11 -m venv venv # Create virtual environment
     source venv/bin/activate # Use virtual enviornment
+    #venv/Scripts/activate on Windows
     pip install -r requirements.txt # Install dependencies
     flask --app api run
     ```

validator/core/matchers.py

@@ -277,5 +277,5 @@ def list_matcher_requirements(matcher: Matcher) -> list[str]:
     Only supports NameList atm
     """
     if not isinstance(matcher, NameListMatcher):
-        raise NotImplemented
+        raise NotImplementedError
     return [course for course in matcher.name_list]

validator/core/parser.py

@@ -1,4 +1,4 @@
-""" Parser for *.req files."""
+"""Parser for *.req files."""
 
 from core.requirement import Requirement
 from core.matchers import Matcher

validator/core/requirement.py

@@ -1,4 +1,5 @@
 """Requirement represents a degree requirements."""
+
 from utils import hashable
 from core import matchers
 

validator/degree_solver.py

@@ -334,7 +334,7 @@ def __str__(self) -> str:
 
 
 def format_core_reqs(
-    reqs: dict[str, core.store.AssignmentStoreJSON]
+    reqs: dict[str, core.store.AssignmentStoreJSON],
 ) -> list[AbstractRequirement]:
     core_reqs = []
     for req_name, req_info in reqs.items():

validator/gen_schema.py

@@ -166,7 +166,7 @@ def requirement_schema_to_empty_json_body(s: dict[str, Any]) -> dict[str, Any]:
 
 snips = dict(
     zip(
-        list(map(lambda curr: curr["matcher"]["const"], requirement_schemas)),  # type: ignore
+        list(map(lambda curr: curr["matcher"]["const"], requirement_schemas)),
         list(
             map(
                 lambda curr: {
@@ -186,7 +186,7 @@ def requirement_schema_to_empty_json_body(s: dict[str, Any]) -> dict[str, Any]:
     )
 )
 
-snips["$comment"] = f"Generated by {path.basename(__file__)} on {datetime.now()}"  # type: ignore
+snips["$comment"] = f"Generated by {path.basename(__file__)} on {datetime.now()}"
 
 with open(".vscode/major.schema.json", "w") as f:
     f.write(dumps(schema, indent=2))

validator/major/requirements/shared.py

@@ -1,4 +1,4 @@
-""" Definitions for shared requirements """
+"""Definitions for shared requirements"""
 
 from __future__ import annotations
 import json
@@ -330,9 +330,9 @@ def __init__(
     ) -> None:
         self.required_hours = required_hours
         self.requirements = requirements
-        self.valid_courses: dict[
-            str, int
-        ] = valid_courses  # Stores map of course & # hours fulfilled (i.e. {"CS 1200": 2}). This is done due to course splitting (1 course can be used to satisfy multiple requirements)
+        self.valid_courses: dict[str, int] = (
+            valid_courses  # Stores map of course & # hours fulfilled (i.e. {"CS 1200": 2}). This is done due to course splitting (1 course can be used to satisfy multiple requirements)
+        )
         self.metadata: dict[str, Any] = metadata
         self.override_filled = False
 

validator/major/tests/edge_cases/test_arts_technology_emerging_communication.py

@@ -1 +1 @@
-# TODO: implement
+# TODO: implement