Skip to content

WIP add custom shebang on py_console_script_binary #2867

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

Jump to bottom
Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

WIP add custom shebang on py_console_script_binary #2867

wants to merge 4 commits into from
+25 −0

Conversation

chrisirhc
Copy link
Contributor

@chrisirhc chrisirhc commented May 8, 2025 •
edited
Loading

The shebang allows users of the console binary to use it like a binary executable.

This functionality came with wheel entry points here:

rules_python/python/private/pypi/whl_library.bzl

Line 507 in 9dfa3ab

{shebang}

However, if one uses py_console_script_binary, they're unable to use it with a shebang.

With this change, one can specify a shebang like:

py_console_script_binary(
    name = "yamllint",
    pkg = "@pip//yamllint",
    shebang = "#!/usr/bin/env python3",
)

TODOs:

  • Update tests
  • Add test for this functionality
  • Leave default to without shebang so this is a non-breaking change

arrdem
arrdem reviewed May 9, 2025
View reviewed changes
python/private/py_console_script_gen.py
):
"""Run the generator

Args:
entry_points: The entry_points.txt file to be parsed.
out: The output file.
console_script: The console_script entry in the entry_points.txt file.
console_script_guess: The string used for guessing the console_script if it is not provided.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unused?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm what do you mean?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@arrdem arrdem arrdem left review comments

@rickeylev rickeylev Awaiting requested review from rickeylev rickeylev will be requested when the pull request is marked ready for review rickeylev is a code owner

@aignas aignas Awaiting requested review from aignas aignas will be requested when the pull request is marked ready for review aignas is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@chrisirhc @arrdem