Shorter python imports for postprocessing tools #2727
Merged
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
codingS3b
changed the title
psychocoderHPC
previously requested changes
Oct 15, 2018
|
|
||
| __all__ = ["EnergyHistogram", | ||
| "PhaseSpace", | ||
| "PNG"] |
ax3l
reviewed
Oct 15, 2018
| from .png_visualizer import Visualizer as PNGVisualizer | ||
|
|
||
|
|
||
| __all__ = ["EnergyHistogramVisualizer", |
There was a problem hiding this comment.
I would not suffix them with Visualizer, although I see the charm when importing data readers and visualizers at the same time into main scope... Do you know any best practices on this?
There was a problem hiding this comment.
No, not really. I would also have to read up on that.
Naming collisions were the main reason for suffixing them this way.
There was a problem hiding this comment.
Ok, but then let us at least Suffix them with PlotMPL or just MPL to be descriptive and consistent with the dir name
There was a problem hiding this comment.
Ok, I changed the suffix to 'MPL'
4 tasks
ax3l
approved these changes
Oct 15, 2018
ax3l
modified the milestones:
0.5.0 / 1.0.0: Next Stable,
0.4.0: CPU Support, Filter & Merging
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.
In order to shorten the import statements when using python visualizers, they are now included within the
plot_mpl/__init__.pywith meaningful aliases (since they are all called Visualizer).Instead of writing
from picongpu.plugins.plot_mpl.phase_space_visualizer import Visualizer as PhaseSpaceVisualizerone could then shorten this tofrom picongpu.plugins.plot_mpl import PhaseSpaceVisualizer