Added to_table method to OptionsDictionary to provide embed_options replacement capability in Jupyter.
#1924
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…table representation using the tabulate package. The __rst__() method now uses tabulate to build the underlying restructured text. Tests for repr changed because tabulate includes two spaces between columns instead of one.
swryan
requested changes
Feb 26, 2021
| ])) | ||
|
|
||
| def test_to_table(self): |
There was a problem hiding this comment.
I think we need a skipTest on this in case tabulate is not installed... and/or a test for the "tabulate not installed" message...
| except ImportError as e: | ||
| msg = "'to_table' requires the tabulate package but it is not currently installed." \ | ||
| " Use `pip install tablulate` or install openmdao with" \ | ||
| " `pip install openmdao[notebooks]`." |
There was a problem hiding this comment.
tabulate should probably be added to the docs optional dependencies, since it is now required to build the docs
swryan
approved these changes
Feb 26, 2021
Kenneth-T-Moore
approved these changes
Mar 1, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
OptionsDictionary now has a new method
to_table()which can output a table representation using the tabulate package.The
__rst__()method now uses tabulate to build the underlying restructured text.Tests for repr changed because tabulate includes two spaces between columns instead of one.
Related Issues
None
Backwards incompatibilities
None
New Dependencies
tabulate is now used when building the Sphinx documentation.
It is included when pip installed with [notebooks] or [all].