Skip to content

feat: Creating one py_binary per main module#1584

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
aignas merged 13 commits into from
Dec 13, 2023
Merged

feat: Creating one py_binary per main module #1584

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
2c178ae
Creating one py_binary per main module
linzhp Nov 29, 2023
401125f
revert accidental changes
linzhp Nov 29, 2023
c436ec8
handle empty lines
linzhp Nov 29, 2023
1784a99
reimplementing parse_main to fix a failing test
linzhp Nov 29, 2023
050efeb
fixed error message
linzhp Nov 29, 2023
d1b0593
Adding test cases for multiple py_binary and tests files
linzhp Dec 3, 2023
b6999fa
Merge branch 'main' into py_binary
linzhp Dec 3, 2023
2423b0c
sorting py_binary
linzhp Dec 3, 2023
bb82dde
fix test failures
linzhp Dec 4, 2023
38c10a9
increase timeout for requirements_3_10_test
linzhp Dec 4, 2023
bbd0389
formatting build file
linzhp Dec 4, 2023
de9ce9b
revert bazel version change
linzhp Dec 4, 2023
94e6327
extracting ensureNoCollision
linzhp Dec 9, 2023
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 examples/bzlmod/BUILD.bazel
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ compile_pip_requirements_3_9(
# with pip-compile.
compile_pip_requirements_3_10(
name = "requirements_3_10",
timeout = "moderate",
src = "requirements.in",
requirements_txt = "requirements_lock_3_10.txt",
requirements_windows = "requirements_windows_3_10.txt",
Expand Down
11 changes: 10 additions & 1 deletion gazelle/python/BUILD.bazel
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
load("@bazel_gazelle//:def.bzl", "gazelle_binary")
load("@io_bazel_rules_go//go:def.bzl", "go_library")
load("@rules_python//python:defs.bzl", "py_binary")
load("@rules_python//python:defs.bzl", "py_binary", "py_test")
load(":gazelle_test.bzl", "gazelle_test")

go_library(
Expand DownExpand Up@@ -58,6 +58,15 @@ py_binary(
visibility = ["//visibility:public"],
)

py_test(
name = "parse_test",
srcs = [
"parse.py",
"parse_test.py",
],
imports = ["."],
)

filegroup(
name = "helper.zip",
srcs = [":helper"],
Expand Down
2 changes: 1 addition & 1 deletion gazelle/python/__main__.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@

if __name__ == "__main__":
if len(sys.argv) < 2:
sys.exit("Please provide subcommand, either print or std_modules")
sys.exit("Please provide subcommand, either parse or std_modules")
if sys.argv[1] == "parse":
sys.exit(parse.main(sys.stdin, sys.stdout))
elif sys.argv[1] == "std_modules":
Expand Down
115 changes: 65 additions & 50 deletions gazelle/python/generate.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import (
"log"
"os"
"path/filepath"
"sort"
"strings"

"github.com/bazelbuild/bazel-gazelle/config"
Expand DownExpand Up@@ -89,9 +90,9 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
pyTestFilenames := treeset.NewWith(godsutils.StringComparator)
pyFileNames := treeset.NewWith(godsutils.StringComparator)

// hasPyBinary controls whether a py_binary target should be generated for
// hasPyBinaryEntryPointFile controls whether a single py_binary target should be generated for
// this package or not.
hasPyBinary := false
hasPyBinaryEntryPointFile := false

// hasPyTestEntryPointFile and hasPyTestEntryPointTarget control whether a py_test target should
// be generated for this package or not.
Expand All@@ -106,8 +107,8 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
ext := filepath.Ext(f)
if ext == ".py" {
pyFileNames.Add(f)
if !hasPyBinary && f == pyBinaryEntrypointFilename {
hasPyBinary = true
if !hasPyBinaryEntryPointFile && f == pyBinaryEntrypointFilename {
hasPyBinaryEntryPointFile = true
} else if !hasPyTestEntryPointFile && f == pyTestEntrypointFilename {
hasPyTestEntryPointFile = true
} else if f == conftestFilename {
Expand DownExpand Up@@ -219,7 +220,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
collisionErrors := singlylinkedlist.New()

appendPyLibrary := func(srcs *treeset.Set, pyLibraryTargetName string) {
deps, err := parser.parse(srcs)
deps, mainModules, err := parser.parse(srcs)
if err != nil {
log.Fatalf("ERROR: %v\n", err)
}
Expand All@@ -228,16 +229,33 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
// exists, and if it is of a different kind from the one we are
// generating. If so, we have to throw an error since Gazelle won't
// generate it correctly.
if args.File != nil {
for _, t := range args.File.Rules {
if t.Name() == pyLibraryTargetName && t.Kind() != actualPyLibraryKind {
fqTarget := label.New("", args.Rel, pyLibraryTargetName)
err := fmt.Errorf("failed to generate target %q of kind %q: "+
"a target of kind %q with the same name already exists. "+
"Use the '# gazelle:%s' directive to change the naming convention.",
fqTarget.String(), actualPyLibraryKind, t.Kind(), pythonconfig.LibraryNamingConvention)
collisionErrors.Add(err)
if err := ensureNoCollision(args.File, pyLibraryTargetName, actualPyLibraryKind); err != nil {
fqTarget := label.New("", args.Rel, pyLibraryTargetName)
err := fmt.Errorf("failed to generate target %q of kind %q: %w. "+
"Use the '# gazelle:%s' directive to change the naming convention.",
fqTarget.String(), actualPyLibraryKind, err, pythonconfig.LibraryNamingConvention)
collisionErrors.Add(err)
}

if !hasPyBinaryEntryPointFile {
sort.Strings(mainModules)
// Creating one py_binary target per main module when __main__.py doesn't exist.
for _, filename := range mainModules {
pyBinaryTargetName := strings.TrimSuffix(filepath.Base(filename), ".py")
if err := ensureNoCollision(args.File, pyBinaryTargetName, actualPyBinaryKind); err != nil {
fqTarget := label.New("", args.Rel, pyBinaryTargetName)
log.Printf("failed to generate target %q of kind %q: %v",
fqTarget.String(), actualPyBinaryKind, err)
continue
}
srcs.Remove(filename)
pyBinary := newTargetBuilder(pyBinaryKind, pyBinaryTargetName, pythonProjectRoot, args.Rel, pyFileNames).
addVisibility(visibility).
addSrc(filename).
addModuleDependencies(deps).
generateImportsAttribute().build()
result.Gen = append(result.Gen, pyBinary)
result.Imports = append(result.Imports, pyBinary.PrivateAttr(config.GazelleImportsKey))
}
}

Expand DownExpand Up@@ -270,8 +288,8 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
appendPyLibrary(pyLibraryFilenames, cfg.RenderLibraryName(packageName))
}

if hasPyBinary {
deps, err := parser.parseSingle(pyBinaryEntrypointFilename)
if hasPyBinaryEntryPointFile {
deps, _, err := parser.parseSingle(pyBinaryEntrypointFilename)
if err != nil {
log.Fatalf("ERROR: %v\n", err)
}
Expand All@@ -282,17 +300,12 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
// exists, and if it is of a different kind from the one we are
// generating. If so, we have to throw an error since Gazelle won't
// generate it correctly.
if args.File != nil {
for _, t := range args.File.Rules {
if t.Name() == pyBinaryTargetName && t.Kind() != actualPyBinaryKind {
fqTarget := label.New("", args.Rel, pyBinaryTargetName)
err := fmt.Errorf("failed to generate target %q of kind %q: "+
"a target of kind %q with the same name already exists. "+
"Use the '# gazelle:%s' directive to change the naming convention.",
fqTarget.String(), actualPyBinaryKind, t.Kind(), pythonconfig.BinaryNamingConvention)
collisionErrors.Add(err)
}
}
if err := ensureNoCollision(args.File, pyBinaryTargetName, actualPyBinaryKind); err != nil {
fqTarget := label.New("", args.Rel, pyBinaryTargetName)
err := fmt.Errorf("failed to generate target %q of kind %q: %w. "+
"Use the '# gazelle:%s' directive to change the naming convention.",
fqTarget.String(), actualPyBinaryKind, err, pythonconfig.BinaryNamingConvention)
collisionErrors.Add(err)
}

pyBinaryTarget := newTargetBuilder(pyBinaryKind, pyBinaryTargetName, pythonProjectRoot, args.Rel, pyFileNames).
Expand All@@ -310,7 +323,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes

var conftest *rule.Rule
if hasConftestFile {
deps, err := parser.parseSingle(conftestFilename)
deps, _, err := parser.parseSingle(conftestFilename)
if err != nil {
log.Fatalf("ERROR: %v\n", err)
}
Expand All@@ -319,16 +332,11 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
// exists, and if it is of a different kind from the one we are
// generating. If so, we have to throw an error since Gazelle won't
// generate it correctly.
if args.File != nil {
for _, t := range args.File.Rules {
if t.Name() == conftestTargetname && t.Kind() != actualPyLibraryKind {
fqTarget := label.New("", args.Rel, conftestTargetname)
err := fmt.Errorf("failed to generate target %q of kind %q: "+
"a target of kind %q with the same name already exists.",
fqTarget.String(), actualPyLibraryKind, t.Kind())
collisionErrors.Add(err)
}
}
if err := ensureNoCollision(args.File, conftestTargetname, actualPyLibraryKind); err != nil {
fqTarget := label.New("", args.Rel, conftestTargetname)
err := fmt.Errorf("failed to generate target %q of kind %q: %w. ",
fqTarget.String(), actualPyLibraryKind, err)
collisionErrors.Add(err)
}

conftestTarget := newTargetBuilder(pyLibraryKind, conftestTargetname, pythonProjectRoot, args.Rel, pyFileNames).
Expand All@@ -346,25 +354,20 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes

var pyTestTargets []*targetBuilder
newPyTestTargetBuilder := func(srcs *treeset.Set, pyTestTargetName string) *targetBuilder {
deps, err := parser.parse(srcs)
deps, _, err := parser.parse(srcs)
if err != nil {
log.Fatalf("ERROR: %v\n", err)
}
// Check if a target with the same name we are generating already
// exists, and if it is of a different kind from the one we are
// generating. If so, we have to throw an error since Gazelle won't
// generate it correctly.
if args.File != nil {
for _, t := range args.File.Rules {
if t.Name() == pyTestTargetName && t.Kind() != actualPyTestKind {
fqTarget := label.New("", args.Rel, pyTestTargetName)
err := fmt.Errorf("failed to generate target %q of kind %q: "+
"a target of kind %q with the same name already exists. "+
"Use the '# gazelle:%s' directive to change the naming convention.",
fqTarget.String(), actualPyTestKind, t.Kind(), pythonconfig.TestNamingConvention)
collisionErrors.Add(err)
}
}
if err := ensureNoCollision(args.File, pyTestTargetName, actualPyTestKind); err != nil {
fqTarget := label.New("", args.Rel, pyTestTargetName)
err := fmt.Errorf("failed to generate target %q of kind %q: %w. "+
"Use the '# gazelle:%s' directive to change the naming convention.",
fqTarget.String(), actualPyTestKind, err, pythonconfig.TestNamingConvention)
collisionErrors.Add(err)
}
return newTargetBuilder(pyTestKind, pyTestTargetName, pythonProjectRoot, args.Rel, pyFileNames).
addSrcs(srcs).
Expand DownExpand Up@@ -476,3 +479,15 @@ func isEntrypointFile(path string) bool {
return false
}
}

func ensureNoCollision(file *rule.File, targetName, kind string) error {
if file == nil {
return nil
}
for _, t := range file.Rules {
if t.Name() == targetName && t.Kind() != kind {
return fmt.Errorf("a target of kind %q with the same name already exists", t.Kind())
}
}
return nil
}
31 changes: 30 additions & 1 deletion gazelle/python/parse.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@
import os
import sys
from io import BytesIO
from tokenize import COMMENT, tokenize
from tokenize import COMMENT, NAME, OP, STRING, tokenize


def parse_import_statements(content, filepath):
Expand DownExpand Up@@ -59,6 +59,30 @@ def parse_comments(content):
return comments


def parse_main(content):
g = tokenize(BytesIO(content.encode("utf-8")).readline)
for token_type, token_val, start, _, _ in g:
if token_type != NAME or token_val != "if" or start[1] != 0:
continue
try:
token_type, token_val, start, _, _ = next(g)
if token_type != NAME or token_val != "__name__":
continue
token_type, token_val, start, _, _ = next(g)
if token_type != OP or token_val != "==":
continue
token_type, token_val, start, _, _ = next(g)
if token_type != STRING or token_val.strip("\"'") != '__main__':
continue
token_type, token_val, start, _, _ = next(g)
if token_type != OP or token_val != ":":
continue
return True
except StopIteration:
break
return False


def parse(repo_root, rel_package_path, filename):
rel_filepath = os.path.join(rel_package_path, filename)
abs_filepath = os.path.join(repo_root, rel_filepath)
Expand All@@ -70,11 +94,16 @@ def parse(repo_root, rel_package_path, filename):
parse_import_statements, content, rel_filepath
)
comments_future = executor.submit(parse_comments, content)
main_future = executor.submit(parse_main, content)
modules = modules_future.result()
comments = comments_future.result()
has_main = main_future.result()

output = {
"filename": filename,
"modules": modules,
"comments": comments,
"has_main": has_main,
}
return output

Expand Down
39 changes: 39 additions & 0 deletions gazelle/python/parse_test.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
import unittest
import parse

class TestParse(unittest.TestCase):
def test_not_has_main(self):
content = "a = 1\nb = 2"
self.assertFalse(parse.parse_main(content))

def test_has_main_in_function(self):
content = """
def foo():
if __name__ == "__main__":
a = 3
"""
self.assertFalse(parse.parse_main(content))

def test_has_main(self):
content = """
import unittest

from lib import main


class ExampleTest(unittest.TestCase):
def test_main(self):
self.assertEqual(
"",
main([["A", 1], ["B", 2]]),
)


if __name__ == "__main__":
unittest.main()
"""
self.assertTrue(parse.parse_main(content))


if __name__ == "__main__":
unittest.main()
Loading
, '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" + '
feat: Creating one py_binary per main module by linzhp · Pull Request #1584 · bazel-contrib/rules_python · GitHub
Skip to content
feat: Creating one py_binary per main module#1584

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

aignas
merged 13 commits into

from

Dec 13, 2023
 Merged


feat: Creating one py_binary per main module
#1584
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
2c178ae

Creating one py_binary per main module


linzhp Nov 29, 2023
401125f

revert accidental changes


linzhp Nov 29, 2023
c436ec8

handle empty lines


linzhp Nov 29, 2023
1784a99

reimplementing parse_main to fix a failing test


linzhp Nov 29, 2023
050efeb

fixed error message


linzhp Nov 29, 2023
d1b0593

Adding test cases for multiple py_binary and tests files


linzhp Dec 3, 2023
b6999fa

Merge branch 'main' into py_binary


linzhp Dec 3, 2023
2423b0c

sorting py_binary


linzhp Dec 3, 2023
bb82dde

fix test failures


linzhp Dec 4, 2023
38c10a9

increase timeout for requirements_3_10_test


linzhp Dec 4, 2023
bbd0389

formatting build file


linzhp Dec 4, 2023
de9ce9b

revert bazel version change


linzhp Dec 4, 2023
94e6327

extracting ensureNoCollision


linzhp Dec 9, 2023

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
examples/bzlmod/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ compile_pip_requirements_3_9(
# with pip-compile.
compile_pip_requirements_3_10(
 name = "requirements_3_10",
 timeout = "moderate",
 src = "requirements.in",
 requirements_txt = "requirements_lock_3_10.txt",
 requirements_windows = "requirements_windows_3_10.txt",
Expand Down

11 changes: 10 additions & 1 deletion
gazelle/python/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
load("@bazel_gazelle//:def.bzl", "gazelle_binary")
load("@io_bazel_rules_go//go:def.bzl", "go_library")
load("@rules_python//python:defs.bzl", "py_binary")
load("@rules_python//python:defs.bzl", "py_binary", "py_test")
load(":gazelle_test.bzl", "gazelle_test")

go_library(
Expand DownExpand Up@@ -58,6 +58,15 @@ py_binary(
 visibility = ["//visibility:public"],
)

py_test(
 name = "parse_test",
 srcs = [
 "parse.py",
 "parse_test.py",
 ],
 imports = ["."],
)

filegroup(
 name = "helper.zip",
 srcs = [":helper"],
Expand Down

2 changes: 1 addition & 1 deletion
gazelle/python/__main__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@

if __name__ == "__main__":
 if len(sys.argv) < 2:
 sys.exit("Please provide subcommand, either print or std_modules")
 sys.exit("Please provide subcommand, either parse or std_modules")
 if sys.argv[1] == "parse":
 sys.exit(parse.main(sys.stdin, sys.stdout))
 elif sys.argv[1] == "std_modules":
Expand Down

115 changes: 65 additions & 50 deletions
gazelle/python/generate.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import (
	"log"
	"os"
	"path/filepath"
	"sort"
	"strings"

	"github.com/bazelbuild/bazel-gazelle/config"
Expand DownExpand Up@@ -89,9 +90,9 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
	pyTestFilenames := treeset.NewWith(godsutils.StringComparator)
	pyFileNames := treeset.NewWith(godsutils.StringComparator)

	// hasPyBinary controls whether a py_binary target should be generated for
	// hasPyBinaryEntryPointFile controls whether a single py_binary target should be generated for
	// this package or not.
hasPyBinary := false
hasPyBinaryEntryPointFile := false

	// hasPyTestEntryPointFile and hasPyTestEntryPointTarget control whether a py_test target should
	// be generated for this package or not.
Expand All@@ -106,8 +107,8 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 ext := filepath.Ext(f)
 if ext == ".py" {
 pyFileNames.Add(f)
 if !hasPyBinary && f == pyBinaryEntrypointFilename {
hasPyBinary = true
 if !hasPyBinaryEntryPointFile && f == pyBinaryEntrypointFilename {
hasPyBinaryEntryPointFile = true
 } else if !hasPyTestEntryPointFile && f == pyTestEntrypointFilename {
 hasPyTestEntryPointFile = true
 } else if f == conftestFilename {
Expand DownExpand Up@@ -219,7 +220,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
	collisionErrors := singlylinkedlist.New()

	appendPyLibrary := func(srcs *treeset.Set, pyLibraryTargetName string) {
 deps, err := parser.parse(srcs)
 deps, mainModules, err := parser.parse(srcs)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
Expand All@@ -228,16 +229,33 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == pyLibraryTargetName && t.Kind() != actualPyLibraryKind {
 fqTarget := label.New("", args.Rel, pyLibraryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyLibraryKind, t.Kind(), pythonconfig.LibraryNamingConvention)
 collisionErrors.Add(err)
 if err := ensureNoCollision(args.File, pyLibraryTargetName, actualPyLibraryKind); err != nil {
 fqTarget := label.New("", args.Rel, pyLibraryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyLibraryKind, err, pythonconfig.LibraryNamingConvention)
 collisionErrors.Add(err)
 }

 if !hasPyBinaryEntryPointFile {
 sort.Strings(mainModules)
 // Creating one py_binary target per main module when __main__.py doesn't exist.
 for _, filename := range mainModules {
 pyBinaryTargetName := strings.TrimSuffix(filepath.Base(filename), ".py")
 if err := ensureNoCollision(args.File, pyBinaryTargetName, actualPyBinaryKind); err != nil {
 fqTarget := label.New("", args.Rel, pyBinaryTargetName)
 log.Printf("failed to generate target %q of kind %q: %v",
 fqTarget.String(), actualPyBinaryKind, err)
 continue
 }
 srcs.Remove(filename)
 pyBinary := newTargetBuilder(pyBinaryKind, pyBinaryTargetName, pythonProjectRoot, args.Rel, pyFileNames).
 addVisibility(visibility).
 addSrc(filename).
 addModuleDependencies(deps).
 generateImportsAttribute().build()
 result.Gen = append(result.Gen, pyBinary)
 result.Imports = append(result.Imports, pyBinary.PrivateAttr(config.GazelleImportsKey))
 }
 }

Expand DownExpand Up@@ -270,8 +288,8 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 appendPyLibrary(pyLibraryFilenames, cfg.RenderLibraryName(packageName))
	}

	if hasPyBinary {
 deps, err := parser.parseSingle(pyBinaryEntrypointFilename)
	if hasPyBinaryEntryPointFile {
 deps, _, err := parser.parseSingle(pyBinaryEntrypointFilename)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
Expand All@@ -282,17 +300,12 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == pyBinaryTargetName && t.Kind() != actualPyBinaryKind {
 fqTarget := label.New("", args.Rel, pyBinaryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyBinaryKind, t.Kind(), pythonconfig.BinaryNamingConvention)
 collisionErrors.Add(err)
 }
 }
 if err := ensureNoCollision(args.File, pyBinaryTargetName, actualPyBinaryKind); err != nil {
 fqTarget := label.New("", args.Rel, pyBinaryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyBinaryKind, err, pythonconfig.BinaryNamingConvention)
 collisionErrors.Add(err)
 }

 pyBinaryTarget := newTargetBuilder(pyBinaryKind, pyBinaryTargetName, pythonProjectRoot, args.Rel, pyFileNames).
Expand All@@ -310,7 +323,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes

	var conftest *rule.Rule
	if hasConftestFile {
 deps, err := parser.parseSingle(conftestFilename)
 deps, _, err := parser.parseSingle(conftestFilename)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
Expand All@@ -319,16 +332,11 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == conftestTargetname && t.Kind() != actualPyLibraryKind {
 fqTarget := label.New("", args.Rel, conftestTargetname)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists.",
 fqTarget.String(), actualPyLibraryKind, t.Kind())
 collisionErrors.Add(err)
 }
 }
 if err := ensureNoCollision(args.File, conftestTargetname, actualPyLibraryKind); err != nil {
 fqTarget := label.New("", args.Rel, conftestTargetname)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. ",
 fqTarget.String(), actualPyLibraryKind, err)
 collisionErrors.Add(err)
 }

 conftestTarget := newTargetBuilder(pyLibraryKind, conftestTargetname, pythonProjectRoot, args.Rel, pyFileNames).
Expand All@@ -346,25 +354,20 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes

	var pyTestTargets []*targetBuilder
	newPyTestTargetBuilder := func(srcs *treeset.Set, pyTestTargetName string) *targetBuilder {
 deps, err := parser.parse(srcs)
 deps, _, err := parser.parse(srcs)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
 // Check if a target with the same name we are generating already
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == pyTestTargetName && t.Kind() != actualPyTestKind {
 fqTarget := label.New("", args.Rel, pyTestTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyTestKind, t.Kind(), pythonconfig.TestNamingConvention)
 collisionErrors.Add(err)
 }
 }
 if err := ensureNoCollision(args.File, pyTestTargetName, actualPyTestKind); err != nil {
 fqTarget := label.New("", args.Rel, pyTestTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyTestKind, err, pythonconfig.TestNamingConvention)
 collisionErrors.Add(err)
 }
 return newTargetBuilder(pyTestKind, pyTestTargetName, pythonProjectRoot, args.Rel, pyFileNames).
 addSrcs(srcs).
Expand DownExpand Up@@ -476,3 +479,15 @@ func isEntrypointFile(path string) bool {
 return false
	}
}

func ensureNoCollision(file *rule.File, targetName, kind string) error {
	if file == nil {
 return nil
	}
	for _, t := range file.Rules {
 if t.Name() == targetName && t.Kind() != kind {
 return fmt.Errorf("a target of kind %q with the same name already exists", t.Kind())
 }
	}
	return nil
}

31 changes: 30 additions & 1 deletion
gazelle/python/parse.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@
import os
import sys
from io import BytesIO
from tokenize import COMMENT, tokenize
from tokenize import COMMENT, NAME, OP, STRING, tokenize


def parse_import_statements(content, filepath):
Expand DownExpand Up@@ -59,6 +59,30 @@ def parse_comments(content):
 return comments


def parse_main(content):
 g = tokenize(BytesIO(content.encode("utf-8")).readline)
 for token_type, token_val, start, _, _ in g:
 if token_type != NAME or token_val != "if" or start[1] != 0:
 continue
 try:
 token_type, token_val, start, _, _ = next(g)
 if token_type != NAME or token_val != "__name__":
 continue
 token_type, token_val, start, _, _ = next(g)
 if token_type != OP or token_val != "==":
 continue
 token_type, token_val, start, _, _ = next(g)
 if token_type != STRING or token_val.strip("\"'") != '__main__':
 continue
 token_type, token_val, start, _, _ = next(g)
 if token_type != OP or token_val != ":":
 continue
 return True
 except StopIteration:
 break
 return False


def parse(repo_root, rel_package_path, filename):
 rel_filepath = os.path.join(rel_package_path, filename)
 abs_filepath = os.path.join(repo_root, rel_filepath)
Expand All@@ -70,11 +94,16 @@ def parse(repo_root, rel_package_path, filename):
 parse_import_statements, content, rel_filepath
 )
 comments_future = executor.submit(parse_comments, content)
 main_future = executor.submit(parse_main, content)
 modules = modules_future.result()
 comments = comments_future.result()
 has_main = main_future.result()

 output = {
 "filename": filename,
 "modules": modules,
 "comments": comments,
 "has_main": has_main,
 }
 return output

Expand Down

39 changes: 39 additions & 0 deletions
gazelle/python/parse_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
import unittest
import parse

class TestParse(unittest.TestCase):
 def test_not_has_main(self):
 content = "a = 1\nb = 2"
 self.assertFalse(parse.parse_main(content))

 def test_has_main_in_function(self):
 content = """
def foo():
 if __name__ == "__main__":
 a = 3
"""
 self.assertFalse(parse.parse_main(content))

 def test_has_main(self):
 content = """
import unittest

from lib import main


class ExampleTest(unittest.TestCase):
 def test_main(self):
 self.assertEqual(
 "",
 main([["A", 1], ["B", 2]]),
 )


if __name__ == "__main__":
 unittest.main()
"""
 self.assertTrue(parse.parse_main(content))


if __name__ == "__main__":
 unittest.main()
Loading

, '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('^' + ".*" + '
feat: Creating one py_binary per main module by linzhp · Pull Request #1584 · bazel-contrib/rules_python · GitHub
Skip to content
feat: Creating one py_binary per main module#1584

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

aignas
merged 13 commits into

from

Dec 13, 2023
 Merged


feat: Creating one py_binary per main module
#1584
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
2c178ae

Creating one py_binary per main module


linzhp Nov 29, 2023
401125f

revert accidental changes


linzhp Nov 29, 2023
c436ec8

handle empty lines


linzhp Nov 29, 2023
1784a99

reimplementing parse_main to fix a failing test


linzhp Nov 29, 2023
050efeb

fixed error message


linzhp Nov 29, 2023
d1b0593

Adding test cases for multiple py_binary and tests files


linzhp Dec 3, 2023
b6999fa

Merge branch 'main' into py_binary


linzhp Dec 3, 2023
2423b0c

sorting py_binary


linzhp Dec 3, 2023
bb82dde

fix test failures


linzhp Dec 4, 2023
38c10a9

increase timeout for requirements_3_10_test


linzhp Dec 4, 2023
bbd0389

formatting build file


linzhp Dec 4, 2023
de9ce9b

revert bazel version change


linzhp Dec 4, 2023
94e6327

extracting ensureNoCollision


linzhp Dec 9, 2023

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
examples/bzlmod/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ compile_pip_requirements_3_9(
# with pip-compile.
compile_pip_requirements_3_10(
 name = "requirements_3_10",
 timeout = "moderate",
 src = "requirements.in",
 requirements_txt = "requirements_lock_3_10.txt",
 requirements_windows = "requirements_windows_3_10.txt",
Expand Down

11 changes: 10 additions & 1 deletion
gazelle/python/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
load("@bazel_gazelle//:def.bzl", "gazelle_binary")
load("@io_bazel_rules_go//go:def.bzl", "go_library")
load("@rules_python//python:defs.bzl", "py_binary")
load("@rules_python//python:defs.bzl", "py_binary", "py_test")
load(":gazelle_test.bzl", "gazelle_test")

go_library(
Expand DownExpand Up@@ -58,6 +58,15 @@ py_binary(
 visibility = ["//visibility:public"],
)

py_test(
 name = "parse_test",
 srcs = [
 "parse.py",
 "parse_test.py",
 ],
 imports = ["."],
)

filegroup(
 name = "helper.zip",
 srcs = [":helper"],
Expand Down

2 changes: 1 addition & 1 deletion
gazelle/python/__main__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@

if __name__ == "__main__":
 if len(sys.argv) < 2:
 sys.exit("Please provide subcommand, either print or std_modules")
 sys.exit("Please provide subcommand, either parse or std_modules")
 if sys.argv[1] == "parse":
 sys.exit(parse.main(sys.stdin, sys.stdout))
 elif sys.argv[1] == "std_modules":
Expand Down

115 changes: 65 additions & 50 deletions
gazelle/python/generate.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import (
	"log"
	"os"
	"path/filepath"
	"sort"
	"strings"

	"github.com/bazelbuild/bazel-gazelle/config"
Expand DownExpand Up@@ -89,9 +90,9 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
	pyTestFilenames := treeset.NewWith(godsutils.StringComparator)
	pyFileNames := treeset.NewWith(godsutils.StringComparator)

	// hasPyBinary controls whether a py_binary target should be generated for
	// hasPyBinaryEntryPointFile controls whether a single py_binary target should be generated for
	// this package or not.
hasPyBinary := false
hasPyBinaryEntryPointFile := false

	// hasPyTestEntryPointFile and hasPyTestEntryPointTarget control whether a py_test target should
	// be generated for this package or not.
Expand All@@ -106,8 +107,8 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 ext := filepath.Ext(f)
 if ext == ".py" {
 pyFileNames.Add(f)
 if !hasPyBinary && f == pyBinaryEntrypointFilename {
hasPyBinary = true
 if !hasPyBinaryEntryPointFile && f == pyBinaryEntrypointFilename {
hasPyBinaryEntryPointFile = true
 } else if !hasPyTestEntryPointFile && f == pyTestEntrypointFilename {
 hasPyTestEntryPointFile = true
 } else if f == conftestFilename {
Expand DownExpand Up@@ -219,7 +220,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
	collisionErrors := singlylinkedlist.New()

	appendPyLibrary := func(srcs *treeset.Set, pyLibraryTargetName string) {
 deps, err := parser.parse(srcs)
 deps, mainModules, err := parser.parse(srcs)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
Expand All@@ -228,16 +229,33 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == pyLibraryTargetName && t.Kind() != actualPyLibraryKind {
 fqTarget := label.New("", args.Rel, pyLibraryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyLibraryKind, t.Kind(), pythonconfig.LibraryNamingConvention)
 collisionErrors.Add(err)
 if err := ensureNoCollision(args.File, pyLibraryTargetName, actualPyLibraryKind); err != nil {
 fqTarget := label.New("", args.Rel, pyLibraryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyLibraryKind, err, pythonconfig.LibraryNamingConvention)
 collisionErrors.Add(err)
 }

 if !hasPyBinaryEntryPointFile {
 sort.Strings(mainModules)
 // Creating one py_binary target per main module when __main__.py doesn't exist.
 for _, filename := range mainModules {
 pyBinaryTargetName := strings.TrimSuffix(filepath.Base(filename), ".py")
 if err := ensureNoCollision(args.File, pyBinaryTargetName, actualPyBinaryKind); err != nil {
 fqTarget := label.New("", args.Rel, pyBinaryTargetName)
 log.Printf("failed to generate target %q of kind %q: %v",
 fqTarget.String(), actualPyBinaryKind, err)
 continue
 }
 srcs.Remove(filename)
 pyBinary := newTargetBuilder(pyBinaryKind, pyBinaryTargetName, pythonProjectRoot, args.Rel, pyFileNames).
 addVisibility(visibility).
 addSrc(filename).
 addModuleDependencies(deps).
 generateImportsAttribute().build()
 result.Gen = append(result.Gen, pyBinary)
 result.Imports = append(result.Imports, pyBinary.PrivateAttr(config.GazelleImportsKey))
 }
 }

Expand DownExpand Up@@ -270,8 +288,8 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 appendPyLibrary(pyLibraryFilenames, cfg.RenderLibraryName(packageName))
	}

	if hasPyBinary {
 deps, err := parser.parseSingle(pyBinaryEntrypointFilename)
	if hasPyBinaryEntryPointFile {
 deps, _, err := parser.parseSingle(pyBinaryEntrypointFilename)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
Expand All@@ -282,17 +300,12 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == pyBinaryTargetName && t.Kind() != actualPyBinaryKind {
 fqTarget := label.New("", args.Rel, pyBinaryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyBinaryKind, t.Kind(), pythonconfig.BinaryNamingConvention)
 collisionErrors.Add(err)
 }
 }
 if err := ensureNoCollision(args.File, pyBinaryTargetName, actualPyBinaryKind); err != nil {
 fqTarget := label.New("", args.Rel, pyBinaryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyBinaryKind, err, pythonconfig.BinaryNamingConvention)
 collisionErrors.Add(err)
 }

 pyBinaryTarget := newTargetBuilder(pyBinaryKind, pyBinaryTargetName, pythonProjectRoot, args.Rel, pyFileNames).
Expand All@@ -310,7 +323,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes

	var conftest *rule.Rule
	if hasConftestFile {
 deps, err := parser.parseSingle(conftestFilename)
 deps, _, err := parser.parseSingle(conftestFilename)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
Expand All@@ -319,16 +332,11 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == conftestTargetname && t.Kind() != actualPyLibraryKind {
 fqTarget := label.New("", args.Rel, conftestTargetname)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists.",
 fqTarget.String(), actualPyLibraryKind, t.Kind())
 collisionErrors.Add(err)
 }
 }
 if err := ensureNoCollision(args.File, conftestTargetname, actualPyLibraryKind); err != nil {
 fqTarget := label.New("", args.Rel, conftestTargetname)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. ",
 fqTarget.String(), actualPyLibraryKind, err)
 collisionErrors.Add(err)
 }

 conftestTarget := newTargetBuilder(pyLibraryKind, conftestTargetname, pythonProjectRoot, args.Rel, pyFileNames).
Expand All@@ -346,25 +354,20 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes

	var pyTestTargets []*targetBuilder
	newPyTestTargetBuilder := func(srcs *treeset.Set, pyTestTargetName string) *targetBuilder {
 deps, err := parser.parse(srcs)
 deps, _, err := parser.parse(srcs)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
 // Check if a target with the same name we are generating already
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == pyTestTargetName && t.Kind() != actualPyTestKind {
 fqTarget := label.New("", args.Rel, pyTestTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyTestKind, t.Kind(), pythonconfig.TestNamingConvention)
 collisionErrors.Add(err)
 }
 }
 if err := ensureNoCollision(args.File, pyTestTargetName, actualPyTestKind); err != nil {
 fqTarget := label.New("", args.Rel, pyTestTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyTestKind, err, pythonconfig.TestNamingConvention)
 collisionErrors.Add(err)
 }
 return newTargetBuilder(pyTestKind, pyTestTargetName, pythonProjectRoot, args.Rel, pyFileNames).
 addSrcs(srcs).
Expand DownExpand Up@@ -476,3 +479,15 @@ func isEntrypointFile(path string) bool {
 return false
	}
}

func ensureNoCollision(file *rule.File, targetName, kind string) error {
	if file == nil {
 return nil
	}
	for _, t := range file.Rules {
 if t.Name() == targetName && t.Kind() != kind {
 return fmt.Errorf("a target of kind %q with the same name already exists", t.Kind())
 }
	}
	return nil
}

31 changes: 30 additions & 1 deletion
gazelle/python/parse.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@
import os
import sys
from io import BytesIO
from tokenize import COMMENT, tokenize
from tokenize import COMMENT, NAME, OP, STRING, tokenize


def parse_import_statements(content, filepath):
Expand DownExpand Up@@ -59,6 +59,30 @@ def parse_comments(content):
 return comments


def parse_main(content):
 g = tokenize(BytesIO(content.encode("utf-8")).readline)
 for token_type, token_val, start, _, _ in g:
 if token_type != NAME or token_val != "if" or start[1] != 0:
 continue
 try:
 token_type, token_val, start, _, _ = next(g)
 if token_type != NAME or token_val != "__name__":
 continue
 token_type, token_val, start, _, _ = next(g)
 if token_type != OP or token_val != "==":
 continue
 token_type, token_val, start, _, _ = next(g)
 if token_type != STRING or token_val.strip("\"'") != '__main__':
 continue
 token_type, token_val, start, _, _ = next(g)
 if token_type != OP or token_val != ":":
 continue
 return True
 except StopIteration:
 break
 return False


def parse(repo_root, rel_package_path, filename):
 rel_filepath = os.path.join(rel_package_path, filename)
 abs_filepath = os.path.join(repo_root, rel_filepath)
Expand All@@ -70,11 +94,16 @@ def parse(repo_root, rel_package_path, filename):
 parse_import_statements, content, rel_filepath
 )
 comments_future = executor.submit(parse_comments, content)
 main_future = executor.submit(parse_main, content)
 modules = modules_future.result()
 comments = comments_future.result()
 has_main = main_future.result()

 output = {
 "filename": filename,
 "modules": modules,
 "comments": comments,
 "has_main": has_main,
 }
 return output

Expand Down

39 changes: 39 additions & 0 deletions
gazelle/python/parse_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
import unittest
import parse

class TestParse(unittest.TestCase):
 def test_not_has_main(self):
 content = "a = 1\nb = 2"
 self.assertFalse(parse.parse_main(content))

 def test_has_main_in_function(self):
 content = """
def foo():
 if __name__ == "__main__":
 a = 3
"""
 self.assertFalse(parse.parse_main(content))

 def test_has_main(self):
 content = """
import unittest

from lib import main


class ExampleTest(unittest.TestCase):
 def test_main(self):
 self.assertEqual(
 "",
 main([["A", 1], ["B", 2]]),
 )


if __name__ == "__main__":
 unittest.main()
"""
 self.assertTrue(parse.parse_main(content))


if __name__ == "__main__":
 unittest.main()
Loading

, '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('^' + ".*" + '
feat: Creating one py_binary per main module by linzhp · Pull Request #1584 · bazel-contrib/rules_python · GitHub
Skip to content
feat: Creating one py_binary per main module#1584

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

aignas
merged 13 commits into

from

Dec 13, 2023
 Merged


feat: Creating one py_binary per main module
#1584
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
2c178ae

Creating one py_binary per main module


linzhp Nov 29, 2023
401125f

revert accidental changes


linzhp Nov 29, 2023
c436ec8

handle empty lines


linzhp Nov 29, 2023
1784a99

reimplementing parse_main to fix a failing test


linzhp Nov 29, 2023
050efeb

fixed error message


linzhp Nov 29, 2023
d1b0593

Adding test cases for multiple py_binary and tests files


linzhp Dec 3, 2023
b6999fa

Merge branch 'main' into py_binary


linzhp Dec 3, 2023
2423b0c

sorting py_binary


linzhp Dec 3, 2023
bb82dde

fix test failures


linzhp Dec 4, 2023
38c10a9

increase timeout for requirements_3_10_test


linzhp Dec 4, 2023
bbd0389

formatting build file


linzhp Dec 4, 2023
de9ce9b

revert bazel version change


linzhp Dec 4, 2023
94e6327

extracting ensureNoCollision


linzhp Dec 9, 2023

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
examples/bzlmod/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ compile_pip_requirements_3_9(
# with pip-compile.
compile_pip_requirements_3_10(
 name = "requirements_3_10",
 timeout = "moderate",
 src = "requirements.in",
 requirements_txt = "requirements_lock_3_10.txt",
 requirements_windows = "requirements_windows_3_10.txt",
Expand Down

11 changes: 10 additions & 1 deletion
gazelle/python/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
load("@bazel_gazelle//:def.bzl", "gazelle_binary")
load("@io_bazel_rules_go//go:def.bzl", "go_library")
load("@rules_python//python:defs.bzl", "py_binary")
load("@rules_python//python:defs.bzl", "py_binary", "py_test")
load(":gazelle_test.bzl", "gazelle_test")

go_library(
Expand DownExpand Up@@ -58,6 +58,15 @@ py_binary(
 visibility = ["//visibility:public"],
)

py_test(
 name = "parse_test",
 srcs = [
 "parse.py",
 "parse_test.py",
 ],
 imports = ["."],
)

filegroup(
 name = "helper.zip",
 srcs = [":helper"],
Expand Down

2 changes: 1 addition & 1 deletion
gazelle/python/__main__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@

if __name__ == "__main__":
 if len(sys.argv) < 2:
 sys.exit("Please provide subcommand, either print or std_modules")
 sys.exit("Please provide subcommand, either parse or std_modules")
 if sys.argv[1] == "parse":
 sys.exit(parse.main(sys.stdin, sys.stdout))
 elif sys.argv[1] == "std_modules":
Expand Down

115 changes: 65 additions & 50 deletions
gazelle/python/generate.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import (
	"log"
	"os"
	"path/filepath"
	"sort"
	"strings"

	"github.com/bazelbuild/bazel-gazelle/config"
Expand DownExpand Up@@ -89,9 +90,9 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
	pyTestFilenames := treeset.NewWith(godsutils.StringComparator)
	pyFileNames := treeset.NewWith(godsutils.StringComparator)

	// hasPyBinary controls whether a py_binary target should be generated for
	// hasPyBinaryEntryPointFile controls whether a single py_binary target should be generated for
	// this package or not.
hasPyBinary := false
hasPyBinaryEntryPointFile := false

	// hasPyTestEntryPointFile and hasPyTestEntryPointTarget control whether a py_test target should
	// be generated for this package or not.
Expand All@@ -106,8 +107,8 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 ext := filepath.Ext(f)
 if ext == ".py" {
 pyFileNames.Add(f)
 if !hasPyBinary && f == pyBinaryEntrypointFilename {
hasPyBinary = true
 if !hasPyBinaryEntryPointFile && f == pyBinaryEntrypointFilename {
hasPyBinaryEntryPointFile = true
 } else if !hasPyTestEntryPointFile && f == pyTestEntrypointFilename {
 hasPyTestEntryPointFile = true
 } else if f == conftestFilename {
Expand DownExpand Up@@ -219,7 +220,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
	collisionErrors := singlylinkedlist.New()

	appendPyLibrary := func(srcs *treeset.Set, pyLibraryTargetName string) {
 deps, err := parser.parse(srcs)
 deps, mainModules, err := parser.parse(srcs)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
Expand All@@ -228,16 +229,33 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == pyLibraryTargetName && t.Kind() != actualPyLibraryKind {
 fqTarget := label.New("", args.Rel, pyLibraryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyLibraryKind, t.Kind(), pythonconfig.LibraryNamingConvention)
 collisionErrors.Add(err)
 if err := ensureNoCollision(args.File, pyLibraryTargetName, actualPyLibraryKind); err != nil {
 fqTarget := label.New("", args.Rel, pyLibraryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyLibraryKind, err, pythonconfig.LibraryNamingConvention)
 collisionErrors.Add(err)
 }

 if !hasPyBinaryEntryPointFile {
 sort.Strings(mainModules)
 // Creating one py_binary target per main module when __main__.py doesn't exist.
 for _, filename := range mainModules {
 pyBinaryTargetName := strings.TrimSuffix(filepath.Base(filename), ".py")
 if err := ensureNoCollision(args.File, pyBinaryTargetName, actualPyBinaryKind); err != nil {
 fqTarget := label.New("", args.Rel, pyBinaryTargetName)
 log.Printf("failed to generate target %q of kind %q: %v",
 fqTarget.String(), actualPyBinaryKind, err)
 continue
 }
 srcs.Remove(filename)
 pyBinary := newTargetBuilder(pyBinaryKind, pyBinaryTargetName, pythonProjectRoot, args.Rel, pyFileNames).
 addVisibility(visibility).
 addSrc(filename).
 addModuleDependencies(deps).
 generateImportsAttribute().build()
 result.Gen = append(result.Gen, pyBinary)
 result.Imports = append(result.Imports, pyBinary.PrivateAttr(config.GazelleImportsKey))
 }
 }

Expand DownExpand Up@@ -270,8 +288,8 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 appendPyLibrary(pyLibraryFilenames, cfg.RenderLibraryName(packageName))
	}

	if hasPyBinary {
 deps, err := parser.parseSingle(pyBinaryEntrypointFilename)
	if hasPyBinaryEntryPointFile {
 deps, _, err := parser.parseSingle(pyBinaryEntrypointFilename)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
Expand All@@ -282,17 +300,12 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == pyBinaryTargetName && t.Kind() != actualPyBinaryKind {
 fqTarget := label.New("", args.Rel, pyBinaryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyBinaryKind, t.Kind(), pythonconfig.BinaryNamingConvention)
 collisionErrors.Add(err)
 }
 }
 if err := ensureNoCollision(args.File, pyBinaryTargetName, actualPyBinaryKind); err != nil {
 fqTarget := label.New("", args.Rel, pyBinaryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyBinaryKind, err, pythonconfig.BinaryNamingConvention)
 collisionErrors.Add(err)
 }

 pyBinaryTarget := newTargetBuilder(pyBinaryKind, pyBinaryTargetName, pythonProjectRoot, args.Rel, pyFileNames).
Expand All@@ -310,7 +323,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes

	var conftest *rule.Rule
	if hasConftestFile {
 deps, err := parser.parseSingle(conftestFilename)
 deps, _, err := parser.parseSingle(conftestFilename)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
Expand All@@ -319,16 +332,11 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == conftestTargetname && t.Kind() != actualPyLibraryKind {
 fqTarget := label.New("", args.Rel, conftestTargetname)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists.",
 fqTarget.String(), actualPyLibraryKind, t.Kind())
 collisionErrors.Add(err)
 }
 }
 if err := ensureNoCollision(args.File, conftestTargetname, actualPyLibraryKind); err != nil {
 fqTarget := label.New("", args.Rel, conftestTargetname)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. ",
 fqTarget.String(), actualPyLibraryKind, err)
 collisionErrors.Add(err)
 }

 conftestTarget := newTargetBuilder(pyLibraryKind, conftestTargetname, pythonProjectRoot, args.Rel, pyFileNames).
Expand All@@ -346,25 +354,20 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes

	var pyTestTargets []*targetBuilder
	newPyTestTargetBuilder := func(srcs *treeset.Set, pyTestTargetName string) *targetBuilder {
 deps, err := parser.parse(srcs)
 deps, _, err := parser.parse(srcs)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
 // Check if a target with the same name we are generating already
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == pyTestTargetName && t.Kind() != actualPyTestKind {
 fqTarget := label.New("", args.Rel, pyTestTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyTestKind, t.Kind(), pythonconfig.TestNamingConvention)
 collisionErrors.Add(err)
 }
 }
 if err := ensureNoCollision(args.File, pyTestTargetName, actualPyTestKind); err != nil {
 fqTarget := label.New("", args.Rel, pyTestTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyTestKind, err, pythonconfig.TestNamingConvention)
 collisionErrors.Add(err)
 }
 return newTargetBuilder(pyTestKind, pyTestTargetName, pythonProjectRoot, args.Rel, pyFileNames).
 addSrcs(srcs).
Expand DownExpand Up@@ -476,3 +479,15 @@ func isEntrypointFile(path string) bool {
 return false
	}
}

func ensureNoCollision(file *rule.File, targetName, kind string) error {
	if file == nil {
 return nil
	}
	for _, t := range file.Rules {
 if t.Name() == targetName && t.Kind() != kind {
 return fmt.Errorf("a target of kind %q with the same name already exists", t.Kind())
 }
	}
	return nil
}

31 changes: 30 additions & 1 deletion
gazelle/python/parse.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@
import os
import sys
from io import BytesIO
from tokenize import COMMENT, tokenize
from tokenize import COMMENT, NAME, OP, STRING, tokenize


def parse_import_statements(content, filepath):
Expand DownExpand Up@@ -59,6 +59,30 @@ def parse_comments(content):
 return comments


def parse_main(content):
 g = tokenize(BytesIO(content.encode("utf-8")).readline)
 for token_type, token_val, start, _, _ in g:
 if token_type != NAME or token_val != "if" or start[1] != 0:
 continue
 try:
 token_type, token_val, start, _, _ = next(g)
 if token_type != NAME or token_val != "__name__":
 continue
 token_type, token_val, start, _, _ = next(g)
 if token_type != OP or token_val != "==":
 continue
 token_type, token_val, start, _, _ = next(g)
 if token_type != STRING or token_val.strip("\"'") != '__main__':
 continue
 token_type, token_val, start, _, _ = next(g)
 if token_type != OP or token_val != ":":
 continue
 return True
 except StopIteration:
 break
 return False


def parse(repo_root, rel_package_path, filename):
 rel_filepath = os.path.join(rel_package_path, filename)
 abs_filepath = os.path.join(repo_root, rel_filepath)
Expand All@@ -70,11 +94,16 @@ def parse(repo_root, rel_package_path, filename):
 parse_import_statements, content, rel_filepath
 )
 comments_future = executor.submit(parse_comments, content)
 main_future = executor.submit(parse_main, content)
 modules = modules_future.result()
 comments = comments_future.result()
 has_main = main_future.result()

 output = {
 "filename": filename,
 "modules": modules,
 "comments": comments,
 "has_main": has_main,
 }
 return output

Expand Down

39 changes: 39 additions & 0 deletions
gazelle/python/parse_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
import unittest
import parse

class TestParse(unittest.TestCase):
 def test_not_has_main(self):
 content = "a = 1\nb = 2"
 self.assertFalse(parse.parse_main(content))

 def test_has_main_in_function(self):
 content = """
def foo():
 if __name__ == "__main__":
 a = 3
"""
 self.assertFalse(parse.parse_main(content))

 def test_has_main(self):
 content = """
import unittest

from lib import main


class ExampleTest(unittest.TestCase):
 def test_main(self):
 self.assertEqual(
 "",
 main([["A", 1], ["B", 2]]),
 )


if __name__ == "__main__":
 unittest.main()
"""
 self.assertTrue(parse.parse_main(content))


if __name__ == "__main__":
 unittest.main()
Loading

, '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" + '
feat: Creating one py_binary per main module by linzhp · Pull Request #1584 · bazel-contrib/rules_python · GitHub
Skip to content
feat: Creating one py_binary per main module#1584

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

aignas
merged 13 commits into

from

Dec 13, 2023
 Merged


feat: Creating one py_binary per main module
#1584
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
2c178ae

Creating one py_binary per main module


linzhp Nov 29, 2023
401125f

revert accidental changes


linzhp Nov 29, 2023
c436ec8

handle empty lines


linzhp Nov 29, 2023
1784a99

reimplementing parse_main to fix a failing test


linzhp Nov 29, 2023
050efeb

fixed error message


linzhp Nov 29, 2023
d1b0593

Adding test cases for multiple py_binary and tests files


linzhp Dec 3, 2023
b6999fa

Merge branch 'main' into py_binary


linzhp Dec 3, 2023
2423b0c

sorting py_binary


linzhp Dec 3, 2023
bb82dde

fix test failures


linzhp Dec 4, 2023
38c10a9

increase timeout for requirements_3_10_test


linzhp Dec 4, 2023
bbd0389

formatting build file


linzhp Dec 4, 2023
de9ce9b

revert bazel version change


linzhp Dec 4, 2023
94e6327

extracting ensureNoCollision


linzhp Dec 9, 2023

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
examples/bzlmod/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ compile_pip_requirements_3_9(
# with pip-compile.
compile_pip_requirements_3_10(
 name = "requirements_3_10",
 timeout = "moderate",
 src = "requirements.in",
 requirements_txt = "requirements_lock_3_10.txt",
 requirements_windows = "requirements_windows_3_10.txt",
Expand Down

11 changes: 10 additions & 1 deletion
gazelle/python/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
load("@bazel_gazelle//:def.bzl", "gazelle_binary")
load("@io_bazel_rules_go//go:def.bzl", "go_library")
load("@rules_python//python:defs.bzl", "py_binary")
load("@rules_python//python:defs.bzl", "py_binary", "py_test")
load(":gazelle_test.bzl", "gazelle_test")

go_library(
Expand DownExpand Up@@ -58,6 +58,15 @@ py_binary(
 visibility = ["//visibility:public"],
)

py_test(
 name = "parse_test",
 srcs = [
 "parse.py",
 "parse_test.py",
 ],
 imports = ["."],
)

filegroup(
 name = "helper.zip",
 srcs = [":helper"],
Expand Down

2 changes: 1 addition & 1 deletion
gazelle/python/__main__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@

if __name__ == "__main__":
 if len(sys.argv) < 2:
 sys.exit("Please provide subcommand, either print or std_modules")
 sys.exit("Please provide subcommand, either parse or std_modules")
 if sys.argv[1] == "parse":
 sys.exit(parse.main(sys.stdin, sys.stdout))
 elif sys.argv[1] == "std_modules":
Expand Down

115 changes: 65 additions & 50 deletions
gazelle/python/generate.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import (
	"log"
	"os"
	"path/filepath"
	"sort"
	"strings"

	"github.com/bazelbuild/bazel-gazelle/config"
Expand DownExpand Up@@ -89,9 +90,9 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
	pyTestFilenames := treeset.NewWith(godsutils.StringComparator)
	pyFileNames := treeset.NewWith(godsutils.StringComparator)

	// hasPyBinary controls whether a py_binary target should be generated for
	// hasPyBinaryEntryPointFile controls whether a single py_binary target should be generated for
	// this package or not.
hasPyBinary := false
hasPyBinaryEntryPointFile := false

	// hasPyTestEntryPointFile and hasPyTestEntryPointTarget control whether a py_test target should
	// be generated for this package or not.
Expand All@@ -106,8 +107,8 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 ext := filepath.Ext(f)
 if ext == ".py" {
 pyFileNames.Add(f)
 if !hasPyBinary && f == pyBinaryEntrypointFilename {
hasPyBinary = true
 if !hasPyBinaryEntryPointFile && f == pyBinaryEntrypointFilename {
hasPyBinaryEntryPointFile = true
 } else if !hasPyTestEntryPointFile && f == pyTestEntrypointFilename {
 hasPyTestEntryPointFile = true
 } else if f == conftestFilename {
Expand DownExpand Up@@ -219,7 +220,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
	collisionErrors := singlylinkedlist.New()

	appendPyLibrary := func(srcs *treeset.Set, pyLibraryTargetName string) {
 deps, err := parser.parse(srcs)
 deps, mainModules, err := parser.parse(srcs)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
Expand All@@ -228,16 +229,33 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == pyLibraryTargetName && t.Kind() != actualPyLibraryKind {
 fqTarget := label.New("", args.Rel, pyLibraryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyLibraryKind, t.Kind(), pythonconfig.LibraryNamingConvention)
 collisionErrors.Add(err)
 if err := ensureNoCollision(args.File, pyLibraryTargetName, actualPyLibraryKind); err != nil {
 fqTarget := label.New("", args.Rel, pyLibraryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyLibraryKind, err, pythonconfig.LibraryNamingConvention)
 collisionErrors.Add(err)
 }

 if !hasPyBinaryEntryPointFile {
 sort.Strings(mainModules)
 // Creating one py_binary target per main module when __main__.py doesn't exist.
 for _, filename := range mainModules {
 pyBinaryTargetName := strings.TrimSuffix(filepath.Base(filename), ".py")
 if err := ensureNoCollision(args.File, pyBinaryTargetName, actualPyBinaryKind); err != nil {
 fqTarget := label.New("", args.Rel, pyBinaryTargetName)
 log.Printf("failed to generate target %q of kind %q: %v",
 fqTarget.String(), actualPyBinaryKind, err)
 continue
 }
 srcs.Remove(filename)
 pyBinary := newTargetBuilder(pyBinaryKind, pyBinaryTargetName, pythonProjectRoot, args.Rel, pyFileNames).
 addVisibility(visibility).
 addSrc(filename).
 addModuleDependencies(deps).
 generateImportsAttribute().build()
 result.Gen = append(result.Gen, pyBinary)
 result.Imports = append(result.Imports, pyBinary.PrivateAttr(config.GazelleImportsKey))
 }
 }

Expand DownExpand Up@@ -270,8 +288,8 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 appendPyLibrary(pyLibraryFilenames, cfg.RenderLibraryName(packageName))
	}

	if hasPyBinary {
 deps, err := parser.parseSingle(pyBinaryEntrypointFilename)
	if hasPyBinaryEntryPointFile {
 deps, _, err := parser.parseSingle(pyBinaryEntrypointFilename)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
Expand All@@ -282,17 +300,12 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == pyBinaryTargetName && t.Kind() != actualPyBinaryKind {
 fqTarget := label.New("", args.Rel, pyBinaryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyBinaryKind, t.Kind(), pythonconfig.BinaryNamingConvention)
 collisionErrors.Add(err)
 }
 }
 if err := ensureNoCollision(args.File, pyBinaryTargetName, actualPyBinaryKind); err != nil {
 fqTarget := label.New("", args.Rel, pyBinaryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyBinaryKind, err, pythonconfig.BinaryNamingConvention)
 collisionErrors.Add(err)
 }

 pyBinaryTarget := newTargetBuilder(pyBinaryKind, pyBinaryTargetName, pythonProjectRoot, args.Rel, pyFileNames).
Expand All@@ -310,7 +323,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes

	var conftest *rule.Rule
	if hasConftestFile {
 deps, err := parser.parseSingle(conftestFilename)
 deps, _, err := parser.parseSingle(conftestFilename)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
Expand All@@ -319,16 +332,11 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == conftestTargetname && t.Kind() != actualPyLibraryKind {
 fqTarget := label.New("", args.Rel, conftestTargetname)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists.",
 fqTarget.String(), actualPyLibraryKind, t.Kind())
 collisionErrors.Add(err)
 }
 }
 if err := ensureNoCollision(args.File, conftestTargetname, actualPyLibraryKind); err != nil {
 fqTarget := label.New("", args.Rel, conftestTargetname)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. ",
 fqTarget.String(), actualPyLibraryKind, err)
 collisionErrors.Add(err)
 }

 conftestTarget := newTargetBuilder(pyLibraryKind, conftestTargetname, pythonProjectRoot, args.Rel, pyFileNames).
Expand All@@ -346,25 +354,20 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes

	var pyTestTargets []*targetBuilder
	newPyTestTargetBuilder := func(srcs *treeset.Set, pyTestTargetName string) *targetBuilder {
 deps, err := parser.parse(srcs)
 deps, _, err := parser.parse(srcs)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
 // Check if a target with the same name we are generating already
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == pyTestTargetName && t.Kind() != actualPyTestKind {
 fqTarget := label.New("", args.Rel, pyTestTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyTestKind, t.Kind(), pythonconfig.TestNamingConvention)
 collisionErrors.Add(err)
 }
 }
 if err := ensureNoCollision(args.File, pyTestTargetName, actualPyTestKind); err != nil {
 fqTarget := label.New("", args.Rel, pyTestTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyTestKind, err, pythonconfig.TestNamingConvention)
 collisionErrors.Add(err)
 }
 return newTargetBuilder(pyTestKind, pyTestTargetName, pythonProjectRoot, args.Rel, pyFileNames).
 addSrcs(srcs).
Expand DownExpand Up@@ -476,3 +479,15 @@ func isEntrypointFile(path string) bool {
 return false
	}
}

func ensureNoCollision(file *rule.File, targetName, kind string) error {
	if file == nil {
 return nil
	}
	for _, t := range file.Rules {
 if t.Name() == targetName && t.Kind() != kind {
 return fmt.Errorf("a target of kind %q with the same name already exists", t.Kind())
 }
	}
	return nil
}

31 changes: 30 additions & 1 deletion
gazelle/python/parse.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@
import os
import sys
from io import BytesIO
from tokenize import COMMENT, tokenize
from tokenize import COMMENT, NAME, OP, STRING, tokenize


def parse_import_statements(content, filepath):
Expand DownExpand Up@@ -59,6 +59,30 @@ def parse_comments(content):
 return comments


def parse_main(content):
 g = tokenize(BytesIO(content.encode("utf-8")).readline)
 for token_type, token_val, start, _, _ in g:
 if token_type != NAME or token_val != "if" or start[1] != 0:
 continue
 try:
 token_type, token_val, start, _, _ = next(g)
 if token_type != NAME or token_val != "__name__":
 continue
 token_type, token_val, start, _, _ = next(g)
 if token_type != OP or token_val != "==":
 continue
 token_type, token_val, start, _, _ = next(g)
 if token_type != STRING or token_val.strip("\"'") != '__main__':
 continue
 token_type, token_val, start, _, _ = next(g)
 if token_type != OP or token_val != ":":
 continue
 return True
 except StopIteration:
 break
 return False


def parse(repo_root, rel_package_path, filename):
 rel_filepath = os.path.join(rel_package_path, filename)
 abs_filepath = os.path.join(repo_root, rel_filepath)
Expand All@@ -70,11 +94,16 @@ def parse(repo_root, rel_package_path, filename):
 parse_import_statements, content, rel_filepath
 )
 comments_future = executor.submit(parse_comments, content)
 main_future = executor.submit(parse_main, content)
 modules = modules_future.result()
 comments = comments_future.result()
 has_main = main_future.result()

 output = {
 "filename": filename,
 "modules": modules,
 "comments": comments,
 "has_main": has_main,
 }
 return output

Expand Down

39 changes: 39 additions & 0 deletions
gazelle/python/parse_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
import unittest
import parse

class TestParse(unittest.TestCase):
 def test_not_has_main(self):
 content = "a = 1\nb = 2"
 self.assertFalse(parse.parse_main(content))

 def test_has_main_in_function(self):
 content = """
def foo():
 if __name__ == "__main__":
 a = 3
"""
 self.assertFalse(parse.parse_main(content))

 def test_has_main(self):
 content = """
import unittest

from lib import main


class ExampleTest(unittest.TestCase):
 def test_main(self):
 self.assertEqual(
 "",
 main([["A", 1], ["B", 2]]),
 )


if __name__ == "__main__":
 unittest.main()
"""
 self.assertTrue(parse.parse_main(content))


if __name__ == "__main__":
 unittest.main()
Loading

, '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('^' + ".*" + '
feat: Creating one py_binary per main module by linzhp · Pull Request #1584 · bazel-contrib/rules_python · GitHub
Skip to content
feat: Creating one py_binary per main module#1584

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

aignas
merged 13 commits into

from

Dec 13, 2023
 Merged


feat: Creating one py_binary per main module
#1584
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
2c178ae

Creating one py_binary per main module


linzhp Nov 29, 2023
401125f

revert accidental changes


linzhp Nov 29, 2023
c436ec8

handle empty lines


linzhp Nov 29, 2023
1784a99

reimplementing parse_main to fix a failing test


linzhp Nov 29, 2023
050efeb

fixed error message


linzhp Nov 29, 2023
d1b0593

Adding test cases for multiple py_binary and tests files


linzhp Dec 3, 2023
b6999fa

Merge branch 'main' into py_binary


linzhp Dec 3, 2023
2423b0c

sorting py_binary


linzhp Dec 3, 2023
bb82dde

fix test failures


linzhp Dec 4, 2023
38c10a9

increase timeout for requirements_3_10_test


linzhp Dec 4, 2023
bbd0389

formatting build file


linzhp Dec 4, 2023
de9ce9b

revert bazel version change


linzhp Dec 4, 2023
94e6327

extracting ensureNoCollision


linzhp Dec 9, 2023

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
examples/bzlmod/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ compile_pip_requirements_3_9(
# with pip-compile.
compile_pip_requirements_3_10(
 name = "requirements_3_10",
 timeout = "moderate",
 src = "requirements.in",
 requirements_txt = "requirements_lock_3_10.txt",
 requirements_windows = "requirements_windows_3_10.txt",
Expand Down

11 changes: 10 additions & 1 deletion
gazelle/python/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
load("@bazel_gazelle//:def.bzl", "gazelle_binary")
load("@io_bazel_rules_go//go:def.bzl", "go_library")
load("@rules_python//python:defs.bzl", "py_binary")
load("@rules_python//python:defs.bzl", "py_binary", "py_test")
load(":gazelle_test.bzl", "gazelle_test")

go_library(
Expand DownExpand Up@@ -58,6 +58,15 @@ py_binary(
 visibility = ["//visibility:public"],
)

py_test(
 name = "parse_test",
 srcs = [
 "parse.py",
 "parse_test.py",
 ],
 imports = ["."],
)

filegroup(
 name = "helper.zip",
 srcs = [":helper"],
Expand Down

2 changes: 1 addition & 1 deletion
gazelle/python/__main__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@

if __name__ == "__main__":
 if len(sys.argv) < 2:
 sys.exit("Please provide subcommand, either print or std_modules")
 sys.exit("Please provide subcommand, either parse or std_modules")
 if sys.argv[1] == "parse":
 sys.exit(parse.main(sys.stdin, sys.stdout))
 elif sys.argv[1] == "std_modules":
Expand Down

115 changes: 65 additions & 50 deletions
gazelle/python/generate.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import (
	"log"
	"os"
	"path/filepath"
	"sort"
	"strings"

	"github.com/bazelbuild/bazel-gazelle/config"
Expand DownExpand Up@@ -89,9 +90,9 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
	pyTestFilenames := treeset.NewWith(godsutils.StringComparator)
	pyFileNames := treeset.NewWith(godsutils.StringComparator)

	// hasPyBinary controls whether a py_binary target should be generated for
	// hasPyBinaryEntryPointFile controls whether a single py_binary target should be generated for
	// this package or not.
hasPyBinary := false
hasPyBinaryEntryPointFile := false

	// hasPyTestEntryPointFile and hasPyTestEntryPointTarget control whether a py_test target should
	// be generated for this package or not.
Expand All@@ -106,8 +107,8 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 ext := filepath.Ext(f)
 if ext == ".py" {
 pyFileNames.Add(f)
 if !hasPyBinary && f == pyBinaryEntrypointFilename {
hasPyBinary = true
 if !hasPyBinaryEntryPointFile && f == pyBinaryEntrypointFilename {
hasPyBinaryEntryPointFile = true
 } else if !hasPyTestEntryPointFile && f == pyTestEntrypointFilename {
 hasPyTestEntryPointFile = true
 } else if f == conftestFilename {
Expand DownExpand Up@@ -219,7 +220,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
	collisionErrors := singlylinkedlist.New()

	appendPyLibrary := func(srcs *treeset.Set, pyLibraryTargetName string) {
 deps, err := parser.parse(srcs)
 deps, mainModules, err := parser.parse(srcs)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
Expand All@@ -228,16 +229,33 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == pyLibraryTargetName && t.Kind() != actualPyLibraryKind {
 fqTarget := label.New("", args.Rel, pyLibraryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyLibraryKind, t.Kind(), pythonconfig.LibraryNamingConvention)
 collisionErrors.Add(err)
 if err := ensureNoCollision(args.File, pyLibraryTargetName, actualPyLibraryKind); err != nil {
 fqTarget := label.New("", args.Rel, pyLibraryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyLibraryKind, err, pythonconfig.LibraryNamingConvention)
 collisionErrors.Add(err)
 }

 if !hasPyBinaryEntryPointFile {
 sort.Strings(mainModules)
 // Creating one py_binary target per main module when __main__.py doesn't exist.
 for _, filename := range mainModules {
 pyBinaryTargetName := strings.TrimSuffix(filepath.Base(filename), ".py")
 if err := ensureNoCollision(args.File, pyBinaryTargetName, actualPyBinaryKind); err != nil {
 fqTarget := label.New("", args.Rel, pyBinaryTargetName)
 log.Printf("failed to generate target %q of kind %q: %v",
 fqTarget.String(), actualPyBinaryKind, err)
 continue
 }
 srcs.Remove(filename)
 pyBinary := newTargetBuilder(pyBinaryKind, pyBinaryTargetName, pythonProjectRoot, args.Rel, pyFileNames).
 addVisibility(visibility).
 addSrc(filename).
 addModuleDependencies(deps).
 generateImportsAttribute().build()
 result.Gen = append(result.Gen, pyBinary)
 result.Imports = append(result.Imports, pyBinary.PrivateAttr(config.GazelleImportsKey))
 }
 }

Expand DownExpand Up@@ -270,8 +288,8 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 appendPyLibrary(pyLibraryFilenames, cfg.RenderLibraryName(packageName))
	}

	if hasPyBinary {
 deps, err := parser.parseSingle(pyBinaryEntrypointFilename)
	if hasPyBinaryEntryPointFile {
 deps, _, err := parser.parseSingle(pyBinaryEntrypointFilename)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
Expand All@@ -282,17 +300,12 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == pyBinaryTargetName && t.Kind() != actualPyBinaryKind {
 fqTarget := label.New("", args.Rel, pyBinaryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyBinaryKind, t.Kind(), pythonconfig.BinaryNamingConvention)
 collisionErrors.Add(err)
 }
 }
 if err := ensureNoCollision(args.File, pyBinaryTargetName, actualPyBinaryKind); err != nil {
 fqTarget := label.New("", args.Rel, pyBinaryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyBinaryKind, err, pythonconfig.BinaryNamingConvention)
 collisionErrors.Add(err)
 }

 pyBinaryTarget := newTargetBuilder(pyBinaryKind, pyBinaryTargetName, pythonProjectRoot, args.Rel, pyFileNames).
Expand All@@ -310,7 +323,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes

	var conftest *rule.Rule
	if hasConftestFile {
 deps, err := parser.parseSingle(conftestFilename)
 deps, _, err := parser.parseSingle(conftestFilename)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
Expand All@@ -319,16 +332,11 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == conftestTargetname && t.Kind() != actualPyLibraryKind {
 fqTarget := label.New("", args.Rel, conftestTargetname)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists.",
 fqTarget.String(), actualPyLibraryKind, t.Kind())
 collisionErrors.Add(err)
 }
 }
 if err := ensureNoCollision(args.File, conftestTargetname, actualPyLibraryKind); err != nil {
 fqTarget := label.New("", args.Rel, conftestTargetname)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. ",
 fqTarget.String(), actualPyLibraryKind, err)
 collisionErrors.Add(err)
 }

 conftestTarget := newTargetBuilder(pyLibraryKind, conftestTargetname, pythonProjectRoot, args.Rel, pyFileNames).
Expand All@@ -346,25 +354,20 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes

	var pyTestTargets []*targetBuilder
	newPyTestTargetBuilder := func(srcs *treeset.Set, pyTestTargetName string) *targetBuilder {
 deps, err := parser.parse(srcs)
 deps, _, err := parser.parse(srcs)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
 // Check if a target with the same name we are generating already
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == pyTestTargetName && t.Kind() != actualPyTestKind {
 fqTarget := label.New("", args.Rel, pyTestTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyTestKind, t.Kind(), pythonconfig.TestNamingConvention)
 collisionErrors.Add(err)
 }
 }
 if err := ensureNoCollision(args.File, pyTestTargetName, actualPyTestKind); err != nil {
 fqTarget := label.New("", args.Rel, pyTestTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyTestKind, err, pythonconfig.TestNamingConvention)
 collisionErrors.Add(err)
 }
 return newTargetBuilder(pyTestKind, pyTestTargetName, pythonProjectRoot, args.Rel, pyFileNames).
 addSrcs(srcs).
Expand DownExpand Up@@ -476,3 +479,15 @@ func isEntrypointFile(path string) bool {
 return false
	}
}

func ensureNoCollision(file *rule.File, targetName, kind string) error {
	if file == nil {
 return nil
	}
	for _, t := range file.Rules {
 if t.Name() == targetName && t.Kind() != kind {
 return fmt.Errorf("a target of kind %q with the same name already exists", t.Kind())
 }
	}
	return nil
}

31 changes: 30 additions & 1 deletion
gazelle/python/parse.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@
import os
import sys
from io import BytesIO
from tokenize import COMMENT, tokenize
from tokenize import COMMENT, NAME, OP, STRING, tokenize


def parse_import_statements(content, filepath):
Expand DownExpand Up@@ -59,6 +59,30 @@ def parse_comments(content):
 return comments


def parse_main(content):
 g = tokenize(BytesIO(content.encode("utf-8")).readline)
 for token_type, token_val, start, _, _ in g:
 if token_type != NAME or token_val != "if" or start[1] != 0:
 continue
 try:
 token_type, token_val, start, _, _ = next(g)
 if token_type != NAME or token_val != "__name__":
 continue
 token_type, token_val, start, _, _ = next(g)
 if token_type != OP or token_val != "==":
 continue
 token_type, token_val, start, _, _ = next(g)
 if token_type != STRING or token_val.strip("\"'") != '__main__':
 continue
 token_type, token_val, start, _, _ = next(g)
 if token_type != OP or token_val != ":":
 continue
 return True
 except StopIteration:
 break
 return False


def parse(repo_root, rel_package_path, filename):
 rel_filepath = os.path.join(rel_package_path, filename)
 abs_filepath = os.path.join(repo_root, rel_filepath)
Expand All@@ -70,11 +94,16 @@ def parse(repo_root, rel_package_path, filename):
 parse_import_statements, content, rel_filepath
 )
 comments_future = executor.submit(parse_comments, content)
 main_future = executor.submit(parse_main, content)
 modules = modules_future.result()
 comments = comments_future.result()
 has_main = main_future.result()

 output = {
 "filename": filename,
 "modules": modules,
 "comments": comments,
 "has_main": has_main,
 }
 return output

Expand Down

39 changes: 39 additions & 0 deletions
gazelle/python/parse_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
import unittest
import parse

class TestParse(unittest.TestCase):
 def test_not_has_main(self):
 content = "a = 1\nb = 2"
 self.assertFalse(parse.parse_main(content))

 def test_has_main_in_function(self):
 content = """
def foo():
 if __name__ == "__main__":
 a = 3
"""
 self.assertFalse(parse.parse_main(content))

 def test_has_main(self):
 content = """
import unittest

from lib import main


class ExampleTest(unittest.TestCase):
 def test_main(self):
 self.assertEqual(
 "",
 main([["A", 1], ["B", 2]]),
 )


if __name__ == "__main__":
 unittest.main()
"""
 self.assertTrue(parse.parse_main(content))


if __name__ == "__main__":
 unittest.main()
Loading

, '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); }
})();
})();
feat: Creating one py_binary per main module by linzhp · Pull Request #1584 · bazel-contrib/rules_python · GitHub
Skip to content
feat: Creating one py_binary per main module#1584

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

aignas
merged 13 commits into

from

Dec 13, 2023
 Merged


feat: Creating one py_binary per main module
#1584
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
2c178ae

Creating one py_binary per main module


linzhp Nov 29, 2023
401125f

revert accidental changes


linzhp Nov 29, 2023
c436ec8

handle empty lines


linzhp Nov 29, 2023
1784a99

reimplementing parse_main to fix a failing test


linzhp Nov 29, 2023
050efeb

fixed error message


linzhp Nov 29, 2023
d1b0593

Adding test cases for multiple py_binary and tests files


linzhp Dec 3, 2023
b6999fa

Merge branch 'main' into py_binary


linzhp Dec 3, 2023
2423b0c

sorting py_binary


linzhp Dec 3, 2023
bb82dde

fix test failures


linzhp Dec 4, 2023
38c10a9

increase timeout for requirements_3_10_test


linzhp Dec 4, 2023
bbd0389

formatting build file


linzhp Dec 4, 2023
de9ce9b

revert bazel version change


linzhp Dec 4, 2023
94e6327

extracting ensureNoCollision


linzhp Dec 9, 2023

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
examples/bzlmod/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ compile_pip_requirements_3_9(
# with pip-compile.
compile_pip_requirements_3_10(
 name = "requirements_3_10",
 timeout = "moderate",
 src = "requirements.in",
 requirements_txt = "requirements_lock_3_10.txt",
 requirements_windows = "requirements_windows_3_10.txt",
Expand Down

11 changes: 10 additions & 1 deletion
gazelle/python/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
load("@bazel_gazelle//:def.bzl", "gazelle_binary")
load("@io_bazel_rules_go//go:def.bzl", "go_library")
load("@rules_python//python:defs.bzl", "py_binary")
load("@rules_python//python:defs.bzl", "py_binary", "py_test")
load(":gazelle_test.bzl", "gazelle_test")

go_library(
Expand DownExpand Up@@ -58,6 +58,15 @@ py_binary(
 visibility = ["//visibility:public"],
)

py_test(
 name = "parse_test",
 srcs = [
 "parse.py",
 "parse_test.py",
 ],
 imports = ["."],
)

filegroup(
 name = "helper.zip",
 srcs = [":helper"],
Expand Down

2 changes: 1 addition & 1 deletion
gazelle/python/__main__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@

if __name__ == "__main__":
 if len(sys.argv) < 2:
 sys.exit("Please provide subcommand, either print or std_modules")
 sys.exit("Please provide subcommand, either parse or std_modules")
 if sys.argv[1] == "parse":
 sys.exit(parse.main(sys.stdin, sys.stdout))
 elif sys.argv[1] == "std_modules":
Expand Down

115 changes: 65 additions & 50 deletions
gazelle/python/generate.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import (
	"log"
	"os"
	"path/filepath"
	"sort"
	"strings"

	"github.com/bazelbuild/bazel-gazelle/config"
Expand DownExpand Up@@ -89,9 +90,9 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
	pyTestFilenames := treeset.NewWith(godsutils.StringComparator)
	pyFileNames := treeset.NewWith(godsutils.StringComparator)

	// hasPyBinary controls whether a py_binary target should be generated for
	// hasPyBinaryEntryPointFile controls whether a single py_binary target should be generated for
	// this package or not.
hasPyBinary := false
hasPyBinaryEntryPointFile := false

	// hasPyTestEntryPointFile and hasPyTestEntryPointTarget control whether a py_test target should
	// be generated for this package or not.
Expand All@@ -106,8 +107,8 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 ext := filepath.Ext(f)
 if ext == ".py" {
 pyFileNames.Add(f)
 if !hasPyBinary && f == pyBinaryEntrypointFilename {
hasPyBinary = true
 if !hasPyBinaryEntryPointFile && f == pyBinaryEntrypointFilename {
hasPyBinaryEntryPointFile = true
 } else if !hasPyTestEntryPointFile && f == pyTestEntrypointFilename {
 hasPyTestEntryPointFile = true
 } else if f == conftestFilename {
Expand DownExpand Up@@ -219,7 +220,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
	collisionErrors := singlylinkedlist.New()

	appendPyLibrary := func(srcs *treeset.Set, pyLibraryTargetName string) {
 deps, err := parser.parse(srcs)
 deps, mainModules, err := parser.parse(srcs)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
Expand All@@ -228,16 +229,33 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == pyLibraryTargetName && t.Kind() != actualPyLibraryKind {
 fqTarget := label.New("", args.Rel, pyLibraryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyLibraryKind, t.Kind(), pythonconfig.LibraryNamingConvention)
 collisionErrors.Add(err)
 if err := ensureNoCollision(args.File, pyLibraryTargetName, actualPyLibraryKind); err != nil {
 fqTarget := label.New("", args.Rel, pyLibraryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyLibraryKind, err, pythonconfig.LibraryNamingConvention)
 collisionErrors.Add(err)
 }

 if !hasPyBinaryEntryPointFile {
 sort.Strings(mainModules)
 // Creating one py_binary target per main module when __main__.py doesn't exist.
 for _, filename := range mainModules {
 pyBinaryTargetName := strings.TrimSuffix(filepath.Base(filename), ".py")
 if err := ensureNoCollision(args.File, pyBinaryTargetName, actualPyBinaryKind); err != nil {
 fqTarget := label.New("", args.Rel, pyBinaryTargetName)
 log.Printf("failed to generate target %q of kind %q: %v",
 fqTarget.String(), actualPyBinaryKind, err)
 continue
 }
 srcs.Remove(filename)
 pyBinary := newTargetBuilder(pyBinaryKind, pyBinaryTargetName, pythonProjectRoot, args.Rel, pyFileNames).
 addVisibility(visibility).
 addSrc(filename).
 addModuleDependencies(deps).
 generateImportsAttribute().build()
 result.Gen = append(result.Gen, pyBinary)
 result.Imports = append(result.Imports, pyBinary.PrivateAttr(config.GazelleImportsKey))
 }
 }

Expand DownExpand Up@@ -270,8 +288,8 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 appendPyLibrary(pyLibraryFilenames, cfg.RenderLibraryName(packageName))
	}

	if hasPyBinary {
 deps, err := parser.parseSingle(pyBinaryEntrypointFilename)
	if hasPyBinaryEntryPointFile {
 deps, _, err := parser.parseSingle(pyBinaryEntrypointFilename)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
Expand All@@ -282,17 +300,12 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == pyBinaryTargetName && t.Kind() != actualPyBinaryKind {
 fqTarget := label.New("", args.Rel, pyBinaryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyBinaryKind, t.Kind(), pythonconfig.BinaryNamingConvention)
 collisionErrors.Add(err)
 }
 }
 if err := ensureNoCollision(args.File, pyBinaryTargetName, actualPyBinaryKind); err != nil {
 fqTarget := label.New("", args.Rel, pyBinaryTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyBinaryKind, err, pythonconfig.BinaryNamingConvention)
 collisionErrors.Add(err)
 }

 pyBinaryTarget := newTargetBuilder(pyBinaryKind, pyBinaryTargetName, pythonProjectRoot, args.Rel, pyFileNames).
Expand All@@ -310,7 +323,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes

	var conftest *rule.Rule
	if hasConftestFile {
 deps, err := parser.parseSingle(conftestFilename)
 deps, _, err := parser.parseSingle(conftestFilename)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
Expand All@@ -319,16 +332,11 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == conftestTargetname && t.Kind() != actualPyLibraryKind {
 fqTarget := label.New("", args.Rel, conftestTargetname)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists.",
 fqTarget.String(), actualPyLibraryKind, t.Kind())
 collisionErrors.Add(err)
 }
 }
 if err := ensureNoCollision(args.File, conftestTargetname, actualPyLibraryKind); err != nil {
 fqTarget := label.New("", args.Rel, conftestTargetname)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. ",
 fqTarget.String(), actualPyLibraryKind, err)
 collisionErrors.Add(err)
 }

 conftestTarget := newTargetBuilder(pyLibraryKind, conftestTargetname, pythonProjectRoot, args.Rel, pyFileNames).
Expand All@@ -346,25 +354,20 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes

	var pyTestTargets []*targetBuilder
	newPyTestTargetBuilder := func(srcs *treeset.Set, pyTestTargetName string) *targetBuilder {
 deps, err := parser.parse(srcs)
 deps, _, err := parser.parse(srcs)
 if err != nil {
 log.Fatalf("ERROR: %v\n", err)
 }
 // Check if a target with the same name we are generating already
 // exists, and if it is of a different kind from the one we are
 // generating. If so, we have to throw an error since Gazelle won't
 // generate it correctly.
 if args.File != nil {
 for _, t := range args.File.Rules {
 if t.Name() == pyTestTargetName && t.Kind() != actualPyTestKind {
 fqTarget := label.New("", args.Rel, pyTestTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: "+
 "a target of kind %q with the same name already exists. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyTestKind, t.Kind(), pythonconfig.TestNamingConvention)
 collisionErrors.Add(err)
 }
 }
 if err := ensureNoCollision(args.File, pyTestTargetName, actualPyTestKind); err != nil {
 fqTarget := label.New("", args.Rel, pyTestTargetName)
 err := fmt.Errorf("failed to generate target %q of kind %q: %w. "+
 "Use the '# gazelle:%s' directive to change the naming convention.",
 fqTarget.String(), actualPyTestKind, err, pythonconfig.TestNamingConvention)
 collisionErrors.Add(err)
 }
 return newTargetBuilder(pyTestKind, pyTestTargetName, pythonProjectRoot, args.Rel, pyFileNames).
 addSrcs(srcs).
Expand DownExpand Up@@ -476,3 +479,15 @@ func isEntrypointFile(path string) bool {
 return false
	}
}

func ensureNoCollision(file *rule.File, targetName, kind string) error {
	if file == nil {
 return nil
	}
	for _, t := range file.Rules {
 if t.Name() == targetName && t.Kind() != kind {
 return fmt.Errorf("a target of kind %q with the same name already exists", t.Kind())
 }
	}
	return nil
}

31 changes: 30 additions & 1 deletion
gazelle/python/parse.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@
import os
import sys
from io import BytesIO
from tokenize import COMMENT, tokenize
from tokenize import COMMENT, NAME, OP, STRING, tokenize


def parse_import_statements(content, filepath):
Expand DownExpand Up@@ -59,6 +59,30 @@ def parse_comments(content):
 return comments


def parse_main(content):
 g = tokenize(BytesIO(content.encode("utf-8")).readline)
 for token_type, token_val, start, _, _ in g:
 if token_type != NAME or token_val != "if" or start[1] != 0:
 continue
 try:
 token_type, token_val, start, _, _ = next(g)
 if token_type != NAME or token_val != "__name__":
 continue
 token_type, token_val, start, _, _ = next(g)
 if token_type != OP or token_val != "==":
 continue
 token_type, token_val, start, _, _ = next(g)
 if token_type != STRING or token_val.strip("\"'") != '__main__':
 continue
 token_type, token_val, start, _, _ = next(g)
 if token_type != OP or token_val != ":":
 continue
 return True
 except StopIteration:
 break
 return False


def parse(repo_root, rel_package_path, filename):
 rel_filepath = os.path.join(rel_package_path, filename)
 abs_filepath = os.path.join(repo_root, rel_filepath)
Expand All@@ -70,11 +94,16 @@ def parse(repo_root, rel_package_path, filename):
 parse_import_statements, content, rel_filepath
 )
 comments_future = executor.submit(parse_comments, content)
 main_future = executor.submit(parse_main, content)
 modules = modules_future.result()
 comments = comments_future.result()
 has_main = main_future.result()

 output = {
 "filename": filename,
 "modules": modules,
 "comments": comments,
 "has_main": has_main,
 }
 return output

Expand Down

39 changes: 39 additions & 0 deletions
gazelle/python/parse_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
import unittest
import parse

class TestParse(unittest.TestCase):
 def test_not_has_main(self):
 content = "a = 1\nb = 2"
 self.assertFalse(parse.parse_main(content))

 def test_has_main_in_function(self):
 content = """
def foo():
 if __name__ == "__main__":
 a = 3
"""
 self.assertFalse(parse.parse_main(content))

 def test_has_main(self):
 content = """
import unittest

from lib import main


class ExampleTest(unittest.TestCase):
 def test_main(self):
 self.assertEqual(
 "",
 main([["A", 1], ["B", 2]]),
 )


if __name__ == "__main__":
 unittest.main()
"""
 self.assertTrue(parse.parse_main(content))


if __name__ == "__main__":
 unittest.main()
Loading