Skip to content
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.

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

Log which suffix values were skipped at the DEBUG level #3043

Merged
merged 1 commit into from
Nov 27, 2023

Conversation

jsiirola
Copy link
Member

Fixes # .

Summary/Motivation:

Updates to the NL writer have silenced a lot of the warnings that were previously generated for declared export suffixes that were not emitted as part of the NL file. This adds additional logging (so you can get the component / data names for the skipped suffixes at the DEBUG level.

Changes proposed in this PR:

  • Restore logging of the names of skipped export suffix datas, but only at the DEBUG level
  • Add a test of this behavior

Legal Acknowledgement

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

  1. I agree my contributions are submitted under the BSD license.
  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.

Copy link

codecov bot commented Nov 19, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (15a7bff) 87.96% compared to head (6d04656) 87.97%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3043   +/-   ##
=======================================
  Coverage   87.96%   87.97%           
=======================================
  Files         770      770           
  Lines       90162    90166    +4     
=======================================
+ Hits        79310    79322   +12     
+ Misses      10852    10844    -8     
Flag Coverage Δ
linux 85.28% <100.00%> (+<0.01%) ⬆️
osx 75.11% <100.00%> (+<0.01%) ⬆️
other 85.47% <100.00%> (+<0.01%) ⬆️
win 82.54% <100.00%> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@mrmundt
Copy link
Contributor

mrmundt commented Nov 20, 2023

After verbally talking about this PR with @jsiirola , we think it would be a good idea to add further explanation to https://pyomo.readthedocs.io/en/stable/errors.html because the reason that we skip some Suffixes can be intractable to a newer user.

@blnicho
Copy link
Member

blnicho commented Nov 27, 2023

I opened a separate issue for documenting the skipped export suffix warnings so going to go ahead and merge this.

@blnicho blnicho merged commit 4a49039 into Pyomo:main Nov 27, 2023
30 checks passed
@jsiirola jsiirola deleted the nlv2-suffix-debug-log branch November 27, 2023 21:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants