Refactor config parsing and validation w/ pydantic

oedokumaci · Feb 17, 2023 · fbf38a0 · fbf38a0
1 parent 48d4f7c
commit fbf38a0
Show file tree

Hide file tree

Showing 8 changed files with 140 additions and 201 deletions.
diff --git a/config/config.yaml b/config/config.yaml
@@ -1,5 +1,6 @@
-proposer_and_responder: [man, woman]
-preference_type: random
+proposer_side_name: man
+responder_side_name: woman
 number_of_proposers: 12 
 number_of_responders: 12
-log_file: logs.log
+preference_type: random
+log_file_name: logs.log
diff --git a/config/example_config.yaml b/config/example_config.yaml
@@ -1,5 +1,6 @@
-proposer_and_responder: [woman, man] # first entry is proposer, second is responder
-preference_type: random # random for now, input will be implemented later
-number_of_proposers: 5 # number of proposers, not necessarily equal to number of responders
-number_of_responders: 7 # number of responders, not necessarily equal to number of proposers
-log_file: logs.log # log file name, will be saved in logs folder
+proposer_side_name: man
+responder_side_name: woman
+number_of_proposers: 5
+number_of_responders: 7
+preference_type: random # only random is valid for now, custom input will be implemented later
+log_file: logs.log # will be saved in logs folder
diff --git a/pdm.lock b/pdm.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -7,6 +7,7 @@ authors = [
 ]
 dependencies = [
     "pyyaml>=6.0",
+    "pydantic>=1.10.5",
 ]
 requires-python = ">=3.9"
 readme = "README.md"

diff --git a/requirements.txt b/requirements.txt
@@ -22,6 +22,7 @@ pdm==2.4.5
 platformdirs==2.5.2
 pluggy==1.0.0
 pre-commit==3.0.4
+pydantic==1.10.5
 pygments==2.14.0
 pyproject-hooks==1.0.0
 pytest==7.2.1
@@ -35,6 +36,7 @@ setuptools==65.5.0
 shellingham==1.5.0.post1
 tomli==2.0.1
 tomlkit==0.11.6
+typing-extensions==4.5.0
 unearth==0.7.2
 urllib3==1.26.14
 virtualenv==20.16.6
diff --git a/src/gale_shapley/cli.py b/src/gale_shapley/cli.py
@@ -1,12 +1,12 @@
 """Command line application module for Gale-Shapley algorithm."""
 
-from gale_shapley.config_parser import parsed_config
+from gale_shapley.config_parser import config_input
 from gale_shapley.simulator import Simulator
 
 
 def main() -> int:
     """Main function for Gale-Shapley algorithm."""
-    sim = Simulator(*parsed_config)
+    sim = Simulator(config_input)
     sim.number_of_simulations = 1000  # TODO: Make this configurable
     sim.simulate()
     return 0