From 3b31a65a76de7f29f32c27201b35f5f3c17d14e5 Mon Sep 17 00:00:00 2001
From: Friedemann Kleint <Friedemann.Kleint@qt.io>
Date: Tue, 13 Sep 2022 09:08:21 +0200
Subject: Documentation/patch_qhp.py: Brush up script

- Fix flake8 warnings
- Warn about errors
- Move line processing into a function for further extension
- Make file a positional argument

Pick-to: 6.3
Change-Id: Ice191b8b78ff3a151581066ae0fc493ecb54fb64
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
---
 sources/shiboken6/doc/scripts/patch_qhp.py | 65 ++++++++++++++++++------------
 1 file changed, 39 insertions(+), 26 deletions(-)

(limited to 'sources/shiboken6/doc/scripts/patch_qhp.py')

diff --git a/sources/shiboken6/doc/scripts/patch_qhp.py b/sources/shiboken6/doc/scripts/patch_qhp.py
index c0786d9ab..1f86162a9 100644
--- a/sources/shiboken6/doc/scripts/patch_qhp.py
+++ b/sources/shiboken6/doc/scripts/patch_qhp.py
@@ -3,31 +3,44 @@
 
 import fileinput
 import re
+import sys
 from argparse import ArgumentParser, RawTextHelpFormatter
 
-options = ArgumentParser(description='Qhp file updater',
-                         formatter_class=RawTextHelpFormatter)
-options.add_argument('-f',
-                     '--filename',
-                     type=str,
-                     help='Qhp filename with the relative path.',
-                     required=True)
-options.add_argument('-v',
-                     '--vfolder',
-                     type=str,
-                     help='String to be injected into the Qhp file.')
-args=options.parse_args()
-
-try:
-    for line in fileinput.input(args.filename,inplace=True,backup='.bak'):
-        line_copy=line.strip()
-        if not line_copy: # check for empty line
-            continue
-        match=re.match('(^.*virtualFolder.)doc(.*$)',line)
-        if match:
-            repl=''.join([match.group(1), args.vfolder, match.group(2)])
-            print(line.replace(match.group(0),repl),end=' ')
-        else:
-            print(line.rstrip())
-except:
-    pass
+
+DESC="""Qhp file updater
+
+Replaces virtual folder ids in .qhp files preparing for
+registering the documentation in Qt Assistant."""
+
+
+VIRTUAL_FOLDER_PATTERN = re.compile("(^.*virtualFolder.)doc(.*$)")
+
+
+virtual_folder = ""
+
+
+def process_line(line):
+    global virtual_folder
+    match = VIRTUAL_FOLDER_PATTERN.match(line)
+    if match:
+        print(f"{match.group(1)}{virtual_folder}{match.group(2)}")
+        return
+    sys.stdout.write(line)
+
+
+if __name__ == '__main__':
+    arg_parser = ArgumentParser(description=DESC,
+                                formatter_class=RawTextHelpFormatter)
+    arg_parser.add_argument('-v', '--vfolder', type=str,
+                            help='String to be injected into the Qhp file.')
+    arg_parser.add_argument("file", type=str,  help='Qhp filename.')
+    options = arg_parser.parse_args()
+    virtual_folder = options.vfolder
+
+    try:
+        with fileinput.input(options.file, inplace=True,
+                             backup=".bak") as fh:
+            for line in fh:
+                process_line(line)
+    except Exception as e:
+        print(f"WARNING: patch_qhp.py failed: {e}", file=sys.stderr)
-- 
cgit v1.2.3