RuntimeError consolidation (#1000)

* Added new exceptions based on RuntimeError inventory results

* Changed RuntimeErrors in abm\models

* Corrected name of SystemConfigurationError

* Updated RuntimeErrors in abm\tables

* Added SubprocessError

* Updated RuntimeErrors in core directory

* Renamed `TableSliceError` to `TableSlicingError`

* Classified RuntimeErrors in input and settings checkers as ModelConfigurationErrors

* Created `SegmentedSpecificationError` for when there's an issue with a spec table that's created for a specific segment

* Added TableIndexError

* Classified RuntimeError in initialize_tours as InputPopulationError

* Created EstimationDataError

* Improved clarity of a couple error messages

* Blacken code

* Updated code to reflect older version of Black (22.12.0)

* Updated error messages to look for in activitysim.core tests

* Updated error to look for in abm.text

* Changed SystemConfigurationError to TableSlicingError in test

* Reclasified error when a step is run more than once from TableSlicingError to DuplicateWorkflowNameError

* Renamed InputPopulationError to InputTableError for clarity as it can be raised if tours are being input

---------

Co-authored-by: Jeffrey Newman <[email protected]>

Author: JoeJimFlood

activitysim/abm/models/disaggregate_accessibility.py

@@ -622,9 +622,11 @@ def create_proto_pop(self):
 
         # Create ID columns, defaults to "%tablename%_id"
         hhid, perid, tourid = (
-            self.params[x]["index_col"]
-            if len(self.params[x]["index_col"]) > 0
-            else x + "_id"
+            (
+                self.params[x]["index_col"]
+                if len(self.params[x]["index_col"]) > 0
+                else x + "_id"
+            )
             for x in klist
         )
 

activitysim/abm/models/initialize_tours.py

@@ -10,6 +10,7 @@
 from activitysim.core import expressions, tracing, workflow
 from activitysim.core.configuration import PydanticReadable
 from activitysim.core.configuration.base import PreprocessorSettings
+from activitysim.core.exceptions import InputTableError
 from activitysim.core.input import read_input_table
 
 logger = logging.getLogger(__name__)
@@ -140,7 +141,7 @@ def initialize_tours(
             f"{tours_without_persons.sum()} tours out of {len(persons)} without persons\n"
             f"{pd.Series({'person_id': tours_without_persons.index.values})}"
         )
-        raise RuntimeError(f"{tours_without_persons.sum()} tours with bad person_id")
+        raise InputTableError(f"{tours_without_persons.sum()} tours with bad person_id")
 
     if trace_hh_id:
         state.tracing.trace_df(tours, label="initialize_tours", warn_if_empty=True)

activitysim/abm/models/input_checker.py

@@ -13,6 +13,7 @@
 
 from activitysim.core import workflow
 from activitysim.core.input import read_input_table
+from activitysim.core.exceptions import ModelConfigurationError
 
 logger = logging.getLogger(__name__)
 file_logger = logger.getChild("logfile")
@@ -468,6 +469,6 @@ def input_checker(state: workflow.State):
 
     if input_check_failure:
         logger.error("Run is killed due to input checker failure!!")
-        raise RuntimeError(
+        raise ModelConfigurationError(
             "Encountered error in input checker, see input_checker.log for details"
         )

activitysim/abm/models/joint_tour_participation.py

@@ -21,6 +21,7 @@
 from activitysim.core.configuration.base import ComputeSettings, PreprocessorSettings
 from activitysim.core.configuration.logit import LogitComponentSettings
 from activitysim.core.util import assign_in_place, reindex
+from activitysim.core.exceptions import InvalidTravelError
 
 logger = logging.getLogger(__name__)
 
@@ -218,11 +219,11 @@ def participants_chooser(
                 non_choice_col = [col for col in probs.columns if col != choice_col][0]
                 probs[non_choice_col] = 1 - probs[choice_col]
                 if iter > MAX_ITERATIONS + 1:
-                    raise RuntimeError(
+                    raise InvalidTravelError(
                         f"{num_tours_remaining} tours could not be satisfied even with forcing participation"
                     )
             else:
-                raise RuntimeError(
+                raise InvalidTravelError(
                     f"{num_tours_remaining} tours could not be satisfied after {iter} iterations"
                 )
 

activitysim/abm/models/location_choice.py

@@ -18,6 +18,7 @@
 from activitysim.core.interaction_sample import interaction_sample
 from activitysim.core.interaction_sample_simulate import interaction_sample_simulate
 from activitysim.core.util import reindex
+from activitysim.core.exceptions import DuplicateWorkflowTableError
 
 """
 The school/workplace location model predicts the zones in which various people will
@@ -1125,7 +1126,7 @@ def iterate_location_choice(
         assert len(save_sample_df.index.get_level_values(0).unique()) == len(choices_df)
         # lest they try to put school and workplace samples into the same table
         if state.is_table(sample_table_name):
-            raise RuntimeError(
+            raise DuplicateWorkflowTableError(
                 "dest choice sample table %s already exists" % sample_table_name
             )
         state.extend_table(sample_table_name, save_sample_df)

activitysim/abm/models/parking_location_choice.py

@@ -23,6 +23,7 @@
 from activitysim.core.interaction_sample_simulate import interaction_sample_simulate
 from activitysim.core.tracing import print_elapsed_time
 from activitysim.core.util import assign_in_place, drop_unused_columns
+from activitysim.core.exceptions import DuplicateWorkflowTableError
 
 logger = logging.getLogger(__name__)
 
@@ -500,7 +501,9 @@ def parking_location(
 
         # lest they try to put tour samples into the same table
         if state.is_table(sample_table_name):
-            raise RuntimeError("sample table %s already exists" % sample_table_name)
+            raise DuplicateWorkflowTableError(
+                "sample table %s already exists" % sample_table_name
+            )
         state.extend_table(sample_table_name, save_sample_df)
 
     expressions.annotate_tables(

activitysim/abm/models/settings_checker.py

@@ -21,6 +21,7 @@
     eval_nest_coefficients,
     read_model_coefficient_template,
 )
+from activitysim.core.exceptions import ModelConfigurationError
 
 # import model settings
 from activitysim.abm.models.accessibility import AccessibilitySettings
@@ -760,7 +761,7 @@ def check_model_settings(
         for e in all_errors:
             logger.error(f"\t{str(e)}")
             file_logger.error(f"\t{str(e)}")
-        raise RuntimeError(
+        raise ModelConfigurationError(
             f"Encountered one or more errors in settings checker. See f{log_file} for details."
         )
     msg = f"Setting Checker Complete. No runtime errors were raised. Check f{log_file} for warnings. These *may* prevent model from successfully running."

activitysim/abm/models/trip_departure_choice.py

@@ -27,6 +27,7 @@
 from activitysim.core.skim_dataset import SkimDataset
 from activitysim.core.skim_dictionary import SkimDict
 from activitysim.core.util import reindex
+from activitysim.core.exceptions import SegmentedSpecificationError
 
 logger = logging.getLogger(__name__)
 
@@ -219,7 +220,7 @@ def choose_tour_leg_pattern(
         )
 
     if len(spec.columns) > 1:
-        raise RuntimeError("spec must have only one column")
+        raise SegmentedSpecificationError("spec must have only one column")
 
     # - join choosers and alts
     # in vanilla interaction_simulate interaction_df is cross join of choosers and alternatives

activitysim/abm/models/trip_destination.py

@@ -35,6 +35,7 @@
 from activitysim.core.skim_dictionary import DataFrameMatrix
 from activitysim.core.tracing import print_elapsed_time
 from activitysim.core.util import assign_in_place, reindex
+from activitysim.core.exceptions import InvalidTravelError, DuplicateWorkflowTableError
 
 logger = logging.getLogger(__name__)
 
@@ -1668,7 +1669,7 @@ def trip_destination(
     # testing feature t0 make sure at least one trip fails so trip_purpose_and_destination model is run
     if state.settings.testing_fail_trip_destination and not trips_df.failed.any():
         if (trips_df.trip_num < trips_df.trip_count).sum() == 0:
-            raise RuntimeError(
+            raise InvalidTravelError(
                 "can't honor 'testing_fail_trip_destination' setting because no intermediate trips"
             )
 
@@ -1749,7 +1750,9 @@ def trip_destination(
 
         # lest they try to put tour samples into the same table
         if state.is_table(sample_table_name):
-            raise RuntimeError("sample table %s already exists" % sample_table_name)
+            raise DuplicateWorkflowTableError(
+                "sample table %s already exists" % sample_table_name
+            )
         state.extend_table(sample_table_name, save_sample_df)
 
     expressions.annotate_tables(

activitysim/abm/models/trip_purpose.py

@@ -22,6 +22,7 @@
 )
 from activitysim.core.configuration.base import PreprocessorSettings, PydanticReadable
 from activitysim.core.util import reindex
+from activitysim.core.exceptions import InvalidTravelError
 
 logger = logging.getLogger(__name__)
 
@@ -134,7 +135,7 @@ def choose_intermediate_trip_purpose(
             state.tracing.write_csv(
                 unmatched_choosers, file_name=file_name, transpose=False
             )
-            raise RuntimeError(
+            raise InvalidTravelError(
                 "Some trips could not be matched to probs based on join columns %s."
                 % probs_join_cols
             )