Skip to content

Improve Python comments filtering #96

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

Open
Vladyslav-Kuksiuk wants to merge 2 commits into
base: improve-csharp-filtering
Choose a base branch
from
+43 −3
Open

Improve Python comments filtering #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
76e9cf1
Improve python comment filtering.
Vladyslav-Kuksiuk Jul 6, 2026
d213346
Improve tests.
Vladyslav-Kuksiuk Jul 6, 2026
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
17 changes: 14 additions & 3 deletions embedding/commentfilter/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ const (
cStyleBlockCommentEnd = "*/"
cStyleDocCommentStart = "/**"
javaTextBlockDelimiter = "\"\"\""
pythonDoubleQuoteBlock = "\"\"\""
pythonSingleQuoteBlock = "'''"
goRawStringDelimiter = "`"
goQuoteChars = "\"'"
jsQuoteChars = "\"'`"
Expand Down Expand Up @@ -62,9 +64,9 @@ var filtersByExtension = map[string]filterEntry{
".proto": filterConfig(MarkerCommentFilter{Syntax: cStyleSyntax}, regularModes),

// Python
".py": filterConfig(MarkerCommentFilter{Syntax: hashLineSyntax}, noneMode),
".pyi": filterConfig(MarkerCommentFilter{Syntax: hashLineSyntax}, noneMode),
".pyw": filterConfig(MarkerCommentFilter{Syntax: hashLineSyntax}, noneMode),
".py": filterConfig(MarkerCommentFilter{Syntax: pythonSyntax}, noneMode),
".pyi": filterConfig(MarkerCommentFilter{Syntax: pythonSyntax}, noneMode),
".pyw": filterConfig(MarkerCommentFilter{Syntax: pythonSyntax}, noneMode),

// YAML
".yml": filterConfig(MarkerCommentFilter{Syntax: hashLineSyntax}, noneMode),
Expand Down Expand Up @@ -131,6 +133,15 @@ var hashLineSyntax = CommentMarker{
QuoteChars: "\"'",
}

var pythonSyntax = CommentMarker{
Inline: []string{"#"},
TextBlocks: []TextBlockMarker{
{Delimiter: pythonDoubleQuoteBlock, Escapes: true},
{Delimiter: pythonSingleQuoteBlock, Escapes: true},
},
QuoteChars: "\"'",
}

var xmlSyntax = CommentMarker{
Block: []BlockMarker{
{Start: "<!--", End: "-->"},
Expand Down
29 changes: 29 additions & 0 deletions embedding/commentfilter/python_filter_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,33 @@ var _ = Describe("Python", func() {

assertFiltered("module.py", RetainNone, lines, expected)
})

It("should strip comments without treating triple-quoted string content as comments", func() {
lines := []string{
"# module comment",
"def message():",
" \"\"\"",
" Keep this # docstring text.",
" \"\"\"",
` escaped = """a\"""" # inline comment`,
" value = '''",
" Keep this # multiline text.",
" ''' # inline comment",
" return value # real comment",
}

expected := []string{
"def message():",
" \"\"\"",
" Keep this # docstring text.",
" \"\"\"",
` escaped = """a\"""" `,
" value = '''",
" Keep this # multiline text.",
" ''' ",
" return value ",
}

assertFiltered("module.py", RetainNone, lines, expected)
})
})
Loading