Replace open+read/write with pathlib's read/write_text/bytes (#3263)

Author: happz

pyproject.toml

@@ -413,6 +413,8 @@ builtins-ignorelist = ["help", "format", "input", "filter", "copyright", "max"]
 "pathlib.PosixPath".msg = "Use tmt._compat.pathlib.Path instead."
 "warnings.deprecated".msg = "Use tmt._compat.warnings.deprecated instead."
 "os.path".msg = "Use tmt._compat.pathlib.Path and pathlib instead."
+# Banning builtins is not yet supported: https://github.com/astral-sh/ruff/issues/10079
+# "builtins.open".msg = "Use Path.{write_text,append_text,read_text,write_bytes,read_bytes} instead."
 
 [tool.ruff.lint.isort]
 known-first-party = ["tmt"]

tests/unit/test_export_to_nitrate.py

@@ -22,7 +22,7 @@ def test_export_to_nitrate_step(self):
         file_name = 'test.md'
         assert file_name in files
 
-        step = convert_manual_to_nitrate(file_name)[0]
+        step = convert_manual_to_nitrate(Path(file_name))[0]
         html_generated = """<b>Test</b>\
 <p>Step 1.</p><p>Verify tmt shows help page
 <code>bash
@@ -46,7 +46,7 @@ def test_export_to_nitrate_expect(self):
         file_name = 'test.md'
         assert file_name in files
 
-        expect = convert_manual_to_nitrate(file_name)[1]
+        expect = convert_manual_to_nitrate(Path(file_name))[1]
         html_generated = """<b>Test</b>\
 <p>Step 1.</p><p>Text similar to the one below is displayed
 ```
@@ -78,7 +78,7 @@ def test_export_to_nitrate_empty_file(self):
         files = os.listdir()
         file_name = 'test_empty.md'
         assert file_name in files
-        html = convert_manual_to_nitrate(file_name)
+        html = convert_manual_to_nitrate(Path(file_name))
         html_generated = ('', '', '', '')
         assert html == html_generated
 
@@ -87,7 +87,7 @@ def test_export_to_nitrate_setup_doesnt_exist(self):
         files = os.listdir()
         file_name = 'test.md'
         assert file_name in files
-        cleanup = convert_manual_to_nitrate(file_name)[2]
+        cleanup = convert_manual_to_nitrate(Path(file_name))[2]
         html_generated = ''
         assert cleanup == html_generated
 
@@ -97,7 +97,7 @@ def test_export_to_nitrate_cleanup_latest_heading(self):
         file_name = 'test.md'
         assert file_name in files
 
-        cleanup = convert_manual_to_nitrate(file_name)[3]
+        cleanup = convert_manual_to_nitrate(Path(file_name))[3]
         html_generated = """<p>Optionally remove temporary directory created \
 in the first step
 2 line of cleanup

tmt/_compat/pathlib.py

@@ -1,6 +1,7 @@
 import os
 import pathlib
-from typing import Union
+from collections.abc import Iterator
+from typing import Optional, Union
 
 
 class Path(pathlib.PosixPath):
@@ -43,3 +44,25 @@ def unrooted(self) -> "Path":
             return self.relative_to("/")
 
         return self
+
+    def append_text(
+            self,
+            data: str,
+            encoding: Optional[str] = None,
+            errors: Optional[str] = None,
+            newline: Optional[str] = None) -> int:
+        """ Open the file pointed to in text mode, append data to it, and close the file """
+
+        with self.open('a', encoding=encoding, errors=errors, newline=newline) as f:
+            return f.write(data)
+
+    def splitlines(
+            self,
+            encoding: Optional[str] = None,
+            errors: Optional[str] = None,
+            keepends: bool = False) -> Iterator[str]:
+        """ Yield decoded lines of the pointed-to file as a sequence of strings """
+
+        yield from self \
+            .read_text(encoding=encoding, errors=errors) \
+            .splitlines(keepends=keepends)

tmt/base.py

@@ -4326,8 +4326,8 @@ def resolve_dynamic_ref(
 
     # Read it, process it and get the value of the attribute 'ref'
     try:
-        with open(ref_filepath, encoding='utf-8') as datafile:
-            data = tmt.utils.yaml_to_dict(datafile.read())
+        data = tmt.utils.yaml_to_dict(ref_filepath.read_text(encoding='utf-8'))
+
     except OSError as error:
         raise tmt.utils.FileError(f"Failed to read '{ref_filepath}'.") from error
     # Build a dynamic reference tree, adjust ref based on the context

tmt/checks/avc.py

@@ -61,9 +61,7 @@ def _save_report(
         *report
         ]
 
-    mode = 'a' if append else 'w'
-
-    invocation.phase.write(report_filepath, '\n'.join(report), mode=mode)
+    invocation.phase.write(report_filepath, '\n'.join(report), mode='a' if append else 'w')
 
     return report_filepath
 

tmt/cli.py

@@ -2196,10 +2196,9 @@ def setup_completion(shell: str, install: bool, context: Context) -> None:
         Path(script).write_text(completions)
         # If requested, modify .bashrc or .zshrc
         if shell != 'fish':
-            config_path = Path(f'~/.{shell}rc').expanduser()
-            with open(config_path, 'a') as shell_config:
-                shell_config.write('\n# Generated by tmt\n')
-                shell_config.write(f'source {script}')
+            shell_config = Path(f'~/.{shell}rc').expanduser()
+            shell_config.append_text('\n# Generated by tmt\n')
+            shell_config.append_text(f'source {script}')
 
     else:
         logger.info(completions)

tmt/convert.py

@@ -157,10 +157,8 @@ def write_markdown(path: Path, content: dict[str, str]) -> None:
         to_print += "# Cleanup\n" + content['cleanup'] + '\n'
 
     try:
-        with open(path, 'w', encoding='utf-8') as md_file:
-            md_file.write(to_print)
-            echo(style(
-                f"Test case successfully stored into '{path}'.", fg='magenta'))
+        path.write_text(to_print, encoding='utf-8')
+        echo(style(f"Test case successfully stored into '{path}'.", fg='magenta'))
     except OSError:
         raise ConvertError(f"Unable to write '{path}'.")
 
@@ -269,22 +267,21 @@ def read_datafile(
             # As 'make' command was specified for test, ensure Makefile present.
             makefile_path = path / 'Makefile'
             try:
-                with open(makefile_path, encoding='utf-8') as makefile_file:
-                    makefile = makefile_file.read()
-                    search_result = \
-                        re.search(makefile_regex_test, makefile, re.MULTILINE)
+                search_result = re.search(
+                    makefile_regex_test,
+                    makefile_path.read_text(encoding='utf-8'),
+                    re.MULTILINE)
             except OSError:
                 raise ConvertError("Makefile is missing.")
             # Retrieve the path to the test file from the Makefile
             if search_result is not None:
                 test_path = path / search_result.group(1).split()[-1]
         # Read the test file and determine the framework used.
         if test_path:
-            with open(test_path, encoding="utf-8") as test_file:
-                if re.search("beakerlib", test_file.read(), re.MULTILINE):
-                    data["framework"] = "beakerlib"
-                else:
-                    data["framework"] = "shell"
+            if re.search("beakerlib", test_path.read_text(encoding="utf-8"), re.MULTILINE):
+                data["framework"] = "beakerlib"
+            else:
+                data["framework"] = "shell"
         else:
             data["framework"] = "shell"
         echo(style("framework: ", fg="green") + data["framework"])
@@ -452,8 +449,7 @@ def read(
         assert filename is not None  # type check
         datafile_path = path / filename
         try:
-            with open(datafile_path, encoding='utf-8') as datafile_file:
-                datafile = datafile_file.read()
+            datafile = datafile_path.read_text(encoding='utf-8')
         except OSError:
             raise ConvertError(f"Unable to open '{datafile_path}'.")
         echo(f"found in '{datafile_path}'.")
@@ -462,8 +458,7 @@ def read(
     testinfo_path = path / 'testinfo.desc'
     if testinfo_path.is_file():
         try:
-            with open(testinfo_path, encoding='utf-8') as testinfo_file:
-                old_testinfo = testinfo_file.read()
+            old_testinfo = testinfo_path.read_text(encoding='utf-8')
             testinfo_path.unlink()
         except OSError:
             raise ConvertError(
@@ -495,8 +490,7 @@ def read(
 
         # Read testinfo.desc
         try:
-            with open(testinfo_path, encoding='utf-8') as testinfo_file:
-                testinfo = testinfo_file.read()
+            testinfo = testinfo_path.read_text(encoding='utf-8')
         except OSError:
             raise ConvertError(f"Unable to open '{testinfo_path}'.")
 
@@ -561,8 +555,8 @@ def target_content_build() -> list[str]:
         # Restore the original testinfo.desc content (if existed)
         if old_testinfo:
             try:
-                with open(testinfo_path, 'w', encoding='utf-8') as testinfo_file:
-                    testinfo_file.write(old_testinfo)
+                testinfo_path.write_text(old_testinfo, encoding='utf-8')
+
             except OSError:
                 raise ConvertError(
                     f"Unable to write '{testinfo_path}'.")
@@ -578,8 +572,7 @@ def target_content_build() -> list[str]:
         echo(style('Purpose ', fg='blue'), nl=False)
         purpose_path = path / 'PURPOSE'
         try:
-            with open(purpose_path, encoding='utf-8') as purpose_file:
-                content = purpose_file.read()
+            content = purpose_path.read_text(encoding='utf-8')
             echo(f"found in '{purpose_path}'.")
             for header in ['PURPOSE', 'Description', 'Author']:
                 content = re.sub(f'^{header}.*\n', '', content)
@@ -1171,8 +1164,8 @@ def write(path: Path, data: NitrateDataType, quiet: bool = False) -> None:
 
     # Store metadata into a fmf file
     try:
-        with open(path, 'w', encoding='utf-8') as fmf_file:
-            fmf_file.write(tmt.utils.dict_to_yaml(sorted_data))
+        path.write_text(tmt.utils.dict_to_yaml(sorted_data), encoding='utf-8')
+
     except OSError:
         raise ConvertError(f"Unable to write '{path}'")
     if not quiet:

tmt/export/nitrate.py

@@ -285,10 +285,10 @@ def get_category(path: Path) -> str:
     """ Get category from Makefile """
     category = DEFAULT_NITRATE_CATEGORY
     try:
-        with open(path / 'Makefile', encoding='utf-8') as makefile_file:
-            makefile = makefile_file.read()
         category_search = re.search(
-            r'echo\s+"Type:\s*(.*)"', makefile, re.MULTILINE)
+            r'echo\s+"Type:\s*(.*)"',
+            (path / 'Makefile').read_text(encoding='utf-8'),
+            re.MULTILINE)
         if category_search:
             category = category_search.group(1)
     # Default to 'Sanity' if Makefile or Type not found

tmt/steps/execute/__init__.py

@@ -371,8 +371,7 @@ def handle_reboot(self) -> bool:
 
         elif self.soft_reboot_requested:
             # Extract custom hints from the file, and reset it.
-            with open(self.reboot_request_path) as reboot_file:
-                reboot_data = json.loads(reboot_file.read())
+            reboot_data = json.loads(self.reboot_request_path.read_text())
 
             if reboot_data.get('command'):
                 with suppress(TypeError):
@@ -629,12 +628,10 @@ def _load_custom_results_file(self, invocation: TestInvocation) -> ResultCollect
             filepaths=[custom_results_path_yaml, custom_results_path_json])
 
         if custom_results_path_yaml.exists():
-            with open(custom_results_path_yaml) as results_file:
-                collection.results = tmt.utils.yaml_to_list(results_file)
+            collection.results = tmt.utils.yaml_to_list(custom_results_path_yaml.read_text())
 
         elif custom_results_path_json.exists():
-            with open(custom_results_path_json) as results_file:
-                collection.results = tmt.utils.json_to_list(results_file)
+            collection.results = tmt.utils.json_to_list(custom_results_path_json.read_text())
 
         else:
             return collection

tmt/steps/provision/testcloud.py

@@ -764,8 +764,7 @@ def prepare_ssh_key(self, key_type: Optional[str] = None) -> None:
                 command += Command("-t", key_type)
             self._run_guest_command(command, silent=True)
             self.verbose('key', self.key[0], 'green')
-            with open(self.workdir / f'{key_name}.pub') as pubkey_file:
-                public_key = pubkey_file.read()
+            public_key = (self.workdir / f'{key_name}.pub').read_text()
 
         # Place public key content into the machine configuration
         self.config.USER_DATA = Template(USER_DATA).safe_substitute(