Skip to contentSkip to conversation

scripts/spdxcheck.py: improve Python 3 compat

PATCH In review Thomas Weißschuh 2 participants 2 messages Sep 16, 2018 – Sep 17, 2018 Licenses and spdx stuff

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 scripts/spdxcheck.py: improve Python 3 compat

When reading lines from a text-mode fd strings are returned. These can not be decoded again into strings, breaking the logic in parser.
Just make sure all files are opened in binary mode on Python 3, so the current logic keeps working.

This remains compatible with Python 2 and should have no functional change.

---
 scripts/spdxcheck.py | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
scripts/spdxcheck.py +5 -2
index 839e190bbd7a..8f472f995d70 100755
@@ -250,12 +250,15 @@ if __name__ == '__main__':
 
     try:
         if len(args.path) and args.path[0] == '-':
-            parser.parse_lines(sys.stdin, args.maxlines, '-')
+            parser.parse_lines(
+                    # always get the binary fd
+                    getattr(sys.stdin, 'buffer', sys.stdin),
+                    args.maxlines, '-')
         else:
             if args.path:
                 for p in args.path:
                     if os.path.isfile(p):
-                        parser.parse_lines(open(p), args.maxlines, p)
+                        parser.parse_lines(open(p, 'rb'), args.maxlines, p)
                     elif os.path.isdir(p):
                         scan_git_subtree(repo.head.reference.commit.tree, p)
                     else:
Signature · 1 line
2.18.0
Reviewed-by on v1 1/1
#1 lore raw
Quoted 19 lines · Thomas Weißschuh

When reading lines from a text-mode fd strings are returned. These can not be decoded again into strings, breaking the logic in parser.
Just make sure all files are opened in binary mode on Python 3, so the current logic keeps working.

This remains compatible with Python 2 and should have no functional change.

---
 scripts/spdxcheck.py | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
scripts/spdxcheck.py +0 -0
index 839e190bbd7a..8f472f995d70 100755

scripts/spdxcheck.py if __name__ == '__main__': · line 256

Quoted 8 lines
scripts/spdxcheck.py +4 -1
@@ -250,12 +250,15 @@ if __name__ == '__main__':
 
     try:
         if len(args.path) and args.path[0] == '-':
-            parser.parse_lines(sys.stdin, args.maxlines, '-')
+            parser.parse_lines(
+                    # always get the binary fd
+                    getattr(sys.stdin, 'buffer', sys.stdin),
+                    args.maxlines, '-')

I think a slightly more "Pythonic" way to do this would be:

try:
parser.parse_lines(sys.stdin.buffer, args.maxlines, '-')
except AttributeError:
# Python 2 doesn't have a binary buffer interface on stdin parser.parse_lines(sys.stdin, args.maxlines, '-')

but they're equivalent so it's completely personal preference.

scripts/spdxcheck.py if __name__ == '__main__': · line 264

Quoted 10 lines
scripts/spdxcheck.py +1 -1
         else:
             if args.path:
                 for p in args.path:
                     if os.path.isfile(p):
-                        parser.parse_lines(open(p), args.maxlines, p)
+                        parser.parse_lines(open(p, 'rb'), args.maxlines, p)
                     elif os.path.isdir(p):
                         scan_git_subtree(repo.head.reference.commit.tree, p)
                     else:

For what it's worth: