Skip to content

fix(rules): make py_console_script_binary compatible with symbolic macros #3195

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 11, 2025
Merged

fix(rules): make py_console_script_binary compatible with symbolic macros #3195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
57c5f23
Ensure symbolic macro compatibility for py_console_script_binary
janwinkler1 Aug 19, 2025
79b3f86
Reformat
janwinkler1 Aug 19, 2025
16d708d
minor adjustments
aignas Oct 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,8 @@ END_UNRELEASED_TEMPLATE
variants. Setting {obj}`--py_linux_libc=musl` and `--py_freethreaded=yes` now
activate them, respectively.
([#3262](https://github.com/bazel-contrib/rules_python/issues/3262)).
* (rules) {obj}`py_console_script_binary` is now compatible with symbolic macros
([#3195](https://github.com/bazel-contrib/rules_python/pull/3195)).

{#v0-0-0-added}
### Added
Expand Down
7 changes: 5 additions & 2 deletions python/private/py_console_script_binary.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ def py_console_script_binary(
script = None,
binary_rule = py_binary,
shebang = "",
main = None,
**kwargs):
"""Generate a py_binary for a console_script entry_point.

Expand All @@ -66,20 +67,22 @@ def py_console_script_binary(
package as the `pkg` Label.
script: {type}`str`, The console script name that the py_binary is going to be
generated for. Defaults to the normalized name attribute.
main: {type}`str`, the python file to be generated, defaults to `<name>_entry_point.py` to
be compatible with symbolic macros.
binary_rule: {type}`callable`, The rule/macro to use to instantiate
the target. It's expected to behave like {obj}`py_binary`.
Defaults to {obj}`py_binary`.
shebang: {type}`str`, The shebang to use for the entry point python file.
Defaults to empty string.
**kwargs: Extra parameters forwarded to `binary_rule`.
"""
main = "rules_python_entry_point_{}.py".format(name)
main = main or name + "_entry_point.py"

if kwargs.pop("srcs", None):
fail("passing 'srcs' attribute to py_console_script_binary is unsupported")

py_console_script_gen(
name = "_{}_gen".format(name),
name = name + "_gen__",
entry_points_txt = entry_points_txt or _dist_info(pkg),
out = main,
console_script = script,
Expand Down