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

Updates to pyutilib.misc.config #88

Merged
merged 16 commits into from
Mar 18, 2020

Conversation

jsiirola
Copy link
Contributor

Fixes: #N/A

Summary/Motivation:

This PR adds some long-overdue documentation for the ConfigValue / ConfigList / ConfigDict system. As part of this, it resolved some bugs and begins the process to rename ConfigBlock to ConfigDict (both names are currently supported). The documentation was confirmed to build and pass doctests (using the Pyomo Online Docs harness).

Changes proposed in this PR:

  • Rename ConfigBlock to ConfigDict
  • Add ConfigDict.declare_from() method
  • Resolve a bug involving ConfigDict.set_value() and __getitem__ for derived ConfigDict classes
  • Add a visibility option to display()
  • Add lots of documentation

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 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.

@coveralls
Copy link

coveralls commented Mar 18, 2020

Coverage Status

Coverage decreased (-0.08%) to 60.993% when pulling f129c2e on jsiirola:config-updates into 0fd5f24 on PyUtilib:master.

@codecov-io
Copy link

codecov-io commented Mar 18, 2020

Codecov Report

Merging #88 into master will decrease coverage by 0.09%.
The diff coverage is 66.66%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #88      +/-   ##
==========================================
- Coverage   63.10%   63.00%   -0.10%     
==========================================
  Files          87       87              
  Lines        8800     8824      +24     
==========================================
+ Hits         5553     5560       +7     
- Misses       3247     3264      +17     
Impacted Files Coverage Δ
pyutilib/misc/config.py 92.51% <66.66%> (-2.23%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0fd5f24...f129c2e. Read the comment docs.

Copy link
Contributor

@michaelbynum michaelbynum left a comment

Choose a reason for hiding this comment

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

I love it!

@michaelbynum michaelbynum merged commit 03a7350 into PyUtilib:master Mar 18, 2020
@jsiirola jsiirola deleted the config-updates branch March 18, 2020 18:11
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.

None yet

4 participants