Prioritizing source directory in the sys.path #384
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.
This PR prioritizes the supplied source directory in the
sys.path
.Currently, the source directory of the
Builder
instance, when supplied, is appended tosys.path
:I think the source directory should come first:
By inserting itself into the first position in the path, module imports from the given source directory are prioritized over other modules. In particular, if one has a source file that happens to share the same name with another file also in the path (e.g.
random
,trace
,collections
, etc.), this change ensures quartodoc/griffe picks the package-level module over a base module.For me, this fixes griffe-related resolution issues that arise from mixing relative imports with editable installs (#323).