feat(gazelle): Allow disabling sibling module resolution #3106
Conversation
converting the import to an appropriate absolute import)
|
Thanks for the PR. Since the current gazelle code would result in un-runnable code, is there a good reason to not default to the correct behaviour and have the flag in case some user wants to do this step-wise? |
Honestly, my main reason is a feeling of "I must be missing something" about it. The sibling import behavior is not accidental: there's code added that only exists for resolving sibling imports, a test that explicitly tests for this behavior, and multiple other tests that implicitly depend on it. And, as far as I know, it was all written much after python2 was unsupported, which is the only reason that I can think of for why this would be desired. That said, I'd be happy to switch the default if you believe that would be ok. |
Currently, gazelle allows absolute imports to be resolved to sibling modules: an
import foostatement will resolve to afoo.pyfile in the same folder if such file exists. This seems to be a Python 2 behavior (ie. pre-from __future__ import absolute_import), and doesn't work on the current rules_python setup.This behavior is explicitly tested in the siblings_import test case. However, recreating the exact same repository layout from this test case and running
bazel test //pkg:unit_test, the test fails with the import failing.This PR adds a new directive,
gazelle:python_resolve_sibling_imports, to allow disabling such behavior.The actual changes are in 2 places:
gazelle/python/target.go, the directive is added toif t.siblingSrcs.Contains(fileName) && fileName != filepath.Base(dep.Filepath), which is where the import is converted to a full absolute import if it matches a sibling file;gazelle/python/generate.go, the handling ofconftest.pywas dependent on this behavior (ie. it added a dependency on the moduleconftest, assuming that it would be resolved to the relative module). That was modified to compute the full absolute module path instead.I also explicitly added
gazelle:python_resolve_sibling_imports trueto any test that breaks if the default value of this directive is changed tofalse.