feat(gazelle): Allow customizing pip repo target naming convention

gazelle/README.md

@@ -147,6 +147,12 @@ Python-specific directives are as follows:
 | Controls the `py_test` naming convention. Follows the same interpolation rules as `python_library_naming_convention`. | |
 | `# gazelle:resolve py ...` | n/a |
 | Instructs the plugin what target to add as a dependency to satisfy a given import statement. The syntax is `# gazelle:resolve py import-string label` where `import-string` is the symbol in the python `import` statement, and `label` is the Bazel label that Gazelle should write in `deps`. | |
+| `# gazelle:python_pip_repo_naming_convention` | `$repo_name$_$distribution_name$` |
+| Controls the external dependency label naming convention. It interpolates `$repo_name$` and `$distribution_name$` with the Bazel external pip repository name and the sanitized Python package name respectively. E.g. if the Bazel external pip repository name is `my_pip_deps` and we are resolving external Python package named `flake-bugbear`, setting this to `$repo_name$_host_$distribution_name$` would result in a generated target named `my_pip_deps_host_flake8_bugbear`. | |
+| `# gazelle:python_pip_package_naming_convention` | n/a |
+| Controls the external dependency label naming convention. It interpolates `$distribution_name$` with the sanitized Python package name. See `gazelle:python_pip_repo_naming_convention` for details. This may be useful if you have `alias` targets which point to platform specific Python wheels in your repo, e.g. `//third_party/pip:flake8_bugbear_alias`. | |
+| `# gazelle:python_pip_target_naming_convention` | `pkg` |
+| Controls the external dependency label naming convention. It interpolates `$distribution_name$` with the sanitized Python package name respectively. See `gazelle:python_pip_repo_naming_convention` for details. This may be useful if you have `alias` targets which point to platform specific Python wheels in your repo, e.g. `//third_party/pip:flake8_bugbear_alias` or if you are using `gazelle` with `bzlmod`. | |
 
 ### Libraries
 

gazelle/configure.go

@@ -48,6 +48,9 @@ func (py *Configurer) KnownDirectives() []string {
  pythonconfig.LibraryNamingConvention,
  pythonconfig.BinaryNamingConvention,
  pythonconfig.TestNamingConvention,
+ pythonconfig.PipRepoNamingConvention,
+ pythonconfig.PipPackageNamingConvention,
+ pythonconfig.PipTargetNamingConvention,
 	}
 }
 
@@ -136,6 +139,12 @@ func (py *Configurer) Configure(c *config.Config, rel string, f *rule.File) {
  config.SetBinaryNamingConvention(strings.TrimSpace(d.Value))
  case pythonconfig.TestNamingConvention:
  config.SetTestNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipRepoNamingConvention:
+ config.SetPipRepoNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipPackageNamingConvention:
+ config.SetPipPackageNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipTargetNamingConvention:
+ config.SetPipTargetNamingConvention(strings.TrimSpace(d.Value))
  }
 	}
 

gazelle/pythonconfig/BUILD.bazel

@@ -1,4 +1,4 @@
-load("@io_bazel_rules_go//go:def.bzl", "go_library")
+load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
 
 go_library(
  name = "pythonconfig",
@@ -20,3 +20,9 @@ filegroup(
  srcs = glob(["**"]),
  visibility = ["//gazelle:__pkg__"],
 )
+
+go_test(
+ name = "pythonconfig_test",
+ srcs = ["pythonconfig_test.go"],
+ embed = [":pythonconfig"],
+)

gazelle/pythonconfig/pythonconfig.go

@@ -49,6 +49,17 @@ const (
 	// naming convention. See python_library_naming_convention for more info on
 	// the package name interpolation.
 	TestNamingConvention = "python_test_naming_convention"
+	// PipRepoNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. E.g. if the Python package name is `foo` and the
+	// pip repository is named `my_pip`, setting this
+	// to `$repo_name$_$distribution_name$` would render to `@my_pip_foo`.
+	PipRepoNamingConvention = "python_pip_repo_naming_convention"
+	// PipPackageNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. By default it is ``
+	PipPackageNamingConvention = "python_pip_package_naming_convention"
+	// PipTargetNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. By default it is `pkg`
+	PipTargetNamingConvention = "python_pip_target_naming_convention"
 )
 
 // GenerationModeType represents one of the generation modes for the Python
@@ -67,7 +78,9 @@ const (
 )
 
 const (
-	packageNameNamingConventionSubstitution = "$package_name$"
+	repoNamePipRepoNamingConventionSubstitution = "$repo_name$"
+	distributionNamePipRepoNamingConventionSubstitution = "$distribution_name$"
+	packageNameNamingConventionSubstitution = "$package_name$"
 )
 
 // defaultIgnoreFiles is the list of default values used in the
@@ -99,14 +112,17 @@ type Config struct {
 	pythonProjectRoot string
 	gazelleManifest *manifest.Manifest
 
-	excludedPatterns *singlylinkedlist.List
-	ignoreFiles map[string]struct{}
-	ignoreDependencies map[string]struct{}
-	validateImportStatements bool
-	coarseGrainedGeneration bool
-	libraryNamingConvention string
-	binaryNamingConvention string
-	testNamingConvention string
+	excludedPatterns *singlylinkedlist.List
+	ignoreFiles map[string]struct{}
+	ignoreDependencies map[string]struct{}
+	validateImportStatements bool
+	coarseGrainedGeneration bool
+	libraryNamingConvention string
+	binaryNamingConvention string
+	testNamingConvention string
+	pipRepoNamingConvention string
+	pipPackageNamingConvention string
+	pipTargetNamingConvention string
 }
 
 // New creates a new Config.
@@ -115,17 +131,20 @@ func New(
 	pythonProjectRoot string,
 ) *Config {
 	return &Config{
- extensionEnabled: true,
- repoRoot: repoRoot,
- pythonProjectRoot: pythonProjectRoot,
- excludedPatterns: singlylinkedlist.New(),
- ignoreFiles: make(map[string]struct{}),
- ignoreDependencies: make(map[string]struct{}),
- validateImportStatements: true,
- coarseGrainedGeneration: false,
- libraryNamingConvention: packageNameNamingConventionSubstitution,
- binaryNamingConvention: fmt.Sprintf("%s_bin", packageNameNamingConventionSubstitution),
- testNamingConvention: fmt.Sprintf("%s_test", packageNameNamingConventionSubstitution),
+ extensionEnabled: true,
+ repoRoot: repoRoot,
+ pythonProjectRoot: pythonProjectRoot,
+ excludedPatterns: singlylinkedlist.New(),
+ ignoreFiles: make(map[string]struct{}),
+ ignoreDependencies: make(map[string]struct{}),
+ validateImportStatements: true,
+ coarseGrainedGeneration: false,
+ libraryNamingConvention: packageNameNamingConventionSubstitution,
+ binaryNamingConvention: fmt.Sprintf("%s_bin", packageNameNamingConventionSubstitution),
+ testNamingConvention: fmt.Sprintf("%s_test", packageNameNamingConventionSubstitution),
+ pipRepoNamingConvention: fmt.Sprintf("%s_%s", repoNamePipRepoNamingConventionSubstitution, distributionNamePipRepoNamingConventionSubstitution),
+ pipPackageNamingConvention: "",
+ pipTargetNamingConvention: "pkg",
 	}
 }
 
@@ -150,6 +169,9 @@ func (c *Config) NewChild() *Config {
  libraryNamingConvention: c.libraryNamingConvention,
  binaryNamingConvention: c.binaryNamingConvention,
  testNamingConvention: c.testNamingConvention,
+ pipRepoNamingConvention: c.pipRepoNamingConvention,
+ pipPackageNamingConvention: c.pipPackageNamingConvention,
+ pipTargetNamingConvention: c.pipTargetNamingConvention,
 	}
 }
 
@@ -195,24 +217,32 @@ func (c *Config) SetGazelleManifest(gazelleManifest *manifest.Manifest) {
 // name.
 func (c *Config) FindThirdPartyDependency(modName string) (string, bool) {
 	for currentCfg := c; currentCfg != nil; currentCfg = currentCfg.parent {
- if currentCfg.gazelleManifest != nil {
- gazelleManifest := currentCfg.gazelleManifest
- if distributionName, ok := gazelleManifest.ModulesMapping[modName]; ok {
- var distributionRepositoryName string
- if gazelleManifest.PipDepsRepositoryName != "" {
- distributionRepositoryName = gazelleManifest.PipDepsRepositoryName
- } else if gazelleManifest.PipRepository != nil {
- distributionRepositoryName = gazelleManifest.PipRepository.Name
- }
- sanitizedDistribution := strings.ToLower(distributionName)
- sanitizedDistribution = strings.ReplaceAll(sanitizedDistribution, "-", "_")
- var lbl label.Label
- // @<repository_name>_<distribution_name>//:pkg
- distributionRepositoryName = distributionRepositoryName + "_" + sanitizedDistribution
- lbl = label.New(distributionRepositoryName, "", "pkg")
- return lbl.String(), true
- }
+
+ if currentCfg.gazelleManifest == nil {
+ continue
+ }
+
+ gazelleManifest := currentCfg.gazelleManifest
+ distributionName, ok := gazelleManifest.ModulesMapping[modName]
+ if !ok {
+ continue
  }
+
+ var distributionRepositoryName string
+ if gazelleManifest.PipDepsRepositoryName != "" {
+ distributionRepositoryName = gazelleManifest.PipDepsRepositoryName
+ } else if gazelleManifest.PipRepository != nil {
+ distributionRepositoryName = gazelleManifest.PipRepository.Name
+ }
+ sanitizedDistribution := strings.ToLower(distributionName)
+ sanitizedDistribution = strings.ReplaceAll(sanitizedDistribution, "-", "_")
+
+ lbl := label.New(
+ currentCfg.renderPipRepository(distributionRepositoryName, sanitizedDistribution),
+ currentCfg.renderPipPackage(sanitizedDistribution),
+ currentCfg.renderPipTarget(sanitizedDistribution),
+ )
+ return lbl.String(), true
 	}
 	return "", false
 }
@@ -327,6 +357,37 @@ func (c *Config) SetTestNamingConvention(testNamingConvention string) {
 	c.testNamingConvention = testNamingConvention
 }
 
+// SetPipRepoNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipRepoNamingConvention(pipRepoNamingConvention string) {
+	c.pipRepoNamingConvention = pipRepoNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipRepository(distributionRepoName, distributionName string) string {
+	rendered := strings.ReplaceAll(c.pipRepoNamingConvention, repoNamePipRepoNamingConventionSubstitution, distributionRepoName)
+	return strings.ReplaceAll(rendered, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
+// SetPipPackageNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipPackageNamingConvention(pipPackageNamingConvention string) {
+	c.pipPackageNamingConvention = pipPackageNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipPackage(distributionName string) string {
+	return strings.ReplaceAll(c.pipPackageNamingConvention, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
+// SetPipTargetNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipTargetNamingConvention(pipTargetNamingConvention string) {
+	c.pipTargetNamingConvention = pipTargetNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipTarget(distributionName string) string {
+	return strings.ReplaceAll(c.pipTargetNamingConvention, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
 // RenderTestName returns the py_test target name by performing all
 // substitutions.
 func (c *Config) RenderTestName(packageName string) string {

gazelle/pythonconfig/pythonconfig_test.go

@@ -0,0 +1,19 @@
+package pythonconfig
+
+import (
+	"reflect"
+	"testing"
+)
+
+func TestConfigNewChild(t *testing.T) {
+	parent := New("foo", "bar")
+	child := parent.NewChild()
+
+	if child.parent == nil {
+ t.Error("child parent should not be nil")
+	}
+	child.parent = nil
+	if !reflect.DeepEqual(child, parent) {
+ t.Errorf("child and should should be equal other than the parent reference. Parent: %#v\nChild: %#v", parent, child)
+	}
+}

gazelle/pythonconfig/types.go

@@ -100,4 +100,4 @@ func (sml *StringMapList) Set(s string) error {
 func (sml *StringMapList) Get(key string) (string, bool) {
 	val, exists := sml.mapping[key]
 	return val, exists
-}
+}

gazelle/testdata/pip_repo_convention/BUILD.in

@@ -0,0 +1,3 @@
+# gazelle:python_pip_repo_naming_convention $repo_name$
+# gazelle:python_pip_package_naming_convention $distribution_name$
+# gazelle:python_pip_target_naming_convention $distribution_name$_pkg

gazelle/testdata/pip_repo_convention/BUILD.out

@@ -0,0 +1,31 @@
+load("@rules_python//python:defs.bzl", "py_binary", "py_library")
+
+# gazelle:python_pip_repo_naming_convention $repo_name$
+# gazelle:python_pip_package_naming_convention $distribution_name$
+# gazelle:python_pip_target_naming_convention $distribution_name$_pkg
+
+py_library(
+ name = "pip_repo_convention",
+ srcs = [
+ "__init__.py",
+ "bar.py",
+ "foo.py",
+ ],
+ visibility = ["//:__subpackages__"],
+ deps = [
+ "@pip_deps//baz:baz_pkg",
+ "@pip_deps//boto3:boto3_pkg",
+ "@pip_deps//djangorestframework:djangorestframework_pkg",
+ ],
+)
+
+py_binary(
+ name = "pip_repo_convention_bin",
+ srcs = ["__main__.py"],
+ main = "__main__.py",
+ visibility = ["//:__subpackages__"],
+ deps = [
+ ":pip_repo_convention",
+ "@pip_deps//baz:baz_pkg",
+ ],
+)

gazelle/testdata/pip_repo_convention/README.md

@@ -0,0 +1,3 @@
+# Pip repo convention
+
+This test case asserts that the dependency labels generated by gazelle follow a particular convention, that can be changed using directives.

gazelle/testdata/pip_repo_convention/WORKSPACE

@@ -0,0 +1 @@
+# This is a Bazel workspace for the Gazelle test data.

gazelle/testdata/pip_repo_convention/__init__.py

@@ -0,0 +1 @@
+# For test purposes only.

gazelle/testdata/pip_repo_convention/__main__.py

@@ -0,0 +1,5 @@
+import bar
+import foo
+
+_ = bar
+_ = foo

gazelle/testdata/pip_repo_convention/bar.py

@@ -0,0 +1,11 @@
+import os
+
+import bar
+import boto3
+import rest_framework
+
+_ = os
+
+_ = bar
+_ = boto3
+_ = rest_framework

gazelle/testdata/pip_repo_convention/foo.py

@@ -0,0 +1,11 @@
+import sys
+
+import boto3
+import foo
+import rest_framework
+
+_ = sys
+
+_ = boto3
+_ = foo
+_ = rest_framework

gazelle/testdata/pip_repo_convention/gazelle_python.yaml

@@ -0,0 +1,8 @@
+manifest:
+ modules_mapping:
+ boto3: boto3
+ rest_framework: djangorestframework
+ foo: baz
+ bar: baz
+ pip_repository:
+ name: pip_deps

gazelle/testdata/pip_repo_convention/test.yaml

@@ -0,0 +1 @@
+---

gazelle/README.md

@@ -147,6 +147,12 @@ Python-specific directives are as follows:
 | Controls the `py_test` naming convention. Follows the same interpolation rules as `python_library_naming_convention`. | |
 | `# gazelle:resolve py ...` | n/a |
 | Instructs the plugin what target to add as a dependency to satisfy a given import statement. The syntax is `# gazelle:resolve py import-string label` where `import-string` is the symbol in the python `import` statement, and `label` is the Bazel label that Gazelle should write in `deps`. | |
+| `# gazelle:python_pip_repo_naming_convention` | `$repo_name$_$distribution_name$` |
+| Controls the external dependency label naming convention. It interpolates `$repo_name$` and `$distribution_name$` with the Bazel external pip repository name and the sanitized Python package name respectively. E.g. if the Bazel external pip repository name is `my_pip_deps` and we are resolving external Python package named `flake-bugbear`, setting this to `$repo_name$_host_$distribution_name$` would result in a generated target named `my_pip_deps_host_flake8_bugbear`. | |
+| `# gazelle:python_pip_package_naming_convention` | n/a |
+| Controls the external dependency label naming convention. It interpolates `$distribution_name$` with the sanitized Python package name. See `gazelle:python_pip_repo_naming_convention` for details. This may be useful if you have `alias` targets which point to platform specific Python wheels in your repo, e.g. `//third_party/pip:flake8_bugbear_alias`. | |
+| `# gazelle:python_pip_target_naming_convention` | `pkg` |
+| Controls the external dependency label naming convention. It interpolates `$distribution_name$` with the sanitized Python package name respectively. See `gazelle:python_pip_repo_naming_convention` for details. This may be useful if you have `alias` targets which point to platform specific Python wheels in your repo, e.g. `//third_party/pip:flake8_bugbear_alias` or if you are using `gazelle` with `bzlmod`. | |
 
 ### Libraries
 

gazelle/configure.go

@@ -48,6 +48,9 @@ func (py *Configurer) KnownDirectives() []string {
  pythonconfig.LibraryNamingConvention,
  pythonconfig.BinaryNamingConvention,
  pythonconfig.TestNamingConvention,
+ pythonconfig.PipRepoNamingConvention,
+ pythonconfig.PipPackageNamingConvention,
+ pythonconfig.PipTargetNamingConvention,
 	}
 }
 
@@ -136,6 +139,12 @@ func (py *Configurer) Configure(c *config.Config, rel string, f *rule.File) {
  config.SetBinaryNamingConvention(strings.TrimSpace(d.Value))
  case pythonconfig.TestNamingConvention:
  config.SetTestNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipRepoNamingConvention:
+ config.SetPipRepoNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipPackageNamingConvention:
+ config.SetPipPackageNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipTargetNamingConvention:
+ config.SetPipTargetNamingConvention(strings.TrimSpace(d.Value))
  }
 	}
 

gazelle/pythonconfig/BUILD.bazel

@@ -1,4 +1,4 @@
-load("@io_bazel_rules_go//go:def.bzl", "go_library")
+load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
 
 go_library(
  name = "pythonconfig",
@@ -20,3 +20,9 @@ filegroup(
  srcs = glob(["**"]),
  visibility = ["//gazelle:__pkg__"],
 )
+
+go_test(
+ name = "pythonconfig_test",
+ srcs = ["pythonconfig_test.go"],
+ embed = [":pythonconfig"],
+)

gazelle/pythonconfig/pythonconfig.go

@@ -49,6 +49,17 @@ const (
 	// naming convention. See python_library_naming_convention for more info on
 	// the package name interpolation.
 	TestNamingConvention = "python_test_naming_convention"
+	// PipRepoNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. E.g. if the Python package name is `foo` and the
+	// pip repository is named `my_pip`, setting this
+	// to `$repo_name$_$distribution_name$` would render to `@my_pip_foo`.
+	PipRepoNamingConvention = "python_pip_repo_naming_convention"
+	// PipPackageNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. By default it is ``
+	PipPackageNamingConvention = "python_pip_package_naming_convention"
+	// PipTargetNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. By default it is `pkg`
+	PipTargetNamingConvention = "python_pip_target_naming_convention"
 )
 
 // GenerationModeType represents one of the generation modes for the Python
@@ -67,7 +78,9 @@ const (
 )
 
 const (
-	packageNameNamingConventionSubstitution = "$package_name$"
+	repoNamePipRepoNamingConventionSubstitution = "$repo_name$"
+	distributionNamePipRepoNamingConventionSubstitution = "$distribution_name$"
+	packageNameNamingConventionSubstitution = "$package_name$"
 )
 
 // defaultIgnoreFiles is the list of default values used in the
@@ -99,14 +112,17 @@ type Config struct {
 	pythonProjectRoot string
 	gazelleManifest *manifest.Manifest
 
-	excludedPatterns *singlylinkedlist.List
-	ignoreFiles map[string]struct{}
-	ignoreDependencies map[string]struct{}
-	validateImportStatements bool
-	coarseGrainedGeneration bool
-	libraryNamingConvention string
-	binaryNamingConvention string
-	testNamingConvention string
+	excludedPatterns *singlylinkedlist.List
+	ignoreFiles map[string]struct{}
+	ignoreDependencies map[string]struct{}
+	validateImportStatements bool
+	coarseGrainedGeneration bool
+	libraryNamingConvention string
+	binaryNamingConvention string
+	testNamingConvention string
+	pipRepoNamingConvention string
+	pipPackageNamingConvention string
+	pipTargetNamingConvention string
 }
 
 // New creates a new Config.
@@ -115,17 +131,20 @@ func New(
 	pythonProjectRoot string,
 ) *Config {
 	return &Config{
- extensionEnabled: true,
- repoRoot: repoRoot,
- pythonProjectRoot: pythonProjectRoot,
- excludedPatterns: singlylinkedlist.New(),
- ignoreFiles: make(map[string]struct{}),
- ignoreDependencies: make(map[string]struct{}),
- validateImportStatements: true,
- coarseGrainedGeneration: false,
- libraryNamingConvention: packageNameNamingConventionSubstitution,
- binaryNamingConvention: fmt.Sprintf("%s_bin", packageNameNamingConventionSubstitution),
- testNamingConvention: fmt.Sprintf("%s_test", packageNameNamingConventionSubstitution),
+ extensionEnabled: true,
+ repoRoot: repoRoot,
+ pythonProjectRoot: pythonProjectRoot,
+ excludedPatterns: singlylinkedlist.New(),
+ ignoreFiles: make(map[string]struct{}),
+ ignoreDependencies: make(map[string]struct{}),
+ validateImportStatements: true,
+ coarseGrainedGeneration: false,
+ libraryNamingConvention: packageNameNamingConventionSubstitution,
+ binaryNamingConvention: fmt.Sprintf("%s_bin", packageNameNamingConventionSubstitution),
+ testNamingConvention: fmt.Sprintf("%s_test", packageNameNamingConventionSubstitution),
+ pipRepoNamingConvention: fmt.Sprintf("%s_%s", repoNamePipRepoNamingConventionSubstitution, distributionNamePipRepoNamingConventionSubstitution),
+ pipPackageNamingConvention: "",
+ pipTargetNamingConvention: "pkg",
 	}
 }
 
@@ -150,6 +169,9 @@ func (c *Config) NewChild() *Config {
  libraryNamingConvention: c.libraryNamingConvention,
  binaryNamingConvention: c.binaryNamingConvention,
  testNamingConvention: c.testNamingConvention,
+ pipRepoNamingConvention: c.pipRepoNamingConvention,
+ pipPackageNamingConvention: c.pipPackageNamingConvention,
+ pipTargetNamingConvention: c.pipTargetNamingConvention,
 	}
 }
 
@@ -195,24 +217,32 @@ func (c *Config) SetGazelleManifest(gazelleManifest *manifest.Manifest) {
 // name.
 func (c *Config) FindThirdPartyDependency(modName string) (string, bool) {
 	for currentCfg := c; currentCfg != nil; currentCfg = currentCfg.parent {
- if currentCfg.gazelleManifest != nil {
- gazelleManifest := currentCfg.gazelleManifest
- if distributionName, ok := gazelleManifest.ModulesMapping[modName]; ok {
- var distributionRepositoryName string
- if gazelleManifest.PipDepsRepositoryName != "" {
- distributionRepositoryName = gazelleManifest.PipDepsRepositoryName
- } else if gazelleManifest.PipRepository != nil {
- distributionRepositoryName = gazelleManifest.PipRepository.Name
- }
- sanitizedDistribution := strings.ToLower(distributionName)
- sanitizedDistribution = strings.ReplaceAll(sanitizedDistribution, "-", "_")
- var lbl label.Label
- // @<repository_name>_<distribution_name>//:pkg
- distributionRepositoryName = distributionRepositoryName + "_" + sanitizedDistribution
- lbl = label.New(distributionRepositoryName, "", "pkg")
- return lbl.String(), true
- }
+
+ if currentCfg.gazelleManifest == nil {
+ continue
+ }
+
+ gazelleManifest := currentCfg.gazelleManifest
+ distributionName, ok := gazelleManifest.ModulesMapping[modName]
+ if !ok {
+ continue
  }
+
+ var distributionRepositoryName string
+ if gazelleManifest.PipDepsRepositoryName != "" {
+ distributionRepositoryName = gazelleManifest.PipDepsRepositoryName
+ } else if gazelleManifest.PipRepository != nil {
+ distributionRepositoryName = gazelleManifest.PipRepository.Name
+ }
+ sanitizedDistribution := strings.ToLower(distributionName)
+ sanitizedDistribution = strings.ReplaceAll(sanitizedDistribution, "-", "_")
+
+ lbl := label.New(
+ currentCfg.renderPipRepository(distributionRepositoryName, sanitizedDistribution),
+ currentCfg.renderPipPackage(sanitizedDistribution),
+ currentCfg.renderPipTarget(sanitizedDistribution),
+ )
+ return lbl.String(), true
 	}
 	return "", false
 }
@@ -327,6 +357,37 @@ func (c *Config) SetTestNamingConvention(testNamingConvention string) {
 	c.testNamingConvention = testNamingConvention
 }
 
+// SetPipRepoNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipRepoNamingConvention(pipRepoNamingConvention string) {
+	c.pipRepoNamingConvention = pipRepoNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipRepository(distributionRepoName, distributionName string) string {
+	rendered := strings.ReplaceAll(c.pipRepoNamingConvention, repoNamePipRepoNamingConventionSubstitution, distributionRepoName)
+	return strings.ReplaceAll(rendered, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
+// SetPipPackageNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipPackageNamingConvention(pipPackageNamingConvention string) {
+	c.pipPackageNamingConvention = pipPackageNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipPackage(distributionName string) string {
+	return strings.ReplaceAll(c.pipPackageNamingConvention, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
+// SetPipTargetNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipTargetNamingConvention(pipTargetNamingConvention string) {
+	c.pipTargetNamingConvention = pipTargetNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipTarget(distributionName string) string {
+	return strings.ReplaceAll(c.pipTargetNamingConvention, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
 // RenderTestName returns the py_test target name by performing all
 // substitutions.
 func (c *Config) RenderTestName(packageName string) string {

gazelle/pythonconfig/pythonconfig_test.go

@@ -0,0 +1,19 @@
+package pythonconfig
+
+import (
+	"reflect"
+	"testing"
+)
+
+func TestConfigNewChild(t *testing.T) {
+	parent := New("foo", "bar")
+	child := parent.NewChild()
+
+	if child.parent == nil {
+ t.Error("child parent should not be nil")
+	}
+	child.parent = nil
+	if !reflect.DeepEqual(child, parent) {
+ t.Errorf("child and should should be equal other than the parent reference. Parent: %#v\nChild: %#v", parent, child)
+	}
+}

gazelle/pythonconfig/types.go

@@ -100,4 +100,4 @@ func (sml *StringMapList) Set(s string) error {
 func (sml *StringMapList) Get(key string) (string, bool) {
 	val, exists := sml.mapping[key]
 	return val, exists
-}
+}

gazelle/testdata/pip_repo_convention/BUILD.in

@@ -0,0 +1,3 @@
+# gazelle:python_pip_repo_naming_convention $repo_name$
+# gazelle:python_pip_package_naming_convention $distribution_name$
+# gazelle:python_pip_target_naming_convention $distribution_name$_pkg

gazelle/testdata/pip_repo_convention/BUILD.out

@@ -0,0 +1,31 @@
+load("@rules_python//python:defs.bzl", "py_binary", "py_library")
+
+# gazelle:python_pip_repo_naming_convention $repo_name$
+# gazelle:python_pip_package_naming_convention $distribution_name$
+# gazelle:python_pip_target_naming_convention $distribution_name$_pkg
+
+py_library(
+ name = "pip_repo_convention",
+ srcs = [
+ "__init__.py",
+ "bar.py",
+ "foo.py",
+ ],
+ visibility = ["//:__subpackages__"],
+ deps = [
+ "@pip_deps//baz:baz_pkg",
+ "@pip_deps//boto3:boto3_pkg",
+ "@pip_deps//djangorestframework:djangorestframework_pkg",
+ ],
+)
+
+py_binary(
+ name = "pip_repo_convention_bin",
+ srcs = ["__main__.py"],
+ main = "__main__.py",
+ visibility = ["//:__subpackages__"],
+ deps = [
+ ":pip_repo_convention",
+ "@pip_deps//baz:baz_pkg",
+ ],
+)

gazelle/testdata/pip_repo_convention/README.md

@@ -0,0 +1,3 @@
+# Pip repo convention
+
+This test case asserts that the dependency labels generated by gazelle follow a particular convention, that can be changed using directives.

gazelle/testdata/pip_repo_convention/WORKSPACE

@@ -0,0 +1 @@
+# This is a Bazel workspace for the Gazelle test data.

gazelle/testdata/pip_repo_convention/__init__.py

@@ -0,0 +1 @@
+# For test purposes only.

gazelle/testdata/pip_repo_convention/__main__.py

@@ -0,0 +1,5 @@
+import bar
+import foo
+
+_ = bar
+_ = foo

gazelle/testdata/pip_repo_convention/bar.py

@@ -0,0 +1,11 @@
+import os
+
+import bar
+import boto3
+import rest_framework
+
+_ = os
+
+_ = bar
+_ = boto3
+_ = rest_framework

gazelle/testdata/pip_repo_convention/foo.py

@@ -0,0 +1,11 @@
+import sys
+
+import boto3
+import foo
+import rest_framework
+
+_ = sys
+
+_ = boto3
+_ = foo
+_ = rest_framework

gazelle/testdata/pip_repo_convention/gazelle_python.yaml

@@ -0,0 +1,8 @@
+manifest:
+ modules_mapping:
+ boto3: boto3
+ rest_framework: djangorestframework
+ foo: baz
+ bar: baz
+ pip_repository:
+ name: pip_deps

gazelle/testdata/pip_repo_convention/test.yaml

@@ -0,0 +1 @@
+---

gazelle/README.md

@@ -147,6 +147,12 @@ Python-specific directives are as follows:
 | Controls the `py_test` naming convention. Follows the same interpolation rules as `python_library_naming_convention`. | |
 | `# gazelle:resolve py ...` | n/a |
 | Instructs the plugin what target to add as a dependency to satisfy a given import statement. The syntax is `# gazelle:resolve py import-string label` where `import-string` is the symbol in the python `import` statement, and `label` is the Bazel label that Gazelle should write in `deps`. | |
+| `# gazelle:python_pip_repo_naming_convention` | `$repo_name$_$distribution_name$` |
+| Controls the external dependency label naming convention. It interpolates `$repo_name$` and `$distribution_name$` with the Bazel external pip repository name and the sanitized Python package name respectively. E.g. if the Bazel external pip repository name is `my_pip_deps` and we are resolving external Python package named `flake-bugbear`, setting this to `$repo_name$_host_$distribution_name$` would result in a generated target named `my_pip_deps_host_flake8_bugbear`. | |
+| `# gazelle:python_pip_package_naming_convention` | n/a |
+| Controls the external dependency label naming convention. It interpolates `$distribution_name$` with the sanitized Python package name. See `gazelle:python_pip_repo_naming_convention` for details. This may be useful if you have `alias` targets which point to platform specific Python wheels in your repo, e.g. `//third_party/pip:flake8_bugbear_alias`. | |
+| `# gazelle:python_pip_target_naming_convention` | `pkg` |
+| Controls the external dependency label naming convention. It interpolates `$distribution_name$` with the sanitized Python package name respectively. See `gazelle:python_pip_repo_naming_convention` for details. This may be useful if you have `alias` targets which point to platform specific Python wheels in your repo, e.g. `//third_party/pip:flake8_bugbear_alias` or if you are using `gazelle` with `bzlmod`. | |
 
 ### Libraries
 

gazelle/configure.go

@@ -48,6 +48,9 @@ func (py *Configurer) KnownDirectives() []string {
  pythonconfig.LibraryNamingConvention,
  pythonconfig.BinaryNamingConvention,
  pythonconfig.TestNamingConvention,
+ pythonconfig.PipRepoNamingConvention,
+ pythonconfig.PipPackageNamingConvention,
+ pythonconfig.PipTargetNamingConvention,
 	}
 }
 
@@ -136,6 +139,12 @@ func (py *Configurer) Configure(c *config.Config, rel string, f *rule.File) {
  config.SetBinaryNamingConvention(strings.TrimSpace(d.Value))
  case pythonconfig.TestNamingConvention:
  config.SetTestNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipRepoNamingConvention:
+ config.SetPipRepoNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipPackageNamingConvention:
+ config.SetPipPackageNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipTargetNamingConvention:
+ config.SetPipTargetNamingConvention(strings.TrimSpace(d.Value))
  }
 	}
 

gazelle/pythonconfig/BUILD.bazel

@@ -1,4 +1,4 @@
-load("@io_bazel_rules_go//go:def.bzl", "go_library")
+load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
 
 go_library(
  name = "pythonconfig",
@@ -20,3 +20,9 @@ filegroup(
  srcs = glob(["**"]),
  visibility = ["//gazelle:__pkg__"],
 )
+
+go_test(
+ name = "pythonconfig_test",
+ srcs = ["pythonconfig_test.go"],
+ embed = [":pythonconfig"],
+)

gazelle/pythonconfig/pythonconfig.go

@@ -49,6 +49,17 @@ const (
 	// naming convention. See python_library_naming_convention for more info on
 	// the package name interpolation.
 	TestNamingConvention = "python_test_naming_convention"
+	// PipRepoNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. E.g. if the Python package name is `foo` and the
+	// pip repository is named `my_pip`, setting this
+	// to `$repo_name$_$distribution_name$` would render to `@my_pip_foo`.
+	PipRepoNamingConvention = "python_pip_repo_naming_convention"
+	// PipPackageNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. By default it is ``
+	PipPackageNamingConvention = "python_pip_package_naming_convention"
+	// PipTargetNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. By default it is `pkg`
+	PipTargetNamingConvention = "python_pip_target_naming_convention"
 )
 
 // GenerationModeType represents one of the generation modes for the Python
@@ -67,7 +78,9 @@ const (
 )
 
 const (
-	packageNameNamingConventionSubstitution = "$package_name$"
+	repoNamePipRepoNamingConventionSubstitution = "$repo_name$"
+	distributionNamePipRepoNamingConventionSubstitution = "$distribution_name$"
+	packageNameNamingConventionSubstitution = "$package_name$"
 )
 
 // defaultIgnoreFiles is the list of default values used in the
@@ -99,14 +112,17 @@ type Config struct {
 	pythonProjectRoot string
 	gazelleManifest *manifest.Manifest
 
-	excludedPatterns *singlylinkedlist.List
-	ignoreFiles map[string]struct{}
-	ignoreDependencies map[string]struct{}
-	validateImportStatements bool
-	coarseGrainedGeneration bool
-	libraryNamingConvention string
-	binaryNamingConvention string
-	testNamingConvention string
+	excludedPatterns *singlylinkedlist.List
+	ignoreFiles map[string]struct{}
+	ignoreDependencies map[string]struct{}
+	validateImportStatements bool
+	coarseGrainedGeneration bool
+	libraryNamingConvention string
+	binaryNamingConvention string
+	testNamingConvention string
+	pipRepoNamingConvention string
+	pipPackageNamingConvention string
+	pipTargetNamingConvention string
 }
 
 // New creates a new Config.
@@ -115,17 +131,20 @@ func New(
 	pythonProjectRoot string,
 ) *Config {
 	return &Config{
- extensionEnabled: true,
- repoRoot: repoRoot,
- pythonProjectRoot: pythonProjectRoot,
- excludedPatterns: singlylinkedlist.New(),
- ignoreFiles: make(map[string]struct{}),
- ignoreDependencies: make(map[string]struct{}),
- validateImportStatements: true,
- coarseGrainedGeneration: false,
- libraryNamingConvention: packageNameNamingConventionSubstitution,
- binaryNamingConvention: fmt.Sprintf("%s_bin", packageNameNamingConventionSubstitution),
- testNamingConvention: fmt.Sprintf("%s_test", packageNameNamingConventionSubstitution),
+ extensionEnabled: true,
+ repoRoot: repoRoot,
+ pythonProjectRoot: pythonProjectRoot,
+ excludedPatterns: singlylinkedlist.New(),
+ ignoreFiles: make(map[string]struct{}),
+ ignoreDependencies: make(map[string]struct{}),
+ validateImportStatements: true,
+ coarseGrainedGeneration: false,
+ libraryNamingConvention: packageNameNamingConventionSubstitution,
+ binaryNamingConvention: fmt.Sprintf("%s_bin", packageNameNamingConventionSubstitution),
+ testNamingConvention: fmt.Sprintf("%s_test", packageNameNamingConventionSubstitution),
+ pipRepoNamingConvention: fmt.Sprintf("%s_%s", repoNamePipRepoNamingConventionSubstitution, distributionNamePipRepoNamingConventionSubstitution),
+ pipPackageNamingConvention: "",
+ pipTargetNamingConvention: "pkg",
 	}
 }
 
@@ -150,6 +169,9 @@ func (c *Config) NewChild() *Config {
  libraryNamingConvention: c.libraryNamingConvention,
  binaryNamingConvention: c.binaryNamingConvention,
  testNamingConvention: c.testNamingConvention,
+ pipRepoNamingConvention: c.pipRepoNamingConvention,
+ pipPackageNamingConvention: c.pipPackageNamingConvention,
+ pipTargetNamingConvention: c.pipTargetNamingConvention,
 	}
 }
 
@@ -195,24 +217,32 @@ func (c *Config) SetGazelleManifest(gazelleManifest *manifest.Manifest) {
 // name.
 func (c *Config) FindThirdPartyDependency(modName string) (string, bool) {
 	for currentCfg := c; currentCfg != nil; currentCfg = currentCfg.parent {
- if currentCfg.gazelleManifest != nil {
- gazelleManifest := currentCfg.gazelleManifest
- if distributionName, ok := gazelleManifest.ModulesMapping[modName]; ok {
- var distributionRepositoryName string
- if gazelleManifest.PipDepsRepositoryName != "" {
- distributionRepositoryName = gazelleManifest.PipDepsRepositoryName
- } else if gazelleManifest.PipRepository != nil {
- distributionRepositoryName = gazelleManifest.PipRepository.Name
- }
- sanitizedDistribution := strings.ToLower(distributionName)
- sanitizedDistribution = strings.ReplaceAll(sanitizedDistribution, "-", "_")
- var lbl label.Label
- // @<repository_name>_<distribution_name>//:pkg
- distributionRepositoryName = distributionRepositoryName + "_" + sanitizedDistribution
- lbl = label.New(distributionRepositoryName, "", "pkg")
- return lbl.String(), true
- }
+
+ if currentCfg.gazelleManifest == nil {
+ continue
+ }
+
+ gazelleManifest := currentCfg.gazelleManifest
+ distributionName, ok := gazelleManifest.ModulesMapping[modName]
+ if !ok {
+ continue
  }
+
+ var distributionRepositoryName string
+ if gazelleManifest.PipDepsRepositoryName != "" {
+ distributionRepositoryName = gazelleManifest.PipDepsRepositoryName
+ } else if gazelleManifest.PipRepository != nil {
+ distributionRepositoryName = gazelleManifest.PipRepository.Name
+ }
+ sanitizedDistribution := strings.ToLower(distributionName)
+ sanitizedDistribution = strings.ReplaceAll(sanitizedDistribution, "-", "_")
+
+ lbl := label.New(
+ currentCfg.renderPipRepository(distributionRepositoryName, sanitizedDistribution),
+ currentCfg.renderPipPackage(sanitizedDistribution),
+ currentCfg.renderPipTarget(sanitizedDistribution),
+ )
+ return lbl.String(), true
 	}
 	return "", false
 }
@@ -327,6 +357,37 @@ func (c *Config) SetTestNamingConvention(testNamingConvention string) {
 	c.testNamingConvention = testNamingConvention
 }
 
+// SetPipRepoNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipRepoNamingConvention(pipRepoNamingConvention string) {
+	c.pipRepoNamingConvention = pipRepoNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipRepository(distributionRepoName, distributionName string) string {
+	rendered := strings.ReplaceAll(c.pipRepoNamingConvention, repoNamePipRepoNamingConventionSubstitution, distributionRepoName)
+	return strings.ReplaceAll(rendered, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
+// SetPipPackageNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipPackageNamingConvention(pipPackageNamingConvention string) {
+	c.pipPackageNamingConvention = pipPackageNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipPackage(distributionName string) string {
+	return strings.ReplaceAll(c.pipPackageNamingConvention, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
+// SetPipTargetNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipTargetNamingConvention(pipTargetNamingConvention string) {
+	c.pipTargetNamingConvention = pipTargetNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipTarget(distributionName string) string {
+	return strings.ReplaceAll(c.pipTargetNamingConvention, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
 // RenderTestName returns the py_test target name by performing all
 // substitutions.
 func (c *Config) RenderTestName(packageName string) string {

gazelle/pythonconfig/pythonconfig_test.go

@@ -0,0 +1,19 @@
+package pythonconfig
+
+import (
+	"reflect"
+	"testing"
+)
+
+func TestConfigNewChild(t *testing.T) {
+	parent := New("foo", "bar")
+	child := parent.NewChild()
+
+	if child.parent == nil {
+ t.Error("child parent should not be nil")
+	}
+	child.parent = nil
+	if !reflect.DeepEqual(child, parent) {
+ t.Errorf("child and should should be equal other than the parent reference. Parent: %#v\nChild: %#v", parent, child)
+	}
+}

gazelle/pythonconfig/types.go

@@ -100,4 +100,4 @@ func (sml *StringMapList) Set(s string) error {
 func (sml *StringMapList) Get(key string) (string, bool) {
 	val, exists := sml.mapping[key]
 	return val, exists
-}
+}

gazelle/testdata/pip_repo_convention/BUILD.in

@@ -0,0 +1,3 @@
+# gazelle:python_pip_repo_naming_convention $repo_name$
+# gazelle:python_pip_package_naming_convention $distribution_name$
+# gazelle:python_pip_target_naming_convention $distribution_name$_pkg

gazelle/testdata/pip_repo_convention/BUILD.out

@@ -0,0 +1,31 @@
+load("@rules_python//python:defs.bzl", "py_binary", "py_library")
+
+# gazelle:python_pip_repo_naming_convention $repo_name$
+# gazelle:python_pip_package_naming_convention $distribution_name$
+# gazelle:python_pip_target_naming_convention $distribution_name$_pkg
+
+py_library(
+ name = "pip_repo_convention",
+ srcs = [
+ "__init__.py",
+ "bar.py",
+ "foo.py",
+ ],
+ visibility = ["//:__subpackages__"],
+ deps = [
+ "@pip_deps//baz:baz_pkg",
+ "@pip_deps//boto3:boto3_pkg",
+ "@pip_deps//djangorestframework:djangorestframework_pkg",
+ ],
+)
+
+py_binary(
+ name = "pip_repo_convention_bin",
+ srcs = ["__main__.py"],
+ main = "__main__.py",
+ visibility = ["//:__subpackages__"],
+ deps = [
+ ":pip_repo_convention",
+ "@pip_deps//baz:baz_pkg",
+ ],
+)

gazelle/testdata/pip_repo_convention/README.md

@@ -0,0 +1,3 @@
+# Pip repo convention
+
+This test case asserts that the dependency labels generated by gazelle follow a particular convention, that can be changed using directives.

gazelle/testdata/pip_repo_convention/WORKSPACE

@@ -0,0 +1 @@
+# This is a Bazel workspace for the Gazelle test data.

gazelle/testdata/pip_repo_convention/__init__.py

@@ -0,0 +1 @@
+# For test purposes only.

gazelle/testdata/pip_repo_convention/__main__.py

@@ -0,0 +1,5 @@
+import bar
+import foo
+
+_ = bar
+_ = foo

gazelle/testdata/pip_repo_convention/bar.py

@@ -0,0 +1,11 @@
+import os
+
+import bar
+import boto3
+import rest_framework
+
+_ = os
+
+_ = bar
+_ = boto3
+_ = rest_framework

gazelle/testdata/pip_repo_convention/foo.py

@@ -0,0 +1,11 @@
+import sys
+
+import boto3
+import foo
+import rest_framework
+
+_ = sys
+
+_ = boto3
+_ = foo
+_ = rest_framework

gazelle/testdata/pip_repo_convention/gazelle_python.yaml

@@ -0,0 +1,8 @@
+manifest:
+ modules_mapping:
+ boto3: boto3
+ rest_framework: djangorestframework
+ foo: baz
+ bar: baz
+ pip_repository:
+ name: pip_deps

gazelle/testdata/pip_repo_convention/test.yaml

@@ -0,0 +1 @@
+---

gazelle/README.md

@@ -147,6 +147,12 @@ Python-specific directives are as follows:
 | Controls the `py_test` naming convention. Follows the same interpolation rules as `python_library_naming_convention`. | |
 | `# gazelle:resolve py ...` | n/a |
 | Instructs the plugin what target to add as a dependency to satisfy a given import statement. The syntax is `# gazelle:resolve py import-string label` where `import-string` is the symbol in the python `import` statement, and `label` is the Bazel label that Gazelle should write in `deps`. | |
+| `# gazelle:python_pip_repo_naming_convention` | `$repo_name$_$distribution_name$` |
+| Controls the external dependency label naming convention. It interpolates `$repo_name$` and `$distribution_name$` with the Bazel external pip repository name and the sanitized Python package name respectively. E.g. if the Bazel external pip repository name is `my_pip_deps` and we are resolving external Python package named `flake-bugbear`, setting this to `$repo_name$_host_$distribution_name$` would result in a generated target named `my_pip_deps_host_flake8_bugbear`. | |
+| `# gazelle:python_pip_package_naming_convention` | n/a |
+| Controls the external dependency label naming convention. It interpolates `$distribution_name$` with the sanitized Python package name. See `gazelle:python_pip_repo_naming_convention` for details. This may be useful if you have `alias` targets which point to platform specific Python wheels in your repo, e.g. `//third_party/pip:flake8_bugbear_alias`. | |
+| `# gazelle:python_pip_target_naming_convention` | `pkg` |
+| Controls the external dependency label naming convention. It interpolates `$distribution_name$` with the sanitized Python package name respectively. See `gazelle:python_pip_repo_naming_convention` for details. This may be useful if you have `alias` targets which point to platform specific Python wheels in your repo, e.g. `//third_party/pip:flake8_bugbear_alias` or if you are using `gazelle` with `bzlmod`. | |
 
 ### Libraries
 

gazelle/configure.go

@@ -48,6 +48,9 @@ func (py *Configurer) KnownDirectives() []string {
  pythonconfig.LibraryNamingConvention,
  pythonconfig.BinaryNamingConvention,
  pythonconfig.TestNamingConvention,
+ pythonconfig.PipRepoNamingConvention,
+ pythonconfig.PipPackageNamingConvention,
+ pythonconfig.PipTargetNamingConvention,
 	}
 }
 
@@ -136,6 +139,12 @@ func (py *Configurer) Configure(c *config.Config, rel string, f *rule.File) {
  config.SetBinaryNamingConvention(strings.TrimSpace(d.Value))
  case pythonconfig.TestNamingConvention:
  config.SetTestNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipRepoNamingConvention:
+ config.SetPipRepoNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipPackageNamingConvention:
+ config.SetPipPackageNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipTargetNamingConvention:
+ config.SetPipTargetNamingConvention(strings.TrimSpace(d.Value))
  }
 	}
 

gazelle/pythonconfig/BUILD.bazel

@@ -1,4 +1,4 @@
-load("@io_bazel_rules_go//go:def.bzl", "go_library")
+load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
 
 go_library(
  name = "pythonconfig",
@@ -20,3 +20,9 @@ filegroup(
  srcs = glob(["**"]),
  visibility = ["//gazelle:__pkg__"],
 )
+
+go_test(
+ name = "pythonconfig_test",
+ srcs = ["pythonconfig_test.go"],
+ embed = [":pythonconfig"],
+)

gazelle/pythonconfig/pythonconfig.go

@@ -49,6 +49,17 @@ const (
 	// naming convention. See python_library_naming_convention for more info on
 	// the package name interpolation.
 	TestNamingConvention = "python_test_naming_convention"
+	// PipRepoNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. E.g. if the Python package name is `foo` and the
+	// pip repository is named `my_pip`, setting this
+	// to `$repo_name$_$distribution_name$` would render to `@my_pip_foo`.
+	PipRepoNamingConvention = "python_pip_repo_naming_convention"
+	// PipPackageNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. By default it is ``
+	PipPackageNamingConvention = "python_pip_package_naming_convention"
+	// PipTargetNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. By default it is `pkg`
+	PipTargetNamingConvention = "python_pip_target_naming_convention"
 )
 
 // GenerationModeType represents one of the generation modes for the Python
@@ -67,7 +78,9 @@ const (
 )
 
 const (
-	packageNameNamingConventionSubstitution = "$package_name$"
+	repoNamePipRepoNamingConventionSubstitution = "$repo_name$"
+	distributionNamePipRepoNamingConventionSubstitution = "$distribution_name$"
+	packageNameNamingConventionSubstitution = "$package_name$"
 )
 
 // defaultIgnoreFiles is the list of default values used in the
@@ -99,14 +112,17 @@ type Config struct {
 	pythonProjectRoot string
 	gazelleManifest *manifest.Manifest
 
-	excludedPatterns *singlylinkedlist.List
-	ignoreFiles map[string]struct{}
-	ignoreDependencies map[string]struct{}
-	validateImportStatements bool
-	coarseGrainedGeneration bool
-	libraryNamingConvention string
-	binaryNamingConvention string
-	testNamingConvention string
+	excludedPatterns *singlylinkedlist.List
+	ignoreFiles map[string]struct{}
+	ignoreDependencies map[string]struct{}
+	validateImportStatements bool
+	coarseGrainedGeneration bool
+	libraryNamingConvention string
+	binaryNamingConvention string
+	testNamingConvention string
+	pipRepoNamingConvention string
+	pipPackageNamingConvention string
+	pipTargetNamingConvention string
 }
 
 // New creates a new Config.
@@ -115,17 +131,20 @@ func New(
 	pythonProjectRoot string,
 ) *Config {
 	return &Config{
- extensionEnabled: true,
- repoRoot: repoRoot,
- pythonProjectRoot: pythonProjectRoot,
- excludedPatterns: singlylinkedlist.New(),
- ignoreFiles: make(map[string]struct{}),
- ignoreDependencies: make(map[string]struct{}),
- validateImportStatements: true,
- coarseGrainedGeneration: false,
- libraryNamingConvention: packageNameNamingConventionSubstitution,
- binaryNamingConvention: fmt.Sprintf("%s_bin", packageNameNamingConventionSubstitution),
- testNamingConvention: fmt.Sprintf("%s_test", packageNameNamingConventionSubstitution),
+ extensionEnabled: true,
+ repoRoot: repoRoot,
+ pythonProjectRoot: pythonProjectRoot,
+ excludedPatterns: singlylinkedlist.New(),
+ ignoreFiles: make(map[string]struct{}),
+ ignoreDependencies: make(map[string]struct{}),
+ validateImportStatements: true,
+ coarseGrainedGeneration: false,
+ libraryNamingConvention: packageNameNamingConventionSubstitution,
+ binaryNamingConvention: fmt.Sprintf("%s_bin", packageNameNamingConventionSubstitution),
+ testNamingConvention: fmt.Sprintf("%s_test", packageNameNamingConventionSubstitution),
+ pipRepoNamingConvention: fmt.Sprintf("%s_%s", repoNamePipRepoNamingConventionSubstitution, distributionNamePipRepoNamingConventionSubstitution),
+ pipPackageNamingConvention: "",
+ pipTargetNamingConvention: "pkg",
 	}
 }
 
@@ -150,6 +169,9 @@ func (c *Config) NewChild() *Config {
  libraryNamingConvention: c.libraryNamingConvention,
  binaryNamingConvention: c.binaryNamingConvention,
  testNamingConvention: c.testNamingConvention,
+ pipRepoNamingConvention: c.pipRepoNamingConvention,
+ pipPackageNamingConvention: c.pipPackageNamingConvention,
+ pipTargetNamingConvention: c.pipTargetNamingConvention,
 	}
 }
 
@@ -195,24 +217,32 @@ func (c *Config) SetGazelleManifest(gazelleManifest *manifest.Manifest) {
 // name.
 func (c *Config) FindThirdPartyDependency(modName string) (string, bool) {
 	for currentCfg := c; currentCfg != nil; currentCfg = currentCfg.parent {
- if currentCfg.gazelleManifest != nil {
- gazelleManifest := currentCfg.gazelleManifest
- if distributionName, ok := gazelleManifest.ModulesMapping[modName]; ok {
- var distributionRepositoryName string
- if gazelleManifest.PipDepsRepositoryName != "" {
- distributionRepositoryName = gazelleManifest.PipDepsRepositoryName
- } else if gazelleManifest.PipRepository != nil {
- distributionRepositoryName = gazelleManifest.PipRepository.Name
- }
- sanitizedDistribution := strings.ToLower(distributionName)
- sanitizedDistribution = strings.ReplaceAll(sanitizedDistribution, "-", "_")
- var lbl label.Label
- // @<repository_name>_<distribution_name>//:pkg
- distributionRepositoryName = distributionRepositoryName + "_" + sanitizedDistribution
- lbl = label.New(distributionRepositoryName, "", "pkg")
- return lbl.String(), true
- }
+
+ if currentCfg.gazelleManifest == nil {
+ continue
+ }
+
+ gazelleManifest := currentCfg.gazelleManifest
+ distributionName, ok := gazelleManifest.ModulesMapping[modName]
+ if !ok {
+ continue
  }
+
+ var distributionRepositoryName string
+ if gazelleManifest.PipDepsRepositoryName != "" {
+ distributionRepositoryName = gazelleManifest.PipDepsRepositoryName
+ } else if gazelleManifest.PipRepository != nil {
+ distributionRepositoryName = gazelleManifest.PipRepository.Name
+ }
+ sanitizedDistribution := strings.ToLower(distributionName)
+ sanitizedDistribution = strings.ReplaceAll(sanitizedDistribution, "-", "_")
+
+ lbl := label.New(
+ currentCfg.renderPipRepository(distributionRepositoryName, sanitizedDistribution),
+ currentCfg.renderPipPackage(sanitizedDistribution),
+ currentCfg.renderPipTarget(sanitizedDistribution),
+ )
+ return lbl.String(), true
 	}
 	return "", false
 }
@@ -327,6 +357,37 @@ func (c *Config) SetTestNamingConvention(testNamingConvention string) {
 	c.testNamingConvention = testNamingConvention
 }
 
+// SetPipRepoNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipRepoNamingConvention(pipRepoNamingConvention string) {
+	c.pipRepoNamingConvention = pipRepoNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipRepository(distributionRepoName, distributionName string) string {
+	rendered := strings.ReplaceAll(c.pipRepoNamingConvention, repoNamePipRepoNamingConventionSubstitution, distributionRepoName)
+	return strings.ReplaceAll(rendered, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
+// SetPipPackageNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipPackageNamingConvention(pipPackageNamingConvention string) {
+	c.pipPackageNamingConvention = pipPackageNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipPackage(distributionName string) string {
+	return strings.ReplaceAll(c.pipPackageNamingConvention, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
+// SetPipTargetNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipTargetNamingConvention(pipTargetNamingConvention string) {
+	c.pipTargetNamingConvention = pipTargetNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipTarget(distributionName string) string {
+	return strings.ReplaceAll(c.pipTargetNamingConvention, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
 // RenderTestName returns the py_test target name by performing all
 // substitutions.
 func (c *Config) RenderTestName(packageName string) string {

gazelle/pythonconfig/pythonconfig_test.go

@@ -0,0 +1,19 @@
+package pythonconfig
+
+import (
+	"reflect"
+	"testing"
+)
+
+func TestConfigNewChild(t *testing.T) {
+	parent := New("foo", "bar")
+	child := parent.NewChild()
+
+	if child.parent == nil {
+ t.Error("child parent should not be nil")
+	}
+	child.parent = nil
+	if !reflect.DeepEqual(child, parent) {
+ t.Errorf("child and should should be equal other than the parent reference. Parent: %#v\nChild: %#v", parent, child)
+	}
+}

gazelle/pythonconfig/types.go

@@ -100,4 +100,4 @@ func (sml *StringMapList) Set(s string) error {
 func (sml *StringMapList) Get(key string) (string, bool) {
 	val, exists := sml.mapping[key]
 	return val, exists
-}
+}

gazelle/testdata/pip_repo_convention/BUILD.in

@@ -0,0 +1,3 @@
+# gazelle:python_pip_repo_naming_convention $repo_name$
+# gazelle:python_pip_package_naming_convention $distribution_name$
+# gazelle:python_pip_target_naming_convention $distribution_name$_pkg

gazelle/testdata/pip_repo_convention/BUILD.out

@@ -0,0 +1,31 @@
+load("@rules_python//python:defs.bzl", "py_binary", "py_library")
+
+# gazelle:python_pip_repo_naming_convention $repo_name$
+# gazelle:python_pip_package_naming_convention $distribution_name$
+# gazelle:python_pip_target_naming_convention $distribution_name$_pkg
+
+py_library(
+ name = "pip_repo_convention",
+ srcs = [
+ "__init__.py",
+ "bar.py",
+ "foo.py",
+ ],
+ visibility = ["//:__subpackages__"],
+ deps = [
+ "@pip_deps//baz:baz_pkg",
+ "@pip_deps//boto3:boto3_pkg",
+ "@pip_deps//djangorestframework:djangorestframework_pkg",
+ ],
+)
+
+py_binary(
+ name = "pip_repo_convention_bin",
+ srcs = ["__main__.py"],
+ main = "__main__.py",
+ visibility = ["//:__subpackages__"],
+ deps = [
+ ":pip_repo_convention",
+ "@pip_deps//baz:baz_pkg",
+ ],
+)

gazelle/testdata/pip_repo_convention/README.md

@@ -0,0 +1,3 @@
+# Pip repo convention
+
+This test case asserts that the dependency labels generated by gazelle follow a particular convention, that can be changed using directives.

gazelle/testdata/pip_repo_convention/WORKSPACE

@@ -0,0 +1 @@
+# This is a Bazel workspace for the Gazelle test data.

gazelle/testdata/pip_repo_convention/__init__.py

@@ -0,0 +1 @@
+# For test purposes only.

gazelle/testdata/pip_repo_convention/__main__.py

@@ -0,0 +1,5 @@
+import bar
+import foo
+
+_ = bar
+_ = foo

gazelle/testdata/pip_repo_convention/bar.py

@@ -0,0 +1,11 @@
+import os
+
+import bar
+import boto3
+import rest_framework
+
+_ = os
+
+_ = bar
+_ = boto3
+_ = rest_framework

gazelle/testdata/pip_repo_convention/foo.py

@@ -0,0 +1,11 @@
+import sys
+
+import boto3
+import foo
+import rest_framework
+
+_ = sys
+
+_ = boto3
+_ = foo
+_ = rest_framework

gazelle/testdata/pip_repo_convention/gazelle_python.yaml

@@ -0,0 +1,8 @@
+manifest:
+ modules_mapping:
+ boto3: boto3
+ rest_framework: djangorestframework
+ foo: baz
+ bar: baz
+ pip_repository:
+ name: pip_deps

gazelle/testdata/pip_repo_convention/test.yaml

@@ -0,0 +1 @@
+---

gazelle/README.md

@@ -147,6 +147,12 @@ Python-specific directives are as follows:
 | Controls the `py_test` naming convention. Follows the same interpolation rules as `python_library_naming_convention`. | |
 | `# gazelle:resolve py ...` | n/a |
 | Instructs the plugin what target to add as a dependency to satisfy a given import statement. The syntax is `# gazelle:resolve py import-string label` where `import-string` is the symbol in the python `import` statement, and `label` is the Bazel label that Gazelle should write in `deps`. | |
+| `# gazelle:python_pip_repo_naming_convention` | `$repo_name$_$distribution_name$` |
+| Controls the external dependency label naming convention. It interpolates `$repo_name$` and `$distribution_name$` with the Bazel external pip repository name and the sanitized Python package name respectively. E.g. if the Bazel external pip repository name is `my_pip_deps` and we are resolving external Python package named `flake-bugbear`, setting this to `$repo_name$_host_$distribution_name$` would result in a generated target named `my_pip_deps_host_flake8_bugbear`. | |
+| `# gazelle:python_pip_package_naming_convention` | n/a |
+| Controls the external dependency label naming convention. It interpolates `$distribution_name$` with the sanitized Python package name. See `gazelle:python_pip_repo_naming_convention` for details. This may be useful if you have `alias` targets which point to platform specific Python wheels in your repo, e.g. `//third_party/pip:flake8_bugbear_alias`. | |
+| `# gazelle:python_pip_target_naming_convention` | `pkg` |
+| Controls the external dependency label naming convention. It interpolates `$distribution_name$` with the sanitized Python package name respectively. See `gazelle:python_pip_repo_naming_convention` for details. This may be useful if you have `alias` targets which point to platform specific Python wheels in your repo, e.g. `//third_party/pip:flake8_bugbear_alias` or if you are using `gazelle` with `bzlmod`. | |
 
 ### Libraries
 

gazelle/configure.go

@@ -48,6 +48,9 @@ func (py *Configurer) KnownDirectives() []string {
  pythonconfig.LibraryNamingConvention,
  pythonconfig.BinaryNamingConvention,
  pythonconfig.TestNamingConvention,
+ pythonconfig.PipRepoNamingConvention,
+ pythonconfig.PipPackageNamingConvention,
+ pythonconfig.PipTargetNamingConvention,
 	}
 }
 
@@ -136,6 +139,12 @@ func (py *Configurer) Configure(c *config.Config, rel string, f *rule.File) {
  config.SetBinaryNamingConvention(strings.TrimSpace(d.Value))
  case pythonconfig.TestNamingConvention:
  config.SetTestNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipRepoNamingConvention:
+ config.SetPipRepoNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipPackageNamingConvention:
+ config.SetPipPackageNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipTargetNamingConvention:
+ config.SetPipTargetNamingConvention(strings.TrimSpace(d.Value))
  }
 	}
 

gazelle/pythonconfig/BUILD.bazel

@@ -1,4 +1,4 @@
-load("@io_bazel_rules_go//go:def.bzl", "go_library")
+load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
 
 go_library(
  name = "pythonconfig",
@@ -20,3 +20,9 @@ filegroup(
  srcs = glob(["**"]),
  visibility = ["//gazelle:__pkg__"],
 )
+
+go_test(
+ name = "pythonconfig_test",
+ srcs = ["pythonconfig_test.go"],
+ embed = [":pythonconfig"],
+)

gazelle/pythonconfig/pythonconfig.go

@@ -49,6 +49,17 @@ const (
 	// naming convention. See python_library_naming_convention for more info on
 	// the package name interpolation.
 	TestNamingConvention = "python_test_naming_convention"
+	// PipRepoNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. E.g. if the Python package name is `foo` and the
+	// pip repository is named `my_pip`, setting this
+	// to `$repo_name$_$distribution_name$` would render to `@my_pip_foo`.
+	PipRepoNamingConvention = "python_pip_repo_naming_convention"
+	// PipPackageNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. By default it is ``
+	PipPackageNamingConvention = "python_pip_package_naming_convention"
+	// PipTargetNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. By default it is `pkg`
+	PipTargetNamingConvention = "python_pip_target_naming_convention"
 )
 
 // GenerationModeType represents one of the generation modes for the Python
@@ -67,7 +78,9 @@ const (
 )
 
 const (
-	packageNameNamingConventionSubstitution = "$package_name$"
+	repoNamePipRepoNamingConventionSubstitution = "$repo_name$"
+	distributionNamePipRepoNamingConventionSubstitution = "$distribution_name$"
+	packageNameNamingConventionSubstitution = "$package_name$"
 )
 
 // defaultIgnoreFiles is the list of default values used in the
@@ -99,14 +112,17 @@ type Config struct {
 	pythonProjectRoot string
 	gazelleManifest *manifest.Manifest
 
-	excludedPatterns *singlylinkedlist.List
-	ignoreFiles map[string]struct{}
-	ignoreDependencies map[string]struct{}
-	validateImportStatements bool
-	coarseGrainedGeneration bool
-	libraryNamingConvention string
-	binaryNamingConvention string
-	testNamingConvention string
+	excludedPatterns *singlylinkedlist.List
+	ignoreFiles map[string]struct{}
+	ignoreDependencies map[string]struct{}
+	validateImportStatements bool
+	coarseGrainedGeneration bool
+	libraryNamingConvention string
+	binaryNamingConvention string
+	testNamingConvention string
+	pipRepoNamingConvention string
+	pipPackageNamingConvention string
+	pipTargetNamingConvention string
 }
 
 // New creates a new Config.
@@ -115,17 +131,20 @@ func New(
 	pythonProjectRoot string,
 ) *Config {
 	return &Config{
- extensionEnabled: true,
- repoRoot: repoRoot,
- pythonProjectRoot: pythonProjectRoot,
- excludedPatterns: singlylinkedlist.New(),
- ignoreFiles: make(map[string]struct{}),
- ignoreDependencies: make(map[string]struct{}),
- validateImportStatements: true,
- coarseGrainedGeneration: false,
- libraryNamingConvention: packageNameNamingConventionSubstitution,
- binaryNamingConvention: fmt.Sprintf("%s_bin", packageNameNamingConventionSubstitution),
- testNamingConvention: fmt.Sprintf("%s_test", packageNameNamingConventionSubstitution),
+ extensionEnabled: true,
+ repoRoot: repoRoot,
+ pythonProjectRoot: pythonProjectRoot,
+ excludedPatterns: singlylinkedlist.New(),
+ ignoreFiles: make(map[string]struct{}),
+ ignoreDependencies: make(map[string]struct{}),
+ validateImportStatements: true,
+ coarseGrainedGeneration: false,
+ libraryNamingConvention: packageNameNamingConventionSubstitution,
+ binaryNamingConvention: fmt.Sprintf("%s_bin", packageNameNamingConventionSubstitution),
+ testNamingConvention: fmt.Sprintf("%s_test", packageNameNamingConventionSubstitution),
+ pipRepoNamingConvention: fmt.Sprintf("%s_%s", repoNamePipRepoNamingConventionSubstitution, distributionNamePipRepoNamingConventionSubstitution),
+ pipPackageNamingConvention: "",
+ pipTargetNamingConvention: "pkg",
 	}
 }
 
@@ -150,6 +169,9 @@ func (c *Config) NewChild() *Config {
  libraryNamingConvention: c.libraryNamingConvention,
  binaryNamingConvention: c.binaryNamingConvention,
  testNamingConvention: c.testNamingConvention,
+ pipRepoNamingConvention: c.pipRepoNamingConvention,
+ pipPackageNamingConvention: c.pipPackageNamingConvention,
+ pipTargetNamingConvention: c.pipTargetNamingConvention,
 	}
 }
 
@@ -195,24 +217,32 @@ func (c *Config) SetGazelleManifest(gazelleManifest *manifest.Manifest) {
 // name.
 func (c *Config) FindThirdPartyDependency(modName string) (string, bool) {
 	for currentCfg := c; currentCfg != nil; currentCfg = currentCfg.parent {
- if currentCfg.gazelleManifest != nil {
- gazelleManifest := currentCfg.gazelleManifest
- if distributionName, ok := gazelleManifest.ModulesMapping[modName]; ok {
- var distributionRepositoryName string
- if gazelleManifest.PipDepsRepositoryName != "" {
- distributionRepositoryName = gazelleManifest.PipDepsRepositoryName
- } else if gazelleManifest.PipRepository != nil {
- distributionRepositoryName = gazelleManifest.PipRepository.Name
- }
- sanitizedDistribution := strings.ToLower(distributionName)
- sanitizedDistribution = strings.ReplaceAll(sanitizedDistribution, "-", "_")
- var lbl label.Label
- // @<repository_name>_<distribution_name>//:pkg
- distributionRepositoryName = distributionRepositoryName + "_" + sanitizedDistribution
- lbl = label.New(distributionRepositoryName, "", "pkg")
- return lbl.String(), true
- }
+
+ if currentCfg.gazelleManifest == nil {
+ continue
+ }
+
+ gazelleManifest := currentCfg.gazelleManifest
+ distributionName, ok := gazelleManifest.ModulesMapping[modName]
+ if !ok {
+ continue
  }
+
+ var distributionRepositoryName string
+ if gazelleManifest.PipDepsRepositoryName != "" {
+ distributionRepositoryName = gazelleManifest.PipDepsRepositoryName
+ } else if gazelleManifest.PipRepository != nil {
+ distributionRepositoryName = gazelleManifest.PipRepository.Name
+ }
+ sanitizedDistribution := strings.ToLower(distributionName)
+ sanitizedDistribution = strings.ReplaceAll(sanitizedDistribution, "-", "_")
+
+ lbl := label.New(
+ currentCfg.renderPipRepository(distributionRepositoryName, sanitizedDistribution),
+ currentCfg.renderPipPackage(sanitizedDistribution),
+ currentCfg.renderPipTarget(sanitizedDistribution),
+ )
+ return lbl.String(), true
 	}
 	return "", false
 }
@@ -327,6 +357,37 @@ func (c *Config) SetTestNamingConvention(testNamingConvention string) {
 	c.testNamingConvention = testNamingConvention
 }
 
+// SetPipRepoNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipRepoNamingConvention(pipRepoNamingConvention string) {
+	c.pipRepoNamingConvention = pipRepoNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipRepository(distributionRepoName, distributionName string) string {
+	rendered := strings.ReplaceAll(c.pipRepoNamingConvention, repoNamePipRepoNamingConventionSubstitution, distributionRepoName)
+	return strings.ReplaceAll(rendered, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
+// SetPipPackageNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipPackageNamingConvention(pipPackageNamingConvention string) {
+	c.pipPackageNamingConvention = pipPackageNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipPackage(distributionName string) string {
+	return strings.ReplaceAll(c.pipPackageNamingConvention, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
+// SetPipTargetNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipTargetNamingConvention(pipTargetNamingConvention string) {
+	c.pipTargetNamingConvention = pipTargetNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipTarget(distributionName string) string {
+	return strings.ReplaceAll(c.pipTargetNamingConvention, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
 // RenderTestName returns the py_test target name by performing all
 // substitutions.
 func (c *Config) RenderTestName(packageName string) string {

gazelle/pythonconfig/pythonconfig_test.go

@@ -0,0 +1,19 @@
+package pythonconfig
+
+import (
+	"reflect"
+	"testing"
+)
+
+func TestConfigNewChild(t *testing.T) {
+	parent := New("foo", "bar")
+	child := parent.NewChild()
+
+	if child.parent == nil {
+ t.Error("child parent should not be nil")
+	}
+	child.parent = nil
+	if !reflect.DeepEqual(child, parent) {
+ t.Errorf("child and should should be equal other than the parent reference. Parent: %#v\nChild: %#v", parent, child)
+	}
+}

gazelle/pythonconfig/types.go

@@ -100,4 +100,4 @@ func (sml *StringMapList) Set(s string) error {
 func (sml *StringMapList) Get(key string) (string, bool) {
 	val, exists := sml.mapping[key]
 	return val, exists
-}
+}

gazelle/testdata/pip_repo_convention/BUILD.in

@@ -0,0 +1,3 @@
+# gazelle:python_pip_repo_naming_convention $repo_name$
+# gazelle:python_pip_package_naming_convention $distribution_name$
+# gazelle:python_pip_target_naming_convention $distribution_name$_pkg

gazelle/testdata/pip_repo_convention/BUILD.out

@@ -0,0 +1,31 @@
+load("@rules_python//python:defs.bzl", "py_binary", "py_library")
+
+# gazelle:python_pip_repo_naming_convention $repo_name$
+# gazelle:python_pip_package_naming_convention $distribution_name$
+# gazelle:python_pip_target_naming_convention $distribution_name$_pkg
+
+py_library(
+ name = "pip_repo_convention",
+ srcs = [
+ "__init__.py",
+ "bar.py",
+ "foo.py",
+ ],
+ visibility = ["//:__subpackages__"],
+ deps = [
+ "@pip_deps//baz:baz_pkg",
+ "@pip_deps//boto3:boto3_pkg",
+ "@pip_deps//djangorestframework:djangorestframework_pkg",
+ ],
+)
+
+py_binary(
+ name = "pip_repo_convention_bin",
+ srcs = ["__main__.py"],
+ main = "__main__.py",
+ visibility = ["//:__subpackages__"],
+ deps = [
+ ":pip_repo_convention",
+ "@pip_deps//baz:baz_pkg",
+ ],
+)

gazelle/testdata/pip_repo_convention/README.md

@@ -0,0 +1,3 @@
+# Pip repo convention
+
+This test case asserts that the dependency labels generated by gazelle follow a particular convention, that can be changed using directives.

gazelle/testdata/pip_repo_convention/WORKSPACE

@@ -0,0 +1 @@
+# This is a Bazel workspace for the Gazelle test data.

gazelle/testdata/pip_repo_convention/__init__.py

@@ -0,0 +1 @@
+# For test purposes only.

gazelle/testdata/pip_repo_convention/__main__.py

@@ -0,0 +1,5 @@
+import bar
+import foo
+
+_ = bar
+_ = foo

gazelle/testdata/pip_repo_convention/bar.py

@@ -0,0 +1,11 @@
+import os
+
+import bar
+import boto3
+import rest_framework
+
+_ = os
+
+_ = bar
+_ = boto3
+_ = rest_framework

gazelle/testdata/pip_repo_convention/foo.py

@@ -0,0 +1,11 @@
+import sys
+
+import boto3
+import foo
+import rest_framework
+
+_ = sys
+
+_ = boto3
+_ = foo
+_ = rest_framework

gazelle/testdata/pip_repo_convention/gazelle_python.yaml

@@ -0,0 +1,8 @@
+manifest:
+ modules_mapping:
+ boto3: boto3
+ rest_framework: djangorestframework
+ foo: baz
+ bar: baz
+ pip_repository:
+ name: pip_deps

gazelle/testdata/pip_repo_convention/test.yaml

@@ -0,0 +1 @@
+---

gazelle/README.md

@@ -147,6 +147,12 @@ Python-specific directives are as follows:
 | Controls the `py_test` naming convention. Follows the same interpolation rules as `python_library_naming_convention`. | |
 | `# gazelle:resolve py ...` | n/a |
 | Instructs the plugin what target to add as a dependency to satisfy a given import statement. The syntax is `# gazelle:resolve py import-string label` where `import-string` is the symbol in the python `import` statement, and `label` is the Bazel label that Gazelle should write in `deps`. | |
+| `# gazelle:python_pip_repo_naming_convention` | `$repo_name$_$distribution_name$` |
+| Controls the external dependency label naming convention. It interpolates `$repo_name$` and `$distribution_name$` with the Bazel external pip repository name and the sanitized Python package name respectively. E.g. if the Bazel external pip repository name is `my_pip_deps` and we are resolving external Python package named `flake-bugbear`, setting this to `$repo_name$_host_$distribution_name$` would result in a generated target named `my_pip_deps_host_flake8_bugbear`. | |
+| `# gazelle:python_pip_package_naming_convention` | n/a |
+| Controls the external dependency label naming convention. It interpolates `$distribution_name$` with the sanitized Python package name. See `gazelle:python_pip_repo_naming_convention` for details. This may be useful if you have `alias` targets which point to platform specific Python wheels in your repo, e.g. `//third_party/pip:flake8_bugbear_alias`. | |
+| `# gazelle:python_pip_target_naming_convention` | `pkg` |
+| Controls the external dependency label naming convention. It interpolates `$distribution_name$` with the sanitized Python package name respectively. See `gazelle:python_pip_repo_naming_convention` for details. This may be useful if you have `alias` targets which point to platform specific Python wheels in your repo, e.g. `//third_party/pip:flake8_bugbear_alias` or if you are using `gazelle` with `bzlmod`. | |
 
 ### Libraries
 

gazelle/configure.go

@@ -48,6 +48,9 @@ func (py *Configurer) KnownDirectives() []string {
  pythonconfig.LibraryNamingConvention,
  pythonconfig.BinaryNamingConvention,
  pythonconfig.TestNamingConvention,
+ pythonconfig.PipRepoNamingConvention,
+ pythonconfig.PipPackageNamingConvention,
+ pythonconfig.PipTargetNamingConvention,
 	}
 }
 
@@ -136,6 +139,12 @@ func (py *Configurer) Configure(c *config.Config, rel string, f *rule.File) {
  config.SetBinaryNamingConvention(strings.TrimSpace(d.Value))
  case pythonconfig.TestNamingConvention:
  config.SetTestNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipRepoNamingConvention:
+ config.SetPipRepoNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipPackageNamingConvention:
+ config.SetPipPackageNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipTargetNamingConvention:
+ config.SetPipTargetNamingConvention(strings.TrimSpace(d.Value))
  }
 	}
 

gazelle/pythonconfig/BUILD.bazel

@@ -1,4 +1,4 @@
-load("@io_bazel_rules_go//go:def.bzl", "go_library")
+load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
 
 go_library(
  name = "pythonconfig",
@@ -20,3 +20,9 @@ filegroup(
  srcs = glob(["**"]),
  visibility = ["//gazelle:__pkg__"],
 )
+
+go_test(
+ name = "pythonconfig_test",
+ srcs = ["pythonconfig_test.go"],
+ embed = [":pythonconfig"],
+)

gazelle/pythonconfig/pythonconfig.go

@@ -49,6 +49,17 @@ const (
 	// naming convention. See python_library_naming_convention for more info on
 	// the package name interpolation.
 	TestNamingConvention = "python_test_naming_convention"
+	// PipRepoNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. E.g. if the Python package name is `foo` and the
+	// pip repository is named `my_pip`, setting this
+	// to `$repo_name$_$distribution_name$` would render to `@my_pip_foo`.
+	PipRepoNamingConvention = "python_pip_repo_naming_convention"
+	// PipPackageNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. By default it is ``
+	PipPackageNamingConvention = "python_pip_package_naming_convention"
+	// PipTargetNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. By default it is `pkg`
+	PipTargetNamingConvention = "python_pip_target_naming_convention"
 )
 
 // GenerationModeType represents one of the generation modes for the Python
@@ -67,7 +78,9 @@ const (
 )
 
 const (
-	packageNameNamingConventionSubstitution = "$package_name$"
+	repoNamePipRepoNamingConventionSubstitution = "$repo_name$"
+	distributionNamePipRepoNamingConventionSubstitution = "$distribution_name$"
+	packageNameNamingConventionSubstitution = "$package_name$"
 )
 
 // defaultIgnoreFiles is the list of default values used in the
@@ -99,14 +112,17 @@ type Config struct {
 	pythonProjectRoot string
 	gazelleManifest *manifest.Manifest
 
-	excludedPatterns *singlylinkedlist.List
-	ignoreFiles map[string]struct{}
-	ignoreDependencies map[string]struct{}
-	validateImportStatements bool
-	coarseGrainedGeneration bool
-	libraryNamingConvention string
-	binaryNamingConvention string
-	testNamingConvention string
+	excludedPatterns *singlylinkedlist.List
+	ignoreFiles map[string]struct{}
+	ignoreDependencies map[string]struct{}
+	validateImportStatements bool
+	coarseGrainedGeneration bool
+	libraryNamingConvention string
+	binaryNamingConvention string
+	testNamingConvention string
+	pipRepoNamingConvention string
+	pipPackageNamingConvention string
+	pipTargetNamingConvention string
 }
 
 // New creates a new Config.
@@ -115,17 +131,20 @@ func New(
 	pythonProjectRoot string,
 ) *Config {
 	return &Config{
- extensionEnabled: true,
- repoRoot: repoRoot,
- pythonProjectRoot: pythonProjectRoot,
- excludedPatterns: singlylinkedlist.New(),
- ignoreFiles: make(map[string]struct{}),
- ignoreDependencies: make(map[string]struct{}),
- validateImportStatements: true,
- coarseGrainedGeneration: false,
- libraryNamingConvention: packageNameNamingConventionSubstitution,
- binaryNamingConvention: fmt.Sprintf("%s_bin", packageNameNamingConventionSubstitution),
- testNamingConvention: fmt.Sprintf("%s_test", packageNameNamingConventionSubstitution),
+ extensionEnabled: true,
+ repoRoot: repoRoot,
+ pythonProjectRoot: pythonProjectRoot,
+ excludedPatterns: singlylinkedlist.New(),
+ ignoreFiles: make(map[string]struct{}),
+ ignoreDependencies: make(map[string]struct{}),
+ validateImportStatements: true,
+ coarseGrainedGeneration: false,
+ libraryNamingConvention: packageNameNamingConventionSubstitution,
+ binaryNamingConvention: fmt.Sprintf("%s_bin", packageNameNamingConventionSubstitution),
+ testNamingConvention: fmt.Sprintf("%s_test", packageNameNamingConventionSubstitution),
+ pipRepoNamingConvention: fmt.Sprintf("%s_%s", repoNamePipRepoNamingConventionSubstitution, distributionNamePipRepoNamingConventionSubstitution),
+ pipPackageNamingConvention: "",
+ pipTargetNamingConvention: "pkg",
 	}
 }
 
@@ -150,6 +169,9 @@ func (c *Config) NewChild() *Config {
  libraryNamingConvention: c.libraryNamingConvention,
  binaryNamingConvention: c.binaryNamingConvention,
  testNamingConvention: c.testNamingConvention,
+ pipRepoNamingConvention: c.pipRepoNamingConvention,
+ pipPackageNamingConvention: c.pipPackageNamingConvention,
+ pipTargetNamingConvention: c.pipTargetNamingConvention,
 	}
 }
 
@@ -195,24 +217,32 @@ func (c *Config) SetGazelleManifest(gazelleManifest *manifest.Manifest) {
 // name.
 func (c *Config) FindThirdPartyDependency(modName string) (string, bool) {
 	for currentCfg := c; currentCfg != nil; currentCfg = currentCfg.parent {
- if currentCfg.gazelleManifest != nil {
- gazelleManifest := currentCfg.gazelleManifest
- if distributionName, ok := gazelleManifest.ModulesMapping[modName]; ok {
- var distributionRepositoryName string
- if gazelleManifest.PipDepsRepositoryName != "" {
- distributionRepositoryName = gazelleManifest.PipDepsRepositoryName
- } else if gazelleManifest.PipRepository != nil {
- distributionRepositoryName = gazelleManifest.PipRepository.Name
- }
- sanitizedDistribution := strings.ToLower(distributionName)
- sanitizedDistribution = strings.ReplaceAll(sanitizedDistribution, "-", "_")
- var lbl label.Label
- // @<repository_name>_<distribution_name>//:pkg
- distributionRepositoryName = distributionRepositoryName + "_" + sanitizedDistribution
- lbl = label.New(distributionRepositoryName, "", "pkg")
- return lbl.String(), true
- }
+
+ if currentCfg.gazelleManifest == nil {
+ continue
+ }
+
+ gazelleManifest := currentCfg.gazelleManifest
+ distributionName, ok := gazelleManifest.ModulesMapping[modName]
+ if !ok {
+ continue
  }
+
+ var distributionRepositoryName string
+ if gazelleManifest.PipDepsRepositoryName != "" {
+ distributionRepositoryName = gazelleManifest.PipDepsRepositoryName
+ } else if gazelleManifest.PipRepository != nil {
+ distributionRepositoryName = gazelleManifest.PipRepository.Name
+ }
+ sanitizedDistribution := strings.ToLower(distributionName)
+ sanitizedDistribution = strings.ReplaceAll(sanitizedDistribution, "-", "_")
+
+ lbl := label.New(
+ currentCfg.renderPipRepository(distributionRepositoryName, sanitizedDistribution),
+ currentCfg.renderPipPackage(sanitizedDistribution),
+ currentCfg.renderPipTarget(sanitizedDistribution),
+ )
+ return lbl.String(), true
 	}
 	return "", false
 }
@@ -327,6 +357,37 @@ func (c *Config) SetTestNamingConvention(testNamingConvention string) {
 	c.testNamingConvention = testNamingConvention
 }
 
+// SetPipRepoNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipRepoNamingConvention(pipRepoNamingConvention string) {
+	c.pipRepoNamingConvention = pipRepoNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipRepository(distributionRepoName, distributionName string) string {
+	rendered := strings.ReplaceAll(c.pipRepoNamingConvention, repoNamePipRepoNamingConventionSubstitution, distributionRepoName)
+	return strings.ReplaceAll(rendered, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
+// SetPipPackageNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipPackageNamingConvention(pipPackageNamingConvention string) {
+	c.pipPackageNamingConvention = pipPackageNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipPackage(distributionName string) string {
+	return strings.ReplaceAll(c.pipPackageNamingConvention, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
+// SetPipTargetNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipTargetNamingConvention(pipTargetNamingConvention string) {
+	c.pipTargetNamingConvention = pipTargetNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipTarget(distributionName string) string {
+	return strings.ReplaceAll(c.pipTargetNamingConvention, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
 // RenderTestName returns the py_test target name by performing all
 // substitutions.
 func (c *Config) RenderTestName(packageName string) string {

gazelle/pythonconfig/pythonconfig_test.go

@@ -0,0 +1,19 @@
+package pythonconfig
+
+import (
+	"reflect"
+	"testing"
+)
+
+func TestConfigNewChild(t *testing.T) {
+	parent := New("foo", "bar")
+	child := parent.NewChild()
+
+	if child.parent == nil {
+ t.Error("child parent should not be nil")
+	}
+	child.parent = nil
+	if !reflect.DeepEqual(child, parent) {
+ t.Errorf("child and should should be equal other than the parent reference. Parent: %#v\nChild: %#v", parent, child)
+	}
+}

gazelle/pythonconfig/types.go

@@ -100,4 +100,4 @@ func (sml *StringMapList) Set(s string) error {
 func (sml *StringMapList) Get(key string) (string, bool) {
 	val, exists := sml.mapping[key]
 	return val, exists
-}
+}

gazelle/testdata/pip_repo_convention/BUILD.in

@@ -0,0 +1,3 @@
+# gazelle:python_pip_repo_naming_convention $repo_name$
+# gazelle:python_pip_package_naming_convention $distribution_name$
+# gazelle:python_pip_target_naming_convention $distribution_name$_pkg

gazelle/testdata/pip_repo_convention/BUILD.out

@@ -0,0 +1,31 @@
+load("@rules_python//python:defs.bzl", "py_binary", "py_library")
+
+# gazelle:python_pip_repo_naming_convention $repo_name$
+# gazelle:python_pip_package_naming_convention $distribution_name$
+# gazelle:python_pip_target_naming_convention $distribution_name$_pkg
+
+py_library(
+ name = "pip_repo_convention",
+ srcs = [
+ "__init__.py",
+ "bar.py",
+ "foo.py",
+ ],
+ visibility = ["//:__subpackages__"],
+ deps = [
+ "@pip_deps//baz:baz_pkg",
+ "@pip_deps//boto3:boto3_pkg",
+ "@pip_deps//djangorestframework:djangorestframework_pkg",
+ ],
+)
+
+py_binary(
+ name = "pip_repo_convention_bin",
+ srcs = ["__main__.py"],
+ main = "__main__.py",
+ visibility = ["//:__subpackages__"],
+ deps = [
+ ":pip_repo_convention",
+ "@pip_deps//baz:baz_pkg",
+ ],
+)

gazelle/testdata/pip_repo_convention/README.md

@@ -0,0 +1,3 @@
+# Pip repo convention
+
+This test case asserts that the dependency labels generated by gazelle follow a particular convention, that can be changed using directives.

gazelle/testdata/pip_repo_convention/WORKSPACE

@@ -0,0 +1 @@
+# This is a Bazel workspace for the Gazelle test data.

gazelle/testdata/pip_repo_convention/__init__.py

@@ -0,0 +1 @@
+# For test purposes only.

gazelle/testdata/pip_repo_convention/__main__.py

@@ -0,0 +1,5 @@
+import bar
+import foo
+
+_ = bar
+_ = foo

gazelle/testdata/pip_repo_convention/bar.py

@@ -0,0 +1,11 @@
+import os
+
+import bar
+import boto3
+import rest_framework
+
+_ = os
+
+_ = bar
+_ = boto3
+_ = rest_framework

gazelle/testdata/pip_repo_convention/foo.py

@@ -0,0 +1,11 @@
+import sys
+
+import boto3
+import foo
+import rest_framework
+
+_ = sys
+
+_ = boto3
+_ = foo
+_ = rest_framework

gazelle/testdata/pip_repo_convention/gazelle_python.yaml

@@ -0,0 +1,8 @@
+manifest:
+ modules_mapping:
+ boto3: boto3
+ rest_framework: djangorestframework
+ foo: baz
+ bar: baz
+ pip_repository:
+ name: pip_deps

gazelle/testdata/pip_repo_convention/test.yaml

@@ -0,0 +1 @@
+---

gazelle/README.md

@@ -147,6 +147,12 @@ Python-specific directives are as follows:
 | Controls the `py_test` naming convention. Follows the same interpolation rules as `python_library_naming_convention`. | |
 | `# gazelle:resolve py ...` | n/a |
 | Instructs the plugin what target to add as a dependency to satisfy a given import statement. The syntax is `# gazelle:resolve py import-string label` where `import-string` is the symbol in the python `import` statement, and `label` is the Bazel label that Gazelle should write in `deps`. | |
+| `# gazelle:python_pip_repo_naming_convention` | `$repo_name$_$distribution_name$` |
+| Controls the external dependency label naming convention. It interpolates `$repo_name$` and `$distribution_name$` with the Bazel external pip repository name and the sanitized Python package name respectively. E.g. if the Bazel external pip repository name is `my_pip_deps` and we are resolving external Python package named `flake-bugbear`, setting this to `$repo_name$_host_$distribution_name$` would result in a generated target named `my_pip_deps_host_flake8_bugbear`. | |
+| `# gazelle:python_pip_package_naming_convention` | n/a |
+| Controls the external dependency label naming convention. It interpolates `$distribution_name$` with the sanitized Python package name. See `gazelle:python_pip_repo_naming_convention` for details. This may be useful if you have `alias` targets which point to platform specific Python wheels in your repo, e.g. `//third_party/pip:flake8_bugbear_alias`. | |
+| `# gazelle:python_pip_target_naming_convention` | `pkg` |
+| Controls the external dependency label naming convention. It interpolates `$distribution_name$` with the sanitized Python package name respectively. See `gazelle:python_pip_repo_naming_convention` for details. This may be useful if you have `alias` targets which point to platform specific Python wheels in your repo, e.g. `//third_party/pip:flake8_bugbear_alias` or if you are using `gazelle` with `bzlmod`. | |
 
 ### Libraries
 

gazelle/configure.go

@@ -48,6 +48,9 @@ func (py *Configurer) KnownDirectives() []string {
  pythonconfig.LibraryNamingConvention,
  pythonconfig.BinaryNamingConvention,
  pythonconfig.TestNamingConvention,
+ pythonconfig.PipRepoNamingConvention,
+ pythonconfig.PipPackageNamingConvention,
+ pythonconfig.PipTargetNamingConvention,
 	}
 }
 
@@ -136,6 +139,12 @@ func (py *Configurer) Configure(c *config.Config, rel string, f *rule.File) {
  config.SetBinaryNamingConvention(strings.TrimSpace(d.Value))
  case pythonconfig.TestNamingConvention:
  config.SetTestNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipRepoNamingConvention:
+ config.SetPipRepoNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipPackageNamingConvention:
+ config.SetPipPackageNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipTargetNamingConvention:
+ config.SetPipTargetNamingConvention(strings.TrimSpace(d.Value))
  }
 	}
 

gazelle/pythonconfig/BUILD.bazel

@@ -1,4 +1,4 @@
-load("@io_bazel_rules_go//go:def.bzl", "go_library")
+load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
 
 go_library(
  name = "pythonconfig",
@@ -20,3 +20,9 @@ filegroup(
  srcs = glob(["**"]),
  visibility = ["//gazelle:__pkg__"],
 )
+
+go_test(
+ name = "pythonconfig_test",
+ srcs = ["pythonconfig_test.go"],
+ embed = [":pythonconfig"],
+)

gazelle/pythonconfig/pythonconfig.go

@@ -49,6 +49,17 @@ const (
 	// naming convention. See python_library_naming_convention for more info on
 	// the package name interpolation.
 	TestNamingConvention = "python_test_naming_convention"
+	// PipRepoNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. E.g. if the Python package name is `foo` and the
+	// pip repository is named `my_pip`, setting this
+	// to `$repo_name$_$distribution_name$` would render to `@my_pip_foo`.
+	PipRepoNamingConvention = "python_pip_repo_naming_convention"
+	// PipPackageNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. By default it is ``
+	PipPackageNamingConvention = "python_pip_package_naming_convention"
+	// PipTargetNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. By default it is `pkg`
+	PipTargetNamingConvention = "python_pip_target_naming_convention"
 )
 
 // GenerationModeType represents one of the generation modes for the Python
@@ -67,7 +78,9 @@ const (
 )
 
 const (
-	packageNameNamingConventionSubstitution = "$package_name$"
+	repoNamePipRepoNamingConventionSubstitution = "$repo_name$"
+	distributionNamePipRepoNamingConventionSubstitution = "$distribution_name$"
+	packageNameNamingConventionSubstitution = "$package_name$"
 )
 
 // defaultIgnoreFiles is the list of default values used in the
@@ -99,14 +112,17 @@ type Config struct {
 	pythonProjectRoot string
 	gazelleManifest *manifest.Manifest
 
-	excludedPatterns *singlylinkedlist.List
-	ignoreFiles map[string]struct{}
-	ignoreDependencies map[string]struct{}
-	validateImportStatements bool
-	coarseGrainedGeneration bool
-	libraryNamingConvention string
-	binaryNamingConvention string
-	testNamingConvention string
+	excludedPatterns *singlylinkedlist.List
+	ignoreFiles map[string]struct{}
+	ignoreDependencies map[string]struct{}
+	validateImportStatements bool
+	coarseGrainedGeneration bool
+	libraryNamingConvention string
+	binaryNamingConvention string
+	testNamingConvention string
+	pipRepoNamingConvention string
+	pipPackageNamingConvention string
+	pipTargetNamingConvention string
 }
 
 // New creates a new Config.
@@ -115,17 +131,20 @@ func New(
 	pythonProjectRoot string,
 ) *Config {
 	return &Config{
- extensionEnabled: true,
- repoRoot: repoRoot,
- pythonProjectRoot: pythonProjectRoot,
- excludedPatterns: singlylinkedlist.New(),
- ignoreFiles: make(map[string]struct{}),
- ignoreDependencies: make(map[string]struct{}),
- validateImportStatements: true,
- coarseGrainedGeneration: false,
- libraryNamingConvention: packageNameNamingConventionSubstitution,
- binaryNamingConvention: fmt.Sprintf("%s_bin", packageNameNamingConventionSubstitution),
- testNamingConvention: fmt.Sprintf("%s_test", packageNameNamingConventionSubstitution),
+ extensionEnabled: true,
+ repoRoot: repoRoot,
+ pythonProjectRoot: pythonProjectRoot,
+ excludedPatterns: singlylinkedlist.New(),
+ ignoreFiles: make(map[string]struct{}),
+ ignoreDependencies: make(map[string]struct{}),
+ validateImportStatements: true,
+ coarseGrainedGeneration: false,
+ libraryNamingConvention: packageNameNamingConventionSubstitution,
+ binaryNamingConvention: fmt.Sprintf("%s_bin", packageNameNamingConventionSubstitution),
+ testNamingConvention: fmt.Sprintf("%s_test", packageNameNamingConventionSubstitution),
+ pipRepoNamingConvention: fmt.Sprintf("%s_%s", repoNamePipRepoNamingConventionSubstitution, distributionNamePipRepoNamingConventionSubstitution),
+ pipPackageNamingConvention: "",
+ pipTargetNamingConvention: "pkg",
 	}
 }
 
@@ -150,6 +169,9 @@ func (c *Config) NewChild() *Config {
  libraryNamingConvention: c.libraryNamingConvention,
  binaryNamingConvention: c.binaryNamingConvention,
  testNamingConvention: c.testNamingConvention,
+ pipRepoNamingConvention: c.pipRepoNamingConvention,
+ pipPackageNamingConvention: c.pipPackageNamingConvention,
+ pipTargetNamingConvention: c.pipTargetNamingConvention,
 	}
 }
 
@@ -195,24 +217,32 @@ func (c *Config) SetGazelleManifest(gazelleManifest *manifest.Manifest) {
 // name.
 func (c *Config) FindThirdPartyDependency(modName string) (string, bool) {
 	for currentCfg := c; currentCfg != nil; currentCfg = currentCfg.parent {
- if currentCfg.gazelleManifest != nil {
- gazelleManifest := currentCfg.gazelleManifest
- if distributionName, ok := gazelleManifest.ModulesMapping[modName]; ok {
- var distributionRepositoryName string
- if gazelleManifest.PipDepsRepositoryName != "" {
- distributionRepositoryName = gazelleManifest.PipDepsRepositoryName
- } else if gazelleManifest.PipRepository != nil {
- distributionRepositoryName = gazelleManifest.PipRepository.Name
- }
- sanitizedDistribution := strings.ToLower(distributionName)
- sanitizedDistribution = strings.ReplaceAll(sanitizedDistribution, "-", "_")
- var lbl label.Label
- // @<repository_name>_<distribution_name>//:pkg
- distributionRepositoryName = distributionRepositoryName + "_" + sanitizedDistribution
- lbl = label.New(distributionRepositoryName, "", "pkg")
- return lbl.String(), true
- }
+
+ if currentCfg.gazelleManifest == nil {
+ continue
+ }
+
+ gazelleManifest := currentCfg.gazelleManifest
+ distributionName, ok := gazelleManifest.ModulesMapping[modName]
+ if !ok {
+ continue
  }
+
+ var distributionRepositoryName string
+ if gazelleManifest.PipDepsRepositoryName != "" {
+ distributionRepositoryName = gazelleManifest.PipDepsRepositoryName
+ } else if gazelleManifest.PipRepository != nil {
+ distributionRepositoryName = gazelleManifest.PipRepository.Name
+ }
+ sanitizedDistribution := strings.ToLower(distributionName)
+ sanitizedDistribution = strings.ReplaceAll(sanitizedDistribution, "-", "_")
+
+ lbl := label.New(
+ currentCfg.renderPipRepository(distributionRepositoryName, sanitizedDistribution),
+ currentCfg.renderPipPackage(sanitizedDistribution),
+ currentCfg.renderPipTarget(sanitizedDistribution),
+ )
+ return lbl.String(), true
 	}
 	return "", false
 }
@@ -327,6 +357,37 @@ func (c *Config) SetTestNamingConvention(testNamingConvention string) {
 	c.testNamingConvention = testNamingConvention
 }
 
+// SetPipRepoNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipRepoNamingConvention(pipRepoNamingConvention string) {
+	c.pipRepoNamingConvention = pipRepoNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipRepository(distributionRepoName, distributionName string) string {
+	rendered := strings.ReplaceAll(c.pipRepoNamingConvention, repoNamePipRepoNamingConventionSubstitution, distributionRepoName)
+	return strings.ReplaceAll(rendered, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
+// SetPipPackageNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipPackageNamingConvention(pipPackageNamingConvention string) {
+	c.pipPackageNamingConvention = pipPackageNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipPackage(distributionName string) string {
+	return strings.ReplaceAll(c.pipPackageNamingConvention, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
+// SetPipTargetNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipTargetNamingConvention(pipTargetNamingConvention string) {
+	c.pipTargetNamingConvention = pipTargetNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipTarget(distributionName string) string {
+	return strings.ReplaceAll(c.pipTargetNamingConvention, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
 // RenderTestName returns the py_test target name by performing all
 // substitutions.
 func (c *Config) RenderTestName(packageName string) string {

gazelle/pythonconfig/pythonconfig_test.go

@@ -0,0 +1,19 @@
+package pythonconfig
+
+import (
+	"reflect"
+	"testing"
+)
+
+func TestConfigNewChild(t *testing.T) {
+	parent := New("foo", "bar")
+	child := parent.NewChild()
+
+	if child.parent == nil {
+ t.Error("child parent should not be nil")
+	}
+	child.parent = nil
+	if !reflect.DeepEqual(child, parent) {
+ t.Errorf("child and should should be equal other than the parent reference. Parent: %#v\nChild: %#v", parent, child)
+	}
+}

gazelle/pythonconfig/types.go

@@ -100,4 +100,4 @@ func (sml *StringMapList) Set(s string) error {
 func (sml *StringMapList) Get(key string) (string, bool) {
 	val, exists := sml.mapping[key]
 	return val, exists
-}
+}

gazelle/testdata/pip_repo_convention/BUILD.in

@@ -0,0 +1,3 @@
+# gazelle:python_pip_repo_naming_convention $repo_name$
+# gazelle:python_pip_package_naming_convention $distribution_name$
+# gazelle:python_pip_target_naming_convention $distribution_name$_pkg

gazelle/testdata/pip_repo_convention/BUILD.out

@@ -0,0 +1,31 @@
+load("@rules_python//python:defs.bzl", "py_binary", "py_library")
+
+# gazelle:python_pip_repo_naming_convention $repo_name$
+# gazelle:python_pip_package_naming_convention $distribution_name$
+# gazelle:python_pip_target_naming_convention $distribution_name$_pkg
+
+py_library(
+ name = "pip_repo_convention",
+ srcs = [
+ "__init__.py",
+ "bar.py",
+ "foo.py",
+ ],
+ visibility = ["//:__subpackages__"],
+ deps = [
+ "@pip_deps//baz:baz_pkg",
+ "@pip_deps//boto3:boto3_pkg",
+ "@pip_deps//djangorestframework:djangorestframework_pkg",
+ ],
+)
+
+py_binary(
+ name = "pip_repo_convention_bin",
+ srcs = ["__main__.py"],
+ main = "__main__.py",
+ visibility = ["//:__subpackages__"],
+ deps = [
+ ":pip_repo_convention",
+ "@pip_deps//baz:baz_pkg",
+ ],
+)

gazelle/testdata/pip_repo_convention/README.md

@@ -0,0 +1,3 @@
+# Pip repo convention
+
+This test case asserts that the dependency labels generated by gazelle follow a particular convention, that can be changed using directives.

gazelle/testdata/pip_repo_convention/WORKSPACE

@@ -0,0 +1 @@
+# This is a Bazel workspace for the Gazelle test data.

gazelle/testdata/pip_repo_convention/__init__.py

@@ -0,0 +1 @@
+# For test purposes only.

gazelle/testdata/pip_repo_convention/__main__.py

@@ -0,0 +1,5 @@
+import bar
+import foo
+
+_ = bar
+_ = foo

gazelle/testdata/pip_repo_convention/bar.py

@@ -0,0 +1,11 @@
+import os
+
+import bar
+import boto3
+import rest_framework
+
+_ = os
+
+_ = bar
+_ = boto3
+_ = rest_framework

gazelle/testdata/pip_repo_convention/foo.py

@@ -0,0 +1,11 @@
+import sys
+
+import boto3
+import foo
+import rest_framework
+
+_ = sys
+
+_ = boto3
+_ = foo
+_ = rest_framework

gazelle/testdata/pip_repo_convention/gazelle_python.yaml

@@ -0,0 +1,8 @@
+manifest:
+ modules_mapping:
+ boto3: boto3
+ rest_framework: djangorestframework
+ foo: baz
+ bar: baz
+ pip_repository:
+ name: pip_deps

gazelle/testdata/pip_repo_convention/test.yaml

@@ -0,0 +1 @@
+---

gazelle/README.md

@@ -147,6 +147,12 @@ Python-specific directives are as follows:
 | Controls the `py_test` naming convention. Follows the same interpolation rules as `python_library_naming_convention`. | |
 | `# gazelle:resolve py ...` | n/a |
 | Instructs the plugin what target to add as a dependency to satisfy a given import statement. The syntax is `# gazelle:resolve py import-string label` where `import-string` is the symbol in the python `import` statement, and `label` is the Bazel label that Gazelle should write in `deps`. | |
+| `# gazelle:python_pip_repo_naming_convention` | `$repo_name$_$distribution_name$` |
+| Controls the external dependency label naming convention. It interpolates `$repo_name$` and `$distribution_name$` with the Bazel external pip repository name and the sanitized Python package name respectively. E.g. if the Bazel external pip repository name is `my_pip_deps` and we are resolving external Python package named `flake-bugbear`, setting this to `$repo_name$_host_$distribution_name$` would result in a generated target named `my_pip_deps_host_flake8_bugbear`. | |
+| `# gazelle:python_pip_package_naming_convention` | n/a |
+| Controls the external dependency label naming convention. It interpolates `$distribution_name$` with the sanitized Python package name. See `gazelle:python_pip_repo_naming_convention` for details. This may be useful if you have `alias` targets which point to platform specific Python wheels in your repo, e.g. `//third_party/pip:flake8_bugbear_alias`. | |
+| `# gazelle:python_pip_target_naming_convention` | `pkg` |
+| Controls the external dependency label naming convention. It interpolates `$distribution_name$` with the sanitized Python package name respectively. See `gazelle:python_pip_repo_naming_convention` for details. This may be useful if you have `alias` targets which point to platform specific Python wheels in your repo, e.g. `//third_party/pip:flake8_bugbear_alias` or if you are using `gazelle` with `bzlmod`. | |
 
 ### Libraries
 

gazelle/configure.go

@@ -48,6 +48,9 @@ func (py *Configurer) KnownDirectives() []string {
  pythonconfig.LibraryNamingConvention,
  pythonconfig.BinaryNamingConvention,
  pythonconfig.TestNamingConvention,
+ pythonconfig.PipRepoNamingConvention,
+ pythonconfig.PipPackageNamingConvention,
+ pythonconfig.PipTargetNamingConvention,
 	}
 }
 
@@ -136,6 +139,12 @@ func (py *Configurer) Configure(c *config.Config, rel string, f *rule.File) {
  config.SetBinaryNamingConvention(strings.TrimSpace(d.Value))
  case pythonconfig.TestNamingConvention:
  config.SetTestNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipRepoNamingConvention:
+ config.SetPipRepoNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipPackageNamingConvention:
+ config.SetPipPackageNamingConvention(strings.TrimSpace(d.Value))
+ case pythonconfig.PipTargetNamingConvention:
+ config.SetPipTargetNamingConvention(strings.TrimSpace(d.Value))
  }
 	}
 

gazelle/pythonconfig/BUILD.bazel

@@ -1,4 +1,4 @@
-load("@io_bazel_rules_go//go:def.bzl", "go_library")
+load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
 
 go_library(
  name = "pythonconfig",
@@ -20,3 +20,9 @@ filegroup(
  srcs = glob(["**"]),
  visibility = ["//gazelle:__pkg__"],
 )
+
+go_test(
+ name = "pythonconfig_test",
+ srcs = ["pythonconfig_test.go"],
+ embed = [":pythonconfig"],
+)

gazelle/pythonconfig/pythonconfig.go

@@ -49,6 +49,17 @@ const (
 	// naming convention. See python_library_naming_convention for more info on
 	// the package name interpolation.
 	TestNamingConvention = "python_test_naming_convention"
+	// PipRepoNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. E.g. if the Python package name is `foo` and the
+	// pip repository is named `my_pip`, setting this
+	// to `$repo_name$_$distribution_name$` would render to `@my_pip_foo`.
+	PipRepoNamingConvention = "python_pip_repo_naming_convention"
+	// PipPackageNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. By default it is ``
+	PipPackageNamingConvention = "python_pip_package_naming_convention"
+	// PipTargetNamingConvention represents the directive that controls the
+	// mapping between Python modules and the repos. By default it is `pkg`
+	PipTargetNamingConvention = "python_pip_target_naming_convention"
 )
 
 // GenerationModeType represents one of the generation modes for the Python
@@ -67,7 +78,9 @@ const (
 )
 
 const (
-	packageNameNamingConventionSubstitution = "$package_name$"
+	repoNamePipRepoNamingConventionSubstitution = "$repo_name$"
+	distributionNamePipRepoNamingConventionSubstitution = "$distribution_name$"
+	packageNameNamingConventionSubstitution = "$package_name$"
 )
 
 // defaultIgnoreFiles is the list of default values used in the
@@ -99,14 +112,17 @@ type Config struct {
 	pythonProjectRoot string
 	gazelleManifest *manifest.Manifest
 
-	excludedPatterns *singlylinkedlist.List
-	ignoreFiles map[string]struct{}
-	ignoreDependencies map[string]struct{}
-	validateImportStatements bool
-	coarseGrainedGeneration bool
-	libraryNamingConvention string
-	binaryNamingConvention string
-	testNamingConvention string
+	excludedPatterns *singlylinkedlist.List
+	ignoreFiles map[string]struct{}
+	ignoreDependencies map[string]struct{}
+	validateImportStatements bool
+	coarseGrainedGeneration bool
+	libraryNamingConvention string
+	binaryNamingConvention string
+	testNamingConvention string
+	pipRepoNamingConvention string
+	pipPackageNamingConvention string
+	pipTargetNamingConvention string
 }
 
 // New creates a new Config.
@@ -115,17 +131,20 @@ func New(
 	pythonProjectRoot string,
 ) *Config {
 	return &Config{
- extensionEnabled: true,
- repoRoot: repoRoot,
- pythonProjectRoot: pythonProjectRoot,
- excludedPatterns: singlylinkedlist.New(),
- ignoreFiles: make(map[string]struct{}),
- ignoreDependencies: make(map[string]struct{}),
- validateImportStatements: true,
- coarseGrainedGeneration: false,
- libraryNamingConvention: packageNameNamingConventionSubstitution,
- binaryNamingConvention: fmt.Sprintf("%s_bin", packageNameNamingConventionSubstitution),
- testNamingConvention: fmt.Sprintf("%s_test", packageNameNamingConventionSubstitution),
+ extensionEnabled: true,
+ repoRoot: repoRoot,
+ pythonProjectRoot: pythonProjectRoot,
+ excludedPatterns: singlylinkedlist.New(),
+ ignoreFiles: make(map[string]struct{}),
+ ignoreDependencies: make(map[string]struct{}),
+ validateImportStatements: true,
+ coarseGrainedGeneration: false,
+ libraryNamingConvention: packageNameNamingConventionSubstitution,
+ binaryNamingConvention: fmt.Sprintf("%s_bin", packageNameNamingConventionSubstitution),
+ testNamingConvention: fmt.Sprintf("%s_test", packageNameNamingConventionSubstitution),
+ pipRepoNamingConvention: fmt.Sprintf("%s_%s", repoNamePipRepoNamingConventionSubstitution, distributionNamePipRepoNamingConventionSubstitution),
+ pipPackageNamingConvention: "",
+ pipTargetNamingConvention: "pkg",
 	}
 }
 
@@ -150,6 +169,9 @@ func (c *Config) NewChild() *Config {
  libraryNamingConvention: c.libraryNamingConvention,
  binaryNamingConvention: c.binaryNamingConvention,
  testNamingConvention: c.testNamingConvention,
+ pipRepoNamingConvention: c.pipRepoNamingConvention,
+ pipPackageNamingConvention: c.pipPackageNamingConvention,
+ pipTargetNamingConvention: c.pipTargetNamingConvention,
 	}
 }
 
@@ -195,24 +217,32 @@ func (c *Config) SetGazelleManifest(gazelleManifest *manifest.Manifest) {
 // name.
 func (c *Config) FindThirdPartyDependency(modName string) (string, bool) {
 	for currentCfg := c; currentCfg != nil; currentCfg = currentCfg.parent {
- if currentCfg.gazelleManifest != nil {
- gazelleManifest := currentCfg.gazelleManifest
- if distributionName, ok := gazelleManifest.ModulesMapping[modName]; ok {
- var distributionRepositoryName string
- if gazelleManifest.PipDepsRepositoryName != "" {
- distributionRepositoryName = gazelleManifest.PipDepsRepositoryName
- } else if gazelleManifest.PipRepository != nil {
- distributionRepositoryName = gazelleManifest.PipRepository.Name
- }
- sanitizedDistribution := strings.ToLower(distributionName)
- sanitizedDistribution = strings.ReplaceAll(sanitizedDistribution, "-", "_")
- var lbl label.Label
- // @<repository_name>_<distribution_name>//:pkg
- distributionRepositoryName = distributionRepositoryName + "_" + sanitizedDistribution
- lbl = label.New(distributionRepositoryName, "", "pkg")
- return lbl.String(), true
- }
+
+ if currentCfg.gazelleManifest == nil {
+ continue
+ }
+
+ gazelleManifest := currentCfg.gazelleManifest
+ distributionName, ok := gazelleManifest.ModulesMapping[modName]
+ if !ok {
+ continue
  }
+
+ var distributionRepositoryName string
+ if gazelleManifest.PipDepsRepositoryName != "" {
+ distributionRepositoryName = gazelleManifest.PipDepsRepositoryName
+ } else if gazelleManifest.PipRepository != nil {
+ distributionRepositoryName = gazelleManifest.PipRepository.Name
+ }
+ sanitizedDistribution := strings.ToLower(distributionName)
+ sanitizedDistribution = strings.ReplaceAll(sanitizedDistribution, "-", "_")
+
+ lbl := label.New(
+ currentCfg.renderPipRepository(distributionRepositoryName, sanitizedDistribution),
+ currentCfg.renderPipPackage(sanitizedDistribution),
+ currentCfg.renderPipTarget(sanitizedDistribution),
+ )
+ return lbl.String(), true
 	}
 	return "", false
 }
@@ -327,6 +357,37 @@ func (c *Config) SetTestNamingConvention(testNamingConvention string) {
 	c.testNamingConvention = testNamingConvention
 }
 
+// SetPipRepoNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipRepoNamingConvention(pipRepoNamingConvention string) {
+	c.pipRepoNamingConvention = pipRepoNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipRepository(distributionRepoName, distributionName string) string {
+	rendered := strings.ReplaceAll(c.pipRepoNamingConvention, repoNamePipRepoNamingConventionSubstitution, distributionRepoName)
+	return strings.ReplaceAll(rendered, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
+// SetPipPackageNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipPackageNamingConvention(pipPackageNamingConvention string) {
+	c.pipPackageNamingConvention = pipPackageNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipPackage(distributionName string) string {
+	return strings.ReplaceAll(c.pipPackageNamingConvention, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
+// SetPipTargetNamingConvention sets the dependency naming convention.
+func (c *Config) SetPipTargetNamingConvention(pipTargetNamingConvention string) {
+	c.pipTargetNamingConvention = pipTargetNamingConvention
+}
+
+// Accepts sanitized input.
+func (c *Config) renderPipTarget(distributionName string) string {
+	return strings.ReplaceAll(c.pipTargetNamingConvention, distributionNamePipRepoNamingConventionSubstitution, distributionName)
+}
+
 // RenderTestName returns the py_test target name by performing all
 // substitutions.
 func (c *Config) RenderTestName(packageName string) string {

gazelle/pythonconfig/pythonconfig_test.go

@@ -0,0 +1,19 @@
+package pythonconfig
+
+import (
+	"reflect"
+	"testing"
+)
+
+func TestConfigNewChild(t *testing.T) {
+	parent := New("foo", "bar")
+	child := parent.NewChild()
+
+	if child.parent == nil {
+ t.Error("child parent should not be nil")
+	}
+	child.parent = nil
+	if !reflect.DeepEqual(child, parent) {
+ t.Errorf("child and should should be equal other than the parent reference. Parent: %#v\nChild: %#v", parent, child)
+	}
+}

gazelle/pythonconfig/types.go

@@ -100,4 +100,4 @@ func (sml *StringMapList) Set(s string) error {
 func (sml *StringMapList) Get(key string) (string, bool) {
 	val, exists := sml.mapping[key]
 	return val, exists
-}
+}

gazelle/testdata/pip_repo_convention/BUILD.in

@@ -0,0 +1,3 @@
+# gazelle:python_pip_repo_naming_convention $repo_name$
+# gazelle:python_pip_package_naming_convention $distribution_name$
+# gazelle:python_pip_target_naming_convention $distribution_name$_pkg

gazelle/testdata/pip_repo_convention/BUILD.out

@@ -0,0 +1,31 @@
+load("@rules_python//python:defs.bzl", "py_binary", "py_library")
+
+# gazelle:python_pip_repo_naming_convention $repo_name$
+# gazelle:python_pip_package_naming_convention $distribution_name$
+# gazelle:python_pip_target_naming_convention $distribution_name$_pkg
+
+py_library(
+ name = "pip_repo_convention",
+ srcs = [
+ "__init__.py",
+ "bar.py",
+ "foo.py",
+ ],
+ visibility = ["//:__subpackages__"],
+ deps = [
+ "@pip_deps//baz:baz_pkg",
+ "@pip_deps//boto3:boto3_pkg",
+ "@pip_deps//djangorestframework:djangorestframework_pkg",
+ ],
+)
+
+py_binary(
+ name = "pip_repo_convention_bin",
+ srcs = ["__main__.py"],
+ main = "__main__.py",
+ visibility = ["//:__subpackages__"],
+ deps = [
+ ":pip_repo_convention",
+ "@pip_deps//baz:baz_pkg",
+ ],
+)

gazelle/testdata/pip_repo_convention/README.md

@@ -0,0 +1,3 @@
+# Pip repo convention
+
+This test case asserts that the dependency labels generated by gazelle follow a particular convention, that can be changed using directives.

gazelle/testdata/pip_repo_convention/WORKSPACE

@@ -0,0 +1 @@
+# This is a Bazel workspace for the Gazelle test data.

gazelle/testdata/pip_repo_convention/__init__.py

@@ -0,0 +1 @@
+# For test purposes only.

gazelle/testdata/pip_repo_convention/__main__.py

@@ -0,0 +1,5 @@
+import bar
+import foo
+
+_ = bar
+_ = foo

gazelle/testdata/pip_repo_convention/bar.py

@@ -0,0 +1,11 @@
+import os
+
+import bar
+import boto3
+import rest_framework
+
+_ = os
+
+_ = bar
+_ = boto3
+_ = rest_framework

gazelle/testdata/pip_repo_convention/foo.py

@@ -0,0 +1,11 @@
+import sys
+
+import boto3
+import foo
+import rest_framework
+
+_ = sys
+
+_ = boto3
+_ = foo
+_ = rest_framework

gazelle/testdata/pip_repo_convention/gazelle_python.yaml

@@ -0,0 +1,8 @@
+manifest:
+ modules_mapping:
+ boto3: boto3
+ rest_framework: djangorestframework
+ foo: baz
+ bar: baz
+ pip_repository:
+ name: pip_deps

gazelle/testdata/pip_repo_convention/test.yaml

@@ -0,0 +1 @@
+---