Gazelle bzlmod poc v2#971

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

Closed
aignas wants to merge 7 commits into from
Closed

Gazelle bzlmod poc v2 #971

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
abde25c
breaking: feat(gazelle): Move the plugin to a separate workspace
aignas Jan 4, 2023
de9ae05
feat: Store alias labels in requirements arrays if using bzlmod
aignas Jan 3, 2023
6d86634
feat(gazelle): Support bzlmod
aignas Jan 4, 2023
e221f25
feat(gazelle): store metadata in a structure and read it
aignas Jan 3, 2023
51f2863
Update the example code
aignas Jan 4, 2023
9c024a6
Use bzlmod in the example
aignas Jan 4, 2023
543923b
Revert "Use bzlmod in the example"
aignas Jan 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
11 changes: 3 additions & 8 deletions .bazelci/presubmit.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,17 +10,11 @@ buildifier:
# As a regression test for #225, check that wheel targets still build when
# their package path is qualified with the repo name.
- "@rules_python//examples/wheel/..."
- "-//gazelle/..."
build_flags:
- "--keep_going"
test_targets:
- "--"
- "..."
# The gazelle tests are not compatible with Windows, so we only test them
# on Linux. The build file generation, which uses this Gazelle extension,
# runs on all platforms, and is asserted by the build_file_generation
# integration tests below.
- "-//gazelle/..."
test_flags:
- "--test_tag_filters=-integration-test"
.reusable_build_test_all: &reusable_build_test_all
Expand All@@ -30,8 +24,9 @@ tasks:
gazelle_extension:
name: Test the Gazelle extension
platform: ubuntu2004
build_targets: ["//gazelle/..."]
test_targets: ["//gazelle/..."]
build_targets: ["//..."]
test_targets: ["//..."]
working_directory: gazelle
ubuntu:
<<: *reusable_config
name: Default test on Ubuntu
Expand Down
4 changes: 2 additions & 2 deletions .bazelrc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
# This lets us glob() up all the files inside the examples to make them inputs to tests
# (Note, we cannot use `common --deleted_packages` because the bazel version command doesn't support it)
# To update these lines, run tools/bazel_integration_test/update_deleted_packages.sh
build --deleted_packages=examples/build_file_generation,examples/build_file_generation/get_url,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/build_file_generation/get_url,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
build --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps

test --test_output=errors

Expand Down
20 changes: 1 addition & 19 deletions BUILD.bazel
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.

load("@bazel_gazelle//:def.bzl", "gazelle")
load(":version.bzl", "BAZEL_VERSION")

