Add option to pass select_innermost_module during resolution
#114
Conversation
See roo-oliv#113 (comment) Resolves issue when `sys.path` has a prefix-path for the module path. (e.g. `PROJECT_ROOT` and `PROJECT_ROOT/.venv/lib/python3.11/site-packages`) The default behaviour is to match the shortes path possible (or the outermost module) but this causes a module_name as follows: `.venv.lib.python3.11.site-packages.module_name` while it most likely should be `module_name` as this is directly a subdir from the `site-packages`. The default behaviour is set to use the outermost to ensure no breaking change with current version.
|
|
Hi, @AlexVndnblcke! Thank you very much for taking the time to contribute to the project! ❤️ At first, it seems like a reasonable feature to add, I'll take the time to add tests to it and perform some validations. Also, I'm trying to think how to make it easier for a new dev to understand when to use this feature, ideally before getting into an error like you did. |
|
Thanks for the follow-up @roo-oliv. After submitting this patch I retraced the problem a little deeper, into pycollect. In the Detecting a valid module is however less trivial than this patch, as there are different ways a module can be defined. However, since it is based on the Alternatively, the python approach would be to attempt an import of that module and consider it validated if it succeeds. For reference, the validation could be added here: As for this patch, perhaps a rename could offer some solace. But keeping the parameter terse is a hard one here. Let me know what you think, I'm open to provide a patch for pycollect if you think that approach would be better. |
|
Hey all, any update on this PR? |
See #113 (comment)
Resolves issue when
sys.pathhas a prefix-path for the module path. (e.g.PROJECT_ROOTandPROJECT_ROOT/.venv/lib/python3.11/site-packages)The default behaviour is to match the shortes path possible (or the outermost module) but this causes a module_name as follows:
.venv.lib.python3.11.site-packages.module_namewhile it most likely should bemodule_nameas this is directly a subdir from thesite-packages.The default behaviour is set to use the outermost to ensure no breaking change with current version.