From 1b80c71076493d568956e97fbfc705d6cc5644eb Mon Sep 17 00:00:00 2001 From: PatrikKopkan Date: Thu, 5 Sep 2019 16:54:54 +0200 Subject: [PATCH 1/2] bpo-37064: Add option -k to Tools/scripts/pathfix.py (GH-15548) Add flag -k to pathscript.py script: preserve shebang flags. (cherry picked from commit 50254ac4c179cb412e90682098c97db786143929) --- Lib/test/test_tools/test_pathfix.py | 64 +++++++++++++++++++ .../2019-05-27-15-26-12.bpo-37064.k_SPW2.rst | 1 + Tools/scripts/pathfix.py | 39 +++++++++-- 3 files changed, 99 insertions(+), 5 deletions(-) create mode 100644 Lib/test/test_tools/test_pathfix.py create mode 100644 Misc/NEWS.d/next/Tools-Demos/2019-05-27-15-26-12.bpo-37064.k_SPW2.rst diff --git a/Lib/test/test_tools/test_pathfix.py b/Lib/test/test_tools/test_pathfix.py new file mode 100644 index 00000000000000..5c0dd1d5a60c06 --- /dev/null +++ b/Lib/test/test_tools/test_pathfix.py @@ -0,0 +1,64 @@ +import os +import subprocess +import sys +import unittest +from test import support +from test.test_tools import import_tool, scriptsdir + + +class TestPathfixFunctional(unittest.TestCase): + script = os.path.join(scriptsdir, 'pathfix.py') + + def setUp(self): + self.temp_file = support.TESTFN + self.addCleanup(support.unlink, support.TESTFN) + + def pathfix(self, shebang, pathfix_flags): + with open(self.temp_file, 'w', encoding='utf8') as f: + f.write(f'{shebang}\n' + 'print("Hello world")\n') + + proc = subprocess.run( + [sys.executable, self.script, + *pathfix_flags, '-n', self.temp_file], + capture_output=True) + self.assertEqual(proc.returncode, 0, proc) + + with open(self.temp_file, 'r', encoding='utf8') as f: + output = f.read() + + lines = output.split('\n') + self.assertEqual(lines[1:], ['print("Hello world")', '']) + shebang = lines[0] + return shebang + + def test_pathfix(self): + self.assertEqual( + self.pathfix( + '#! /usr/bin/env python', + ['-i', '/usr/bin/python3',]), + '#! /usr/bin/python3', + ) + self.assertEqual( + self.pathfix( + '#! /usr/bin/env python -R', + ['-i', '/usr/bin/python3', ]), + '#! /usr/bin/python3', + ) + + def test_pathfix_keeping_flags(self): + self.assertEqual( + self.pathfix( + '#! /usr/bin/env python -R', + ['-i', '/usr/bin/python3', '-k',]), + '#! /usr/bin/python3 -R', + ) + self.assertEqual( + self.pathfix( + '#! /usr/bin/env python', + ['-i', '/usr/bin/python3', '-k',]), + '#! /usr/bin/python3', + ) + + +if __name__ == '__main__': + unittest.main() diff --git a/Misc/NEWS.d/next/Tools-Demos/2019-05-27-15-26-12.bpo-37064.k_SPW2.rst b/Misc/NEWS.d/next/Tools-Demos/2019-05-27-15-26-12.bpo-37064.k_SPW2.rst new file mode 100644 index 00000000000000..02599077c9d5f9 --- /dev/null +++ b/Misc/NEWS.d/next/Tools-Demos/2019-05-27-15-26-12.bpo-37064.k_SPW2.rst @@ -0,0 +1 @@ +Add flag -k to pathscript.py script: preserve shebang flags. \ No newline at end of file diff --git a/Tools/scripts/pathfix.py b/Tools/scripts/pathfix.py index 1a0cf1c9e69ce7..eee684e3502d5b 100755 --- a/Tools/scripts/pathfix.py +++ b/Tools/scripts/pathfix.py @@ -1,6 +1,6 @@ #!/usr/bin/env python3 -# Change the #! line occurring in Python scripts. The new interpreter +# Change the #! line (shebang) occurring in Python scripts. The new interpreter # pathname must be given with a -i option. # # Command line arguments are files or directories to be processed. @@ -10,7 +10,12 @@ # arguments). # The original file is kept as a back-up (with a "~" attached to its name), # -n flag can be used to disable this. -# + +# Sometimes you may find shebangs with flags such as `#! /usr/bin/env python -si`. +# Normally, pathfix overwrites the entire line, including the flags. +# To change interpreter and keep flags from the original shebang line, use -k. + + # Undoubtedly you can do this using find and sed or perl, but this is # a nice example of Python code that recurses down a directory tree # and uses regular expressions. Also note several subtleties like @@ -33,16 +38,19 @@ new_interpreter = None preserve_timestamps = False create_backup = True +keep_flags = False def main(): global new_interpreter global preserve_timestamps global create_backup - usage = ('usage: %s -i /interpreter -p -n file-or-directory ...\n' % + global keep_flags + + usage = ('usage: %s -i /interpreter -p -n -k file-or-directory ...\n' % sys.argv[0]) try: - opts, args = getopt.getopt(sys.argv[1:], 'i:pn') + opts, args = getopt.getopt(sys.argv[1:], 'i:kpn') except getopt.error as msg: err(str(msg) + '\n') err(usage) @@ -54,6 +62,8 @@ def main(): preserve_timestamps = True if o == '-n': create_backup = False + if o == '-k': + keep_flags = True if not new_interpreter or not new_interpreter.startswith(b'/') or \ not args: err('-i option or file-or-directory missing\n') @@ -70,10 +80,14 @@ def main(): if fix(arg): bad = 1 sys.exit(bad) + ispythonprog = re.compile(r'^[a-zA-Z0-9_]+\.py$') + + def ispython(name): return bool(ispythonprog.match(name)) + def recursedown(dirname): dbg('recursedown(%r)\n' % (dirname,)) bad = 0 @@ -96,6 +110,7 @@ def recursedown(dirname): if recursedown(fullname): bad = 1 return bad + def fix(filename): ## dbg('fix(%r)\n' % (filename,)) try: @@ -164,12 +179,26 @@ def fix(filename): # Return success return 0 + +def parse_shebang(shebangline): + shebangline = shebangline.rstrip(b'\n') + start = shebangline.find(b' -') + if start == -1: + return b'' + return shebangline[start:] + + def fixline(line): if not line.startswith(b'#!'): return line + if b"python" not in line: return line - return b'#! ' + new_interpreter + b'\n' + flags = b'' + if keep_flags: + flags = parse_shebang(line) + return b'#! ' + new_interpreter + flags + b'\n' + if __name__ == '__main__': main() From d9754dd5626529bec7a248ce2ecb1097e4e9632d Mon Sep 17 00:00:00 2001 From: PatrikKopkan Date: Wed, 25 Sep 2019 14:26:28 +0200 Subject: [PATCH 2/2] bpo-37064: Add option -a to pathfix.py tool (GH-15717) Add option -a to Tools/Scripts/pathfix.py script: add flags. (cherry picked from commit 1dc1acbd73f05f14c974b7ce1041787d7abef31e) --- Lib/test/test_tools/test_pathfix.py | 73 ++++++++++++++----- .../2019-05-27-15-26-12.bpo-37064.k_SPW2.rst | 3 +- Tools/scripts/pathfix.py | 35 +++++++-- 3 files changed, 88 insertions(+), 23 deletions(-) diff --git a/Lib/test/test_tools/test_pathfix.py b/Lib/test/test_tools/test_pathfix.py index 5c0dd1d5a60c06..ce3d536c12932c 100644 --- a/Lib/test/test_tools/test_pathfix.py +++ b/Lib/test/test_tools/test_pathfix.py @@ -13,51 +13,90 @@ def setUp(self): self.temp_file = support.TESTFN self.addCleanup(support.unlink, support.TESTFN) - def pathfix(self, shebang, pathfix_flags): + def pathfix(self, shebang, pathfix_flags, exitcode=0, stdout='', stderr=''): with open(self.temp_file, 'w', encoding='utf8') as f: f.write(f'{shebang}\n' + 'print("Hello world")\n') proc = subprocess.run( [sys.executable, self.script, *pathfix_flags, '-n', self.temp_file], - capture_output=True) - self.assertEqual(proc.returncode, 0, proc) + capture_output=True, text=1) + + if stdout == '' and proc.returncode == 0: + stdout = f'{self.temp_file}: updating\n' + self.assertEqual(proc.returncode, exitcode, proc) + self.assertEqual(proc.stdout, stdout, proc) + self.assertEqual(proc.stderr, stderr, proc) with open(self.temp_file, 'r', encoding='utf8') as f: output = f.read() lines = output.split('\n') self.assertEqual(lines[1:], ['print("Hello world")', '']) - shebang = lines[0] - return shebang + new_shebang = lines[0] + + if proc.returncode != 0: + self.assertEqual(shebang, new_shebang) + + return new_shebang def test_pathfix(self): self.assertEqual( self.pathfix( '#! /usr/bin/env python', - ['-i', '/usr/bin/python3',]), - '#! /usr/bin/python3', - ) + ['-i', '/usr/bin/python3']), + '#! /usr/bin/python3') self.assertEqual( self.pathfix( '#! /usr/bin/env python -R', - ['-i', '/usr/bin/python3', ]), - '#! /usr/bin/python3', - ) + ['-i', '/usr/bin/python3']), + '#! /usr/bin/python3') def test_pathfix_keeping_flags(self): self.assertEqual( self.pathfix( '#! /usr/bin/env python -R', - ['-i', '/usr/bin/python3', '-k',]), - '#! /usr/bin/python3 -R', - ) + ['-i', '/usr/bin/python3', '-k']), + '#! /usr/bin/python3 -R') self.assertEqual( self.pathfix( '#! /usr/bin/env python', - ['-i', '/usr/bin/python3', '-k',]), - '#! /usr/bin/python3', - ) + ['-i', '/usr/bin/python3', '-k']), + '#! /usr/bin/python3') + + def test_pathfix_adding_flag(self): + self.assertEqual( + self.pathfix( + '#! /usr/bin/env python', + ['-i', '/usr/bin/python3', '-a', 's']), + '#! /usr/bin/python3 -s') + self.assertEqual( + self.pathfix( + '#! /usr/bin/env python -S', + ['-i', '/usr/bin/python3', '-a', 's']), + '#! /usr/bin/python3 -s') + self.assertEqual( + self.pathfix( + '#! /usr/bin/env python -V', + ['-i', '/usr/bin/python3', '-a', 'v', '-k']), + '#! /usr/bin/python3 -vV') + self.assertEqual( + self.pathfix( + '#! /usr/bin/env python', + ['-i', '/usr/bin/python3', '-a', 'Rs']), + '#! /usr/bin/python3 -Rs') + self.assertEqual( + self.pathfix( + '#! /usr/bin/env python -W default', + ['-i', '/usr/bin/python3', '-a', 's', '-k']), + '#! /usr/bin/python3 -sW default') + + def test_pathfix_adding_errors(self): + self.pathfix( + '#! /usr/bin/env python -E', + ['-i', '/usr/bin/python3', '-a', 'W default', '-k'], + exitcode=2, + stderr="-a option doesn't support whitespaces") if __name__ == '__main__': diff --git a/Misc/NEWS.d/next/Tools-Demos/2019-05-27-15-26-12.bpo-37064.k_SPW2.rst b/Misc/NEWS.d/next/Tools-Demos/2019-05-27-15-26-12.bpo-37064.k_SPW2.rst index 02599077c9d5f9..d1210e29532bc6 100644 --- a/Misc/NEWS.d/next/Tools-Demos/2019-05-27-15-26-12.bpo-37064.k_SPW2.rst +++ b/Misc/NEWS.d/next/Tools-Demos/2019-05-27-15-26-12.bpo-37064.k_SPW2.rst @@ -1 +1,2 @@ -Add flag -k to pathscript.py script: preserve shebang flags. \ No newline at end of file +Add option -k to pathscript.py script: preserve shebang flags. +Add option -a to pathscript.py script: add flags. diff --git a/Tools/scripts/pathfix.py b/Tools/scripts/pathfix.py index eee684e3502d5b..237a3d96e9fab5 100755 --- a/Tools/scripts/pathfix.py +++ b/Tools/scripts/pathfix.py @@ -14,6 +14,7 @@ # Sometimes you may find shebangs with flags such as `#! /usr/bin/env python -si`. # Normally, pathfix overwrites the entire line, including the flags. # To change interpreter and keep flags from the original shebang line, use -k. +# If you want to keep flags and add to them one single literal flag, use option -a. # Undoubtedly you can do this using find and sed or perl, but this is @@ -39,6 +40,7 @@ preserve_timestamps = False create_backup = True keep_flags = False +add_flags = b'' def main(): @@ -46,11 +48,12 @@ def main(): global preserve_timestamps global create_backup global keep_flags + global add_flags - usage = ('usage: %s -i /interpreter -p -n -k file-or-directory ...\n' % + usage = ('usage: %s -i /interpreter -p -n -k -a file-or-directory ...\n' % sys.argv[0]) try: - opts, args = getopt.getopt(sys.argv[1:], 'i:kpn') + opts, args = getopt.getopt(sys.argv[1:], 'i:a:kpn') except getopt.error as msg: err(str(msg) + '\n') err(usage) @@ -64,6 +67,11 @@ def main(): create_backup = False if o == '-k': keep_flags = True + if o == '-a': + add_flags = a.encode() + if b' ' in add_flags: + err("-a option doesn't support whitespaces") + sys.exit(2) if not new_interpreter or not new_interpreter.startswith(b'/') or \ not args: err('-i option or file-or-directory missing\n') @@ -188,15 +196,32 @@ def parse_shebang(shebangline): return shebangline[start:] +def populate_flags(shebangline): + old_flags = b'' + if keep_flags: + old_flags = parse_shebang(shebangline) + if old_flags: + old_flags = old_flags[2:] + if not (old_flags or add_flags): + return b'' + # On Linux, the entire string following the interpreter name + # is passed as a single argument to the interpreter. + # e.g. "#! /usr/bin/python3 -W Error -s" runs "/usr/bin/python3 "-W Error -s" + # so shebang should have single '-' where flags are given and + # flag might need argument for that reasons adding new flags is + # between '-' and original flags + # e.g. #! /usr/bin/python3 -sW Error + return b' -' + add_flags + old_flags + + def fixline(line): if not line.startswith(b'#!'): return line if b"python" not in line: return line - flags = b'' - if keep_flags: - flags = parse_shebang(line) + + flags = populate_flags(line) return b'#! ' + new_interpreter + flags + b'\n'