package(default_visibility = ["//visibility:public"])
Expand All@@ -32,13 +31,13 @@ filegroup(
"WORKSPACE",
"internal_deps.bzl",
"internal_setup.bzl",
"//gazelle:distribution",
"//python:distribution",
"//python/pip_install:distribution",
"//third_party/github.com/bazelbuild/bazel-skylib/lib:distribution",
"//third_party/github.com/bazelbuild/bazel-skylib/rules:distribution",
"//third_party/github.com/bazelbuild/bazel-skylib/rules/private:distribution",
"//tools:distribution",
"@rules_python_gazelle_plugin//:distribution",
],
visibility = [
"//examples:__pkg__",
Expand All@@ -64,23 +63,6 @@ filegroup(
visibility = ["//visibility:public"],
)

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python
# gazelle:exclude bazel-out
# gazelle:exclude examples/**
gazelle(name = "gazelle")

gazelle(
name = "gazelle_update_repos",
args = [
"-from_file=go.mod",
"-to_macro=gazelle/deps.bzl%gazelle_deps",
"-prune",
],
command = "update-repos",
)

genrule(
name = "assert_bazelversion",
srcs = [".bazelversion"],
Expand Down
19 changes: 14 additions & 5 deletions WORKSPACE
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,11 +34,6 @@ python_register_multi_toolchains(
python_versions = MINOR_MAPPING.values(),
)

load("//gazelle:deps.bzl", "gazelle_deps")

# gazelle:repository_macro gazelle/deps.bzl%gazelle_deps
gazelle_deps()

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

# Used for Bazel CI
Expand All@@ -58,3 +53,17 @@ rbe_preconfig(
name = "buildkite_config",
toolchain = "ubuntu1804-bazel-java11",
)

local_repository(
name = "rules_python_gazelle_plugin",
path = "gazelle",
)

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
# for python requirements.
_py_gazelle_deps()
32 changes: 11 additions & 21 deletions examples/build_file_generation/BUILD.bazel
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,12 +3,11 @@
# The `load` statement imports the symbol for the rule, in the defined
# ruleset. When the symbol is loaded you can use the rule.
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@pip//:gazelle.bzl", "GAZELLE_PLUGIN_ARGS")
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")
load("@rules_python//python:pip.bzl", "compile_pip_requirements")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")

compile_pip_requirements(
name = "requirements",
Expand All@@ -18,31 +17,22 @@ compile_pip_requirements(
requirements_windows = "requirements_windows.txt",
)

# This repository rule fetches the metadata for python packages we
# depend on. That data is required for the gazelle_python_manifest
# rule to update our manifest file.
# To see what this rule does, try `bazel run @modules_map//:print`
modules_mapping(
name = "modules_map",
exclude_patterns = [
"^_|(\\._)+", # This is the default.
"(\\.tests)+", # Add a custom one to get rid of the psutil tests.
],
wheels = all_whl_requirements,
)

# Gazelle python extension needs a manifest file mapping from
# an import to the installed package that provides it.
# This macro produces two targets:
# - //:gazelle_python_manifest.modules_mapping, which fetches the metadata for
# python packages we depend on. That data is required for the
# gazelle_python_manifest rule to update our manifest file.
# - //:gazelle_python_manifest.update can be used with `bazel run`
# to recalculate the manifest
# - //:gazelle_python_manifest.test is a test target ensuring that
# the manifest doesn't need to be updated
gazelle_python_manifest(
name = "gazelle_python_manifest",
modules_mapping = ":modules_map",
pip_repository_name = "pip",
requirements = "//:requirements_lock.txt",
extend_exclude_patterns = [
"(\\.tests)+", # Add a custom one to get rid of the psutil tests.
],
metadata = GAZELLE_PLUGIN_ARGS,
)

# Our gazelle target points to the python gazelle binary.
Expand All@@ -53,7 +43,7 @@ gazelle_python_manifest(
gazelle(
name = "gazelle",
data = GAZELLE_PYTHON_RUNTIME_DEPS,
gazelle = "@rules_python//gazelle:gazelle_python_binary",
gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)

# This rule is auto-generated and managed by Gazelle,
Expand Down
43 changes: 43 additions & 0 deletions examples/build_file_generation/MODULE.bazel
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
module(
name = "example_bzlmod",
compatibility_level = 1,
version = "0.0.0",
)

bazel_dep(name = "rules_python", version = "0.0.0")
bazel_dep(name = "rules_python_gazelle_plugin", version = "0.0.0")

local_path_override(
module_name = "rules_python",
path = "../..",
)

local_path_override(
module_name = "rules_python_gazelle_plugin",
path = "../../gazelle",
)

python = use_extension("@rules_python//python:extensions.bzl", "python")

python.toolchain(
name = "python3_9",
python_version = "3.9",
)

use_repo(python, "python3_9_toolchains")

register_toolchains(
"@python3_9_toolchains//:all",
)

pip = use_extension("@rules_python//python:extensions.bzl", "pip")

pip.parse(
name = "pip",
requirements_lock = "//:requirements_lock.txt",
requirements_windows = "//:requirements_windows.txt",
)

use_repo(pip, "pip")

bazel_dep(name = "gazelle", repo_name = "bazel_gazelle", version = "0.28.0")
9 changes: 9 additions & 0 deletions examples/build_file_generation/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,3 +18,12 @@ added to the `py_library` target in the `BUILD` file.

For more information on the behavior of the rules_python gazelle extension,
see the README.md file in the /gazelle folder.

# bzlmod

This also works with bzlmod. To do that:
1. Add a line into the `.bazelrc` to enable `bzlmod`.
1. Run `bazel run //:gazelle_python_manifest.update`
1. Run `bazel run //:gazelle`

This is necessary to switch to the `bzlmod` way of accessing third-party dependencies.
15 changes: 14 additions & 1 deletion examples/build_file_generation/WORKSPACE
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,11 @@ local_repository(
path = "../..",
)

local_repository(
name = "rules_python_gazelle_plugin",
path = "../../gazelle",
)

# When not using this example in the rules_python git repo you would load the python
# ruleset using the following StarLark.
# See https://github.com/bazelbuild/rules_python#getting-started for the latest
Expand All@@ -81,6 +86,14 @@ local_repository(
# strip_prefix = "rules_python-0.16.1",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )
#
# load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
# http_archive(
# name = "rules_python_gazelle_plugin",
# sha256 = "497ca47374f48c8b067d786b512ac10a276211810f4a580178ee9b9ad139323a",
# strip_prefix = "rules_python-0.16.1/gazelle",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )

# Next we load the toolchain from rules_python.
load("@rules_python//python:repositories.bzl", "python_register_toolchains")
Expand DownExpand Up@@ -124,7 +137,7 @@ install_deps()

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
Expand Down
2 changes: 2 additions & 0 deletions examples/build_file_generation/WORKSPACE.bzlmod
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# Empty file indicating the root of a Bazel workspace.
# Dependencies and setup are in MODULE.bazel.
5 changes: 3 additions & 2 deletions examples/build_file_generation/gazelle_python.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,5 +113,6 @@ manifest:
zipp: zipp
zipp.py310compat: zipp
pip_repository:
name: pip
integrity: 4153df7683d64d7d6ad56c14ea1c7f7bec84a2ddf9ef8f075d1bb9313b8d11aa
repo_convention: pip_%s
target_convention: pkg
integrity: 75649e137de25ba5161744181a95f4ce3f3d6c41d998a099eab5dcc8a446d395
3 changes: 2 additions & 1 deletion examples/bzlmod/BUILD.bazel
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,8 @@ py_library(
name = "lib",
srcs = ["__init__.py"],
deps = [
requirement("pylint"),
# You can reference libraries using plain text form or the 'requirement' macro
"@pip//:pylint_pkg",
requirement("tabulate"),
requirement("python-dateutil"),
],
Expand Down
13 changes: 13 additions & 0 deletions gazelle/.bazelrc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
test --test_output=errors

# Do NOT implicitly create empty __init__.py files in the runfiles tree.
# By default, these are created in every directory containing Python source code
# or shared libraries, and every parent directory of those directories,
# excluding the repo root directory. With this flag set, we are responsible for
# creating (possibly empty) __init__.py files and adding them to the srcs of
# Python targets as required.
build --incompatible_default_to_explicit_init_py

# Windows makes use of runfiles for some rules
build --enable_runfiles
startup --windows_enable_symlinks
52 changes: 52 additions & 0 deletions gazelle/.gitignore
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
# Compiled Object files
*.slo
*.lo
*.o
*.obj

# Precompiled Headers
*.gch
*.pch

# Compiled Dynamic libraries
*.so
*.dylib
*.dll

# Fortran module files
*.mod
*.smod

# Compiled Static libraries
*.lai
*.la
*.a
*.lib

# Executables
*.exe
*.out
*.app

# Emacs garbage
*~

# Bazel directories
/bazel-*
/bazel-bin
/bazel-genfiles
/bazel-out
/bazel-testlogs
user.bazelrc

# vim swap files
*.swp
*.swo

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out

# Python cache
**/__pycache__/
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Gazelle bzlmod poc v2#971

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

 Closed

aignas
wants to merge
7
commits into

from

 Closed


Gazelle bzlmod poc v2
#971
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
abde25c

breaking: feat(gazelle): Move the plugin to a separate workspace


aignas Jan 4, 2023
de9ae05

feat: Store alias labels in requirements arrays if using bzlmod


aignas Jan 3, 2023
6d86634

feat(gazelle): Support bzlmod


aignas Jan 4, 2023
e221f25

feat(gazelle): store metadata in a structure and read it


aignas Jan 3, 2023
51f2863

Update the example code


aignas Jan 4, 2023
9c024a6

Use bzlmod in the example


aignas Jan 4, 2023
543923b

Revert "Use bzlmod in the example"


aignas Jan 4, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

The table of contents is too big for display.

 Diff view

 Diff view

  •  
  •  
  •  

11 changes: 3 additions & 8 deletions
.bazelci/presubmit.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,17 +10,11 @@ buildifier:
 # As a regression test for #225, check that wheel targets still build when
 # their package path is qualified with the repo name.
 - "@rules_python//examples/wheel/..."
 - "-//gazelle/..."
 build_flags:
 - "--keep_going"
 test_targets:
 - "--"
 - "..."
 # The gazelle tests are not compatible with Windows, so we only test them
 # on Linux. The build file generation, which uses this Gazelle extension,
 # runs on all platforms, and is asserted by the build_file_generation
 # integration tests below.
 - "-//gazelle/..."
 test_flags:
 - "--test_tag_filters=-integration-test"
.reusable_build_test_all: &reusable_build_test_all
Expand All@@ -30,8 +24,9 @@ tasks:
 gazelle_extension:
 name: Test the Gazelle extension
 platform: ubuntu2004
 build_targets: ["//gazelle/..."]
 test_targets: ["//gazelle/..."]
 build_targets: ["//..."]
 test_targets: ["//..."]
 working_directory: gazelle
 ubuntu:
 <<: *reusable_config
 name: Default test on Ubuntu
Expand Down

4 changes: 2 additions & 2 deletions
.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
# This lets us glob() up all the files inside the examples to make them inputs to tests
# (Note, we cannot use `common --deleted_packages` because the bazel version command doesn't support it)
# To update these lines, run tools/bazel_integration_test/update_deleted_packages.sh
build --deleted_packages=examples/build_file_generation,examples/build_file_generation/get_url,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/build_file_generation/get_url,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
build --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps

test --test_output=errors

Expand Down

20 changes: 1 addition & 19 deletions
BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.

load("@bazel_gazelle//:def.bzl", "gazelle")
load(":version.bzl", "BAZEL_VERSION")

package(default_visibility = ["//visibility:public"])
Expand All@@ -32,13 +31,13 @@ filegroup(
 "WORKSPACE",
 "internal_deps.bzl",
 "internal_setup.bzl",
 "//gazelle:distribution",
 "//python:distribution",
 "//python/pip_install:distribution",
 "//third_party/github.com/bazelbuild/bazel-skylib/lib:distribution",
 "//third_party/github.com/bazelbuild/bazel-skylib/rules:distribution",
 "//third_party/github.com/bazelbuild/bazel-skylib/rules/private:distribution",
 "//tools:distribution",
 "@rules_python_gazelle_plugin//:distribution",
 ],
 visibility = [
 "//examples:__pkg__",
Expand All@@ -64,23 +63,6 @@ filegroup(
 visibility = ["//visibility:public"],
)

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python
# gazelle:exclude bazel-out
# gazelle:exclude examples/**
gazelle(name = "gazelle")

gazelle(
 name = "gazelle_update_repos",
 args = [
 "-from_file=go.mod",
 "-to_macro=gazelle/deps.bzl%gazelle_deps",
 "-prune",
 ],
 command = "update-repos",
)

genrule(
 name = "assert_bazelversion",
 srcs = [".bazelversion"],
Expand Down

19 changes: 14 additions & 5 deletions
WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,11 +34,6 @@ python_register_multi_toolchains(
 python_versions = MINOR_MAPPING.values(),
)

load("//gazelle:deps.bzl", "gazelle_deps")

# gazelle:repository_macro gazelle/deps.bzl%gazelle_deps
gazelle_deps()

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

# Used for Bazel CI
Expand All@@ -58,3 +53,17 @@ rbe_preconfig(
 name = "buildkite_config",
 toolchain = "ubuntu1804-bazel-java11",
)

local_repository(
 name = "rules_python_gazelle_plugin",
 path = "gazelle",
)

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
# for python requirements.
_py_gazelle_deps()

32 changes: 11 additions & 21 deletions
examples/build_file_generation/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,12 +3,11 @@
# The `load` statement imports the symbol for the rule, in the defined
# ruleset. When the symbol is loaded you can use the rule.
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@pip//:gazelle.bzl", "GAZELLE_PLUGIN_ARGS")
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")
load("@rules_python//python:pip.bzl", "compile_pip_requirements")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")

compile_pip_requirements(
 name = "requirements",
Expand All@@ -18,31 +17,22 @@ compile_pip_requirements(
 requirements_windows = "requirements_windows.txt",
)

# This repository rule fetches the metadata for python packages we
# depend on. That data is required for the gazelle_python_manifest
# rule to update our manifest file.
# To see what this rule does, try `bazel run @modules_map//:print`
modules_mapping(
 name = "modules_map",
 exclude_patterns = [
 "^_|(\\._)+", # This is the default.
 "(\\.tests)+", # Add a custom one to get rid of the psutil tests.
 ],
 wheels = all_whl_requirements,
)

# Gazelle python extension needs a manifest file mapping from
# an import to the installed package that provides it.
# This macro produces two targets:
# - //:gazelle_python_manifest.modules_mapping, which fetches the metadata for
# python packages we depend on. That data is required for the
# gazelle_python_manifest rule to update our manifest file.
# - //:gazelle_python_manifest.update can be used with `bazel run`
# to recalculate the manifest
# - //:gazelle_python_manifest.test is a test target ensuring that
# the manifest doesn't need to be updated
gazelle_python_manifest(
 name = "gazelle_python_manifest",
 modules_mapping = ":modules_map",
 pip_repository_name = "pip",
 requirements = "//:requirements_lock.txt",
 extend_exclude_patterns = [
 "(\\.tests)+", # Add a custom one to get rid of the psutil tests.
 ],
 metadata = GAZELLE_PLUGIN_ARGS,
)

# Our gazelle target points to the python gazelle binary.
Expand All@@ -53,7 +43,7 @@ gazelle_python_manifest(
gazelle(
 name = "gazelle",
 data = GAZELLE_PYTHON_RUNTIME_DEPS,
 gazelle = "@rules_python//gazelle:gazelle_python_binary",
 gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)

# This rule is auto-generated and managed by Gazelle,
Expand Down

43 changes: 43 additions & 0 deletions
examples/build_file_generation/MODULE.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
module(
 name = "example_bzlmod",
 compatibility_level = 1,
 version = "0.0.0",
)

bazel_dep(name = "rules_python", version = "0.0.0")
bazel_dep(name = "rules_python_gazelle_plugin", version = "0.0.0")

local_path_override(
 module_name = "rules_python",
 path = "../..",
)

local_path_override(
 module_name = "rules_python_gazelle_plugin",
 path = "../../gazelle",
)

python = use_extension("@rules_python//python:extensions.bzl", "python")

python.toolchain(
 name = "python3_9",
 python_version = "3.9",
)

use_repo(python, "python3_9_toolchains")

register_toolchains(
 "@python3_9_toolchains//:all",
)

pip = use_extension("@rules_python//python:extensions.bzl", "pip")

pip.parse(
 name = "pip",
 requirements_lock = "//:requirements_lock.txt",
 requirements_windows = "//:requirements_windows.txt",
)

use_repo(pip, "pip")

bazel_dep(name = "gazelle", repo_name = "bazel_gazelle", version = "0.28.0")

9 changes: 9 additions & 0 deletions
examples/build_file_generation/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,3 +18,12 @@ added to the `py_library` target in the `BUILD` file.

For more information on the behavior of the rules_python gazelle extension,
see the README.md file in the /gazelle folder.

# bzlmod

This also works with bzlmod. To do that:
1. Add a line into the `.bazelrc` to enable `bzlmod`.
1. Run `bazel run //:gazelle_python_manifest.update`
1. Run `bazel run //:gazelle`

This is necessary to switch to the `bzlmod` way of accessing third-party dependencies.

15 changes: 14 additions & 1 deletion
examples/build_file_generation/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,11 @@ local_repository(
 path = "../..",
)

local_repository(
 name = "rules_python_gazelle_plugin",
 path = "../../gazelle",
)

# When not using this example in the rules_python git repo you would load the python
# ruleset using the following StarLark.
# See https://github.com/bazelbuild/rules_python#getting-started for the latest
Expand All@@ -81,6 +86,14 @@ local_repository(
# strip_prefix = "rules_python-0.16.1",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )
#
# load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
# http_archive(
# name = "rules_python_gazelle_plugin",
# sha256 = "497ca47374f48c8b067d786b512ac10a276211810f4a580178ee9b9ad139323a",
# strip_prefix = "rules_python-0.16.1/gazelle",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )

# Next we load the toolchain from rules_python.
load("@rules_python//python:repositories.bzl", "python_register_toolchains")
Expand DownExpand Up@@ -124,7 +137,7 @@ install_deps()

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
Expand Down

2 changes: 2 additions & 0 deletions
examples/build_file_generation/WORKSPACE.bzlmod

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# Empty file indicating the root of a Bazel workspace.
# Dependencies and setup are in MODULE.bazel.

5 changes: 3 additions & 2 deletions
examples/build_file_generation/gazelle_python.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,5 +113,6 @@ manifest:
 zipp: zipp
 zipp.py310compat: zipp
 pip_repository:
 name: pip
integrity: 4153df7683d64d7d6ad56c14ea1c7f7bec84a2ddf9ef8f075d1bb9313b8d11aa
 repo_convention: pip_%s
 target_convention: pkg
integrity: 75649e137de25ba5161744181a95f4ce3f3d6c41d998a099eab5dcc8a446d395

3 changes: 2 additions & 1 deletion
examples/bzlmod/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,8 @@ py_library(
 name = "lib",
 srcs = ["__init__.py"],
 deps = [
 requirement("pylint"),
 # You can reference libraries using plain text form or the 'requirement' macro
 "@pip//:pylint_pkg",
 requirement("tabulate"),
 requirement("python-dateutil"),
 ],
Expand Down

13 changes: 13 additions & 0 deletions
gazelle/.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
test --test_output=errors

# Do NOT implicitly create empty __init__.py files in the runfiles tree.
# By default, these are created in every directory containing Python source code
# or shared libraries, and every parent directory of those directories,
# excluding the repo root directory. With this flag set, we are responsible for
# creating (possibly empty) __init__.py files and adding them to the srcs of
# Python targets as required.
build --incompatible_default_to_explicit_init_py

# Windows makes use of runfiles for some rules
build --enable_runfiles
startup --windows_enable_symlinks

52 changes: 52 additions & 0 deletions
gazelle/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
# Compiled Object files
*.slo
*.lo
*.o
*.obj

# Precompiled Headers
*.gch
*.pch

# Compiled Dynamic libraries
*.so
*.dylib
*.dll

# Fortran module files
*.mod
*.smod

# Compiled Static libraries
*.lai
*.la
*.a
*.lib

# Executables
*.exe
*.out
*.app

# Emacs garbage
*~

# Bazel directories
/bazel-*
/bazel-bin
/bazel-genfiles
/bazel-out
/bazel-testlogs
user.bazelrc

# vim swap files
*.swp
*.swo

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out

# Python cache
**/__pycache__/
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Gazelle bzlmod poc v2#971

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

 Closed

aignas
wants to merge
7
commits into

from

 Closed


Gazelle bzlmod poc v2
#971
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
abde25c

breaking: feat(gazelle): Move the plugin to a separate workspace


aignas Jan 4, 2023
de9ae05

feat: Store alias labels in requirements arrays if using bzlmod


aignas Jan 3, 2023
6d86634

feat(gazelle): Support bzlmod


aignas Jan 4, 2023
e221f25

feat(gazelle): store metadata in a structure and read it


aignas Jan 3, 2023
51f2863

Update the example code


aignas Jan 4, 2023
9c024a6

Use bzlmod in the example


aignas Jan 4, 2023
543923b

Revert "Use bzlmod in the example"


aignas Jan 4, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

The table of contents is too big for display.

 Diff view

 Diff view

  •  
  •  
  •  

11 changes: 3 additions & 8 deletions
.bazelci/presubmit.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,17 +10,11 @@ buildifier:
 # As a regression test for #225, check that wheel targets still build when
 # their package path is qualified with the repo name.
 - "@rules_python//examples/wheel/..."
 - "-//gazelle/..."
 build_flags:
 - "--keep_going"
 test_targets:
 - "--"
 - "..."
 # The gazelle tests are not compatible with Windows, so we only test them
 # on Linux. The build file generation, which uses this Gazelle extension,
 # runs on all platforms, and is asserted by the build_file_generation
 # integration tests below.
 - "-//gazelle/..."
 test_flags:
 - "--test_tag_filters=-integration-test"
.reusable_build_test_all: &reusable_build_test_all
Expand All@@ -30,8 +24,9 @@ tasks:
 gazelle_extension:
 name: Test the Gazelle extension
 platform: ubuntu2004
 build_targets: ["//gazelle/..."]
 test_targets: ["//gazelle/..."]
 build_targets: ["//..."]
 test_targets: ["//..."]
 working_directory: gazelle
 ubuntu:
 <<: *reusable_config
 name: Default test on Ubuntu
Expand Down

4 changes: 2 additions & 2 deletions
.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
# This lets us glob() up all the files inside the examples to make them inputs to tests
# (Note, we cannot use `common --deleted_packages` because the bazel version command doesn't support it)
# To update these lines, run tools/bazel_integration_test/update_deleted_packages.sh
build --deleted_packages=examples/build_file_generation,examples/build_file_generation/get_url,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/build_file_generation/get_url,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
build --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps

test --test_output=errors

Expand Down

20 changes: 1 addition & 19 deletions
BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.

load("@bazel_gazelle//:def.bzl", "gazelle")
load(":version.bzl", "BAZEL_VERSION")

package(default_visibility = ["//visibility:public"])
Expand All@@ -32,13 +31,13 @@ filegroup(
 "WORKSPACE",
 "internal_deps.bzl",
 "internal_setup.bzl",
 "//gazelle:distribution",
 "//python:distribution",
 "//python/pip_install:distribution",
 "//third_party/github.com/bazelbuild/bazel-skylib/lib:distribution",
 "//third_party/github.com/bazelbuild/bazel-skylib/rules:distribution",
 "//third_party/github.com/bazelbuild/bazel-skylib/rules/private:distribution",
 "//tools:distribution",
 "@rules_python_gazelle_plugin//:distribution",
 ],
 visibility = [
 "//examples:__pkg__",
Expand All@@ -64,23 +63,6 @@ filegroup(
 visibility = ["//visibility:public"],
)

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python
# gazelle:exclude bazel-out
# gazelle:exclude examples/**
gazelle(name = "gazelle")

gazelle(
 name = "gazelle_update_repos",
 args = [
 "-from_file=go.mod",
 "-to_macro=gazelle/deps.bzl%gazelle_deps",
 "-prune",
 ],
 command = "update-repos",
)

genrule(
 name = "assert_bazelversion",
 srcs = [".bazelversion"],
Expand Down

19 changes: 14 additions & 5 deletions
WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,11 +34,6 @@ python_register_multi_toolchains(
 python_versions = MINOR_MAPPING.values(),
)

load("//gazelle:deps.bzl", "gazelle_deps")

# gazelle:repository_macro gazelle/deps.bzl%gazelle_deps
gazelle_deps()

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

# Used for Bazel CI
Expand All@@ -58,3 +53,17 @@ rbe_preconfig(
 name = "buildkite_config",
 toolchain = "ubuntu1804-bazel-java11",
)

local_repository(
 name = "rules_python_gazelle_plugin",
 path = "gazelle",
)

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
# for python requirements.
_py_gazelle_deps()

32 changes: 11 additions & 21 deletions
examples/build_file_generation/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,12 +3,11 @@
# The `load` statement imports the symbol for the rule, in the defined
# ruleset. When the symbol is loaded you can use the rule.
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@pip//:gazelle.bzl", "GAZELLE_PLUGIN_ARGS")
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")
load("@rules_python//python:pip.bzl", "compile_pip_requirements")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")

compile_pip_requirements(
 name = "requirements",
Expand All@@ -18,31 +17,22 @@ compile_pip_requirements(
 requirements_windows = "requirements_windows.txt",
)

# This repository rule fetches the metadata for python packages we
# depend on. That data is required for the gazelle_python_manifest
# rule to update our manifest file.
# To see what this rule does, try `bazel run @modules_map//:print`
modules_mapping(
 name = "modules_map",
 exclude_patterns = [
 "^_|(\\._)+", # This is the default.
 "(\\.tests)+", # Add a custom one to get rid of the psutil tests.
 ],
 wheels = all_whl_requirements,
)

# Gazelle python extension needs a manifest file mapping from
# an import to the installed package that provides it.
# This macro produces two targets:
# - //:gazelle_python_manifest.modules_mapping, which fetches the metadata for
# python packages we depend on. That data is required for the
# gazelle_python_manifest rule to update our manifest file.
# - //:gazelle_python_manifest.update can be used with `bazel run`
# to recalculate the manifest
# - //:gazelle_python_manifest.test is a test target ensuring that
# the manifest doesn't need to be updated
gazelle_python_manifest(
 name = "gazelle_python_manifest",
 modules_mapping = ":modules_map",
 pip_repository_name = "pip",
 requirements = "//:requirements_lock.txt",
 extend_exclude_patterns = [
 "(\\.tests)+", # Add a custom one to get rid of the psutil tests.
 ],
 metadata = GAZELLE_PLUGIN_ARGS,
)

# Our gazelle target points to the python gazelle binary.
Expand All@@ -53,7 +43,7 @@ gazelle_python_manifest(
gazelle(
 name = "gazelle",
 data = GAZELLE_PYTHON_RUNTIME_DEPS,
 gazelle = "@rules_python//gazelle:gazelle_python_binary",
 gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)

# This rule is auto-generated and managed by Gazelle,
Expand Down

43 changes: 43 additions & 0 deletions
examples/build_file_generation/MODULE.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
module(
 name = "example_bzlmod",
 compatibility_level = 1,
 version = "0.0.0",
)

bazel_dep(name = "rules_python", version = "0.0.0")
bazel_dep(name = "rules_python_gazelle_plugin", version = "0.0.0")

local_path_override(
 module_name = "rules_python",
 path = "../..",
)

local_path_override(
 module_name = "rules_python_gazelle_plugin",
 path = "../../gazelle",
)

python = use_extension("@rules_python//python:extensions.bzl", "python")

python.toolchain(
 name = "python3_9",
 python_version = "3.9",
)

use_repo(python, "python3_9_toolchains")

register_toolchains(
 "@python3_9_toolchains//:all",
)

pip = use_extension("@rules_python//python:extensions.bzl", "pip")

pip.parse(
 name = "pip",
 requirements_lock = "//:requirements_lock.txt",
 requirements_windows = "//:requirements_windows.txt",
)

use_repo(pip, "pip")

bazel_dep(name = "gazelle", repo_name = "bazel_gazelle", version = "0.28.0")

9 changes: 9 additions & 0 deletions
examples/build_file_generation/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,3 +18,12 @@ added to the `py_library` target in the `BUILD` file.

For more information on the behavior of the rules_python gazelle extension,
see the README.md file in the /gazelle folder.

# bzlmod

This also works with bzlmod. To do that:
1. Add a line into the `.bazelrc` to enable `bzlmod`.
1. Run `bazel run //:gazelle_python_manifest.update`
1. Run `bazel run //:gazelle`

This is necessary to switch to the `bzlmod` way of accessing third-party dependencies.

15 changes: 14 additions & 1 deletion
examples/build_file_generation/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,11 @@ local_repository(
 path = "../..",
)

local_repository(
 name = "rules_python_gazelle_plugin",
 path = "../../gazelle",
)

# When not using this example in the rules_python git repo you would load the python
# ruleset using the following StarLark.
# See https://github.com/bazelbuild/rules_python#getting-started for the latest
Expand All@@ -81,6 +86,14 @@ local_repository(
# strip_prefix = "rules_python-0.16.1",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )
#
# load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
# http_archive(
# name = "rules_python_gazelle_plugin",
# sha256 = "497ca47374f48c8b067d786b512ac10a276211810f4a580178ee9b9ad139323a",
# strip_prefix = "rules_python-0.16.1/gazelle",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )

# Next we load the toolchain from rules_python.
load("@rules_python//python:repositories.bzl", "python_register_toolchains")
Expand DownExpand Up@@ -124,7 +137,7 @@ install_deps()

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
Expand Down

2 changes: 2 additions & 0 deletions
examples/build_file_generation/WORKSPACE.bzlmod

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# Empty file indicating the root of a Bazel workspace.
# Dependencies and setup are in MODULE.bazel.

5 changes: 3 additions & 2 deletions
examples/build_file_generation/gazelle_python.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,5 +113,6 @@ manifest:
 zipp: zipp
 zipp.py310compat: zipp
 pip_repository:
 name: pip
integrity: 4153df7683d64d7d6ad56c14ea1c7f7bec84a2ddf9ef8f075d1bb9313b8d11aa
 repo_convention: pip_%s
 target_convention: pkg
integrity: 75649e137de25ba5161744181a95f4ce3f3d6c41d998a099eab5dcc8a446d395

3 changes: 2 additions & 1 deletion
examples/bzlmod/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,8 @@ py_library(
 name = "lib",
 srcs = ["__init__.py"],
 deps = [
 requirement("pylint"),
 # You can reference libraries using plain text form or the 'requirement' macro
 "@pip//:pylint_pkg",
 requirement("tabulate"),
 requirement("python-dateutil"),
 ],
Expand Down

13 changes: 13 additions & 0 deletions
gazelle/.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
test --test_output=errors

# Do NOT implicitly create empty __init__.py files in the runfiles tree.
# By default, these are created in every directory containing Python source code
# or shared libraries, and every parent directory of those directories,
# excluding the repo root directory. With this flag set, we are responsible for
# creating (possibly empty) __init__.py files and adding them to the srcs of
# Python targets as required.
build --incompatible_default_to_explicit_init_py

# Windows makes use of runfiles for some rules
build --enable_runfiles
startup --windows_enable_symlinks

52 changes: 52 additions & 0 deletions
gazelle/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
# Compiled Object files
*.slo
*.lo
*.o
*.obj

# Precompiled Headers
*.gch
*.pch

# Compiled Dynamic libraries
*.so
*.dylib
*.dll

# Fortran module files
*.mod
*.smod

# Compiled Static libraries
*.lai
*.la
*.a
*.lib

# Executables
*.exe
*.out
*.app

# Emacs garbage
*~

# Bazel directories
/bazel-*
/bazel-bin
/bazel-genfiles
/bazel-out
/bazel-testlogs
user.bazelrc

# vim swap files
*.swp
*.swo

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out

# Python cache
**/__pycache__/
Loading

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

Skip to content
Gazelle bzlmod poc v2#971

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

 Closed

aignas
wants to merge
7
commits into

from

 Closed


Gazelle bzlmod poc v2
#971
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
abde25c

breaking: feat(gazelle): Move the plugin to a separate workspace


aignas Jan 4, 2023
de9ae05

feat: Store alias labels in requirements arrays if using bzlmod


aignas Jan 3, 2023
6d86634

feat(gazelle): Support bzlmod


aignas Jan 4, 2023
e221f25

feat(gazelle): store metadata in a structure and read it


aignas Jan 3, 2023
51f2863

Update the example code


aignas Jan 4, 2023
9c024a6

Use bzlmod in the example


aignas Jan 4, 2023
543923b

Revert "Use bzlmod in the example"


aignas Jan 4, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

The table of contents is too big for display.

 Diff view

 Diff view

  •  
  •  
  •  

11 changes: 3 additions & 8 deletions
.bazelci/presubmit.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,17 +10,11 @@ buildifier:
 # As a regression test for #225, check that wheel targets still build when
 # their package path is qualified with the repo name.
 - "@rules_python//examples/wheel/..."
 - "-//gazelle/..."
 build_flags:
 - "--keep_going"
 test_targets:
 - "--"
 - "..."
 # The gazelle tests are not compatible with Windows, so we only test them
 # on Linux. The build file generation, which uses this Gazelle extension,
 # runs on all platforms, and is asserted by the build_file_generation
 # integration tests below.
 - "-//gazelle/..."
 test_flags:
 - "--test_tag_filters=-integration-test"
.reusable_build_test_all: &reusable_build_test_all
Expand All@@ -30,8 +24,9 @@ tasks:
 gazelle_extension:
 name: Test the Gazelle extension
 platform: ubuntu2004
 build_targets: ["//gazelle/..."]
 test_targets: ["//gazelle/..."]
 build_targets: ["//..."]
 test_targets: ["//..."]
 working_directory: gazelle
 ubuntu:
 <<: *reusable_config
 name: Default test on Ubuntu
Expand Down

4 changes: 2 additions & 2 deletions
.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
# This lets us glob() up all the files inside the examples to make them inputs to tests
# (Note, we cannot use `common --deleted_packages` because the bazel version command doesn't support it)
# To update these lines, run tools/bazel_integration_test/update_deleted_packages.sh
build --deleted_packages=examples/build_file_generation,examples/build_file_generation/get_url,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/build_file_generation/get_url,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
build --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps

test --test_output=errors

Expand Down

20 changes: 1 addition & 19 deletions
BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.

load("@bazel_gazelle//:def.bzl", "gazelle")
load(":version.bzl", "BAZEL_VERSION")

package(default_visibility = ["//visibility:public"])
Expand All@@ -32,13 +31,13 @@ filegroup(
 "WORKSPACE",
 "internal_deps.bzl",
 "internal_setup.bzl",
 "//gazelle:distribution",
 "//python:distribution",
 "//python/pip_install:distribution",
 "//third_party/github.com/bazelbuild/bazel-skylib/lib:distribution",
 "//third_party/github.com/bazelbuild/bazel-skylib/rules:distribution",
 "//third_party/github.com/bazelbuild/bazel-skylib/rules/private:distribution",
 "//tools:distribution",
 "@rules_python_gazelle_plugin//:distribution",
 ],
 visibility = [
 "//examples:__pkg__",
Expand All@@ -64,23 +63,6 @@ filegroup(
 visibility = ["//visibility:public"],
)

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python
# gazelle:exclude bazel-out
# gazelle:exclude examples/**
gazelle(name = "gazelle")

gazelle(
 name = "gazelle_update_repos",
 args = [
 "-from_file=go.mod",
 "-to_macro=gazelle/deps.bzl%gazelle_deps",
 "-prune",
 ],
 command = "update-repos",
)

genrule(
 name = "assert_bazelversion",
 srcs = [".bazelversion"],
Expand Down

19 changes: 14 additions & 5 deletions
WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,11 +34,6 @@ python_register_multi_toolchains(
 python_versions = MINOR_MAPPING.values(),
)

load("//gazelle:deps.bzl", "gazelle_deps")

# gazelle:repository_macro gazelle/deps.bzl%gazelle_deps
gazelle_deps()

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

# Used for Bazel CI
Expand All@@ -58,3 +53,17 @@ rbe_preconfig(
 name = "buildkite_config",
 toolchain = "ubuntu1804-bazel-java11",
)

local_repository(
 name = "rules_python_gazelle_plugin",
 path = "gazelle",
)

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
# for python requirements.
_py_gazelle_deps()

32 changes: 11 additions & 21 deletions
examples/build_file_generation/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,12 +3,11 @@
# The `load` statement imports the symbol for the rule, in the defined
# ruleset. When the symbol is loaded you can use the rule.
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@pip//:gazelle.bzl", "GAZELLE_PLUGIN_ARGS")
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")
load("@rules_python//python:pip.bzl", "compile_pip_requirements")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")

compile_pip_requirements(
 name = "requirements",
Expand All@@ -18,31 +17,22 @@ compile_pip_requirements(
 requirements_windows = "requirements_windows.txt",
)

# This repository rule fetches the metadata for python packages we
# depend on. That data is required for the gazelle_python_manifest
# rule to update our manifest file.
# To see what this rule does, try `bazel run @modules_map//:print`
modules_mapping(
 name = "modules_map",
 exclude_patterns = [
 "^_|(\\._)+", # This is the default.
 "(\\.tests)+", # Add a custom one to get rid of the psutil tests.
 ],
 wheels = all_whl_requirements,
)

# Gazelle python extension needs a manifest file mapping from
# an import to the installed package that provides it.
# This macro produces two targets:
# - //:gazelle_python_manifest.modules_mapping, which fetches the metadata for
# python packages we depend on. That data is required for the
# gazelle_python_manifest rule to update our manifest file.
# - //:gazelle_python_manifest.update can be used with `bazel run`
# to recalculate the manifest
# - //:gazelle_python_manifest.test is a test target ensuring that
# the manifest doesn't need to be updated
gazelle_python_manifest(
 name = "gazelle_python_manifest",
 modules_mapping = ":modules_map",
 pip_repository_name = "pip",
 requirements = "//:requirements_lock.txt",
 extend_exclude_patterns = [
 "(\\.tests)+", # Add a custom one to get rid of the psutil tests.
 ],
 metadata = GAZELLE_PLUGIN_ARGS,
)

# Our gazelle target points to the python gazelle binary.
Expand All@@ -53,7 +43,7 @@ gazelle_python_manifest(
gazelle(
 name = "gazelle",
 data = GAZELLE_PYTHON_RUNTIME_DEPS,
 gazelle = "@rules_python//gazelle:gazelle_python_binary",
 gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)

# This rule is auto-generated and managed by Gazelle,
Expand Down

43 changes: 43 additions & 0 deletions
examples/build_file_generation/MODULE.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
module(
 name = "example_bzlmod",
 compatibility_level = 1,
 version = "0.0.0",
)

bazel_dep(name = "rules_python", version = "0.0.0")
bazel_dep(name = "rules_python_gazelle_plugin", version = "0.0.0")

local_path_override(
 module_name = "rules_python",
 path = "../..",
)

local_path_override(
 module_name = "rules_python_gazelle_plugin",
 path = "../../gazelle",
)

python = use_extension("@rules_python//python:extensions.bzl", "python")

python.toolchain(
 name = "python3_9",
 python_version = "3.9",
)

use_repo(python, "python3_9_toolchains")

register_toolchains(
 "@python3_9_toolchains//:all",
)

pip = use_extension("@rules_python//python:extensions.bzl", "pip")

pip.parse(
 name = "pip",
 requirements_lock = "//:requirements_lock.txt",
 requirements_windows = "//:requirements_windows.txt",
)

use_repo(pip, "pip")

bazel_dep(name = "gazelle", repo_name = "bazel_gazelle", version = "0.28.0")

9 changes: 9 additions & 0 deletions
examples/build_file_generation/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,3 +18,12 @@ added to the `py_library` target in the `BUILD` file.

For more information on the behavior of the rules_python gazelle extension,
see the README.md file in the /gazelle folder.

# bzlmod

This also works with bzlmod. To do that:
1. Add a line into the `.bazelrc` to enable `bzlmod`.
1. Run `bazel run //:gazelle_python_manifest.update`
1. Run `bazel run //:gazelle`

This is necessary to switch to the `bzlmod` way of accessing third-party dependencies.

15 changes: 14 additions & 1 deletion
examples/build_file_generation/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,11 @@ local_repository(
 path = "../..",
)

local_repository(
 name = "rules_python_gazelle_plugin",
 path = "../../gazelle",
)

# When not using this example in the rules_python git repo you would load the python
# ruleset using the following StarLark.
# See https://github.com/bazelbuild/rules_python#getting-started for the latest
Expand All@@ -81,6 +86,14 @@ local_repository(
# strip_prefix = "rules_python-0.16.1",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )
#
# load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
# http_archive(
# name = "rules_python_gazelle_plugin",
# sha256 = "497ca47374f48c8b067d786b512ac10a276211810f4a580178ee9b9ad139323a",
# strip_prefix = "rules_python-0.16.1/gazelle",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )

# Next we load the toolchain from rules_python.
load("@rules_python//python:repositories.bzl", "python_register_toolchains")
Expand DownExpand Up@@ -124,7 +137,7 @@ install_deps()

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
Expand Down

2 changes: 2 additions & 0 deletions
examples/build_file_generation/WORKSPACE.bzlmod

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# Empty file indicating the root of a Bazel workspace.
# Dependencies and setup are in MODULE.bazel.

5 changes: 3 additions & 2 deletions
examples/build_file_generation/gazelle_python.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,5 +113,6 @@ manifest:
 zipp: zipp
 zipp.py310compat: zipp
 pip_repository:
 name: pip
integrity: 4153df7683d64d7d6ad56c14ea1c7f7bec84a2ddf9ef8f075d1bb9313b8d11aa
 repo_convention: pip_%s
 target_convention: pkg
integrity: 75649e137de25ba5161744181a95f4ce3f3d6c41d998a099eab5dcc8a446d395

3 changes: 2 additions & 1 deletion
examples/bzlmod/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,8 @@ py_library(
 name = "lib",
 srcs = ["__init__.py"],
 deps = [
 requirement("pylint"),
 # You can reference libraries using plain text form or the 'requirement' macro
 "@pip//:pylint_pkg",
 requirement("tabulate"),
 requirement("python-dateutil"),
 ],
Expand Down

13 changes: 13 additions & 0 deletions
gazelle/.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
test --test_output=errors

# Do NOT implicitly create empty __init__.py files in the runfiles tree.
# By default, these are created in every directory containing Python source code
# or shared libraries, and every parent directory of those directories,
# excluding the repo root directory. With this flag set, we are responsible for
# creating (possibly empty) __init__.py files and adding them to the srcs of
# Python targets as required.
build --incompatible_default_to_explicit_init_py

# Windows makes use of runfiles for some rules
build --enable_runfiles
startup --windows_enable_symlinks

52 changes: 52 additions & 0 deletions
gazelle/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
# Compiled Object files
*.slo
*.lo
*.o
*.obj

# Precompiled Headers
*.gch
*.pch

# Compiled Dynamic libraries
*.so
*.dylib
*.dll

# Fortran module files
*.mod
*.smod

# Compiled Static libraries
*.lai
*.la
*.a
*.lib

# Executables
*.exe
*.out
*.app

# Emacs garbage
*~

# Bazel directories
/bazel-*
/bazel-bin
/bazel-genfiles
/bazel-out
/bazel-testlogs
user.bazelrc

# vim swap files
*.swp
*.swo

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out

# Python cache
**/__pycache__/
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Gazelle bzlmod poc v2#971

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

 Closed

aignas
wants to merge
7
commits into

from

 Closed


Gazelle bzlmod poc v2
#971
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
abde25c

breaking: feat(gazelle): Move the plugin to a separate workspace


aignas Jan 4, 2023
de9ae05

feat: Store alias labels in requirements arrays if using bzlmod


aignas Jan 3, 2023
6d86634

feat(gazelle): Support bzlmod


aignas Jan 4, 2023
e221f25

feat(gazelle): store metadata in a structure and read it


aignas Jan 3, 2023
51f2863

Update the example code


aignas Jan 4, 2023
9c024a6

Use bzlmod in the example


aignas Jan 4, 2023
543923b

Revert "Use bzlmod in the example"


aignas Jan 4, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

The table of contents is too big for display.

 Diff view

 Diff view

  •  
  •  
  •  

11 changes: 3 additions & 8 deletions
.bazelci/presubmit.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,17 +10,11 @@ buildifier:
 # As a regression test for #225, check that wheel targets still build when
 # their package path is qualified with the repo name.
 - "@rules_python//examples/wheel/..."
 - "-//gazelle/..."
 build_flags:
 - "--keep_going"
 test_targets:
 - "--"
 - "..."
 # The gazelle tests are not compatible with Windows, so we only test them
 # on Linux. The build file generation, which uses this Gazelle extension,
 # runs on all platforms, and is asserted by the build_file_generation
 # integration tests below.
 - "-//gazelle/..."
 test_flags:
 - "--test_tag_filters=-integration-test"
.reusable_build_test_all: &reusable_build_test_all
Expand All@@ -30,8 +24,9 @@ tasks:
 gazelle_extension:
 name: Test the Gazelle extension
 platform: ubuntu2004
 build_targets: ["//gazelle/..."]
 test_targets: ["//gazelle/..."]
 build_targets: ["//..."]
 test_targets: ["//..."]
 working_directory: gazelle
 ubuntu:
 <<: *reusable_config
 name: Default test on Ubuntu
Expand Down

4 changes: 2 additions & 2 deletions
.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
# This lets us glob() up all the files inside the examples to make them inputs to tests
# (Note, we cannot use `common --deleted_packages` because the bazel version command doesn't support it)
# To update these lines, run tools/bazel_integration_test/update_deleted_packages.sh
build --deleted_packages=examples/build_file_generation,examples/build_file_generation/get_url,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/build_file_generation/get_url,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
build --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps

test --test_output=errors

Expand Down

20 changes: 1 addition & 19 deletions
BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.

load("@bazel_gazelle//:def.bzl", "gazelle")
load(":version.bzl", "BAZEL_VERSION")

package(default_visibility = ["//visibility:public"])
Expand All@@ -32,13 +31,13 @@ filegroup(
 "WORKSPACE",
 "internal_deps.bzl",
 "internal_setup.bzl",
 "//gazelle:distribution",
 "//python:distribution",
 "//python/pip_install:distribution",
 "//third_party/github.com/bazelbuild/bazel-skylib/lib:distribution",
 "//third_party/github.com/bazelbuild/bazel-skylib/rules:distribution",
 "//third_party/github.com/bazelbuild/bazel-skylib/rules/private:distribution",
 "//tools:distribution",
 "@rules_python_gazelle_plugin//:distribution",
 ],
 visibility = [
 "//examples:__pkg__",
Expand All@@ -64,23 +63,6 @@ filegroup(
 visibility = ["//visibility:public"],
)

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python
# gazelle:exclude bazel-out
# gazelle:exclude examples/**
gazelle(name = "gazelle")

gazelle(
 name = "gazelle_update_repos",
 args = [
 "-from_file=go.mod",
 "-to_macro=gazelle/deps.bzl%gazelle_deps",
 "-prune",
 ],
 command = "update-repos",
)

genrule(
 name = "assert_bazelversion",
 srcs = [".bazelversion"],
Expand Down

19 changes: 14 additions & 5 deletions
WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,11 +34,6 @@ python_register_multi_toolchains(
 python_versions = MINOR_MAPPING.values(),
)

load("//gazelle:deps.bzl", "gazelle_deps")

# gazelle:repository_macro gazelle/deps.bzl%gazelle_deps
gazelle_deps()

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

# Used for Bazel CI
Expand All@@ -58,3 +53,17 @@ rbe_preconfig(
 name = "buildkite_config",
 toolchain = "ubuntu1804-bazel-java11",
)

local_repository(
 name = "rules_python_gazelle_plugin",
 path = "gazelle",
)

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
# for python requirements.
_py_gazelle_deps()

32 changes: 11 additions & 21 deletions
examples/build_file_generation/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,12 +3,11 @@
# The `load` statement imports the symbol for the rule, in the defined
# ruleset. When the symbol is loaded you can use the rule.
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@pip//:gazelle.bzl", "GAZELLE_PLUGIN_ARGS")
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")
load("@rules_python//python:pip.bzl", "compile_pip_requirements")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")

compile_pip_requirements(
 name = "requirements",
Expand All@@ -18,31 +17,22 @@ compile_pip_requirements(
 requirements_windows = "requirements_windows.txt",
)

# This repository rule fetches the metadata for python packages we
# depend on. That data is required for the gazelle_python_manifest
# rule to update our manifest file.
# To see what this rule does, try `bazel run @modules_map//:print`
modules_mapping(
 name = "modules_map",
 exclude_patterns = [
 "^_|(\\._)+", # This is the default.
 "(\\.tests)+", # Add a custom one to get rid of the psutil tests.
 ],
 wheels = all_whl_requirements,
)

# Gazelle python extension needs a manifest file mapping from
# an import to the installed package that provides it.
# This macro produces two targets:
# - //:gazelle_python_manifest.modules_mapping, which fetches the metadata for
# python packages we depend on. That data is required for the
# gazelle_python_manifest rule to update our manifest file.
# - //:gazelle_python_manifest.update can be used with `bazel run`
# to recalculate the manifest
# - //:gazelle_python_manifest.test is a test target ensuring that
# the manifest doesn't need to be updated
gazelle_python_manifest(
 name = "gazelle_python_manifest",
 modules_mapping = ":modules_map",
 pip_repository_name = "pip",
 requirements = "//:requirements_lock.txt",
 extend_exclude_patterns = [
 "(\\.tests)+", # Add a custom one to get rid of the psutil tests.
 ],
 metadata = GAZELLE_PLUGIN_ARGS,
)

# Our gazelle target points to the python gazelle binary.
Expand All@@ -53,7 +43,7 @@ gazelle_python_manifest(
gazelle(
 name = "gazelle",
 data = GAZELLE_PYTHON_RUNTIME_DEPS,
 gazelle = "@rules_python//gazelle:gazelle_python_binary",
 gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)

# This rule is auto-generated and managed by Gazelle,
Expand Down

43 changes: 43 additions & 0 deletions
examples/build_file_generation/MODULE.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
module(
 name = "example_bzlmod",
 compatibility_level = 1,
 version = "0.0.0",
)

bazel_dep(name = "rules_python", version = "0.0.0")
bazel_dep(name = "rules_python_gazelle_plugin", version = "0.0.0")

local_path_override(
 module_name = "rules_python",
 path = "../..",
)

local_path_override(
 module_name = "rules_python_gazelle_plugin",
 path = "../../gazelle",
)

python = use_extension("@rules_python//python:extensions.bzl", "python")

python.toolchain(
 name = "python3_9",
 python_version = "3.9",
)

use_repo(python, "python3_9_toolchains")

register_toolchains(
 "@python3_9_toolchains//:all",
)

pip = use_extension("@rules_python//python:extensions.bzl", "pip")

pip.parse(
 name = "pip",
 requirements_lock = "//:requirements_lock.txt",
 requirements_windows = "//:requirements_windows.txt",
)

use_repo(pip, "pip")

bazel_dep(name = "gazelle", repo_name = "bazel_gazelle", version = "0.28.0")

9 changes: 9 additions & 0 deletions
examples/build_file_generation/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,3 +18,12 @@ added to the `py_library` target in the `BUILD` file.

For more information on the behavior of the rules_python gazelle extension,
see the README.md file in the /gazelle folder.

# bzlmod

This also works with bzlmod. To do that:
1. Add a line into the `.bazelrc` to enable `bzlmod`.
1. Run `bazel run //:gazelle_python_manifest.update`
1. Run `bazel run //:gazelle`

This is necessary to switch to the `bzlmod` way of accessing third-party dependencies.

15 changes: 14 additions & 1 deletion
examples/build_file_generation/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,11 @@ local_repository(
 path = "../..",
)

local_repository(
 name = "rules_python_gazelle_plugin",
 path = "../../gazelle",
)

# When not using this example in the rules_python git repo you would load the python
# ruleset using the following StarLark.
# See https://github.com/bazelbuild/rules_python#getting-started for the latest
Expand All@@ -81,6 +86,14 @@ local_repository(
# strip_prefix = "rules_python-0.16.1",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )
#
# load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
# http_archive(
# name = "rules_python_gazelle_plugin",
# sha256 = "497ca47374f48c8b067d786b512ac10a276211810f4a580178ee9b9ad139323a",
# strip_prefix = "rules_python-0.16.1/gazelle",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )

# Next we load the toolchain from rules_python.
load("@rules_python//python:repositories.bzl", "python_register_toolchains")
Expand DownExpand Up@@ -124,7 +137,7 @@ install_deps()

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
Expand Down

2 changes: 2 additions & 0 deletions
examples/build_file_generation/WORKSPACE.bzlmod

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# Empty file indicating the root of a Bazel workspace.
# Dependencies and setup are in MODULE.bazel.

5 changes: 3 additions & 2 deletions
examples/build_file_generation/gazelle_python.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,5 +113,6 @@ manifest:
 zipp: zipp
 zipp.py310compat: zipp
 pip_repository:
 name: pip
integrity: 4153df7683d64d7d6ad56c14ea1c7f7bec84a2ddf9ef8f075d1bb9313b8d11aa
 repo_convention: pip_%s
 target_convention: pkg
integrity: 75649e137de25ba5161744181a95f4ce3f3d6c41d998a099eab5dcc8a446d395

3 changes: 2 additions & 1 deletion
examples/bzlmod/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,8 @@ py_library(
 name = "lib",
 srcs = ["__init__.py"],
 deps = [
 requirement("pylint"),
 # You can reference libraries using plain text form or the 'requirement' macro
 "@pip//:pylint_pkg",
 requirement("tabulate"),
 requirement("python-dateutil"),
 ],
Expand Down

13 changes: 13 additions & 0 deletions
gazelle/.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
test --test_output=errors

# Do NOT implicitly create empty __init__.py files in the runfiles tree.
# By default, these are created in every directory containing Python source code
# or shared libraries, and every parent directory of those directories,
# excluding the repo root directory. With this flag set, we are responsible for
# creating (possibly empty) __init__.py files and adding them to the srcs of
# Python targets as required.
build --incompatible_default_to_explicit_init_py

# Windows makes use of runfiles for some rules
build --enable_runfiles
startup --windows_enable_symlinks

52 changes: 52 additions & 0 deletions
gazelle/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
# Compiled Object files
*.slo
*.lo
*.o
*.obj

# Precompiled Headers
*.gch
*.pch

# Compiled Dynamic libraries
*.so
*.dylib
*.dll

# Fortran module files
*.mod
*.smod

# Compiled Static libraries
*.lai
*.la
*.a
*.lib

# Executables
*.exe
*.out
*.app

# Emacs garbage
*~

# Bazel directories
/bazel-*
/bazel-bin
/bazel-genfiles
/bazel-out
/bazel-testlogs
user.bazelrc

# vim swap files
*.swp
*.swo

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out

# Python cache
**/__pycache__/
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Gazelle bzlmod poc v2#971

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

 Closed

aignas
wants to merge
7
commits into

from

 Closed


Gazelle bzlmod poc v2
#971
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
abde25c

breaking: feat(gazelle): Move the plugin to a separate workspace


aignas Jan 4, 2023
de9ae05

feat: Store alias labels in requirements arrays if using bzlmod


aignas Jan 3, 2023
6d86634

feat(gazelle): Support bzlmod


aignas Jan 4, 2023
e221f25

feat(gazelle): store metadata in a structure and read it


aignas Jan 3, 2023
51f2863

Update the example code


aignas Jan 4, 2023
9c024a6

Use bzlmod in the example


aignas Jan 4, 2023
543923b

Revert "Use bzlmod in the example"


aignas Jan 4, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

The table of contents is too big for display.

 Diff view

 Diff view

  •  
  •  
  •  

11 changes: 3 additions & 8 deletions
.bazelci/presubmit.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,17 +10,11 @@ buildifier:
 # As a regression test for #225, check that wheel targets still build when
 # their package path is qualified with the repo name.
 - "@rules_python//examples/wheel/..."
 - "-//gazelle/..."
 build_flags:
 - "--keep_going"
 test_targets:
 - "--"
 - "..."
 # The gazelle tests are not compatible with Windows, so we only test them
 # on Linux. The build file generation, which uses this Gazelle extension,
 # runs on all platforms, and is asserted by the build_file_generation
 # integration tests below.
 - "-//gazelle/..."
 test_flags:
 - "--test_tag_filters=-integration-test"
.reusable_build_test_all: &reusable_build_test_all
Expand All@@ -30,8 +24,9 @@ tasks:
 gazelle_extension:
 name: Test the Gazelle extension
 platform: ubuntu2004
 build_targets: ["//gazelle/..."]
 test_targets: ["//gazelle/..."]
 build_targets: ["//..."]
 test_targets: ["//..."]
 working_directory: gazelle
 ubuntu:
 <<: *reusable_config
 name: Default test on Ubuntu
Expand Down

4 changes: 2 additions & 2 deletions
.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
# This lets us glob() up all the files inside the examples to make them inputs to tests
# (Note, we cannot use `common --deleted_packages` because the bazel version command doesn't support it)
# To update these lines, run tools/bazel_integration_test/update_deleted_packages.sh
build --deleted_packages=examples/build_file_generation,examples/build_file_generation/get_url,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/build_file_generation/get_url,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
build --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps

test --test_output=errors

Expand Down

20 changes: 1 addition & 19 deletions
BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.

load("@bazel_gazelle//:def.bzl", "gazelle")
load(":version.bzl", "BAZEL_VERSION")

package(default_visibility = ["//visibility:public"])
Expand All@@ -32,13 +31,13 @@ filegroup(
 "WORKSPACE",
 "internal_deps.bzl",
 "internal_setup.bzl",
 "//gazelle:distribution",
 "//python:distribution",
 "//python/pip_install:distribution",
 "//third_party/github.com/bazelbuild/bazel-skylib/lib:distribution",
 "//third_party/github.com/bazelbuild/bazel-skylib/rules:distribution",
 "//third_party/github.com/bazelbuild/bazel-skylib/rules/private:distribution",
 "//tools:distribution",
 "@rules_python_gazelle_plugin//:distribution",
 ],
 visibility = [
 "//examples:__pkg__",
Expand All@@ -64,23 +63,6 @@ filegroup(
 visibility = ["//visibility:public"],
)

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python
# gazelle:exclude bazel-out
# gazelle:exclude examples/**
gazelle(name = "gazelle")

gazelle(
 name = "gazelle_update_repos",
 args = [
 "-from_file=go.mod",
 "-to_macro=gazelle/deps.bzl%gazelle_deps",
 "-prune",
 ],
 command = "update-repos",
)

genrule(
 name = "assert_bazelversion",
 srcs = [".bazelversion"],
Expand Down

19 changes: 14 additions & 5 deletions
WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,11 +34,6 @@ python_register_multi_toolchains(
 python_versions = MINOR_MAPPING.values(),
)

load("//gazelle:deps.bzl", "gazelle_deps")

# gazelle:repository_macro gazelle/deps.bzl%gazelle_deps
gazelle_deps()

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

# Used for Bazel CI
Expand All@@ -58,3 +53,17 @@ rbe_preconfig(
 name = "buildkite_config",
 toolchain = "ubuntu1804-bazel-java11",
)

local_repository(
 name = "rules_python_gazelle_plugin",
 path = "gazelle",
)

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
# for python requirements.
_py_gazelle_deps()

32 changes: 11 additions & 21 deletions
examples/build_file_generation/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,12 +3,11 @@
# The `load` statement imports the symbol for the rule, in the defined
# ruleset. When the symbol is loaded you can use the rule.
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@pip//:gazelle.bzl", "GAZELLE_PLUGIN_ARGS")
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")
load("@rules_python//python:pip.bzl", "compile_pip_requirements")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")

compile_pip_requirements(
 name = "requirements",
Expand All@@ -18,31 +17,22 @@ compile_pip_requirements(
 requirements_windows = "requirements_windows.txt",
)

# This repository rule fetches the metadata for python packages we
# depend on. That data is required for the gazelle_python_manifest
# rule to update our manifest file.
# To see what this rule does, try `bazel run @modules_map//:print`
modules_mapping(
 name = "modules_map",
 exclude_patterns = [
 "^_|(\\._)+", # This is the default.
 "(\\.tests)+", # Add a custom one to get rid of the psutil tests.
 ],
 wheels = all_whl_requirements,
)

# Gazelle python extension needs a manifest file mapping from
# an import to the installed package that provides it.
# This macro produces two targets:
# - //:gazelle_python_manifest.modules_mapping, which fetches the metadata for
# python packages we depend on. That data is required for the
# gazelle_python_manifest rule to update our manifest file.
# - //:gazelle_python_manifest.update can be used with `bazel run`
# to recalculate the manifest
# - //:gazelle_python_manifest.test is a test target ensuring that
# the manifest doesn't need to be updated
gazelle_python_manifest(
 name = "gazelle_python_manifest",
 modules_mapping = ":modules_map",
 pip_repository_name = "pip",
 requirements = "//:requirements_lock.txt",
 extend_exclude_patterns = [
 "(\\.tests)+", # Add a custom one to get rid of the psutil tests.
 ],
 metadata = GAZELLE_PLUGIN_ARGS,
)

# Our gazelle target points to the python gazelle binary.
Expand All@@ -53,7 +43,7 @@ gazelle_python_manifest(
gazelle(
 name = "gazelle",
 data = GAZELLE_PYTHON_RUNTIME_DEPS,
 gazelle = "@rules_python//gazelle:gazelle_python_binary",
 gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)

# This rule is auto-generated and managed by Gazelle,
Expand Down

43 changes: 43 additions & 0 deletions
examples/build_file_generation/MODULE.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
module(
 name = "example_bzlmod",
 compatibility_level = 1,
 version = "0.0.0",
)

bazel_dep(name = "rules_python", version = "0.0.0")
bazel_dep(name = "rules_python_gazelle_plugin", version = "0.0.0")

local_path_override(
 module_name = "rules_python",
 path = "../..",
)

local_path_override(
 module_name = "rules_python_gazelle_plugin",
 path = "../../gazelle",
)

python = use_extension("@rules_python//python:extensions.bzl", "python")

python.toolchain(
 name = "python3_9",
 python_version = "3.9",
)

use_repo(python, "python3_9_toolchains")

register_toolchains(
 "@python3_9_toolchains//:all",
)

pip = use_extension("@rules_python//python:extensions.bzl", "pip")

pip.parse(
 name = "pip",
 requirements_lock = "//:requirements_lock.txt",
 requirements_windows = "//:requirements_windows.txt",
)

use_repo(pip, "pip")

bazel_dep(name = "gazelle", repo_name = "bazel_gazelle", version = "0.28.0")

9 changes: 9 additions & 0 deletions
examples/build_file_generation/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,3 +18,12 @@ added to the `py_library` target in the `BUILD` file.

For more information on the behavior of the rules_python gazelle extension,
see the README.md file in the /gazelle folder.

# bzlmod

This also works with bzlmod. To do that:
1. Add a line into the `.bazelrc` to enable `bzlmod`.
1. Run `bazel run //:gazelle_python_manifest.update`
1. Run `bazel run //:gazelle`

This is necessary to switch to the `bzlmod` way of accessing third-party dependencies.

15 changes: 14 additions & 1 deletion
examples/build_file_generation/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,11 @@ local_repository(
 path = "../..",
)

local_repository(
 name = "rules_python_gazelle_plugin",
 path = "../../gazelle",
)

# When not using this example in the rules_python git repo you would load the python
# ruleset using the following StarLark.
# See https://github.com/bazelbuild/rules_python#getting-started for the latest
Expand All@@ -81,6 +86,14 @@ local_repository(
# strip_prefix = "rules_python-0.16.1",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )
#
# load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
# http_archive(
# name = "rules_python_gazelle_plugin",
# sha256 = "497ca47374f48c8b067d786b512ac10a276211810f4a580178ee9b9ad139323a",
# strip_prefix = "rules_python-0.16.1/gazelle",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )

# Next we load the toolchain from rules_python.
load("@rules_python//python:repositories.bzl", "python_register_toolchains")
Expand DownExpand Up@@ -124,7 +137,7 @@ install_deps()

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
Expand Down

2 changes: 2 additions & 0 deletions
examples/build_file_generation/WORKSPACE.bzlmod

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# Empty file indicating the root of a Bazel workspace.
# Dependencies and setup are in MODULE.bazel.

5 changes: 3 additions & 2 deletions
examples/build_file_generation/gazelle_python.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,5 +113,6 @@ manifest:
 zipp: zipp
 zipp.py310compat: zipp
 pip_repository:
 name: pip
integrity: 4153df7683d64d7d6ad56c14ea1c7f7bec84a2ddf9ef8f075d1bb9313b8d11aa
 repo_convention: pip_%s
 target_convention: pkg
integrity: 75649e137de25ba5161744181a95f4ce3f3d6c41d998a099eab5dcc8a446d395

3 changes: 2 additions & 1 deletion
examples/bzlmod/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,8 @@ py_library(
 name = "lib",
 srcs = ["__init__.py"],
 deps = [
 requirement("pylint"),
 # You can reference libraries using plain text form or the 'requirement' macro
 "@pip//:pylint_pkg",
 requirement("tabulate"),
 requirement("python-dateutil"),
 ],
Expand Down

13 changes: 13 additions & 0 deletions
gazelle/.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
test --test_output=errors

# Do NOT implicitly create empty __init__.py files in the runfiles tree.
# By default, these are created in every directory containing Python source code
# or shared libraries, and every parent directory of those directories,
# excluding the repo root directory. With this flag set, we are responsible for
# creating (possibly empty) __init__.py files and adding them to the srcs of
# Python targets as required.
build --incompatible_default_to_explicit_init_py

# Windows makes use of runfiles for some rules
build --enable_runfiles
startup --windows_enable_symlinks

52 changes: 52 additions & 0 deletions
gazelle/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
# Compiled Object files
*.slo
*.lo
*.o
*.obj

# Precompiled Headers
*.gch
*.pch

# Compiled Dynamic libraries
*.so
*.dylib
*.dll

# Fortran module files
*.mod
*.smod

# Compiled Static libraries
*.lai
*.la
*.a
*.lib

# Executables
*.exe
*.out
*.app

# Emacs garbage
*~

# Bazel directories
/bazel-*
/bazel-bin
/bazel-genfiles
/bazel-out
/bazel-testlogs
user.bazelrc

# vim swap files
*.swp
*.swo

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out

# Python cache
**/__pycache__/
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Gazelle bzlmod poc v2#971

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

 Closed

aignas
wants to merge
7
commits into

from

 Closed


Gazelle bzlmod poc v2
#971
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
abde25c

breaking: feat(gazelle): Move the plugin to a separate workspace


aignas Jan 4, 2023
de9ae05

feat: Store alias labels in requirements arrays if using bzlmod


aignas Jan 3, 2023
6d86634

feat(gazelle): Support bzlmod


aignas Jan 4, 2023
e221f25

feat(gazelle): store metadata in a structure and read it


aignas Jan 3, 2023
51f2863

Update the example code


aignas Jan 4, 2023
9c024a6

Use bzlmod in the example


aignas Jan 4, 2023
543923b

Revert "Use bzlmod in the example"


aignas Jan 4, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

The table of contents is too big for display.

 Diff view

 Diff view

  •  
  •  
  •  

11 changes: 3 additions & 8 deletions
.bazelci/presubmit.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,17 +10,11 @@ buildifier:
 # As a regression test for #225, check that wheel targets still build when
 # their package path is qualified with the repo name.
 - "@rules_python//examples/wheel/..."
 - "-//gazelle/..."
 build_flags:
 - "--keep_going"
 test_targets:
 - "--"
 - "..."
 # The gazelle tests are not compatible with Windows, so we only test them
 # on Linux. The build file generation, which uses this Gazelle extension,
 # runs on all platforms, and is asserted by the build_file_generation
 # integration tests below.
 - "-//gazelle/..."
 test_flags:
 - "--test_tag_filters=-integration-test"
.reusable_build_test_all: &reusable_build_test_all
Expand All@@ -30,8 +24,9 @@ tasks:
 gazelle_extension:
 name: Test the Gazelle extension
 platform: ubuntu2004
 build_targets: ["//gazelle/..."]
 test_targets: ["//gazelle/..."]
 build_targets: ["//..."]
 test_targets: ["//..."]
 working_directory: gazelle
 ubuntu:
 <<: *reusable_config
 name: Default test on Ubuntu
Expand Down

4 changes: 2 additions & 2 deletions
.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
# This lets us glob() up all the files inside the examples to make them inputs to tests
# (Note, we cannot use `common --deleted_packages` because the bazel version command doesn't support it)
# To update these lines, run tools/bazel_integration_test/update_deleted_packages.sh
build --deleted_packages=examples/build_file_generation,examples/build_file_generation/get_url,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/build_file_generation/get_url,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
build --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps

test --test_output=errors

Expand Down

20 changes: 1 addition & 19 deletions
BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.

load("@bazel_gazelle//:def.bzl", "gazelle")
load(":version.bzl", "BAZEL_VERSION")

package(default_visibility = ["//visibility:public"])
Expand All@@ -32,13 +31,13 @@ filegroup(
 "WORKSPACE",
 "internal_deps.bzl",
 "internal_setup.bzl",
 "//gazelle:distribution",
 "//python:distribution",
 "//python/pip_install:distribution",
 "//third_party/github.com/bazelbuild/bazel-skylib/lib:distribution",
 "//third_party/github.com/bazelbuild/bazel-skylib/rules:distribution",
 "//third_party/github.com/bazelbuild/bazel-skylib/rules/private:distribution",
 "//tools:distribution",
 "@rules_python_gazelle_plugin//:distribution",
 ],
 visibility = [
 "//examples:__pkg__",
Expand All@@ -64,23 +63,6 @@ filegroup(
 visibility = ["//visibility:public"],
)

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python
# gazelle:exclude bazel-out
# gazelle:exclude examples/**
gazelle(name = "gazelle")

gazelle(
 name = "gazelle_update_repos",
 args = [
 "-from_file=go.mod",
 "-to_macro=gazelle/deps.bzl%gazelle_deps",
 "-prune",
 ],
 command = "update-repos",
)

genrule(
 name = "assert_bazelversion",
 srcs = [".bazelversion"],
Expand Down

19 changes: 14 additions & 5 deletions
WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,11 +34,6 @@ python_register_multi_toolchains(
 python_versions = MINOR_MAPPING.values(),
)

load("//gazelle:deps.bzl", "gazelle_deps")

# gazelle:repository_macro gazelle/deps.bzl%gazelle_deps
gazelle_deps()

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

# Used for Bazel CI
Expand All@@ -58,3 +53,17 @@ rbe_preconfig(
 name = "buildkite_config",
 toolchain = "ubuntu1804-bazel-java11",
)

local_repository(
 name = "rules_python_gazelle_plugin",
 path = "gazelle",
)

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
# for python requirements.
_py_gazelle_deps()

32 changes: 11 additions & 21 deletions
examples/build_file_generation/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,12 +3,11 @@
# The `load` statement imports the symbol for the rule, in the defined
# ruleset. When the symbol is loaded you can use the rule.
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@pip//:gazelle.bzl", "GAZELLE_PLUGIN_ARGS")
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")
load("@rules_python//python:pip.bzl", "compile_pip_requirements")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")

compile_pip_requirements(
 name = "requirements",
Expand All@@ -18,31 +17,22 @@ compile_pip_requirements(
 requirements_windows = "requirements_windows.txt",
)

# This repository rule fetches the metadata for python packages we
# depend on. That data is required for the gazelle_python_manifest
# rule to update our manifest file.
# To see what this rule does, try `bazel run @modules_map//:print`
modules_mapping(
 name = "modules_map",
 exclude_patterns = [
 "^_|(\\._)+", # This is the default.
 "(\\.tests)+", # Add a custom one to get rid of the psutil tests.
 ],
 wheels = all_whl_requirements,
)

# Gazelle python extension needs a manifest file mapping from
# an import to the installed package that provides it.
# This macro produces two targets:
# - //:gazelle_python_manifest.modules_mapping, which fetches the metadata for
# python packages we depend on. That data is required for the
# gazelle_python_manifest rule to update our manifest file.
# - //:gazelle_python_manifest.update can be used with `bazel run`
# to recalculate the manifest
# - //:gazelle_python_manifest.test is a test target ensuring that
# the manifest doesn't need to be updated
gazelle_python_manifest(
 name = "gazelle_python_manifest",
 modules_mapping = ":modules_map",
 pip_repository_name = "pip",
 requirements = "//:requirements_lock.txt",
 extend_exclude_patterns = [
 "(\\.tests)+", # Add a custom one to get rid of the psutil tests.
 ],
 metadata = GAZELLE_PLUGIN_ARGS,
)

# Our gazelle target points to the python gazelle binary.
Expand All@@ -53,7 +43,7 @@ gazelle_python_manifest(
gazelle(
 name = "gazelle",
 data = GAZELLE_PYTHON_RUNTIME_DEPS,
 gazelle = "@rules_python//gazelle:gazelle_python_binary",
 gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)

# This rule is auto-generated and managed by Gazelle,
Expand Down

43 changes: 43 additions & 0 deletions
examples/build_file_generation/MODULE.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
module(
 name = "example_bzlmod",
 compatibility_level = 1,
 version = "0.0.0",
)

bazel_dep(name = "rules_python", version = "0.0.0")
bazel_dep(name = "rules_python_gazelle_plugin", version = "0.0.0")

local_path_override(
 module_name = "rules_python",
 path = "../..",
)

local_path_override(
 module_name = "rules_python_gazelle_plugin",
 path = "../../gazelle",
)

python = use_extension("@rules_python//python:extensions.bzl", "python")

python.toolchain(
 name = "python3_9",
 python_version = "3.9",
)

use_repo(python, "python3_9_toolchains")

register_toolchains(
 "@python3_9_toolchains//:all",
)

pip = use_extension("@rules_python//python:extensions.bzl", "pip")

pip.parse(
 name = "pip",
 requirements_lock = "//:requirements_lock.txt",
 requirements_windows = "//:requirements_windows.txt",
)

use_repo(pip, "pip")

bazel_dep(name = "gazelle", repo_name = "bazel_gazelle", version = "0.28.0")

9 changes: 9 additions & 0 deletions
examples/build_file_generation/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,3 +18,12 @@ added to the `py_library` target in the `BUILD` file.

For more information on the behavior of the rules_python gazelle extension,
see the README.md file in the /gazelle folder.

# bzlmod

This also works with bzlmod. To do that:
1. Add a line into the `.bazelrc` to enable `bzlmod`.
1. Run `bazel run //:gazelle_python_manifest.update`
1. Run `bazel run //:gazelle`

This is necessary to switch to the `bzlmod` way of accessing third-party dependencies.

15 changes: 14 additions & 1 deletion
examples/build_file_generation/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,11 @@ local_repository(
 path = "../..",
)

local_repository(
 name = "rules_python_gazelle_plugin",
 path = "../../gazelle",
)

# When not using this example in the rules_python git repo you would load the python
# ruleset using the following StarLark.
# See https://github.com/bazelbuild/rules_python#getting-started for the latest
Expand All@@ -81,6 +86,14 @@ local_repository(
# strip_prefix = "rules_python-0.16.1",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )
#
# load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
# http_archive(
# name = "rules_python_gazelle_plugin",
# sha256 = "497ca47374f48c8b067d786b512ac10a276211810f4a580178ee9b9ad139323a",
# strip_prefix = "rules_python-0.16.1/gazelle",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )

# Next we load the toolchain from rules_python.
load("@rules_python//python:repositories.bzl", "python_register_toolchains")
Expand DownExpand Up@@ -124,7 +137,7 @@ install_deps()

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
Expand Down

2 changes: 2 additions & 0 deletions
examples/build_file_generation/WORKSPACE.bzlmod

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# Empty file indicating the root of a Bazel workspace.
# Dependencies and setup are in MODULE.bazel.

5 changes: 3 additions & 2 deletions
examples/build_file_generation/gazelle_python.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,5 +113,6 @@ manifest:
 zipp: zipp
 zipp.py310compat: zipp
 pip_repository:
 name: pip
integrity: 4153df7683d64d7d6ad56c14ea1c7f7bec84a2ddf9ef8f075d1bb9313b8d11aa
 repo_convention: pip_%s
 target_convention: pkg
integrity: 75649e137de25ba5161744181a95f4ce3f3d6c41d998a099eab5dcc8a446d395

3 changes: 2 additions & 1 deletion
examples/bzlmod/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,8 @@ py_library(
 name = "lib",
 srcs = ["__init__.py"],
 deps = [
 requirement("pylint"),
 # You can reference libraries using plain text form or the 'requirement' macro
 "@pip//:pylint_pkg",
 requirement("tabulate"),
 requirement("python-dateutil"),
 ],
Expand Down

13 changes: 13 additions & 0 deletions
gazelle/.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
test --test_output=errors

# Do NOT implicitly create empty __init__.py files in the runfiles tree.
# By default, these are created in every directory containing Python source code
# or shared libraries, and every parent directory of those directories,
# excluding the repo root directory. With this flag set, we are responsible for
# creating (possibly empty) __init__.py files and adding them to the srcs of
# Python targets as required.
build --incompatible_default_to_explicit_init_py

# Windows makes use of runfiles for some rules
build --enable_runfiles
startup --windows_enable_symlinks

52 changes: 52 additions & 0 deletions
gazelle/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
# Compiled Object files
*.slo
*.lo
*.o
*.obj

# Precompiled Headers
*.gch
*.pch

# Compiled Dynamic libraries
*.so
*.dylib
*.dll

# Fortran module files
*.mod
*.smod

# Compiled Static libraries
*.lai
*.la
*.a
*.lib

# Executables
*.exe
*.out
*.app

# Emacs garbage
*~

# Bazel directories
/bazel-*
/bazel-bin
/bazel-genfiles
/bazel-out
/bazel-testlogs
user.bazelrc

# vim swap files
*.swp
*.swo

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out

# Python cache
**/__pycache__/
Loading

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

Skip to content
Gazelle bzlmod poc v2#971

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

 Closed

aignas
wants to merge
7
commits into

from

 Closed


Gazelle bzlmod poc v2
#971
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
abde25c

breaking: feat(gazelle): Move the plugin to a separate workspace


aignas Jan 4, 2023
de9ae05

feat: Store alias labels in requirements arrays if using bzlmod


aignas Jan 3, 2023
6d86634

feat(gazelle): Support bzlmod


aignas Jan 4, 2023
e221f25

feat(gazelle): store metadata in a structure and read it


aignas Jan 3, 2023
51f2863

Update the example code


aignas Jan 4, 2023
9c024a6

Use bzlmod in the example


aignas Jan 4, 2023
543923b

Revert "Use bzlmod in the example"


aignas Jan 4, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

The table of contents is too big for display.

 Diff view

 Diff view

  •  
  •  
  •  

11 changes: 3 additions & 8 deletions
.bazelci/presubmit.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,17 +10,11 @@ buildifier:
 # As a regression test for #225, check that wheel targets still build when
 # their package path is qualified with the repo name.
 - "@rules_python//examples/wheel/..."
 - "-//gazelle/..."
 build_flags:
 - "--keep_going"
 test_targets:
 - "--"
 - "..."
 # The gazelle tests are not compatible with Windows, so we only test them
 # on Linux. The build file generation, which uses this Gazelle extension,
 # runs on all platforms, and is asserted by the build_file_generation
 # integration tests below.
 - "-//gazelle/..."
 test_flags:
 - "--test_tag_filters=-integration-test"
.reusable_build_test_all: &reusable_build_test_all
Expand All@@ -30,8 +24,9 @@ tasks:
 gazelle_extension:
 name: Test the Gazelle extension
 platform: ubuntu2004
 build_targets: ["//gazelle/..."]
 test_targets: ["//gazelle/..."]
 build_targets: ["//..."]
 test_targets: ["//..."]
 working_directory: gazelle
 ubuntu:
 <<: *reusable_config
 name: Default test on Ubuntu
Expand Down

4 changes: 2 additions & 2 deletions
.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
# This lets us glob() up all the files inside the examples to make them inputs to tests
# (Note, we cannot use `common --deleted_packages` because the bazel version command doesn't support it)
# To update these lines, run tools/bazel_integration_test/update_deleted_packages.sh
build --deleted_packages=examples/build_file_generation,examples/build_file_generation/get_url,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/build_file_generation/get_url,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
build --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps

test --test_output=errors

Expand Down

20 changes: 1 addition & 19 deletions
BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.

load("@bazel_gazelle//:def.bzl", "gazelle")
load(":version.bzl", "BAZEL_VERSION")

package(default_visibility = ["//visibility:public"])
Expand All@@ -32,13 +31,13 @@ filegroup(
 "WORKSPACE",
 "internal_deps.bzl",
 "internal_setup.bzl",
 "//gazelle:distribution",
 "//python:distribution",
 "//python/pip_install:distribution",
 "//third_party/github.com/bazelbuild/bazel-skylib/lib:distribution",
 "//third_party/github.com/bazelbuild/bazel-skylib/rules:distribution",
 "//third_party/github.com/bazelbuild/bazel-skylib/rules/private:distribution",
 "//tools:distribution",
 "@rules_python_gazelle_plugin//:distribution",
 ],
 visibility = [
 "//examples:__pkg__",
Expand All@@ -64,23 +63,6 @@ filegroup(
 visibility = ["//visibility:public"],
)

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python
# gazelle:exclude bazel-out
# gazelle:exclude examples/**
gazelle(name = "gazelle")

gazelle(
 name = "gazelle_update_repos",
 args = [
 "-from_file=go.mod",
 "-to_macro=gazelle/deps.bzl%gazelle_deps",
 "-prune",
 ],
 command = "update-repos",
)

genrule(
 name = "assert_bazelversion",
 srcs = [".bazelversion"],
Expand Down

19 changes: 14 additions & 5 deletions
WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,11 +34,6 @@ python_register_multi_toolchains(
 python_versions = MINOR_MAPPING.values(),
)

load("//gazelle:deps.bzl", "gazelle_deps")

# gazelle:repository_macro gazelle/deps.bzl%gazelle_deps
gazelle_deps()

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

# Used for Bazel CI
Expand All@@ -58,3 +53,17 @@ rbe_preconfig(
 name = "buildkite_config",
 toolchain = "ubuntu1804-bazel-java11",
)

local_repository(
 name = "rules_python_gazelle_plugin",
 path = "gazelle",
)

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
# for python requirements.
_py_gazelle_deps()

32 changes: 11 additions & 21 deletions
examples/build_file_generation/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,12 +3,11 @@
# The `load` statement imports the symbol for the rule, in the defined
# ruleset. When the symbol is loaded you can use the rule.
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@pip//:gazelle.bzl", "GAZELLE_PLUGIN_ARGS")
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")
load("@rules_python//python:pip.bzl", "compile_pip_requirements")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")

compile_pip_requirements(
 name = "requirements",
Expand All@@ -18,31 +17,22 @@ compile_pip_requirements(
 requirements_windows = "requirements_windows.txt",
)

# This repository rule fetches the metadata for python packages we
# depend on. That data is required for the gazelle_python_manifest
# rule to update our manifest file.
# To see what this rule does, try `bazel run @modules_map//:print`
modules_mapping(
 name = "modules_map",
 exclude_patterns = [
 "^_|(\\._)+", # This is the default.
 "(\\.tests)+", # Add a custom one to get rid of the psutil tests.
 ],
 wheels = all_whl_requirements,
)

# Gazelle python extension needs a manifest file mapping from
# an import to the installed package that provides it.
# This macro produces two targets:
# - //:gazelle_python_manifest.modules_mapping, which fetches the metadata for
# python packages we depend on. That data is required for the
# gazelle_python_manifest rule to update our manifest file.
# - //:gazelle_python_manifest.update can be used with `bazel run`
# to recalculate the manifest
# - //:gazelle_python_manifest.test is a test target ensuring that
# the manifest doesn't need to be updated
gazelle_python_manifest(
 name = "gazelle_python_manifest",
 modules_mapping = ":modules_map",
 pip_repository_name = "pip",
 requirements = "//:requirements_lock.txt",
 extend_exclude_patterns = [
 "(\\.tests)+", # Add a custom one to get rid of the psutil tests.
 ],
 metadata = GAZELLE_PLUGIN_ARGS,
)

# Our gazelle target points to the python gazelle binary.
Expand All@@ -53,7 +43,7 @@ gazelle_python_manifest(
gazelle(
 name = "gazelle",
 data = GAZELLE_PYTHON_RUNTIME_DEPS,
 gazelle = "@rules_python//gazelle:gazelle_python_binary",
 gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)

# This rule is auto-generated and managed by Gazelle,
Expand Down

43 changes: 43 additions & 0 deletions
examples/build_file_generation/MODULE.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
module(
 name = "example_bzlmod",
 compatibility_level = 1,
 version = "0.0.0",
)

bazel_dep(name = "rules_python", version = "0.0.0")
bazel_dep(name = "rules_python_gazelle_plugin", version = "0.0.0")

local_path_override(
 module_name = "rules_python",
 path = "../..",
)

local_path_override(
 module_name = "rules_python_gazelle_plugin",
 path = "../../gazelle",
)

python = use_extension("@rules_python//python:extensions.bzl", "python")

python.toolchain(
 name = "python3_9",
 python_version = "3.9",
)

use_repo(python, "python3_9_toolchains")

register_toolchains(
 "@python3_9_toolchains//:all",
)

pip = use_extension("@rules_python//python:extensions.bzl", "pip")

pip.parse(
 name = "pip",
 requirements_lock = "//:requirements_lock.txt",
 requirements_windows = "//:requirements_windows.txt",
)

use_repo(pip, "pip")

bazel_dep(name = "gazelle", repo_name = "bazel_gazelle", version = "0.28.0")

9 changes: 9 additions & 0 deletions
examples/build_file_generation/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,3 +18,12 @@ added to the `py_library` target in the `BUILD` file.

For more information on the behavior of the rules_python gazelle extension,
see the README.md file in the /gazelle folder.

# bzlmod

This also works with bzlmod. To do that:
1. Add a line into the `.bazelrc` to enable `bzlmod`.
1. Run `bazel run //:gazelle_python_manifest.update`
1. Run `bazel run //:gazelle`

This is necessary to switch to the `bzlmod` way of accessing third-party dependencies.

15 changes: 14 additions & 1 deletion
examples/build_file_generation/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,11 @@ local_repository(
 path = "../..",
)

local_repository(
 name = "rules_python_gazelle_plugin",
 path = "../../gazelle",
)

# When not using this example in the rules_python git repo you would load the python
# ruleset using the following StarLark.
# See https://github.com/bazelbuild/rules_python#getting-started for the latest
Expand All@@ -81,6 +86,14 @@ local_repository(
# strip_prefix = "rules_python-0.16.1",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )
#
# load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
# http_archive(
# name = "rules_python_gazelle_plugin",
# sha256 = "497ca47374f48c8b067d786b512ac10a276211810f4a580178ee9b9ad139323a",
# strip_prefix = "rules_python-0.16.1/gazelle",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )

# Next we load the toolchain from rules_python.
load("@rules_python//python:repositories.bzl", "python_register_toolchains")
Expand DownExpand Up@@ -124,7 +137,7 @@ install_deps()

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
Expand Down

2 changes: 2 additions & 0 deletions
examples/build_file_generation/WORKSPACE.bzlmod

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# Empty file indicating the root of a Bazel workspace.
# Dependencies and setup are in MODULE.bazel.

5 changes: 3 additions & 2 deletions
examples/build_file_generation/gazelle_python.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,5 +113,6 @@ manifest:
 zipp: zipp
 zipp.py310compat: zipp
 pip_repository:
 name: pip
integrity: 4153df7683d64d7d6ad56c14ea1c7f7bec84a2ddf9ef8f075d1bb9313b8d11aa
 repo_convention: pip_%s
 target_convention: pkg
integrity: 75649e137de25ba5161744181a95f4ce3f3d6c41d998a099eab5dcc8a446d395

3 changes: 2 additions & 1 deletion
examples/bzlmod/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,8 @@ py_library(
 name = "lib",
 srcs = ["__init__.py"],
 deps = [
 requirement("pylint"),
 # You can reference libraries using plain text form or the 'requirement' macro
 "@pip//:pylint_pkg",
 requirement("tabulate"),
 requirement("python-dateutil"),
 ],
Expand Down

13 changes: 13 additions & 0 deletions
gazelle/.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
test --test_output=errors

# Do NOT implicitly create empty __init__.py files in the runfiles tree.
# By default, these are created in every directory containing Python source code
# or shared libraries, and every parent directory of those directories,
# excluding the repo root directory. With this flag set, we are responsible for
# creating (possibly empty) __init__.py files and adding them to the srcs of
# Python targets as required.
build --incompatible_default_to_explicit_init_py

# Windows makes use of runfiles for some rules
build --enable_runfiles
startup --windows_enable_symlinks

52 changes: 52 additions & 0 deletions
gazelle/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
# Compiled Object files
*.slo
*.lo
*.o
*.obj

# Precompiled Headers
*.gch
*.pch

# Compiled Dynamic libraries
*.so
*.dylib
*.dll

# Fortran module files
*.mod
*.smod

# Compiled Static libraries
*.lai
*.la
*.a
*.lib

# Executables
*.exe
*.out
*.app

# Emacs garbage
*~

# Bazel directories
/bazel-*
/bazel-bin
/bazel-genfiles
/bazel-out
/bazel-testlogs
user.bazelrc

# vim swap files
*.swp
*.swo

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out

# Python cache
**/__pycache__/
Loading