Ensure shortened module path points to expected object. #273
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
|
This might be a bit overcautious if something like a top-level shortcut like |
choldgraf
reviewed
Jul 29, 2017
sphinx_gallery/backreferences.py
Outdated
| @@ -76,12 +76,21 @@ def get_mapping(self): | |||
|
|
|||
| def get_short_module_name(module_name, obj_name): | |||
| """ Get the shortest possible module name """ | |||
| scope = {} | |||
| try: | |||
| exec('from %s import %s' % (module_name, obj_name), scope, scope) | |||
There was a problem hiding this comment.
could you add a comment to highlight what/why this is being called here?
For example, `matplotlib.pyplot.figure` can be shortened to `matplotlib.figure`, but the former is a function (that is used a lot) while the latter is a module (which is generally used much less).
303c307 to
6025b73
Compare
|
This works well enough for me. I'm merging this. |
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.
For example,
matplotlib.pyplot.figurecan be shortened tomatplotlib.figure, but the former is a function (that is used a lot) while the latter is a module (which is generally used much less).