Improve Python Exception Readability/Consistency

[TimothyWillard]

We should strive to make exceptions readable and consistent throughout gempyor. Some general style guidelines include:

1. Choosing the correct exception for the given issue instead of just defaulting to ValueError or Exception,
2. Making exceptions 1-2 short sentences with no new lines/awkward spacing,
3. Provide context for debugging, something like "expected 'x' to have 5 elements but instead has 7.".

I'm certain there are more guidelines we could come up with though. In some rare cases we might also want to create custom exceptions, one such exceptions I could see an argument for already is FlepimopConfigError or similar for configuration related issues. However, we should evaluate if that's really needed before implementing.

A good first step would be surveying gempyor for wherever we raise something just to get an idea of where we're starting from. I expect that resolving this issue will take more than one PR and will probably be included as a part of other PRs along the way.

Original context for this issue: https://github.com/HopkinsIDD/flepiMoP/pull/277/files#r1702272495.

[emprzy]

Creating a checklist of Python files within gempyor_pkg/src/gempyor as I comb through and check for improvable instances of exceptions/errors (just for my own organization):

• __init__.py
• calibrate.py
• cli.py
• compartments.py NEEDS ATTENTION
• config_validator.py NEEDS ATTENTION
• file_paths.py
• inference.py NEEDS ATTENTION
• inference_parameter.py
• initial_conditions.py NEEDS ATTENTION
• logloss.py
• model_info.py NEEDS ATTENTION
• outcomes.py NEEDS ATTENTION
• parameters.py NEEDS ATTENTION
• postprocess_inference.py
• profile_old.py
• seeding.py NEEDS ATTENTION
• seir.py NEEDS ATTENTION
• simulate.py
• simulation_component.py
• statistics.py NEEDS ATTENTION
• steps_rk4.py
• steps_source.py
• subpopulation_structure.py NEEDS ATTENTION
• testing.py
• utils.py NEEDS ATTENTION

[Juhi-Lakdawala]

Hello emprzy,
I was looking for some good first issue and came across this one. I would also like to help with this issue. I would like to help with exception handling mechanism. Can you assign me this issue

[emprzy]

Hi @Juhi-Lakdawala ! flepiMoP issues are typically for flepiMoP contributors only, sorry!

[TimothyWillard]

Resolved by GH-313 & GH-387.