Skip to content

fix(gazelle) Update gazelle to properly process multi-line python imports#3077

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 4 commits into from
Jul 15, 2025
Merged

fix(gazelle) Update gazelle to properly process multi-line python imports #3077

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ad7fbfa
clean python imports
yushan8 Jul 10, 2025
7f53d6c
Update
yushan8 Jul 10, 2025
f602ffa
address comments
yushan8 Jul 14, 2025
2e4b828
Merge branch 'main' into clean-python-imports
dougthor42 Jul 14, 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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -87,6 +87,7 @@ END_UNRELEASED_TEMPLATE
({gh-issue}`3043`).
* (pypi) The pipstar `defaults` configuration now supports any custom platform
name.
* Multi-line python imports (e.g. with escaped newlines) are now correctly processed by Gazelle.

{#v0-0-0-added}
### Added
Expand Down
14 changes: 14 additions & 0 deletions gazelle/python/file_parser.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -144,6 +144,16 @@ func parseImportStatement(node *sitter.Node, code []byte) (Module, bool) {
return Module{}, false
}

// cleanImportString removes backslashes and all whitespace from the string.
func cleanImportString(s string) string {
s = strings.ReplaceAll(s, "\r\n", "")
s = strings.ReplaceAll(s, "\\", "")
s = strings.ReplaceAll(s, " ", "")
s = strings.ReplaceAll(s, "\n", "")
Comment thread
yushan26 marked this conversation as resolved.
s = strings.ReplaceAll(s, "\t", "")
return s
}

// parseImportStatements parses a node for import statements, returning true if the node is
// an import statement. It updates FileParser.output.Modules with the `module` that the
// import represents.
Expand All@@ -154,6 +164,8 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
if !ok {
continue
}
m.From = cleanImportString(m.From)
m.Name = cleanImportString(m.Name)
m.Filepath = p.relFilepath
m.TypeCheckingOnly = p.inTypeCheckingBlock
if strings.HasPrefix(m.Name, ".") {
Expand All@@ -163,6 +175,7 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
}
} else if node.Type() == sitterNodeTypeImportFromStatement {
from := node.Child(1).Content(p.code)
from = cleanImportString(from)
// If the import is from the current package, we don't need to add it to the modules i.e. from . import Class1.
// If the import is from a different relative package i.e. from .package1 import foo, we need to add it to the modules.
if from == "." {
Expand All@@ -175,6 +188,7 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
}
m.Filepath = p.relFilepath
m.From = from
m.Name = cleanImportString(m.Name)
m.Name = fmt.Sprintf("%s.%s", from, m.Name)
m.TypeCheckingOnly = p.inTypeCheckingBlock
p.output.Modules = append(p.output.Modules, m)
Expand Down
92 changes: 92 additions & 0 deletions gazelle/python/file_parser_test.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -291,3 +291,95 @@ def example_function():
}
}
}

func TestParseImportStatements_MultilineWithBackslashAndWhitespace(t *testing.T) {
t.Parallel()
t.Run("multiline from import", func(t *testing.T) {
p := NewFileParser()
code := []byte(`from foo.bar.\
baz import (
Something,
AnotherThing
)
Comment thread
yushan26 marked this conversation as resolved.

from foo\
.test import (
Foo,
Bar
)
`)
p.SetCodeAndFile(code, "", "test.py")
output, err := p.Parse(context.Background())
assert.NoError(t, err)
// Updated expected to match parser output
expected := []Module{
{
Name: "foo.bar.baz.Something",
LineNumber: 3,
Filepath: "test.py",
From: "foo.bar.baz",
},
{
Name: "foo.bar.baz.AnotherThing",
LineNumber: 4,
Filepath: "test.py",
From: "foo.bar.baz",
},
{
Name: "foo.test.Foo",
LineNumber: 9,
Filepath: "test.py",
From: "foo.test",
},
{
Name: "foo.test.Bar",
LineNumber: 10,
Filepath: "test.py",
From: "foo.test",
},
}
assert.ElementsMatch(t, expected, output.Modules)
})
t.Run("multiline import", func(t *testing.T) {
p := NewFileParser()
code := []byte(`import foo.bar.\
baz
`)
p.SetCodeAndFile(code, "", "test.py")
output, err := p.Parse(context.Background())
assert.NoError(t, err)
// Updated expected to match parser output
expected := []Module{
{
Name: "foo.bar.baz",
LineNumber: 1,
Filepath: "test.py",
From: "",
},
}
assert.ElementsMatch(t, expected, output.Modules)
})
t.Run("windows line endings", func(t *testing.T) {
p := NewFileParser()
code := []byte("from foo.bar.\r\n baz import (\r\n Something,\r\n AnotherThing\r\n)\r\n")
p.SetCodeAndFile(code, "", "test.py")
output, err := p.Parse(context.Background())
assert.NoError(t, err)
// Updated expected to match parser output
expected := []Module{
{
Name: "foo.bar.baz.Something",
LineNumber: 3,
Filepath: "test.py",
From: "foo.bar.baz",
},
{
Name: "foo.bar.baz.AnotherThing",
LineNumber: 4,
Filepath: "test.py",
From: "foo.bar.baz",
},
}
assert.ElementsMatch(t, expected, output.Modules)
})
}
6 changes: 5 additions & 1 deletion gazelle/python/testdata/from_imports/import_nested_var/__init__.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,4 +13,8 @@
# limitations under the License.

# baz is a variable in foo/bar/baz.py
from foo.bar.baz import baz
from foo\
.bar.\
baz import (
baz
)
, '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) Update gazelle to properly process multi-line python imports by yushan26 · Pull Request #3077 · bazel-contrib/rules_python · GitHub
Skip to content
fix(gazelle) Update gazelle to properly process multi-line python imports#3077

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 4 commits into

from

Jul 15, 2025
 Merged


fix(gazelle) Update gazelle to properly process multi-line python imports
#3077
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
ad7fbfa

clean python imports


yushan8 Jul 10, 2025
7f53d6c

Update


yushan8 Jul 10, 2025
f602ffa

address comments


yushan8 Jul 14, 2025
2e4b828

Merge branch 'main' into clean-python-imports


dougthor42 Jul 14, 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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,6 +87,7 @@ END_UNRELEASED_TEMPLATE
 ({gh-issue}`3043`).
* (pypi) The pipstar `defaults` configuration now supports any custom platform
 name.
* Multi-line python imports (e.g. with escaped newlines) are now correctly processed by Gazelle.

{#v0-0-0-added}
### Added
Expand Down

14 changes: 14 additions & 0 deletions
gazelle/python/file_parser.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -144,6 +144,16 @@ func parseImportStatement(node *sitter.Node, code []byte) (Module, bool) {
	return Module{}, false
}

// cleanImportString removes backslashes and all whitespace from the string.
func cleanImportString(s string) string {
	s = strings.ReplaceAll(s, "\r\n", "")
	s = strings.ReplaceAll(s, "\\", "")
	s = strings.ReplaceAll(s, " ", "")
	s = strings.ReplaceAll(s, "\n", "")
Comment thread
yushan26 marked this conversation as resolved.

	s = strings.ReplaceAll(s, "\t", "")
	return s
}

// parseImportStatements parses a node for import statements, returning true if the node is
// an import statement. It updates FileParser.output.Modules with the `module` that the
// import represents.
Expand All@@ -154,6 +164,8 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
 if !ok {
 continue
 }
 m.From = cleanImportString(m.From)
 m.Name = cleanImportString(m.Name)
 m.Filepath = p.relFilepath
 m.TypeCheckingOnly = p.inTypeCheckingBlock
 if strings.HasPrefix(m.Name, ".") {
Expand All@@ -163,6 +175,7 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
 }
	} else if node.Type() == sitterNodeTypeImportFromStatement {
 from := node.Child(1).Content(p.code)
 from = cleanImportString(from)
 // If the import is from the current package, we don't need to add it to the modules i.e. from . import Class1.
 // If the import is from a different relative package i.e. from .package1 import foo, we need to add it to the modules.
 if from == "." {
Expand All@@ -175,6 +188,7 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
 }
 m.Filepath = p.relFilepath
 m.From = from
 m.Name = cleanImportString(m.Name)
 m.Name = fmt.Sprintf("%s.%s", from, m.Name)
 m.TypeCheckingOnly = p.inTypeCheckingBlock
 p.output.Modules = append(p.output.Modules, m)
Expand Down

92 changes: 92 additions & 0 deletions
gazelle/python/file_parser_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -291,3 +291,95 @@ def example_function():
 }
	}
}

