Andrew remove import all #119
Merged
Conversation
This file contains hidden or 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
Before __all__ was used to manage these. But it's clearer to just import what we want users to see.
We *want* users to be able to do: ```python from plotly.graph_objs import * ``` NO ONE should do: ```python from plotly.graph_objs.graph_objs import * ``` The former is a nicely-controlled namespace. The latter is not.
It'd be nice to not let folks `import *` plotly.plotly, but that's a little overkill and perhaps actually useful for fiddling.
| "XBins", | ||
| "YAxis", | ||
| "YBins"] | ||
| __all__ = None |
There was a problem hiding this comment.
Notable: This will force an error when someone tries to import * this module. This is handy for us in particular since we're allowing users to import * the containing package. I find the error message somewhat useful (i.e. not un-useful).
>>> from plotly.graph_objs.graph_objs import *
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: 'NoneType' object does not support indexing
>>> from plotly.graph_objs import * # this is still OKI believe this is the functionality we want.
|
@bpostlethwaite , @chriddyp , taking out all the |
|
thanks @etpinard |
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.
A recent Plotly error unearthed an
import *statement that made interpreting the root cause difficult. In an attempt to have that never be an issue again, this PR removes all theimport *statements.As a side note, the import * statements were acting on modules with a well-defined
__all__objects. However, that's not possible to tell from a Traceback, you still just seeimport *.__all__: https://docs.python.org/2/tutorial/modules.html#importing-from-a-package