Add / improve PDF methods

Author: mdmintz

examples/cdp_mode/ReadMe.md

@@ -521,6 +521,7 @@ sb.cdp.scroll_up(amount=25)
 sb.cdp.scroll_down(amount=25)
 sb.cdp.save_screenshot(name, folder=None, selector=None)
 sb.cdp.print_to_pdf(name, folder=None)
+sb.cdp.save_as_pdf(name, folder=None)
 ```
 
 --------

help_docs/method_summary.md

@@ -247,6 +247,7 @@ self.switch_to_driver(driver)
 self.switch_to_default_driver()
 self.save_screenshot(name, folder=None, selector=None, by="css selector")
 self.save_screenshot_to_logs(name=None, selector=None, by="css selector")
+self.save_as_pdf_to_logs(name=None)
 self.save_data_to_logs(data, file_name=None)
 self.append_data_to_logs(data, file_name=None)
 self.save_page_source(name, folder=None)
@@ -342,6 +343,8 @@ 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.print_to_pdf(name, folder=None)
+# Duplicates:
+# self.save_as_pdf(name, folder=None)
 self.get_downloads_folder()
 self.get_browser_downloads_folder()
 self.get_downloaded_files(regex=None, browser=False)

sbase/steps.py

@@ -1191,6 +1191,15 @@ def set_attributes(context, selector, attribute, value):
     sb.set_attributes(selector, attribute, value)
 
 
+@step("Save as PDF to logs")
+@step("Save as PDF to the logs")
+@step("User saves page as PDF to logs")
+@step("User saves page as PDF to the logs")
+def save_as_pdf_to_logs(context):
+    sb = context.sb
+    sb.save_as_pdf_to_logs()
+
+
 @step("Save page source to logs")
 @step("Save the page source to the logs")
 @step("User saves page source to logs")

seleniumbase/behave/behave_helper.py

@@ -522,6 +522,8 @@ def generate_gherkin(srt_actions):
                 )
         elif action[0] == "ss_tl":
             sb_actions.append("Save screenshot to logs")
+        elif action[0] == "pdftl":
+            sb_actions.append("Save as PDF to logs")
         elif action[0] == "spstl":
             sb_actions.append("Save page source to logs")
         elif action[0] == "sh_fc":

seleniumbase/core/browser_launcher.py

@@ -865,6 +865,7 @@ def uc_open_with_cdp_mode(driver, url=None, **kwargs):
     cdp.scroll_down = CDPM.scroll_down
     cdp.save_screenshot = CDPM.save_screenshot
     cdp.print_to_pdf = CDPM.print_to_pdf
+    cdp.save_as_pdf = CDPM.save_as_pdf
     cdp.page = page  # async world
     cdp.driver = driver.cdp_base  # async world
     cdp.tab = cdp.page  # shortcut (original)

seleniumbase/core/recorder_helper.py

@@ -556,6 +556,9 @@ def generate_sbase_code(srt_actions):
         elif action[0] == "ss_tl":
             method = "save_screenshot_to_logs"
             sb_actions.append("self.%s()" % method)
+        elif action[0] == "pdftl":
+            method = "save_as_pdf_to_logs"
+            sb_actions.append("self.%s()" % method)
         elif action[0] == "spstl":
             method = "save_page_source_to_logs"
             sb_actions.append("self.%s()" % method)

seleniumbase/core/sb_cdp.py

@@ -2571,6 +2571,9 @@ def print_to_pdf(self, name, folder=None):
             filename = os.path.join(folder, name)
         self.loop.run_until_complete(self.page.print_to_pdf(filename))
 
+    def save_as_pdf(self, *args, **kwargs):
+        self.print_to_pdf(*args, **kwargs)
+
 
 class Chrome(CDPMethods):
     def __init__(self, url=None, **kwargs):

seleniumbase/fixtures/base_case.py

@@ -134,6 +134,7 @@ def __initialize_variables(self):
         self.__requests_timeout = None
         self.__page_source_count = 0
         self.__screenshot_count = 0
+        self.__saved_pdf_count = 0
         self.__logs_data_count = 0
         self.__last_data_file = None
         self.__level_0_visual_f = False
@@ -4492,7 +4493,8 @@ def save_screenshot_to_logs(
         If a provided selector is not found, then takes a full-page screenshot.
         (The last_page / failure screenshot is always "screenshot.png")
         The screenshot will be in PNG format."""
-        self.wait_for_ready_state_complete()
+        if not self.__is_cdp_swap_needed():
+            self.wait_for_ready_state_complete()
         test_logpath = os.path.join(self.log_path, self.__get_test_id())
         self.__create_log_path_as_needed(test_logpath)
         if name:
@@ -4510,6 +4512,11 @@ def save_screenshot_to_logs(
         if selector and by:
             selector, by = self.__recalculate_selector(selector, by)
             if page_actions.is_element_present(self.driver, selector, by):
+                if self.__is_cdp_swap_needed():
+                    selector = self.convert_to_css_selector(selector, by=by)
+                    return self.cdp.save_screenshot(
+                        name, folder=test_logpath, selector=selector
+                    )
                 return page_actions.save_screenshot(
                     self.driver, name, test_logpath, selector, by
                 )
@@ -4523,8 +4530,49 @@ def save_screenshot_to_logs(
                         action = ["ss_tl", "", origin, time_stamp]
                         self.__extra_actions.append(action)
         sb_config._has_logs = True
+        if self.__is_cdp_swap_needed():
+            return self.cdp.save_screenshot(name, folder=test_logpath)
         return page_actions.save_screenshot(self.driver, name, test_logpath)
 
+    def save_as_pdf(self, name, folder=None):
+        """Same as self.print_to_pdf()"""
+        return self.print_to_pdf(name, folder=folder)
+
+    def save_as_pdf_to_logs(self, name=None):
+        """Saves the page as a PDF to the "latest_logs/" folder.
+        Naming is automatic:
+            If NO NAME provided: "_1_PDF.pdf", "_2_PDF.pdf", etc.
+            If NAME IS provided, then: "_1_name.pdf", "_2_name.pdf", etc."""
+        if not self.__is_cdp_swap_needed():
+            self.wait_for_ready_state_complete()
+        test_logpath = os.path.join(self.log_path, self.__get_test_id())
+        self.__create_log_path_as_needed(test_logpath)
+        if name:
+            name = str(name)
+        self.__saved_pdf_count += 1
+        if not name or len(name) == 0:
+            name = "_%s_PDF.pdf" % self.__saved_pdf_count
+        else:
+            pre_name = "_%s_" % self.__saved_pdf_count
+            if len(name) >= 4 and name[-4:].lower() == ".pdf":
+                name = name[:-4]
+                if len(name) == 0:
+                    name = "PDF"
+            name = "%s%s.pdf" % (pre_name, name)
+        if self.recorder_mode:
+            url = self.get_current_url()
+            if url and len(url) > 0:
+                if ("http:") in url or ("https:") in url or ("file:") in url:
+                    if self.get_session_storage_item("pause_recorder") == "no":
+                        time_stamp = self.execute_script("return Date.now();")
+                        origin = self.get_origin()
+                        action = ["pdftl", "", origin, time_stamp]
+                        self.__extra_actions.append(action)
+        sb_config._has_logs = True
+        if self.__is_cdp_swap_needed():
+            return self.cdp.print_to_pdf(name, folder=test_logpath)
+        return self.print_to_pdf(name, test_logpath)
+
     def save_page_source_to_logs(self, name=None):
         """Saves the page HTML to the "latest_logs/" folder.
         Naming is automatic:
@@ -5517,6 +5565,7 @@ def __process_recorded_actions(self):
         ext_actions.append("s_scr")
         ext_actions.append("ss_tf")
         ext_actions.append("ss_tl")
+        ext_actions.append("pdftl")
         ext_actions.append("spstl")
         ext_actions.append("da_el")
         ext_actions.append("da_ep")