Skip to content

Better error messages for Modular Properties when config dict in not unpacked #1515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
andrewlee94 merged 1 commit into from
Oct 29, 2024
Merged

Better error messages for Modular Properties when config dict in not unpacked #1515

andrewlee94 merged 1 commit into from
Oct 29, 2024

Conversation

@andrewlee94
Copy link
Contributor

@andrewlee94 andrewlee94 commented Oct 29, 2024

Fixes 1205

Summary/Motivation:

The Modular Properties did not give very useful error messages when given a dict of arguments instead of the unpacked arguments (**kwargs).

Changes proposed in this PR:

  • Add catches for cases where when the dict might not have been unpacked and raise a useful error message.

Legal Acknowledgement

By contributing to this software project, I agree to the following terms and conditions for my contribution:

  1. I agree my contributions are submitted under the license terms described in the LICENSE.txt file at the top level of this directory.
  2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

@andrewlee94 andrewlee94 self-assigned this Oct 29, 2024
@andrewlee94 andrewlee94 added enhancement New feature or request Priority:Normal Normal Priority Issue or PR property packages Issues dealing with properties labels Oct 29, 2024
@andrewlee94 andrewlee94 requested a review from bpaul4 October 29, 2024 18:36
dallan-keylogic
dallan-keylogic approved these changes Oct 29, 2024
View reviewed changes
Copy link
Contributor

@dallan-keylogic dallan-keylogic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

bpaul4
bpaul4 approved these changes Oct 29, 2024
View reviewed changes
Copy link
Contributor

@bpaul4 bpaul4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

@codecov-commenter
Copy link

codecov-commenter commented Oct 29, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.98%. Comparing base (1ed3f2c) to head (d4870db).
Report is 19 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1515      +/-   ##
==========================================
- Coverage   76.99%   76.98%   -0.01%     
==========================================
  Files         382      382              
  Lines       61992    61994       +2     
  Branches    10146    10147       +1     
==========================================
- Hits        47730    47729       -1     
- Misses      11854    11858       +4     
+ Partials     2408     2407       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@andrewlee94 andrewlee94 merged commit 53f756b into IDAES:main Oct 29, 2024
@andrewlee94 andrewlee94 deleted the issue_1205 branch October 29, 2024 19:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bpaul4 bpaul4 bpaul4 approved these changes

@dallan-keylogic dallan-keylogic dallan-keylogic approved these changes

@agarciadiego agarciadiego Awaiting requested review from agarciadiego agarciadiego is a code owner

Assignees

@andrewlee94 andrewlee94

Labels

enhancement New feature or request Priority:Normal Normal Priority Issue or PR property packages Issues dealing with properties

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@andrewlee94 @codecov-commenter @bpaul4 @dallan-keylogic