Python script shebang cleanup #37859
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
These tools used '#!/usr/bin/env python' but required Python 2. This no longer works on systems where Python 3 is the default. Tweak their #! lines to specify python2.
The scripts in tools/gfx_tools were running /bin/python directly. The convention is to use /usr/bin/env python, so switch to that. Also, they were not executable. Make them so.
Some Python scripts had #! lines but were not executable. Make them so.
Co-Authored-By: anothersimulacrum <[email protected]>
This was referenced Feb 16, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
SUMMARY: None
Purpose of change
There was some inconsistency and ambiguity in how the
#!lines in the CDDA Python scripts were written. Want to fix that to make them easier to use and understand.Describe the solution
#!line, always use/usr/bin/envto find Python executable.#!line sayspython2.#!line, make sure it is executable.#!.Describe alternatives you've considered
There are a couple of scripts still that don't specify Python 2 vs 3. Based on comments in the script, it looks like this is deliberate and they should work in both. @mlangsdorf would you prefer that they do specify a particular Python version?
I considered writing something for the CI to check our Python scripts satisfied these properties, but it didn't seem quite worth it.
Testing
Some scripts can now display a help message when they previously couldn't (because my default Python is 3). I didn't actually try to use the scripts 'for real', though.
Additional context
I was about to write a new Python script and came across these inconsistencies which bugged me.