-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Viewcode: Support import paths that differ from the directory structure #10766
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
Closed
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
get_full_modname
get_full_modname
get_full_modname
@AA-Turner, @tk0miya let me know if I need to change anything for this PR to be merged |
danieleades
reviewed
Aug 15, 2022
tests/roots/test-ext-viewcode-find-package/main_package/__init__.py
Outdated
Show resolved
Hide resolved
danieleades
reviewed
Aug 15, 2022
tests/roots/test-ext-viewcode-find-package/main_package/subpackage/__init__.py
Outdated
Show resolved
Hide resolved
danieleades
reviewed
Aug 15, 2022
@danieleades The conflicts have been resolved, so this PR is ready for merging |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
If the module import path used by users does not match the directory / file structure,
import_lib
'simport_module
function cannot find it.Below is a basic example of where this failure occurs:
Using the above directory / file structure, users import
module1
via:Sphinx is generally able to handle this sort of structure, except for the viewcode extension that uses the
get_full_modname
function from here: https://github.com/sphinx-doc/sphinx/blob/5.x/sphinx/util/__init__.pyThat function specifically causes an error with the above example when
importlib
'simport_module
is run:The exact path to the module however has no error:
Feature / Bugfix
This PR is my attempt at fixing the above
import_module
error by locating the exact path to the module, which is then used withimport_module
.Currently this issue can be seen on projects where the viewcode extension is enabled, yet no source code link is created. Example: https://captum.ai/api/utilities.html#visualization
My solution utilizes
importlib
's__import__
function to find the directory module path to the object.