Skip to content
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

Revert "Resolving sibling modules with absolute imports" #1035

Merged
merged 1 commit into from
Feb 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions gazelle/python/generate.go
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
}

pyLibrary = newTargetBuilder(pyLibraryKind, pyLibraryTargetName, pythonProjectRoot, args.Rel, pyLibraryFilenames.Union(pyTestFilenames)).
setUUID(label.New("", args.Rel, pyLibraryTargetName).String()).
addVisibility(visibility).
addSrcs(pyLibraryFilenames).
addModuleDependencies(deps).
Expand Down Expand Up @@ -266,6 +267,10 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
addModuleDependencies(deps).
generateImportsAttribute()

if pyLibrary != nil {
pyBinaryTarget.addModuleDependency(module{Name: pyLibrary.PrivateAttr(uuidKey).(string)})
}

pyBinary := pyBinaryTarget.build()

result.Gen = append(result.Gen, pyBinary)
Expand Down Expand Up @@ -296,6 +301,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
}

conftestTarget := newTargetBuilder(pyLibraryKind, conftestTargetname, pythonProjectRoot, args.Rel, pyLibraryFilenames.Union(pyTestFilenames)).
setUUID(label.New("", args.Rel, conftestTargetname).String()).
addSrc(conftestFilename).
addModuleDependencies(deps).
addVisibility(visibility).
Expand All @@ -309,8 +315,8 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
}

var pyTestTargets []*targetBuilder
newPyTestTargetBuilder := func(srcs *treeset.Set, pyTestTargetName string) *targetBuilder {
deps, err := parser.parse(srcs)
newPyTestTargetBuilder := func(pyTestFilenames *treeset.Set, pyTestTargetName string) *targetBuilder {
deps, err := parser.parse(pyTestFilenames)
if err != nil {
log.Fatalf("ERROR: %v\n", err)
}
Expand All @@ -331,7 +337,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
}
}
return newTargetBuilder(pyTestKind, pyTestTargetName, pythonProjectRoot, args.Rel, pyLibraryFilenames.Union(pyTestFilenames)).
addSrcs(srcs).
addSrcs(pyTestFilenames).
addModuleDependencies(deps).
generateImportsAttribute()
}
Expand Down Expand Up @@ -365,9 +371,14 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
}

for _, pyTestTarget := range pyTestTargets {
if pyLibrary != nil {
pyTestTarget.addModuleDependency(module{Name: pyLibrary.PrivateAttr(uuidKey).(string)})
}

if conftest != nil {
pyTestTarget.addModuleDependency(module{Name: strings.TrimSuffix(conftestFilename, ".py")})
pyTestTarget.addModuleDependency(module{Name: conftest.PrivateAttr(uuidKey).(string)})
}

pyTest := pyTestTarget.build()

result.Gen = append(result.Gen, pyTest)
Expand Down
11 changes: 11 additions & 0 deletions gazelle/python/resolve.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ const (
// resolvedDepsKey is the attribute key used to pass dependencies that don't
// need to be resolved by the dependency resolver in the Resolver step.
resolvedDepsKey = "_gazelle_python_resolved_deps"
// uuidKey is the attribute key used to uniquely identify a py_library
// target that should be imported by a py_test or py_binary in the same
// Bazel package.
uuidKey = "_gazelle_python_library_uuid"
)

// Resolver satisfies the resolve.Resolver interface. It resolves dependencies
Expand Down Expand Up @@ -67,6 +71,13 @@ func (py *Resolver) Imports(c *config.Config, r *rule.Rule, f *rule.File) []reso
provides = append(provides, provide)
}
}
if r.PrivateAttr(uuidKey) != nil {
provide := resolve.ImportSpec{
Lang: languageName,
Imp: r.PrivateAttr(uuidKey).(string),
}
provides = append(provides, provide)
}
if len(provides) == 0 {
return nil
}
Expand Down
27 changes: 17 additions & 10 deletions gazelle/python/target.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,12 @@
package python

import (
"path/filepath"

"github.com/bazelbuild/bazel-gazelle/config"
"github.com/bazelbuild/bazel-gazelle/rule"
"github.com/emirpasic/gods/sets/treeset"
godsutils "github.com/emirpasic/gods/utils"
"path/filepath"
)