func TestParseImportStatements_MultilineWithBackslashAndWhitespace(t *testing.T) {
	t.Parallel()
	t.Run("multiline from import", func(t *testing.T) {
 p := NewFileParser()
 code := []byte(`from foo.bar.\
 baz import (
 Something,
 AnotherThing
)
Comment thread
yushan26 marked this conversation as resolved.


from foo\
	.test import (
 Foo,
 Bar
)
`)
 p.SetCodeAndFile(code, "", "test.py")
 output, err := p.Parse(context.Background())
 assert.NoError(t, err)
 // Updated expected to match parser output
 expected := []Module{
 {
 Name: "foo.bar.baz.Something",
 LineNumber: 3,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 {
 Name: "foo.bar.baz.AnotherThing",
 LineNumber: 4,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 {
 Name: "foo.test.Foo",
 LineNumber: 9,
 Filepath: "test.py",
 From: "foo.test",
 },
 {
 Name: "foo.test.Bar",
 LineNumber: 10,
 Filepath: "test.py",
 From: "foo.test",
 },
 }
 assert.ElementsMatch(t, expected, output.Modules)
	})
	t.Run("multiline import", func(t *testing.T) {
 p := NewFileParser()
 code := []byte(`import foo.bar.\
 baz
`)
 p.SetCodeAndFile(code, "", "test.py")
 output, err := p.Parse(context.Background())
 assert.NoError(t, err)
 // Updated expected to match parser output
 expected := []Module{
 {
 Name: "foo.bar.baz",
 LineNumber: 1,
 Filepath: "test.py",
 From: "",
 },
 }
 assert.ElementsMatch(t, expected, output.Modules)
	})
	t.Run("windows line endings", func(t *testing.T) {
 p := NewFileParser()
 code := []byte("from foo.bar.\r\n baz import (\r\n Something,\r\n AnotherThing\r\n)\r\n")
 p.SetCodeAndFile(code, "", "test.py")
 output, err := p.Parse(context.Background())
 assert.NoError(t, err)
 // Updated expected to match parser output
 expected := []Module{
 {
 Name: "foo.bar.baz.Something",
 LineNumber: 3,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 {
 Name: "foo.bar.baz.AnotherThing",
 LineNumber: 4,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 }
 assert.ElementsMatch(t, expected, output.Modules)
	})
}

6 changes: 5 additions & 1 deletion
gazelle/python/testdata/from_imports/import_nested_var/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,4 +13,8 @@
# limitations under the License.

# baz is a variable in foo/bar/baz.py
from foo.bar.baz import baz
from foo\
 .bar.\
 baz import (
 baz
 )

, '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) Update gazelle to properly process multi-line python imports by yushan26 · Pull Request #3077 · bazel-contrib/rules_python · GitHub
Skip to content
fix(gazelle) Update gazelle to properly process multi-line python imports#3077

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 4 commits into

from

Jul 15, 2025
 Merged


fix(gazelle) Update gazelle to properly process multi-line python imports
#3077
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
ad7fbfa

clean python imports


yushan8 Jul 10, 2025
7f53d6c

Update


yushan8 Jul 10, 2025
f602ffa

address comments


yushan8 Jul 14, 2025
2e4b828

Merge branch 'main' into clean-python-imports


dougthor42 Jul 14, 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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,6 +87,7 @@ END_UNRELEASED_TEMPLATE
 ({gh-issue}`3043`).
* (pypi) The pipstar `defaults` configuration now supports any custom platform
 name.
* Multi-line python imports (e.g. with escaped newlines) are now correctly processed by Gazelle.

{#v0-0-0-added}
### Added
Expand Down

14 changes: 14 additions & 0 deletions
gazelle/python/file_parser.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -144,6 +144,16 @@ func parseImportStatement(node *sitter.Node, code []byte) (Module, bool) {
	return Module{}, false
}

// cleanImportString removes backslashes and all whitespace from the string.
func cleanImportString(s string) string {
	s = strings.ReplaceAll(s, "\r\n", "")
	s = strings.ReplaceAll(s, "\\", "")
	s = strings.ReplaceAll(s, " ", "")
	s = strings.ReplaceAll(s, "\n", "")
Comment thread
yushan26 marked this conversation as resolved.

	s = strings.ReplaceAll(s, "\t", "")
	return s
}

// parseImportStatements parses a node for import statements, returning true if the node is
// an import statement. It updates FileParser.output.Modules with the `module` that the
// import represents.
Expand All@@ -154,6 +164,8 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
 if !ok {
 continue
 }
 m.From = cleanImportString(m.From)
 m.Name = cleanImportString(m.Name)
 m.Filepath = p.relFilepath
 m.TypeCheckingOnly = p.inTypeCheckingBlock
 if strings.HasPrefix(m.Name, ".") {
Expand All@@ -163,6 +175,7 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
 }
	} else if node.Type() == sitterNodeTypeImportFromStatement {
 from := node.Child(1).Content(p.code)
 from = cleanImportString(from)
 // If the import is from the current package, we don't need to add it to the modules i.e. from . import Class1.
 // If the import is from a different relative package i.e. from .package1 import foo, we need to add it to the modules.
 if from == "." {
Expand All@@ -175,6 +188,7 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
 }
 m.Filepath = p.relFilepath
 m.From = from
 m.Name = cleanImportString(m.Name)
 m.Name = fmt.Sprintf("%s.%s", from, m.Name)
 m.TypeCheckingOnly = p.inTypeCheckingBlock
 p.output.Modules = append(p.output.Modules, m)
Expand Down

92 changes: 92 additions & 0 deletions
gazelle/python/file_parser_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -291,3 +291,95 @@ def example_function():
 }
	}
}

func TestParseImportStatements_MultilineWithBackslashAndWhitespace(t *testing.T) {
	t.Parallel()
	t.Run("multiline from import", func(t *testing.T) {
 p := NewFileParser()
 code := []byte(`from foo.bar.\
 baz import (
 Something,
 AnotherThing
)
Comment thread
yushan26 marked this conversation as resolved.


from foo\
	.test import (
 Foo,
 Bar
)
`)
 p.SetCodeAndFile(code, "", "test.py")
 output, err := p.Parse(context.Background())
 assert.NoError(t, err)
 // Updated expected to match parser output
 expected := []Module{
 {
 Name: "foo.bar.baz.Something",
 LineNumber: 3,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 {
 Name: "foo.bar.baz.AnotherThing",
 LineNumber: 4,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 {
 Name: "foo.test.Foo",
 LineNumber: 9,
 Filepath: "test.py",
 From: "foo.test",
 },
 {
 Name: "foo.test.Bar",
 LineNumber: 10,
 Filepath: "test.py",
 From: "foo.test",
 },
 }
 assert.ElementsMatch(t, expected, output.Modules)
	})
	t.Run("multiline import", func(t *testing.T) {
 p := NewFileParser()
 code := []byte(`import foo.bar.\
 baz
`)
 p.SetCodeAndFile(code, "", "test.py")
 output, err := p.Parse(context.Background())
 assert.NoError(t, err)
 // Updated expected to match parser output
 expected := []Module{
 {
 Name: "foo.bar.baz",
 LineNumber: 1,
 Filepath: "test.py",
 From: "",
 },
 }
 assert.ElementsMatch(t, expected, output.Modules)
	})
	t.Run("windows line endings", func(t *testing.T) {
 p := NewFileParser()
 code := []byte("from foo.bar.\r\n baz import (\r\n Something,\r\n AnotherThing\r\n)\r\n")
 p.SetCodeAndFile(code, "", "test.py")
 output, err := p.Parse(context.Background())
 assert.NoError(t, err)
 // Updated expected to match parser output
 expected := []Module{
 {
 Name: "foo.bar.baz.Something",
 LineNumber: 3,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 {
 Name: "foo.bar.baz.AnotherThing",
 LineNumber: 4,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 }
 assert.ElementsMatch(t, expected, output.Modules)
	})
}

6 changes: 5 additions & 1 deletion
gazelle/python/testdata/from_imports/import_nested_var/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,4 +13,8 @@
# limitations under the License.

# baz is a variable in foo/bar/baz.py
from foo.bar.baz import baz
from foo\
 .bar.\
 baz import (
 baz
 )

, '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) Update gazelle to properly process multi-line python imports by yushan26 · Pull Request #3077 · bazel-contrib/rules_python · GitHub
Skip to content
fix(gazelle) Update gazelle to properly process multi-line python imports#3077

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 4 commits into

from

Jul 15, 2025
 Merged


fix(gazelle) Update gazelle to properly process multi-line python imports
#3077
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
ad7fbfa

clean python imports


yushan8 Jul 10, 2025
7f53d6c

Update


yushan8 Jul 10, 2025
f602ffa

address comments


yushan8 Jul 14, 2025
2e4b828

Merge branch 'main' into clean-python-imports


dougthor42 Jul 14, 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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,6 +87,7 @@ END_UNRELEASED_TEMPLATE
 ({gh-issue}`3043`).
* (pypi) The pipstar `defaults` configuration now supports any custom platform
 name.
* Multi-line python imports (e.g. with escaped newlines) are now correctly processed by Gazelle.

{#v0-0-0-added}
### Added
Expand Down

14 changes: 14 additions & 0 deletions
gazelle/python/file_parser.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -144,6 +144,16 @@ func parseImportStatement(node *sitter.Node, code []byte) (Module, bool) {
	return Module{}, false
}

// cleanImportString removes backslashes and all whitespace from the string.
func cleanImportString(s string) string {
	s = strings.ReplaceAll(s, "\r\n", "")
	s = strings.ReplaceAll(s, "\\", "")
	s = strings.ReplaceAll(s, " ", "")
	s = strings.ReplaceAll(s, "\n", "")
Comment thread
yushan26 marked this conversation as resolved.

	s = strings.ReplaceAll(s, "\t", "")
	return s
}

// parseImportStatements parses a node for import statements, returning true if the node is
// an import statement. It updates FileParser.output.Modules with the `module` that the
// import represents.
Expand All@@ -154,6 +164,8 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
 if !ok {
 continue
 }
 m.From = cleanImportString(m.From)
 m.Name = cleanImportString(m.Name)
 m.Filepath = p.relFilepath
 m.TypeCheckingOnly = p.inTypeCheckingBlock
 if strings.HasPrefix(m.Name, ".") {
Expand All@@ -163,6 +175,7 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
 }
	} else if node.Type() == sitterNodeTypeImportFromStatement {
 from := node.Child(1).Content(p.code)
 from = cleanImportString(from)
 // If the import is from the current package, we don't need to add it to the modules i.e. from . import Class1.
 // If the import is from a different relative package i.e. from .package1 import foo, we need to add it to the modules.
 if from == "." {
Expand All@@ -175,6 +188,7 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
 }
 m.Filepath = p.relFilepath
 m.From = from
 m.Name = cleanImportString(m.Name)
 m.Name = fmt.Sprintf("%s.%s", from, m.Name)
 m.TypeCheckingOnly = p.inTypeCheckingBlock
 p.output.Modules = append(p.output.Modules, m)
Expand Down

92 changes: 92 additions & 0 deletions
gazelle/python/file_parser_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -291,3 +291,95 @@ def example_function():
 }
	}
}

func TestParseImportStatements_MultilineWithBackslashAndWhitespace(t *testing.T) {
	t.Parallel()
	t.Run("multiline from import", func(t *testing.T) {
 p := NewFileParser()
 code := []byte(`from foo.bar.\
 baz import (
 Something,
 AnotherThing
)
Comment thread
yushan26 marked this conversation as resolved.


from foo\
	.test import (
 Foo,
 Bar
)
`)
 p.SetCodeAndFile(code, "", "test.py")
 output, err := p.Parse(context.Background())
 assert.NoError(t, err)
 // Updated expected to match parser output
 expected := []Module{
 {
 Name: "foo.bar.baz.Something",
 LineNumber: 3,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 {
 Name: "foo.bar.baz.AnotherThing",
 LineNumber: 4,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 {
 Name: "foo.test.Foo",
 LineNumber: 9,
 Filepath: "test.py",
 From: "foo.test",
 },
 {
 Name: "foo.test.Bar",
 LineNumber: 10,
 Filepath: "test.py",
 From: "foo.test",
 },
 }
 assert.ElementsMatch(t, expected, output.Modules)
	})
	t.Run("multiline import", func(t *testing.T) {
 p := NewFileParser()
 code := []byte(`import foo.bar.\
 baz
`)
 p.SetCodeAndFile(code, "", "test.py")
 output, err := p.Parse(context.Background())
 assert.NoError(t, err)
 // Updated expected to match parser output
 expected := []Module{
 {
 Name: "foo.bar.baz",
 LineNumber: 1,
 Filepath: "test.py",
 From: "",
 },
 }
 assert.ElementsMatch(t, expected, output.Modules)
	})
	t.Run("windows line endings", func(t *testing.T) {
 p := NewFileParser()
 code := []byte("from foo.bar.\r\n baz import (\r\n Something,\r\n AnotherThing\r\n)\r\n")
 p.SetCodeAndFile(code, "", "test.py")
 output, err := p.Parse(context.Background())
 assert.NoError(t, err)
 // Updated expected to match parser output
 expected := []Module{
 {
 Name: "foo.bar.baz.Something",
 LineNumber: 3,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 {
 Name: "foo.bar.baz.AnotherThing",
 LineNumber: 4,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 }
 assert.ElementsMatch(t, expected, output.Modules)
	})
}

6 changes: 5 additions & 1 deletion
gazelle/python/testdata/from_imports/import_nested_var/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,4 +13,8 @@
# limitations under the License.

# baz is a variable in foo/bar/baz.py
from foo.bar.baz import baz
from foo\
 .bar.\
 baz import (
 baz
 )

, '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) Update gazelle to properly process multi-line python imports by yushan26 · Pull Request #3077 · bazel-contrib/rules_python · GitHub
Skip to content
fix(gazelle) Update gazelle to properly process multi-line python imports#3077

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 4 commits into

from

Jul 15, 2025
 Merged


fix(gazelle) Update gazelle to properly process multi-line python imports
#3077
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
ad7fbfa

clean python imports


yushan8 Jul 10, 2025
7f53d6c

Update


yushan8 Jul 10, 2025
f602ffa

address comments


yushan8 Jul 14, 2025
2e4b828

Merge branch 'main' into clean-python-imports


dougthor42 Jul 14, 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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,6 +87,7 @@ END_UNRELEASED_TEMPLATE
 ({gh-issue}`3043`).
* (pypi) The pipstar `defaults` configuration now supports any custom platform
 name.
* Multi-line python imports (e.g. with escaped newlines) are now correctly processed by Gazelle.

{#v0-0-0-added}
### Added
Expand Down

14 changes: 14 additions & 0 deletions
gazelle/python/file_parser.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -144,6 +144,16 @@ func parseImportStatement(node *sitter.Node, code []byte) (Module, bool) {
	return Module{}, false
}

// cleanImportString removes backslashes and all whitespace from the string.
func cleanImportString(s string) string {
	s = strings.ReplaceAll(s, "\r\n", "")
	s = strings.ReplaceAll(s, "\\", "")
	s = strings.ReplaceAll(s, " ", "")
	s = strings.ReplaceAll(s, "\n", "")
Comment thread
yushan26 marked this conversation as resolved.

	s = strings.ReplaceAll(s, "\t", "")
	return s
}

// parseImportStatements parses a node for import statements, returning true if the node is
// an import statement. It updates FileParser.output.Modules with the `module` that the
// import represents.
Expand All@@ -154,6 +164,8 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
 if !ok {
 continue
 }
 m.From = cleanImportString(m.From)
 m.Name = cleanImportString(m.Name)
 m.Filepath = p.relFilepath
 m.TypeCheckingOnly = p.inTypeCheckingBlock
 if strings.HasPrefix(m.Name, ".") {
Expand All@@ -163,6 +175,7 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
 }
	} else if node.Type() == sitterNodeTypeImportFromStatement {
 from := node.Child(1).Content(p.code)
 from = cleanImportString(from)
 // If the import is from the current package, we don't need to add it to the modules i.e. from . import Class1.
 // If the import is from a different relative package i.e. from .package1 import foo, we need to add it to the modules.
 if from == "." {
Expand All@@ -175,6 +188,7 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
 }
 m.Filepath = p.relFilepath
 m.From = from
 m.Name = cleanImportString(m.Name)
 m.Name = fmt.Sprintf("%s.%s", from, m.Name)
 m.TypeCheckingOnly = p.inTypeCheckingBlock
 p.output.Modules = append(p.output.Modules, m)
Expand Down

92 changes: 92 additions & 0 deletions
gazelle/python/file_parser_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -291,3 +291,95 @@ def example_function():
 }
	}
}

func TestParseImportStatements_MultilineWithBackslashAndWhitespace(t *testing.T) {
	t.Parallel()
	t.Run("multiline from import", func(t *testing.T) {
 p := NewFileParser()
 code := []byte(`from foo.bar.\
 baz import (
 Something,
 AnotherThing
)
Comment thread
yushan26 marked this conversation as resolved.


from foo\
	.test import (
 Foo,
 Bar
)
`)
 p.SetCodeAndFile(code, "", "test.py")
 output, err := p.Parse(context.Background())
 assert.NoError(t, err)
 // Updated expected to match parser output
 expected := []Module{
 {
 Name: "foo.bar.baz.Something",
 LineNumber: 3,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 {
 Name: "foo.bar.baz.AnotherThing",
 LineNumber: 4,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 {
 Name: "foo.test.Foo",
 LineNumber: 9,
 Filepath: "test.py",
 From: "foo.test",
 },
 {
 Name: "foo.test.Bar",
 LineNumber: 10,
 Filepath: "test.py",
 From: "foo.test",
 },
 }
 assert.ElementsMatch(t, expected, output.Modules)
	})
	t.Run("multiline import", func(t *testing.T) {
 p := NewFileParser()
 code := []byte(`import foo.bar.\
 baz
`)
 p.SetCodeAndFile(code, "", "test.py")
 output, err := p.Parse(context.Background())
 assert.NoError(t, err)
 // Updated expected to match parser output
 expected := []Module{
 {
 Name: "foo.bar.baz",
 LineNumber: 1,
 Filepath: "test.py",
 From: "",
 },
 }
 assert.ElementsMatch(t, expected, output.Modules)
	})
	t.Run("windows line endings", func(t *testing.T) {
 p := NewFileParser()
 code := []byte("from foo.bar.\r\n baz import (\r\n Something,\r\n AnotherThing\r\n)\r\n")
 p.SetCodeAndFile(code, "", "test.py")
 output, err := p.Parse(context.Background())
 assert.NoError(t, err)
 // Updated expected to match parser output
 expected := []Module{
 {
 Name: "foo.bar.baz.Something",
 LineNumber: 3,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 {
 Name: "foo.bar.baz.AnotherThing",
 LineNumber: 4,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 }
 assert.ElementsMatch(t, expected, output.Modules)
	})
}

6 changes: 5 additions & 1 deletion
gazelle/python/testdata/from_imports/import_nested_var/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,4 +13,8 @@
# limitations under the License.

# baz is a variable in foo/bar/baz.py
from foo.bar.baz import baz
from foo\
 .bar.\
 baz import (
 baz
 )

, '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) Update gazelle to properly process multi-line python imports by yushan26 · Pull Request #3077 · bazel-contrib/rules_python · GitHub
Skip to content
fix(gazelle) Update gazelle to properly process multi-line python imports#3077

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 4 commits into

from

Jul 15, 2025
 Merged


fix(gazelle) Update gazelle to properly process multi-line python imports
#3077
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
ad7fbfa

clean python imports


yushan8 Jul 10, 2025
7f53d6c

Update


yushan8 Jul 10, 2025
f602ffa

address comments


yushan8 Jul 14, 2025
2e4b828

Merge branch 'main' into clean-python-imports


dougthor42 Jul 14, 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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,6 +87,7 @@ END_UNRELEASED_TEMPLATE
 ({gh-issue}`3043`).
* (pypi) The pipstar `defaults` configuration now supports any custom platform
 name.
* Multi-line python imports (e.g. with escaped newlines) are now correctly processed by Gazelle.

{#v0-0-0-added}
### Added
Expand Down

14 changes: 14 additions & 0 deletions
gazelle/python/file_parser.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -144,6 +144,16 @@ func parseImportStatement(node *sitter.Node, code []byte) (Module, bool) {
	return Module{}, false
}

// cleanImportString removes backslashes and all whitespace from the string.
func cleanImportString(s string) string {
	s = strings.ReplaceAll(s, "\r\n", "")
	s = strings.ReplaceAll(s, "\\", "")
	s = strings.ReplaceAll(s, " ", "")
	s = strings.ReplaceAll(s, "\n", "")
Comment thread
yushan26 marked this conversation as resolved.

	s = strings.ReplaceAll(s, "\t", "")
	return s
}

// parseImportStatements parses a node for import statements, returning true if the node is
// an import statement. It updates FileParser.output.Modules with the `module` that the
// import represents.
Expand All@@ -154,6 +164,8 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
 if !ok {
 continue
 }
 m.From = cleanImportString(m.From)
 m.Name = cleanImportString(m.Name)
 m.Filepath = p.relFilepath
 m.TypeCheckingOnly = p.inTypeCheckingBlock
 if strings.HasPrefix(m.Name, ".") {
Expand All@@ -163,6 +175,7 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
 }
	} else if node.Type() == sitterNodeTypeImportFromStatement {
 from := node.Child(1).Content(p.code)
 from = cleanImportString(from)
 // If the import is from the current package, we don't need to add it to the modules i.e. from . import Class1.
 // If the import is from a different relative package i.e. from .package1 import foo, we need to add it to the modules.
 if from == "." {
Expand All@@ -175,6 +188,7 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
 }
 m.Filepath = p.relFilepath
 m.From = from
 m.Name = cleanImportString(m.Name)
 m.Name = fmt.Sprintf("%s.%s", from, m.Name)
 m.TypeCheckingOnly = p.inTypeCheckingBlock
 p.output.Modules = append(p.output.Modules, m)
Expand Down

92 changes: 92 additions & 0 deletions
gazelle/python/file_parser_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -291,3 +291,95 @@ def example_function():
 }
	}
}

func TestParseImportStatements_MultilineWithBackslashAndWhitespace(t *testing.T) {
	t.Parallel()
	t.Run("multiline from import", func(t *testing.T) {
 p := NewFileParser()
 code := []byte(`from foo.bar.\
 baz import (
 Something,
 AnotherThing
)
Comment thread
yushan26 marked this conversation as resolved.


from foo\
	.test import (
 Foo,
 Bar
)
`)
 p.SetCodeAndFile(code, "", "test.py")
 output, err := p.Parse(context.Background())
 assert.NoError(t, err)
 // Updated expected to match parser output
 expected := []Module{
 {
 Name: "foo.bar.baz.Something",
 LineNumber: 3,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 {
 Name: "foo.bar.baz.AnotherThing",
 LineNumber: 4,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 {
 Name: "foo.test.Foo",
 LineNumber: 9,
 Filepath: "test.py",
 From: "foo.test",
 },
 {
 Name: "foo.test.Bar",
 LineNumber: 10,
 Filepath: "test.py",
 From: "foo.test",
 },
 }
 assert.ElementsMatch(t, expected, output.Modules)
	})
	t.Run("multiline import", func(t *testing.T) {
 p := NewFileParser()
 code := []byte(`import foo.bar.\
 baz
`)
 p.SetCodeAndFile(code, "", "test.py")
 output, err := p.Parse(context.Background())
 assert.NoError(t, err)
 // Updated expected to match parser output
 expected := []Module{
 {
 Name: "foo.bar.baz",
 LineNumber: 1,
 Filepath: "test.py",
 From: "",
 },
 }
 assert.ElementsMatch(t, expected, output.Modules)
	})
	t.Run("windows line endings", func(t *testing.T) {
 p := NewFileParser()
 code := []byte("from foo.bar.\r\n baz import (\r\n Something,\r\n AnotherThing\r\n)\r\n")
 p.SetCodeAndFile(code, "", "test.py")
 output, err := p.Parse(context.Background())
 assert.NoError(t, err)
 // Updated expected to match parser output
 expected := []Module{
 {
 Name: "foo.bar.baz.Something",
 LineNumber: 3,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 {
 Name: "foo.bar.baz.AnotherThing",
 LineNumber: 4,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 }
 assert.ElementsMatch(t, expected, output.Modules)
	})
}

6 changes: 5 additions & 1 deletion
gazelle/python/testdata/from_imports/import_nested_var/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,4 +13,8 @@
# limitations under the License.

# baz is a variable in foo/bar/baz.py
from foo.bar.baz import baz
from foo\
 .bar.\
 baz import (
 baz
 )

, '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); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(gazelle) Update gazelle to properly process multi-line python imports by yushan26 · Pull Request #3077 · bazel-contrib/rules_python · GitHub
Skip to content
fix(gazelle) Update gazelle to properly process multi-line python imports#3077

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 4 commits into

from

Jul 15, 2025
 Merged


fix(gazelle) Update gazelle to properly process multi-line python imports
#3077
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
ad7fbfa

clean python imports


yushan8 Jul 10, 2025
7f53d6c

Update


yushan8 Jul 10, 2025
f602ffa

address comments


yushan8 Jul 14, 2025
2e4b828

Merge branch 'main' into clean-python-imports


dougthor42 Jul 14, 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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,6 +87,7 @@ END_UNRELEASED_TEMPLATE
 ({gh-issue}`3043`).
* (pypi) The pipstar `defaults` configuration now supports any custom platform
 name.
* Multi-line python imports (e.g. with escaped newlines) are now correctly processed by Gazelle.

{#v0-0-0-added}
### Added
Expand Down

14 changes: 14 additions & 0 deletions
gazelle/python/file_parser.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -144,6 +144,16 @@ func parseImportStatement(node *sitter.Node, code []byte) (Module, bool) {
	return Module{}, false
}

// cleanImportString removes backslashes and all whitespace from the string.
func cleanImportString(s string) string {
	s = strings.ReplaceAll(s, "\r\n", "")
	s = strings.ReplaceAll(s, "\\", "")
	s = strings.ReplaceAll(s, " ", "")
	s = strings.ReplaceAll(s, "\n", "")
Comment thread
yushan26 marked this conversation as resolved.

	s = strings.ReplaceAll(s, "\t", "")
	return s
}

// parseImportStatements parses a node for import statements, returning true if the node is
// an import statement. It updates FileParser.output.Modules with the `module` that the
// import represents.
Expand All@@ -154,6 +164,8 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
 if !ok {
 continue
 }
 m.From = cleanImportString(m.From)
 m.Name = cleanImportString(m.Name)
 m.Filepath = p.relFilepath
 m.TypeCheckingOnly = p.inTypeCheckingBlock
 if strings.HasPrefix(m.Name, ".") {
Expand All@@ -163,6 +175,7 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
 }
	} else if node.Type() == sitterNodeTypeImportFromStatement {
 from := node.Child(1).Content(p.code)
 from = cleanImportString(from)
 // If the import is from the current package, we don't need to add it to the modules i.e. from . import Class1.
 // If the import is from a different relative package i.e. from .package1 import foo, we need to add it to the modules.
 if from == "." {
Expand All@@ -175,6 +188,7 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
 }
 m.Filepath = p.relFilepath
 m.From = from
 m.Name = cleanImportString(m.Name)
 m.Name = fmt.Sprintf("%s.%s", from, m.Name)
 m.TypeCheckingOnly = p.inTypeCheckingBlock
 p.output.Modules = append(p.output.Modules, m)
Expand Down

92 changes: 92 additions & 0 deletions
gazelle/python/file_parser_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -291,3 +291,95 @@ def example_function():
 }
	}
}

func TestParseImportStatements_MultilineWithBackslashAndWhitespace(t *testing.T) {
	t.Parallel()
	t.Run("multiline from import", func(t *testing.T) {
 p := NewFileParser()
 code := []byte(`from foo.bar.\
 baz import (
 Something,
 AnotherThing
)
Comment thread
yushan26 marked this conversation as resolved.


from foo\
	.test import (
 Foo,
 Bar
)
`)
 p.SetCodeAndFile(code, "", "test.py")
 output, err := p.Parse(context.Background())
 assert.NoError(t, err)
 // Updated expected to match parser output
 expected := []Module{
 {
 Name: "foo.bar.baz.Something",
 LineNumber: 3,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 {
 Name: "foo.bar.baz.AnotherThing",
 LineNumber: 4,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 {
 Name: "foo.test.Foo",
 LineNumber: 9,
 Filepath: "test.py",
 From: "foo.test",
 },
 {
 Name: "foo.test.Bar",
 LineNumber: 10,
 Filepath: "test.py",
 From: "foo.test",
 },
 }
 assert.ElementsMatch(t, expected, output.Modules)
	})
	t.Run("multiline import", func(t *testing.T) {
 p := NewFileParser()
 code := []byte(`import foo.bar.\
 baz
`)
 p.SetCodeAndFile(code, "", "test.py")
 output, err := p.Parse(context.Background())
 assert.NoError(t, err)
 // Updated expected to match parser output
 expected := []Module{
 {
 Name: "foo.bar.baz",
 LineNumber: 1,
 Filepath: "test.py",
 From: "",
 },
 }
 assert.ElementsMatch(t, expected, output.Modules)
	})
	t.Run("windows line endings", func(t *testing.T) {
 p := NewFileParser()
 code := []byte("from foo.bar.\r\n baz import (\r\n Something,\r\n AnotherThing\r\n)\r\n")
 p.SetCodeAndFile(code, "", "test.py")
 output, err := p.Parse(context.Background())
 assert.NoError(t, err)
 // Updated expected to match parser output
 expected := []Module{
 {
 Name: "foo.bar.baz.Something",
 LineNumber: 3,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 {
 Name: "foo.bar.baz.AnotherThing",
 LineNumber: 4,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 }
 assert.ElementsMatch(t, expected, output.Modules)
	})
}

6 changes: 5 additions & 1 deletion
gazelle/python/testdata/from_imports/import_nested_var/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,4 +13,8 @@
# limitations under the License.

# baz is a variable in foo/bar/baz.py
from foo.bar.baz import baz
from foo\
 .bar.\
 baz import (
 baz
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
fix(gazelle) Update gazelle to properly process multi-line python imports by yushan26 · Pull Request #3077 · bazel-contrib/rules_python · GitHub
Skip to content
fix(gazelle) Update gazelle to properly process multi-line python imports#3077

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 4 commits into

from

Jul 15, 2025
 Merged


fix(gazelle) Update gazelle to properly process multi-line python imports
#3077
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
ad7fbfa

clean python imports


yushan8 Jul 10, 2025
7f53d6c

Update


yushan8 Jul 10, 2025
f602ffa

address comments


yushan8 Jul 14, 2025
2e4b828

Merge branch 'main' into clean-python-imports


dougthor42 Jul 14, 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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,6 +87,7 @@ END_UNRELEASED_TEMPLATE
 ({gh-issue}`3043`).
* (pypi) The pipstar `defaults` configuration now supports any custom platform
 name.
* Multi-line python imports (e.g. with escaped newlines) are now correctly processed by Gazelle.

{#v0-0-0-added}
### Added
Expand Down

14 changes: 14 additions & 0 deletions
gazelle/python/file_parser.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -144,6 +144,16 @@ func parseImportStatement(node *sitter.Node, code []byte) (Module, bool) {
	return Module{}, false
}

// cleanImportString removes backslashes and all whitespace from the string.
func cleanImportString(s string) string {
	s = strings.ReplaceAll(s, "\r\n", "")
	s = strings.ReplaceAll(s, "\\", "")
	s = strings.ReplaceAll(s, " ", "")
	s = strings.ReplaceAll(s, "\n", "")
Comment thread
yushan26 marked this conversation as resolved.

	s = strings.ReplaceAll(s, "\t", "")
	return s
}

// parseImportStatements parses a node for import statements, returning true if the node is
// an import statement. It updates FileParser.output.Modules with the `module` that the
// import represents.
Expand All@@ -154,6 +164,8 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
 if !ok {
 continue
 }
 m.From = cleanImportString(m.From)
 m.Name = cleanImportString(m.Name)
 m.Filepath = p.relFilepath
 m.TypeCheckingOnly = p.inTypeCheckingBlock
 if strings.HasPrefix(m.Name, ".") {
Expand All@@ -163,6 +175,7 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
 }
	} else if node.Type() == sitterNodeTypeImportFromStatement {
 from := node.Child(1).Content(p.code)
 from = cleanImportString(from)
 // If the import is from the current package, we don't need to add it to the modules i.e. from . import Class1.
 // If the import is from a different relative package i.e. from .package1 import foo, we need to add it to the modules.
 if from == "." {
Expand All@@ -175,6 +188,7 @@ func (p *FileParser) parseImportStatements(node *sitter.Node) bool {
 }
 m.Filepath = p.relFilepath
 m.From = from
 m.Name = cleanImportString(m.Name)
 m.Name = fmt.Sprintf("%s.%s", from, m.Name)
 m.TypeCheckingOnly = p.inTypeCheckingBlock
 p.output.Modules = append(p.output.Modules, m)
Expand Down

92 changes: 92 additions & 0 deletions
gazelle/python/file_parser_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -291,3 +291,95 @@ def example_function():
 }
	}
}

func TestParseImportStatements_MultilineWithBackslashAndWhitespace(t *testing.T) {
	t.Parallel()
	t.Run("multiline from import", func(t *testing.T) {
 p := NewFileParser()
 code := []byte(`from foo.bar.\
 baz import (
 Something,
 AnotherThing
)
Comment thread
yushan26 marked this conversation as resolved.


from foo\
	.test import (
 Foo,
 Bar
)
`)
 p.SetCodeAndFile(code, "", "test.py")
 output, err := p.Parse(context.Background())
 assert.NoError(t, err)
 // Updated expected to match parser output
 expected := []Module{
 {
 Name: "foo.bar.baz.Something",
 LineNumber: 3,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 {
 Name: "foo.bar.baz.AnotherThing",
 LineNumber: 4,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 {
 Name: "foo.test.Foo",
 LineNumber: 9,
 Filepath: "test.py",
 From: "foo.test",
 },
 {
 Name: "foo.test.Bar",
 LineNumber: 10,
 Filepath: "test.py",
 From: "foo.test",
 },
 }
 assert.ElementsMatch(t, expected, output.Modules)
	})
	t.Run("multiline import", func(t *testing.T) {
 p := NewFileParser()
 code := []byte(`import foo.bar.\
 baz
`)
 p.SetCodeAndFile(code, "", "test.py")
 output, err := p.Parse(context.Background())
 assert.NoError(t, err)
 // Updated expected to match parser output
 expected := []Module{
 {
 Name: "foo.bar.baz",
 LineNumber: 1,
 Filepath: "test.py",
 From: "",
 },
 }
 assert.ElementsMatch(t, expected, output.Modules)
	})
	t.Run("windows line endings", func(t *testing.T) {
 p := NewFileParser()
 code := []byte("from foo.bar.\r\n baz import (\r\n Something,\r\n AnotherThing\r\n)\r\n")
 p.SetCodeAndFile(code, "", "test.py")
 output, err := p.Parse(context.Background())
 assert.NoError(t, err)
 // Updated expected to match parser output
 expected := []Module{
 {
 Name: "foo.bar.baz.Something",
 LineNumber: 3,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 {
 Name: "foo.bar.baz.AnotherThing",
 LineNumber: 4,
 Filepath: "test.py",
 From: "foo.bar.baz",
 },
 }
 assert.ElementsMatch(t, expected, output.Modules)
	})
}

6 changes: 5 additions & 1 deletion
gazelle/python/testdata/from_imports/import_nested_var/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,4 +13,8 @@
# limitations under the License.

# baz is a variable in foo/bar/baz.py
from foo.bar.baz import baz
from foo\
 .bar.\
 baz import (
 baz
 )