BUG#23324748: Guarantee file closing of input files in optionfiles

nmariz · nmariz · commit 806cec361a7f · 2022-02-15T15:22:24.000Z
This patch adds a context manager to open files in the optionfiles
module to be closed correctly.

Thanks for the contribution.
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -20,6 +20,7 @@ v8.0.29
 - BUG#33729842: Character set 'utf8mb3' support
 - BUG#28877987: Return bytes or bytearray if decoding fails
 - BUG#23338623: Add support for Decimal parsing in protocol.py
+- BUG#23324748: Guarantee file closing of input files in optionfile
 - BUG#21528553: Fix API inconsistency when using consume_results=True
 - BUG#21498719: Fix conversion of Python bytearray (c-ext)
 - BUG#20065830: NaN is not supported
diff --git a/lib/mysql/connector/optionfiles.py b/lib/mysql/connector/optionfiles.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2014, 2021, Oracle and/or its affiliates.
+# Copyright (c) 2014, 2022, Oracle and/or its affiliates.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License, version 2.0, as
@@ -224,23 +224,24 @@ def read(self, filenames):  # pylint: disable=W0221
         for priority, filename in enumerate(filenames):
             try:
                 out_file = io.StringIO()
-                for line in codecs.open(filename, encoding='utf-8'):
-                    line = line.strip()
-                    # Skip lines that begin with "!includedir" or "!include"
-                    if line.startswith('!include'):
-                        continue
-
-                    match_obj = self.OPTCRE.match(line)
-                    if not self.SECTCRE.match(line) and match_obj:
-                        optname, delimiter, optval = match_obj.group('option',
-                                                                     'vi',
-                                                                     'value')
-                        if optname and not optval and not delimiter:
-                            out_file.write(line + "=\n")
+                with codecs.open(filename, encoding="utf-8") as in_file:
+                    for line in in_file:
+                        line = line.strip()
+                        # Skip lines that begin with "!includedir" or "!include"
+                        if line.startswith("!include"):
+                            continue
+
+                        match_obj = self.OPTCRE.match(line)
+                        if not self.SECTCRE.match(line) and match_obj:
+                            optname, delimiter, optval = match_obj.group(
+                                "option", "vi", "value"
+                            )
+                            if optname and not optval and not delimiter:
+                                out_file.write(f"{line}=\n")
+                            else:
+                                out_file.write(f"{line}\n")
                         else:
-                            out_file.write(line + '\n')
-                    else:
-                        out_file.write(line + '\n')
+                            out_file.write(f"{line}\n")
                 out_file.seek(0)
             except IOError:
                 continue
