Skip to content

Conversation

@RHammond2
Copy link
Collaborator

Simplify configuration failure tracebacks

This PR is the primary resolution of #251 in that it allows for the passing of the class name that validates a configuration dictionary so that an errors also include the source class. Inclusion of the source model's class name allows a user to refer back to their configuration file and locate the offending or missing parameters in the specific model section. Paired with #468, the connection is direct because it removes the obfuscation of the offending class by enforcing users to list the actual model class rather than a short hand reference.

Section 1: Type of Contribution

  • Feature Enhancement
    • Framework
    • New Model
    • Updated Model
    • Tools/Utilities
    • Other (please describe):
  • Bug Fix
  • Documentation Update
  • CI Changes
  • Other (please describe):

Section 2: Draft PR Checklist

  • Open draft PR
  • Describe the feature that will be added
  • Fill out TODO list steps
  • Describe requested feedback from reviewers on draft PR
  • Complete Section 7: New Model Checklist (if applicable)

TODO:

  • Step 1
  • Step 2

Type of Reviewer Feedback Requested (on Draft PR)

Structural feedback:

Implementation feedback:

Other feedback:

Section 3: General PR Checklist

  • PR description thoroughly describes the new feature, bug fix, etc.
  • Added tests for new functionality or bug fixes
  • Tests pass (If not, and this is expected, please elaborate in the Section 6: Test Results)
  • Documentation
    • Docstrings are up-to-date
    • Related docs/ files are up-to-date, or added when necessary
    • Documentation has been rebuilt successfully
    • Examples have been updated (if applicable)
  • CHANGELOG.md has been updated to describe the changes made in this PR

Section 3: Related Issues

#251

Section 4: Impacted Areas of the Software

Section 4.1: New Files

N/A

Section 4.2: Modified Files

  • h2integrate/core/utilities.py
    • BaseConfig: Adds the optional keyword argument additional_cls_name and modifies the error message depending on the usage.
  • h2integrate/core/test/test_utilities.py: Adds demo classes and tests for BaseConfig.from_dict().
  • For all model classes in H2I, the call to a configuration now utilizes XXConfig.from_dict(config, additional_cls_name=self.__class__.__name__) to ensure the child class always shows up in the traceback.

Section 5: Additional Supporting Information

Please refer to #251 for further details and discussion.

Section 6: Test Results, if applicable

Tests pass, including newly added tests.

Section 7 (Optional): New Model Checklist

  • Model Structure:
    • Follows established naming conventions outlined in docs/developer_guide/coding_guidelines.md
    • Used attrs class to define the Config to load in attributes for the model
      • If applicable: inherit from BaseConfig or CostModelBaseConfig
    • Added: initialize() method, setup() method, compute() method
      • If applicable: inherit from CostModelBaseClass
  • Integration: Model has been properly integrated into H2Integrate
    • Added to supported_models.py
    • If a new commodity_type is added, update create_financial_model in h2integrate_model.py
  • Tests: Unit tests have been added for the new model
    • Pytest-style unit tests
    • Unit tests are in a "test" folder within the folder a new model was added to
    • If applicable add integration tests
  • Example: If applicable, a working example demonstrating the new model has been created
    • Input file comments
    • Run file comments
    • Example has been tested and runs successfully in test_all_examples.py
  • Documentation:
    • Write docstrings using the Google style
    • Model added to the main models list in docs/user_guide/model_overview.md
      • Model documentation page added to the appropriate docs/ section
      • <model_name>.md is added to the _toc.yml

@RHammond2 RHammond2 requested a review from johnjasa January 27, 2026 19:05
@RHammond2 RHammond2 added enhancement New feature or request code cleanup labels Jan 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

code cleanup enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant