Skip to content

fix(gazelle) Fix dependency added as both deps and pyi_deps#3036

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dougthor42 merged 3 commits into from
Jun 29, 2025
Merged

fix(gazelle) Fix dependency added as both deps and pyi_deps #3036

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f26a941
fix(gazelle) Fix dependencies being added as both deps and pyi_deps
amartani Jun 28, 2025
ec67d10
Fix issue
amartani Jun 28, 2025
ae34124
Remove copyright headers
amartani Jun 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 13 additions & 9 deletions gazelle/python/resolve.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -124,12 +124,16 @@ func (py *Resolver) Embeds(r *rule.Rule, from label.Label) []label.Label {
}

// addDependency adds a dependency to either the regular deps or pyiDeps set based on
// whether the module is type-checking only.
func addDependency(dep string, mod Module, deps, pyiDeps *treeset.Set) {
if mod.TypeCheckingOnly {
pyiDeps.Add(dep)
// whether the module is type-checking only. If a module is added as both
// non-type-checking and type-checking, it should end up in deps and not pyiDeps.
func addDependency(dep string, typeCheckingOnly bool, deps, pyiDeps *treeset.Set) {
if typeCheckingOnly {
if !deps.Contains(dep) {
pyiDeps.Add(dep)
}
} else {
deps.Add(dep)
pyiDeps.Remove(dep)
}
}

Expand DownExpand Up@@ -240,7 +244,7 @@ func (py *Resolver) Resolve(
override.Repo = ""
}
dep := override.Rel(from.Repo, from.Pkg).String()
addDependency(dep, mod, deps, pyiDeps)
addDependency(dep, mod.TypeCheckingOnly, deps, pyiDeps)
if explainDependency == dep {
log.Printf("Explaining dependency (%s): "+
"in the target %q, the file %q imports %q at line %d, "+
Expand All@@ -251,7 +255,7 @@ func (py *Resolver) Resolve(
}
} else {
if dep, distributionName, ok := cfg.FindThirdPartyDependency(moduleName); ok {
addDependency(dep, mod, deps, pyiDeps)
addDependency(dep, mod.TypeCheckingOnly, deps, pyiDeps)
// Add the type and stub dependencies if they exist.
modules := []string{
fmt.Sprintf("%s_stubs", strings.ToLower(distributionName)),
Expand All@@ -261,8 +265,8 @@ func (py *Resolver) Resolve(
}
for _, module := range modules {
if dep, _, ok := cfg.FindThirdPartyDependency(module); ok {
// Type stub packages always go to pyiDeps
pyiDeps.Add(dep)
// Type stub packages are added as type-checking only.
addDependency(dep, true, deps, pyiDeps)
}
}
if explainDependency == dep {
Expand DownExpand Up@@ -321,7 +325,7 @@ func (py *Resolver) Resolve(
}
matchLabel := filteredMatches[0].Label.Rel(from.Repo, from.Pkg)
dep := matchLabel.String()
addDependency(dep, mod, deps, pyiDeps)
addDependency(dep, mod.TypeCheckingOnly, deps, pyiDeps)
if explainDependency == dep {
log.Printf("Explaining dependency (%s): "+
"in the target %q, the file %q imports %q at line %d, "+
Expand Down
2 changes: 2 additions & 0 deletions gazelle/python/testdata/type_checking_imports_across_packages/BUILD.in
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# gazelle:python_generation_mode package
# gazelle:python_generate_pyi_deps true
2 changes: 2 additions & 0 deletions gazelle/python/testdata/type_checking_imports_across_packages/BUILD.out
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# gazelle:python_generation_mode package
# gazelle:python_generate_pyi_deps true
6 changes: 6 additions & 0 deletions gazelle/python/testdata/type_checking_imports_across_packages/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
# Overlapping deps and pyi_deps across packages

This test reproduces a case where a dependency may be added to both `deps` and
`pyi_deps`. Package `b` imports `a.foo` normally and imports `a.bar` as a
type-checking only import. The dependency on package `a` should appear only in
`deps` (and not `pyi_deps`) of package `b`.
1 change: 1 addition & 0 deletions gazelle/python/testdata/type_checking_imports_across_packages/WORKSPACE
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
workspace(name = "gazelle_python_test")
Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/a/BUILD.in
View file
Open in desktop
Empty file.
10 changes: 10 additions & 0 deletions gazelle/python/testdata/type_checking_imports_across_packages/a/BUILD.out
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
load("@rules_python//python:defs.bzl", "py_library")

py_library(
name = "a",
srcs = [
"bar.py",
"foo.py",
],
visibility = ["//:__subpackages__"],
)
Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/a/bar.py
View file
Open in desktop
Empty file.
Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/a/foo.py
View file
Open in desktop
Empty file.
Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/b/BUILD.in
View file
Open in desktop
Empty file.
8 changes: 8 additions & 0 deletions gazelle/python/testdata/type_checking_imports_across_packages/b/BUILD.out
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
load("@rules_python//python:defs.bzl", "py_library")

py_library(
name = "b",
srcs = ["b.py"],
visibility = ["//:__subpackages__"],
deps = ["//a"],
)
6 changes: 6 additions & 0 deletions gazelle/python/testdata/type_checking_imports_across_packages/b/b.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
from typing import TYPE_CHECKING

from a import foo

if TYPE_CHECKING:
from a import bar
1 change: 1 addition & 0 deletions gazelle/python/testdata/type_checking_imports_across_packages/test.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
---
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
fix(gazelle) Fix dependency added as both deps and pyi_deps by amartani · Pull Request #3036 · bazel-contrib/rules_python · GitHub
Skip to content
fix(gazelle) Fix dependency added as both deps and pyi_deps#3036

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dougthor42
merged 3 commits into

from

Jun 29, 2025
 Merged


fix(gazelle) Fix dependency added as both deps and pyi_deps
#3036
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
f26a941

fix(gazelle) Fix dependencies being added as both deps and pyi_deps


amartani Jun 28, 2025
ec67d10

Fix issue


amartani Jun 28, 2025
ae34124

Remove copyright headers


amartani Jun 29, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


22 changes: 13 additions & 9 deletions
gazelle/python/resolve.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -124,12 +124,16 @@ func (py *Resolver) Embeds(r *rule.Rule, from label.Label) []label.Label {
}

// addDependency adds a dependency to either the regular deps or pyiDeps set based on
// whether the module is type-checking only.
func addDependency(dep string, mod Module, deps, pyiDeps *treeset.Set) {
	if mod.TypeCheckingOnly {
 pyiDeps.Add(dep)
// whether the module is type-checking only. If a module is added as both
// non-type-checking and type-checking, it should end up in deps and not pyiDeps.
func addDependency(dep string, typeCheckingOnly bool, deps, pyiDeps *treeset.Set) {
	if typeCheckingOnly {
 if !deps.Contains(dep) {
 pyiDeps.Add(dep)
 }
	} else {
 deps.Add(dep)
 pyiDeps.Remove(dep)
	}
}

Expand DownExpand Up@@ -240,7 +244,7 @@ func (py *Resolver) Resolve(
 override.Repo = ""
 }
 dep := override.Rel(from.Repo, from.Pkg).String()
 addDependency(dep, mod, deps, pyiDeps)
 addDependency(dep, mod.TypeCheckingOnly, deps, pyiDeps)
 if explainDependency == dep {
 log.Printf("Explaining dependency (%s): "+
 "in the target %q, the file %q imports %q at line %d, "+
Expand All@@ -251,7 +255,7 @@ func (py *Resolver) Resolve(
 }
 } else {
 if dep, distributionName, ok := cfg.FindThirdPartyDependency(moduleName); ok {
 addDependency(dep, mod, deps, pyiDeps)
 addDependency(dep, mod.TypeCheckingOnly, deps, pyiDeps)
 // Add the type and stub dependencies if they exist.
 modules := []string{
 fmt.Sprintf("%s_stubs", strings.ToLower(distributionName)),
Expand All@@ -261,8 +265,8 @@ func (py *Resolver) Resolve(
 }
 for _, module := range modules {
 if dep, _, ok := cfg.FindThirdPartyDependency(module); ok {
 // Type stub packages always go to pyiDeps
pyiDeps.Add(dep)
 // Type stub packages are added as type-checking only.
addDependency(dep, true, deps, pyiDeps)
 }
 }
 if explainDependency == dep {
Expand DownExpand Up@@ -321,7 +325,7 @@ func (py *Resolver) Resolve(
 }
 matchLabel := filteredMatches[0].Label.Rel(from.Repo, from.Pkg)
 dep := matchLabel.String()
 addDependency(dep, mod, deps, pyiDeps)
 addDependency(dep, mod.TypeCheckingOnly, deps, pyiDeps)
 if explainDependency == dep {
 log.Printf("Explaining dependency (%s): "+
 "in the target %q, the file %q imports %q at line %d, "+
Expand Down

2 changes: 2 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/BUILD.in

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# gazelle:python_generation_mode package
# gazelle:python_generate_pyi_deps true

2 changes: 2 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# gazelle:python_generation_mode package
# gazelle:python_generate_pyi_deps true

6 changes: 6 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
# Overlapping deps and pyi_deps across packages

This test reproduces a case where a dependency may be added to both `deps` and
`pyi_deps`. Package `b` imports `a.foo` normally and imports `a.bar` as a
type-checking only import. The dependency on package `a` should appear only in
`deps` (and not `pyi_deps`) of package `b`.

1 change: 1 addition & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
workspace(name = "gazelle_python_test")
Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/a/BUILD.in

View file


Open in desktop


Empty file.


10 changes: 10 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/a/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
load("@rules_python//python:defs.bzl", "py_library")

py_library(
 name = "a",
 srcs = [
 "bar.py",
 "foo.py",
 ],
 visibility = ["//:__subpackages__"],
)
Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/a/bar.py

View file


Open in desktop


Empty file.

Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/a/foo.py

View file


Open in desktop


Empty file.

Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/b/BUILD.in

View file


Open in desktop


Empty file.


8 changes: 8 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/b/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
load("@rules_python//python:defs.bzl", "py_library")

py_library(
 name = "b",
 srcs = ["b.py"],
 visibility = ["//:__subpackages__"],
 deps = ["//a"],
)

6 changes: 6 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/b/b.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
from typing import TYPE_CHECKING

from a import foo

if TYPE_CHECKING:
 from a import bar

1 change: 1 addition & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/test.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
---

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(gazelle) Fix dependency added as both deps and pyi_deps by amartani · Pull Request #3036 · bazel-contrib/rules_python · GitHub
Skip to content
fix(gazelle) Fix dependency added as both deps and pyi_deps#3036

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dougthor42
merged 3 commits into

from

Jun 29, 2025
 Merged


fix(gazelle) Fix dependency added as both deps and pyi_deps
#3036
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
f26a941

fix(gazelle) Fix dependencies being added as both deps and pyi_deps


amartani Jun 28, 2025
ec67d10

Fix issue


amartani Jun 28, 2025
ae34124

Remove copyright headers


amartani Jun 29, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


22 changes: 13 additions & 9 deletions
gazelle/python/resolve.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -124,12 +124,16 @@ func (py *Resolver) Embeds(r *rule.Rule, from label.Label) []label.Label {
}

// addDependency adds a dependency to either the regular deps or pyiDeps set based on
// whether the module is type-checking only.
func addDependency(dep string, mod Module, deps, pyiDeps *treeset.Set) {
	if mod.TypeCheckingOnly {
 pyiDeps.Add(dep)
// whether the module is type-checking only. If a module is added as both
// non-type-checking and type-checking, it should end up in deps and not pyiDeps.
func addDependency(dep string, typeCheckingOnly bool, deps, pyiDeps *treeset.Set) {
	if typeCheckingOnly {
 if !deps.Contains(dep) {
 pyiDeps.Add(dep)
 }
	} else {
 deps.Add(dep)
 pyiDeps.Remove(dep)
	}
}

Expand DownExpand Up@@ -240,7 +244,7 @@ func (py *Resolver) Resolve(
 override.Repo = ""
 }
 dep := override.Rel(from.Repo, from.Pkg).String()
 addDependency(dep, mod, deps, pyiDeps)
 addDependency(dep, mod.TypeCheckingOnly, deps, pyiDeps)
 if explainDependency == dep {
 log.Printf("Explaining dependency (%s): "+
 "in the target %q, the file %q imports %q at line %d, "+
Expand All@@ -251,7 +255,7 @@ func (py *Resolver) Resolve(
 }
 } else {
 if dep, distributionName, ok := cfg.FindThirdPartyDependency(moduleName); ok {
 addDependency(dep, mod, deps, pyiDeps)
 addDependency(dep, mod.TypeCheckingOnly, deps, pyiDeps)
 // Add the type and stub dependencies if they exist.
 modules := []string{
 fmt.Sprintf("%s_stubs", strings.ToLower(distributionName)),
Expand All@@ -261,8 +265,8 @@ func (py *Resolver) Resolve(
 }
 for _, module := range modules {
 if dep, _, ok := cfg.FindThirdPartyDependency(module); ok {
 // Type stub packages always go to pyiDeps
pyiDeps.Add(dep)
 // Type stub packages are added as type-checking only.
addDependency(dep, true, deps, pyiDeps)
 }
 }
 if explainDependency == dep {
Expand DownExpand Up@@ -321,7 +325,7 @@ func (py *Resolver) Resolve(
 }
 matchLabel := filteredMatches[0].Label.Rel(from.Repo, from.Pkg)
 dep := matchLabel.String()
 addDependency(dep, mod, deps, pyiDeps)
 addDependency(dep, mod.TypeCheckingOnly, deps, pyiDeps)
 if explainDependency == dep {
 log.Printf("Explaining dependency (%s): "+
 "in the target %q, the file %q imports %q at line %d, "+
Expand Down

2 changes: 2 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/BUILD.in

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# gazelle:python_generation_mode package
# gazelle:python_generate_pyi_deps true

2 changes: 2 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# gazelle:python_generation_mode package
# gazelle:python_generate_pyi_deps true

6 changes: 6 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
# Overlapping deps and pyi_deps across packages

This test reproduces a case where a dependency may be added to both `deps` and
`pyi_deps`. Package `b` imports `a.foo` normally and imports `a.bar` as a
type-checking only import. The dependency on package `a` should appear only in
`deps` (and not `pyi_deps`) of package `b`.

1 change: 1 addition & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
workspace(name = "gazelle_python_test")
Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/a/BUILD.in

View file


Open in desktop


Empty file.


10 changes: 10 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/a/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
load("@rules_python//python:defs.bzl", "py_library")

py_library(
 name = "a",
 srcs = [
 "bar.py",
 "foo.py",
 ],
 visibility = ["//:__subpackages__"],
)
Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/a/bar.py

View file


Open in desktop


Empty file.

Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/a/foo.py

View file


Open in desktop


Empty file.

Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/b/BUILD.in

View file


Open in desktop


Empty file.


8 changes: 8 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/b/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
load("@rules_python//python:defs.bzl", "py_library")

py_library(
 name = "b",
 srcs = ["b.py"],
 visibility = ["//:__subpackages__"],
 deps = ["//a"],
)

6 changes: 6 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/b/b.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
from typing import TYPE_CHECKING

from a import foo

if TYPE_CHECKING:
 from a import bar

1 change: 1 addition & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/test.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
---

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(gazelle) Fix dependency added as both deps and pyi_deps by amartani · Pull Request #3036 · bazel-contrib/rules_python · GitHub
Skip to content
fix(gazelle) Fix dependency added as both deps and pyi_deps#3036

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dougthor42
merged 3 commits into

from

Jun 29, 2025
 Merged


fix(gazelle) Fix dependency added as both deps and pyi_deps
#3036
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
f26a941

fix(gazelle) Fix dependencies being added as both deps and pyi_deps


amartani Jun 28, 2025
ec67d10

Fix issue


amartani Jun 28, 2025
ae34124

Remove copyright headers


amartani Jun 29, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


22 changes: 13 additions & 9 deletions
gazelle/python/resolve.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -124,12 +124,16 @@ func (py *Resolver) Embeds(r *rule.Rule, from label.Label) []label.Label {
}

// addDependency adds a dependency to either the regular deps or pyiDeps set based on
// whether the module is type-checking only.
func addDependency(dep string, mod Module, deps, pyiDeps *treeset.Set) {
	if mod.TypeCheckingOnly {
 pyiDeps.Add(dep)
// whether the module is type-checking only. If a module is added as both
// non-type-checking and type-checking, it should end up in deps and not pyiDeps.
func addDependency(dep string, typeCheckingOnly bool, deps, pyiDeps *treeset.Set) {
	if typeCheckingOnly {
 if !deps.Contains(dep) {
 pyiDeps.Add(dep)
 }
	} else {
 deps.Add(dep)
 pyiDeps.Remove(dep)
	}
}

Expand DownExpand Up@@ -240,7 +244,7 @@ func (py *Resolver) Resolve(
 override.Repo = ""
 }
 dep := override.Rel(from.Repo, from.Pkg).String()
 addDependency(dep, mod, deps, pyiDeps)
 addDependency(dep, mod.TypeCheckingOnly, deps, pyiDeps)
 if explainDependency == dep {
 log.Printf("Explaining dependency (%s): "+
 "in the target %q, the file %q imports %q at line %d, "+
Expand All@@ -251,7 +255,7 @@ func (py *Resolver) Resolve(
 }
 } else {
 if dep, distributionName, ok := cfg.FindThirdPartyDependency(moduleName); ok {
 addDependency(dep, mod, deps, pyiDeps)
 addDependency(dep, mod.TypeCheckingOnly, deps, pyiDeps)
 // Add the type and stub dependencies if they exist.
 modules := []string{
 fmt.Sprintf("%s_stubs", strings.ToLower(distributionName)),
Expand All@@ -261,8 +265,8 @@ func (py *Resolver) Resolve(
 }
 for _, module := range modules {
 if dep, _, ok := cfg.FindThirdPartyDependency(module); ok {
 // Type stub packages always go to pyiDeps
pyiDeps.Add(dep)
 // Type stub packages are added as type-checking only.
addDependency(dep, true, deps, pyiDeps)
 }
 }
 if explainDependency == dep {
Expand DownExpand Up@@ -321,7 +325,7 @@ func (py *Resolver) Resolve(
 }
 matchLabel := filteredMatches[0].Label.Rel(from.Repo, from.Pkg)
 dep := matchLabel.String()
 addDependency(dep, mod, deps, pyiDeps)
 addDependency(dep, mod.TypeCheckingOnly, deps, pyiDeps)
 if explainDependency == dep {
 log.Printf("Explaining dependency (%s): "+
 "in the target %q, the file %q imports %q at line %d, "+
Expand Down

2 changes: 2 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/BUILD.in

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# gazelle:python_generation_mode package
# gazelle:python_generate_pyi_deps true

2 changes: 2 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# gazelle:python_generation_mode package
# gazelle:python_generate_pyi_deps true

6 changes: 6 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
# Overlapping deps and pyi_deps across packages

This test reproduces a case where a dependency may be added to both `deps` and
`pyi_deps`. Package `b` imports `a.foo` normally and imports `a.bar` as a
type-checking only import. The dependency on package `a` should appear only in
`deps` (and not `pyi_deps`) of package `b`.

1 change: 1 addition & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
workspace(name = "gazelle_python_test")
Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/a/BUILD.in

View file


Open in desktop


Empty file.


10 changes: 10 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/a/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
load("@rules_python//python:defs.bzl", "py_library")

py_library(
 name = "a",
 srcs = [
 "bar.py",
 "foo.py",
 ],
 visibility = ["//:__subpackages__"],
)
Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/a/bar.py

View file


Open in desktop


Empty file.

Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/a/foo.py

View file


Open in desktop


Empty file.

Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/b/BUILD.in

View file


Open in desktop


Empty file.


8 changes: 8 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/b/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
load("@rules_python//python:defs.bzl", "py_library")

py_library(
 name = "b",
 srcs = ["b.py"],
 visibility = ["//:__subpackages__"],
 deps = ["//a"],
)

6 changes: 6 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/b/b.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
from typing import TYPE_CHECKING

from a import foo

if TYPE_CHECKING:
 from a import bar

1 change: 1 addition & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/test.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
---

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
fix(gazelle) Fix dependency added as both deps and pyi_deps by amartani · Pull Request #3036 · bazel-contrib/rules_python · GitHub
Skip to content
fix(gazelle) Fix dependency added as both deps and pyi_deps#3036

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dougthor42
merged 3 commits into

from

Jun 29, 2025
 Merged


fix(gazelle) Fix dependency added as both deps and pyi_deps
#3036
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
f26a941

fix(gazelle) Fix dependencies being added as both deps and pyi_deps


amartani Jun 28, 2025
ec67d10

Fix issue


amartani Jun 28, 2025
ae34124

Remove copyright headers


amartani Jun 29, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


22 changes: 13 additions & 9 deletions
gazelle/python/resolve.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -124,12 +124,16 @@ func (py *Resolver) Embeds(r *rule.Rule, from label.Label) []label.Label {
}

// addDependency adds a dependency to either the regular deps or pyiDeps set based on
// whether the module is type-checking only.
func addDependency(dep string, mod Module, deps, pyiDeps *treeset.Set) {
	if mod.TypeCheckingOnly {
 pyiDeps.Add(dep)
// whether the module is type-checking only. If a module is added as both
// non-type-checking and type-checking, it should end up in deps and not pyiDeps.
func addDependency(dep string, typeCheckingOnly bool, deps, pyiDeps *treeset.Set) {
	if typeCheckingOnly {
 if !deps.Contains(dep) {
 pyiDeps.Add(dep)
 }
	} else {
 deps.Add(dep)
 pyiDeps.Remove(dep)
	}
}

Expand DownExpand Up@@ -240,7 +244,7 @@ func (py *Resolver) Resolve(
 override.Repo = ""
 }
 dep := override.Rel(from.Repo, from.Pkg).String()
 addDependency(dep, mod, deps, pyiDeps)
 addDependency(dep, mod.TypeCheckingOnly, deps, pyiDeps)
 if explainDependency == dep {
 log.Printf("Explaining dependency (%s): "+
 "in the target %q, the file %q imports %q at line %d, "+
Expand All@@ -251,7 +255,7 @@ func (py *Resolver) Resolve(
 }
 } else {
 if dep, distributionName, ok := cfg.FindThirdPartyDependency(moduleName); ok {
 addDependency(dep, mod, deps, pyiDeps)
 addDependency(dep, mod.TypeCheckingOnly, deps, pyiDeps)
 // Add the type and stub dependencies if they exist.
 modules := []string{
 fmt.Sprintf("%s_stubs", strings.ToLower(distributionName)),
Expand All@@ -261,8 +265,8 @@ func (py *Resolver) Resolve(
 }
 for _, module := range modules {
 if dep, _, ok := cfg.FindThirdPartyDependency(module); ok {
 // Type stub packages always go to pyiDeps
pyiDeps.Add(dep)
 // Type stub packages are added as type-checking only.
addDependency(dep, true, deps, pyiDeps)
 }
 }
 if explainDependency == dep {
Expand DownExpand Up@@ -321,7 +325,7 @@ func (py *Resolver) Resolve(
 }
 matchLabel := filteredMatches[0].Label.Rel(from.Repo, from.Pkg)
 dep := matchLabel.String()
 addDependency(dep, mod, deps, pyiDeps)
 addDependency(dep, mod.TypeCheckingOnly, deps, pyiDeps)
 if explainDependency == dep {
 log.Printf("Explaining dependency (%s): "+
 "in the target %q, the file %q imports %q at line %d, "+
Expand Down

2 changes: 2 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/BUILD.in

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# gazelle:python_generation_mode package
# gazelle:python_generate_pyi_deps true

2 changes: 2 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# gazelle:python_generation_mode package
# gazelle:python_generate_pyi_deps true

6 changes: 6 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
# Overlapping deps and pyi_deps across packages

This test reproduces a case where a dependency may be added to both `deps` and
`pyi_deps`. Package `b` imports `a.foo` normally and imports `a.bar` as a
type-checking only import. The dependency on package `a` should appear only in
`deps` (and not `pyi_deps`) of package `b`.

1 change: 1 addition & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
workspace(name = "gazelle_python_test")
Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/a/BUILD.in

View file


Open in desktop


Empty file.


10 changes: 10 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/a/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
load("@rules_python//python:defs.bzl", "py_library")

py_library(
 name = "a",
 srcs = [
 "bar.py",
 "foo.py",
 ],
 visibility = ["//:__subpackages__"],
)
Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/a/bar.py

View file


Open in desktop


Empty file.

Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/a/foo.py

View file


Open in desktop


Empty file.

Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/b/BUILD.in

View file


Open in desktop


Empty file.


8 changes: 8 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/b/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
load("@rules_python//python:defs.bzl", "py_library")

py_library(
 name = "b",
 srcs = ["b.py"],
 visibility = ["//:__subpackages__"],
 deps = ["//a"],
)

6 changes: 6 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/b/b.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
from typing import TYPE_CHECKING

from a import foo

if TYPE_CHECKING:
 from a import bar

1 change: 1 addition & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/test.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
---

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(gazelle) Fix dependency added as both deps and pyi_deps by amartani · Pull Request #3036 · bazel-contrib/rules_python · GitHub
Skip to content
fix(gazelle) Fix dependency added as both deps and pyi_deps#3036

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dougthor42
merged 3 commits into

from

Jun 29, 2025
 Merged


fix(gazelle) Fix dependency added as both deps and pyi_deps
#3036
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
f26a941

fix(gazelle) Fix dependencies being added as both deps and pyi_deps


amartani Jun 28, 2025
ec67d10

Fix issue


amartani Jun 28, 2025
ae34124

Remove copyright headers


amartani Jun 29, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


22 changes: 13 additions & 9 deletions
gazelle/python/resolve.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -124,12 +124,16 @@ func (py *Resolver) Embeds(r *rule.Rule, from label.Label) []label.Label {
}

// addDependency adds a dependency to either the regular deps or pyiDeps set based on
// whether the module is type-checking only.
func addDependency(dep string, mod Module, deps, pyiDeps *treeset.Set) {
	if mod.TypeCheckingOnly {
 pyiDeps.Add(dep)
// whether the module is type-checking only. If a module is added as both
// non-type-checking and type-checking, it should end up in deps and not pyiDeps.
func addDependency(dep string, typeCheckingOnly bool, deps, pyiDeps *treeset.Set) {
	if typeCheckingOnly {
 if !deps.Contains(dep) {
 pyiDeps.Add(dep)
 }
	} else {
 deps.Add(dep)
 pyiDeps.Remove(dep)
	}
}

Expand DownExpand Up@@ -240,7 +244,7 @@ func (py *Resolver) Resolve(
 override.Repo = ""
 }
 dep := override.Rel(from.Repo, from.Pkg).String()
 addDependency(dep, mod, deps, pyiDeps)
 addDependency(dep, mod.TypeCheckingOnly, deps, pyiDeps)
 if explainDependency == dep {
 log.Printf("Explaining dependency (%s): "+
 "in the target %q, the file %q imports %q at line %d, "+
Expand All@@ -251,7 +255,7 @@ func (py *Resolver) Resolve(
 }
 } else {
 if dep, distributionName, ok := cfg.FindThirdPartyDependency(moduleName); ok {
 addDependency(dep, mod, deps, pyiDeps)
 addDependency(dep, mod.TypeCheckingOnly, deps, pyiDeps)
 // Add the type and stub dependencies if they exist.
 modules := []string{
 fmt.Sprintf("%s_stubs", strings.ToLower(distributionName)),
Expand All@@ -261,8 +265,8 @@ func (py *Resolver) Resolve(
 }
 for _, module := range modules {
 if dep, _, ok := cfg.FindThirdPartyDependency(module); ok {
 // Type stub packages always go to pyiDeps
pyiDeps.Add(dep)
 // Type stub packages are added as type-checking only.
addDependency(dep, true, deps, pyiDeps)
 }
 }
 if explainDependency == dep {
Expand DownExpand Up@@ -321,7 +325,7 @@ func (py *Resolver) Resolve(
 }
 matchLabel := filteredMatches[0].Label.Rel(from.Repo, from.Pkg)
 dep := matchLabel.String()
 addDependency(dep, mod, deps, pyiDeps)
 addDependency(dep, mod.TypeCheckingOnly, deps, pyiDeps)
 if explainDependency == dep {
 log.Printf("Explaining dependency (%s): "+
 "in the target %q, the file %q imports %q at line %d, "+
Expand Down

2 changes: 2 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/BUILD.in

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# gazelle:python_generation_mode package
# gazelle:python_generate_pyi_deps true

2 changes: 2 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# gazelle:python_generation_mode package
# gazelle:python_generate_pyi_deps true

6 changes: 6 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
# Overlapping deps and pyi_deps across packages

This test reproduces a case where a dependency may be added to both `deps` and
`pyi_deps`. Package `b` imports `a.foo` normally and imports `a.bar` as a
type-checking only import. The dependency on package `a` should appear only in
`deps` (and not `pyi_deps`) of package `b`.

1 change: 1 addition & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
workspace(name = "gazelle_python_test")
Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/a/BUILD.in

View file


Open in desktop


Empty file.


10 changes: 10 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/a/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
load("@rules_python//python:defs.bzl", "py_library")

py_library(
 name = "a",
 srcs = [
 "bar.py",
 "foo.py",
 ],
 visibility = ["//:__subpackages__"],
)
Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/a/bar.py

View file


Open in desktop


Empty file.

Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/a/foo.py

View file


Open in desktop


Empty file.

Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/b/BUILD.in

View file


Open in desktop


Empty file.


8 changes: 8 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/b/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
load("@rules_python//python:defs.bzl", "py_library")

py_library(
 name = "b",
 srcs = ["b.py"],
 visibility = ["//:__subpackages__"],
 deps = ["//a"],
)

6 changes: 6 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/b/b.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
from typing import TYPE_CHECKING

from a import foo

if TYPE_CHECKING:
 from a import bar

1 change: 1 addition & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/test.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
---

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
})();
fix(gazelle) Fix dependency added as both deps and pyi_deps by amartani · Pull Request #3036 · bazel-contrib/rules_python · GitHub
Skip to content
fix(gazelle) Fix dependency added as both deps and pyi_deps#3036

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dougthor42
merged 3 commits into

from

Jun 29, 2025
 Merged


fix(gazelle) Fix dependency added as both deps and pyi_deps
#3036
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
f26a941

fix(gazelle) Fix dependencies being added as both deps and pyi_deps


amartani Jun 28, 2025
ec67d10

Fix issue


amartani Jun 28, 2025
ae34124

Remove copyright headers


amartani Jun 29, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


22 changes: 13 additions & 9 deletions
gazelle/python/resolve.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -124,12 +124,16 @@ func (py *Resolver) Embeds(r *rule.Rule, from label.Label) []label.Label {
}

// addDependency adds a dependency to either the regular deps or pyiDeps set based on
// whether the module is type-checking only.
func addDependency(dep string, mod Module, deps, pyiDeps *treeset.Set) {
	if mod.TypeCheckingOnly {
 pyiDeps.Add(dep)
// whether the module is type-checking only. If a module is added as both
// non-type-checking and type-checking, it should end up in deps and not pyiDeps.
func addDependency(dep string, typeCheckingOnly bool, deps, pyiDeps *treeset.Set) {
	if typeCheckingOnly {
 if !deps.Contains(dep) {
 pyiDeps.Add(dep)
 }
	} else {
 deps.Add(dep)
 pyiDeps.Remove(dep)
	}
}

Expand DownExpand Up@@ -240,7 +244,7 @@ func (py *Resolver) Resolve(
 override.Repo = ""
 }
 dep := override.Rel(from.Repo, from.Pkg).String()
 addDependency(dep, mod, deps, pyiDeps)
 addDependency(dep, mod.TypeCheckingOnly, deps, pyiDeps)
 if explainDependency == dep {
 log.Printf("Explaining dependency (%s): "+
 "in the target %q, the file %q imports %q at line %d, "+
Expand All@@ -251,7 +255,7 @@ func (py *Resolver) Resolve(
 }
 } else {
 if dep, distributionName, ok := cfg.FindThirdPartyDependency(moduleName); ok {
 addDependency(dep, mod, deps, pyiDeps)
 addDependency(dep, mod.TypeCheckingOnly, deps, pyiDeps)
 // Add the type and stub dependencies if they exist.
 modules := []string{
 fmt.Sprintf("%s_stubs", strings.ToLower(distributionName)),
Expand All@@ -261,8 +265,8 @@ func (py *Resolver) Resolve(
 }
 for _, module := range modules {
 if dep, _, ok := cfg.FindThirdPartyDependency(module); ok {
 // Type stub packages always go to pyiDeps
pyiDeps.Add(dep)
 // Type stub packages are added as type-checking only.
addDependency(dep, true, deps, pyiDeps)
 }
 }
 if explainDependency == dep {
Expand DownExpand Up@@ -321,7 +325,7 @@ func (py *Resolver) Resolve(
 }
 matchLabel := filteredMatches[0].Label.Rel(from.Repo, from.Pkg)
 dep := matchLabel.String()
 addDependency(dep, mod, deps, pyiDeps)
 addDependency(dep, mod.TypeCheckingOnly, deps, pyiDeps)
 if explainDependency == dep {
 log.Printf("Explaining dependency (%s): "+
 "in the target %q, the file %q imports %q at line %d, "+
Expand Down

2 changes: 2 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/BUILD.in

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# gazelle:python_generation_mode package
# gazelle:python_generate_pyi_deps true

2 changes: 2 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# gazelle:python_generation_mode package
# gazelle:python_generate_pyi_deps true

6 changes: 6 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
# Overlapping deps and pyi_deps across packages

This test reproduces a case where a dependency may be added to both `deps` and
`pyi_deps`. Package `b` imports `a.foo` normally and imports `a.bar` as a
type-checking only import. The dependency on package `a` should appear only in
`deps` (and not `pyi_deps`) of package `b`.

1 change: 1 addition & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
workspace(name = "gazelle_python_test")
Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/a/BUILD.in

View file


Open in desktop


Empty file.


10 changes: 10 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/a/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
load("@rules_python//python:defs.bzl", "py_library")

py_library(
 name = "a",
 srcs = [
 "bar.py",
 "foo.py",
 ],
 visibility = ["//:__subpackages__"],
)
Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/a/bar.py

View file


Open in desktop


Empty file.

Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/a/foo.py

View file


Open in desktop


Empty file.

Empty file addedgazelle/python/testdata/type_checking_imports_across_packages/b/BUILD.in

View file


Open in desktop


Empty file.


8 changes: 8 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/b/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
load("@rules_python//python:defs.bzl", "py_library")

py_library(
 name = "b",
 srcs = ["b.py"],
 visibility = ["//:__subpackages__"],
 deps = ["//a"],
)

6 changes: 6 additions & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/b/b.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
from typing import TYPE_CHECKING

from a import foo

if TYPE_CHECKING:
 from a import bar

1 change: 1 addition & 0 deletions
gazelle/python/testdata/type_checking_imports_across_packages/test.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
---