Refactor io to pass folders as params

Author: meatballs

src/scheduler/cli.py

@@ -79,7 +79,7 @@ def build(
 
     kwargs = {}
     if objective == 'consistency' or diff:
-        original_solution = io.import_solution()
+        original_solution = io.import_solution(session.folders['solution'])
         revised_solution = [
             item for item in original_solution
             if item[0] < len(events)]
@@ -103,8 +103,10 @@ def build(
         allocations = defn.allocations(resources)
         defn.add_allocations(events, slots, solution, allocations)
         logger.debug(convert.schedule_to_text(solution, events, slots))
-        io.export_solution_and_definition(resources, events, slots, solution)
-        io.build_output(resources, events, slots, solution)
+        io.export_solution_and_definition(
+            resources, events, slots, solution, session.folders['solution'])
+        io.build_output(
+            resources, events, slots, solution, session.folders['build'])
 
 
 @scheduler.command()
@@ -124,18 +126,18 @@ def validate(verbosity, input_dir, solution_dir, reload):
     if solution_dir:
         session.folders['solution'] = Path(solution_dir)
 
-    solution = io.import_solution()
+    solution = io.import_solution(session.folders['solution'])
 
     if reload:
         resources = defn.resources()
         events, slots = events_and_slots(resources)
-        original_solution = io.import_solution()
+        original_solution = io.import_solution(session.folders['solution'])
         solution = [
             item for item in original_solution
             if item[0] < len(events)]
     else:
-        solution = io.import_solution()
-        definition = io.import_schedule_definition()
+        solution = io.import_solution(session.folders['solution'])
+        definition = io.import_schedule_definition(session.folders['solution'])
         events = definition['events']
         slots = definition['slots']
 
@@ -166,14 +168,14 @@ def rebuild(verbosity, solution_dir, build_dir):
     if build_dir:
         session.folders['build'] = Path(build_dir)
 
-    solution = io.import_solution()
-    definition = io.import_schedule_definition()
+    solution = io.import_solution(session.folders['solution'])
+    definition = io.import_schedule_definition(session.folders['solution'])
     logger.info('Validating schedule...')
     if is_valid_solution(solution, definition['events'], definition['slots']):
         logger.info('Imported solution is valid')
         io.build_output(
             definition['resources'], definition['events'],
-            definition['slots'], solution)
+            definition['slots'], solution, session.folders['build'])
     else:
         for v in solution_violations(
                 solution, definition['events'], definition['slots']):

src/scheduler/define.py

@@ -6,14 +6,15 @@
 import daiquiri
 
 import scheduler.denormalise as dn
-from scheduler import io
+from scheduler import io, session
 
 logger = daiquiri.getLogger(__name__)
 
 
 def resources():
-    resources = io.import_yaml()
-    resources['events'] = io.import_proposals(resources)
+    resources = io.import_yaml(session.folders['input'])
+    resources['events'] = io.import_proposals(
+        resources, session.folders['input'])
     return resources
 
 

src/scheduler/io.py

@@ -9,19 +9,17 @@
 from ruamel.yaml import YAML
 from slugify import slugify
 
-from scheduler import session
-
 logger = daiquiri.getLogger(__name__)
 yaml = YAML(typ='safe')
 yaml.default_flow_style = False
 
 
-def import_yaml():
+def import_yaml(input_folder):
     """Import all yaml files in the given folder into a single resources
     dict"""
     yaml_resources = {}
     yaml_files = [
-        path for path in session.folders['input'].iterdir()
+        path for path in input_folder.iterdir()
         if path.suffix == '.yml']
     for path in yaml_files:
         with path.open('r') as file:
@@ -30,10 +28,10 @@ def import_yaml():
     return yaml_resources
 
 
-def import_proposals(resources):
+def import_proposals(resources, input_folder):
     """Import the proposals data from a .csv file"""
     proposals = []
-    with Path(session.folders['input'], 'proposals.csv').open('r') as file:
+    with Path(input_folder, 'proposals.csv').open('r') as file:
         reader = csv.DictReader(file)
         for row in reader:
             if row['session_type'] in resources['event_types']:
@@ -50,9 +48,9 @@ def import_proposals(resources):
     return proposals
 
 
-def import_solution():
+def import_solution(solution_folder):
     """Import a previously computed schedule from a .csv file"""
-    csv_file = Path(session.folders['solution'], 'schedule.csv')
+    csv_file = Path(solution_folder, 'schedule.csv')
     logger.info(f'Importing schedule from {csv_file}')
     solution = []
     with Path(csv_file).open('r') as file:
@@ -65,20 +63,22 @@ def import_solution():
     return solution
 
 
-def import_schedule_definition():
+def import_schedule_definition(solution_folder):
     """Import previously pickled schedule"""
-    pickle_file = Path(session.folders['solution'], 'scheduler.pickle')
+    pickle_file = Path(solution_folder, 'scheduler.pickle')
     logger.info(
         f'Importing resources, events, slots and schedule from {pickle_file}')
     with pickle_file.open('rb') as f:
         bundle = pickle.load(f)
     return bundle
 
 
-def pickle_solution_and_definition(resources, events, slots, solution):
+def pickle_solution_and_definition(
+    resources, events, slots, solution, solution_folder
+):
     """Store the computed solution, the resources dict and the associated
     events and slots lists in pickle format"""
-    pickle_file = Path(session.folders['solution'], 'scheduler.pickle')
+    pickle_file = Path(solution_folder, 'scheduler.pickle')
     logger.info(
         f'Pickling resources, events, slots and schedule to {pickle_file}')
     bundle = {
@@ -91,9 +91,9 @@ def pickle_solution_and_definition(resources, events, slots, solution):
         pickle.dump(bundle, f, pickle.HIGHEST_PROTOCOL)
 
 
-def export_schedule(solution, events, slots):
+def export_schedule(solution, events, slots, solution_folder):
     """Write a human readable .csv file of the computed solution"""
-    csv_file = Path(session.folders['solution'], 'schedule.csv')
+    csv_file = Path(solution_folder, 'schedule.csv')
     logger.info(f'Exporting schedule to {csv_file}')
 
     schedule = converter.solution_to_schedule(solution, events, slots)
@@ -114,18 +114,21 @@ def export_schedule(solution, events, slots):
             writer.writerow(item)
 
 
-def export_solution_and_definition(resources, events, slots, solution):
-    session.folders['solution'].mkdir(exist_ok=True)
-    pickle_solution_and_definition(resources, events, slots, solution)
-    export_schedule(solution, events, slots)
+def export_solution_and_definition(
+    resources, events, slots, solution, solution_folder
+):
+    solution_folder.mkdir(exist_ok=True)
+    pickle_solution_and_definition(
+        resources, events, slots, solution, solution_folder)
+    export_schedule(solution, events, slots, solution_folder)
 
 
-def build_output(resources, events, slots, solution):
+def build_output(resources, events, slots, solution, build_folder):
     """Create the yaml files required by the conference django-amber based
     website for display of the programme"""
-    logger.info(f'Creating output files in {session.folders["build"]}...')
-    shutil.rmtree(session.folders['build'], ignore_errors=True)
-    session.folders['build'].mkdir()
+    logger.info(f'Creating output files in {build_folder}...')
+    shutil.rmtree(build_folder, ignore_errors=True)
+    build_folder.mkdir()
 
     day_format = '%A %-d'
     start_format = '%H:%M'
@@ -144,7 +147,7 @@ def build_output(resources, events, slots, solution):
             'title': events[item[0]].name,
         }
 
-        folder = Path(session.folders['build'], day, venue)
+        folder = Path(build_folder, day, venue)
         folder.mkdir(parents=True, exist_ok=True)
         with Path(folder, start_time).open('a') as f:
             yaml.dump(content, f)