Merge pull request #1790 from seleniumbase/more-methods-for-saving-and-reading-file-data

More methods for saving and reading file data

Author: mdmintz

help_docs/method_summary.md

@@ -434,6 +434,10 @@ self.save_file_as(file_url, new_file_name, destination_folder=None)
 
 self.save_data_as(data, file_name, destination_folder=None)
 
+self.append_data_to_file(data, file_name, destination_folder=None)
+
+self.get_file_data(file_name, folder=None)
+
 self.get_downloads_folder()
 
 self.get_browser_downloads_folder()

mkdocs_build/requirements.txt

@@ -13,7 +13,7 @@ Jinja2==3.1.2
 click==8.1.3
 ghp-import==2.1.0
 readme-renderer==37.3
-pymdown-extensions==9.9.2
+pymdown-extensions==9.10
 importlib-metadata==6.0.0
 pipdeptree==2.5.2
 bleach==6.0.0
@@ -27,7 +27,7 @@ cssselect2==0.7.0
 tinycss2==1.2.1
 defusedxml==0.7.1
 mkdocs==1.4.2
-mkdocs-material==9.1.0
+mkdocs-material==9.1.1
 mkdocs-exclude-search==0.6.5
 mkdocs-simple-hooks==0.1.5
 mkdocs-material-extensions==1.1.1

requirements.txt

@@ -30,7 +30,7 @@ idna==3.4
 chardet==4.0.0;python_version<"3.7"
 chardet==5.1.0;python_version>="3.7"
 charset-normalizer==2.0.12;python_version<"3.7"
-charset-normalizer==3.0.1;python_version>="3.7"
+charset-normalizer==3.1.0;python_version>="3.7"
 urllib3==1.26.12;python_version<"3.7"
 urllib3==1.26.14;python_version>="3.7"
 requests==2.27.1;python_version<"3.7"

seleniumbase/__version__.py

@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "4.13.7"
+__version__ = "4.13.8"

seleniumbase/behave/behave_sb.py

@@ -813,8 +813,8 @@ def get_configured_sb(context):
             '(Linux uses "-D headless" by default. '
             'To override, use "-D headed" / "-D gui". '
             'For Xvfb mode instead, use "-D xvfb". '
-            'Or hide this info with "-D headless",'
-            'or by calling the new "-D headless2".)'
+            "Or you can hide this info by using"
+            '"-D headless" / "-D headless2".)'
         )
         sb.headless = True
     # Recorder Mode can still optimize scripts in --headless2 mode.

seleniumbase/fixtures/base_case.py

@@ -6453,13 +6453,32 @@ def save_file_as(self, file_url, new_file_name, destination_folder=None):
         )
 
     def save_data_as(self, data, file_name, destination_folder=None):
-        """Saves the data specified to a file of the name specified.
+        """Saves the data specified to the file specified.
         If no destination folder is specified, the default one is used.
-        (The default [Downloads Folder] = "./downloaded_files")"""
+        (The default folder = "./downloaded_files")
+        Use "." as the destination folder for the current directory."""
         if not destination_folder:
             destination_folder = constants.Files.DOWNLOADS_FOLDER
         page_utils._save_data_as(data, destination_folder, file_name)
 
+    def append_data_to_file(self, data, file_name, destination_folder=None):
+        """Appends the data specified to the file specified.
+        If no destination folder is specified, the default one is used.
+        (The default folder = "./downloaded_files")
+        Use "." as the folder for the current directory."""
+        if not destination_folder:
+            destination_folder = constants.Files.DOWNLOADS_FOLDER
+        page_utils._append_data_to_file(data, destination_folder, file_name)
+
+    def get_file_data(self, file_name, folder=None):
+        """Gets the data from the file specified.
+        If no folder is specified, the default one is used.
+        (The default folder = "./downloaded_files")
+        Use "." as the folder for the current directory."""
+        if not folder:
+            folder = constants.Files.DOWNLOADS_FOLDER
+        return page_utils._get_file_data(folder, file_name)
+
     def get_downloads_folder(self):
         """Returns the path of the SeleniumBase "downloaded_files/" folder.
         Calling self.download_file(file_url) will put that file in here.

seleniumbase/fixtures/page_utils.py

@@ -253,11 +253,45 @@ def _download_file_to(file_url, destination_folder, new_file_name=None):
 
 
 def _save_data_as(data, destination_folder, file_name):
-    out_file = codecs.open(
-        destination_folder + "/" + file_name, "w+", encoding="utf-8"
+    download_file_lock = fasteners.InterProcessLock(
+        constants.MultiBrowser.DOWNLOAD_FILE_LOCK
+    )
+    with download_file_lock:
+        out_file = codecs.open(
+            os.path.join(destination_folder, file_name), "w+", encoding="utf-8"
+        )
+        out_file.writelines(data)
+        out_file.close()
+
+
+def _append_data_to_file(data, destination_folder, file_name):
+    download_file_lock = fasteners.InterProcessLock(
+        constants.MultiBrowser.DOWNLOAD_FILE_LOCK
     )
-    out_file.writelines(data)
-    out_file.close()
+    with download_file_lock:
+        existing_data = ""
+        if os.path.exists(os.path.join(destination_folder, file_name)):
+            with open(os.path.join(destination_folder, file_name), "r") as f:
+                existing_data = f.read()
+            if not existing_data.split("\n")[-1] == "":
+                existing_data += "\n"
+        out_file = codecs.open(
+            os.path.join(destination_folder, file_name), "w+", encoding="utf-8"
+        )
+        out_file.writelines("%s%s" % (existing_data, data))
+        out_file.close()
+
+
+def _get_file_data(folder, file_name):
+    download_file_lock = fasteners.InterProcessLock(
+        constants.MultiBrowser.DOWNLOAD_FILE_LOCK
+    )
+    with download_file_lock:
+        if not os.path.exists(os.path.join(folder, file_name)):
+            raise Exception("File not found!")
+        with open(os.path.join(folder, file_name), "r") as f:
+            data = f.read()
+        return data
 
 
 def make_css_match_first_element_only(selector):

seleniumbase/plugins/pytest_plugin.py

@@ -1587,8 +1587,8 @@ def pytest_configure(config):
             "(Linux uses --headless by default. "
             "To override, use --headed / --gui. "
             "For Xvfb mode instead, use --xvfb. "
-            "Or hide this info with --headless, "
-            "or by calling the new --headless2.)"
+            "Or you can hide this info by using "
+            "--headless / --headless2.)"
         )
         sb_config.headless = True
 

seleniumbase/plugins/selenium_plugin.py

@@ -1138,8 +1138,8 @@ def beforeTest(self, test):
                 "(Linux uses --headless by default. "
                 "To override, use --headed / --gui. "
                 "For Xvfb mode instead, use --xvfb. "
-                "Or hide this info with --headless, "
-                "or by calling the new --headless2.)"
+                "Or you can hide this info by using "
+                "--headless / --headless2.)"
             )
             self.options.headless = True
             test.test.headless = True

setup.py

@@ -154,7 +154,7 @@
         'chardet==4.0.0;python_version<"3.7"',
         'chardet==5.1.0;python_version>="3.7"',  # Stay in sync with "requests"
         'charset-normalizer==2.0.12;python_version<"3.7"',
-        'charset-normalizer==3.0.1;python_version>="3.7"',  # Sync "requests"
+        'charset-normalizer==3.1.0;python_version>="3.7"',  # Sync "requests"
         'urllib3==1.26.12;python_version<"3.7"',
         'urllib3==1.26.14;python_version>="3.7"',
         'requests==2.27.1;python_version<"3.7"',