// targetBuilder builds targets to be generated by Gazelle.
Expand All @@ -28,6 +29,7 @@ type targetBuilder struct {
name string
pythonProjectRoot string
bzlPackage string
uuid string
srcs *treeset.Set
siblingSrcs *treeset.Set
deps *treeset.Set
Expand All @@ -53,6 +55,15 @@ func newTargetBuilder(kind, name, pythonProjectRoot, bzlPackage string, siblingS
}
}

// setUUID sets the given UUID for the target. It's used to index the generated
// target based on this value in addition to the other ways the targets can be
// imported. py_{binary,test} targets in the same Bazel package can add a
// virtual dependency to this UUID that gets resolved in the Resolver interface.
func (t *targetBuilder) setUUID(uuid string) *targetBuilder {
t.uuid = uuid
return t
}

// addSrc adds a single src to the target.
func (t *targetBuilder) addSrc(src string) *targetBuilder {
t.srcs.Add(src)
Expand All @@ -70,16 +81,9 @@ func (t *targetBuilder) addSrcs(srcs *treeset.Set) *targetBuilder {

// addModuleDependency adds a single module dep to the target.
func (t *targetBuilder) addModuleDependency(dep module) *targetBuilder {
fileName := dep.Name + ".py"
if dep.From != "" {
fileName = dep.From + ".py"
if dep.Name+".py" == filepath.Base(dep.Filepath) || !t.siblingSrcs.Contains(dep.Name+".py") {
t.deps.Add(dep)
}
if t.siblingSrcs.Contains(fileName) && fileName != filepath.Base(dep.Filepath) {
// importing another module from the same package, converting to absolute imports to make
// dependency resolution easier
dep.Name = importSpecFromSrc(t.pythonProjectRoot, t.bzlPackage, fileName).Imp
}
t.deps.Add(dep)
return t
}

Expand Down Expand Up @@ -134,6 +138,9 @@ func (t *targetBuilder) generateImportsAttribute() *targetBuilder {
// build returns the assembled *rule.Rule for the target.
func (t *targetBuilder) build() *rule.Rule {
r := rule.NewRule(t.kind, t.name)
if t.uuid != "" {
r.SetPrivateAttr(uuidKey, t.uuid)
}
if !t.srcs.Empty() {
r.SetAttr("srcs", t.srcs.Values())
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,8 @@ py_test(
name = "generated_test_entrypoint_test",
srcs = [":__test__"],
main = ":__test__.py",
deps = [":__test__"],
deps = [
":__test__",
":generated_test_entrypoint",
],
)
1 change: 0 additions & 1 deletion gazelle/python/testdata/naming_convention/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,3 @@
# limitations under the License.

# For test purposes only.
import __init__
1 change: 0 additions & 1 deletion gazelle/python/testdata/naming_convention/__test__.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,3 @@
# limitations under the License.

# For test purposes only.
import __init__
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,3 @@
# limitations under the License.

# For test purposes only.
import __init__
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,3 @@
# limitations under the License.

# For test purposes only.
import __init__
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,3 @@
# limitations under the License.

# For test purposes only.
import __init__
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,3 @@
# limitations under the License.

# For test purposes only.
import __init__
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,5 @@
# limitations under the License.

import boto3
import __init__

_ = boto3
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,3 @@
# limitations under the License.

# For test purposes only.
import __init__
3 changes: 0 additions & 3 deletions gazelle/python/testdata/sibling_imports/README.md

This file was deleted.

1 change: 0 additions & 1 deletion gazelle/python/testdata/sibling_imports/WORKSPACE

This file was deleted.

Empty file.
29 changes: 0 additions & 29 deletions gazelle/python/testdata/sibling_imports/pkg/BUILD.out

This file was deleted.

Empty file.
Empty file.
2 changes: 0 additions & 2 deletions gazelle/python/testdata/sibling_imports/pkg/b.py

This file was deleted.

Empty file.
3 changes: 0 additions & 3 deletions gazelle/python/testdata/sibling_imports/pkg/unit_test.py

This file was deleted.

1 change: 0 additions & 1 deletion gazelle/python/testdata/sibling_imports/test.yaml

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,3 @@
# limitations under the License.

# For test purposes only.
import foo
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,3 @@
# limitations under the License.

# For test purposes only.
import foo.has_main.python.my_module
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,3 @@
# limitations under the License.

# For test purposes only.
import foo.has_test.python.my_module
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ py_binary(
srcs = ["__main__.py"],
main = "__main__.py",
visibility = ["//:__subpackages__"],
deps = ["@gazelle_python_test_baz//:pkg"],
deps = [":with_third_party_requirements"],
)