Add save_page_source_to_logs()

mdmintz · mdmintz · commit b38619628e3e · 2025-07-08T15:06:51.000-04:00
diff --git a/help_docs/method_summary.md b/help_docs/method_summary.md
@@ -250,6 +250,7 @@ self.save_screenshot_to_logs(name=None, selector=None, by="css selector")
 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)
+self.save_page_source_to_logs(name=None)
 self.save_cookies(name="cookies.txt")
 self.load_cookies(name="cookies.txt", expiry=False)
 self.delete_all_cookies()
diff --git a/sbase/steps.py b/sbase/steps.py
@@ -1191,6 +1191,15 @@ def set_attributes(context, selector, attribute, value):
     sb.set_attributes(selector, attribute, value)
 
 
+@step("Save page source to logs")
+@step("Save the page source to the logs")
+@step("User saves page source to logs")
+@step("User saves the page source to the logs")
+def save_page_source_to_logs(context):
+    sb = context.sb
+    sb.save_page_source_to_logs()
+
+
 @step("Activate CDP Mode")
 @step("User activates CDP Mode")
 def activate_cdp_mode(context):
diff --git a/seleniumbase/behave/behave_helper.py b/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] == "spstl":
+            sb_actions.append("Save page source to logs")
         elif action[0] == "sh_fc":
             sb_actions.append("Show file choosers")
         elif action[0] == "pr_da":
diff --git a/seleniumbase/core/recorder_helper.py b/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] == "spstl":
+            method = "save_page_source_to_logs"
+            sb_actions.append("self.%s()" % method)
         elif action[0] == "sh_fc":
             method = "show_file_choosers"
             sb_actions.append("self.%s()" % method)
diff --git a/seleniumbase/fixtures/base_case.py b/seleniumbase/fixtures/base_case.py
@@ -132,6 +132,7 @@ def __initialize_variables(self):
         self.__called_teardown = False
         self.__start_time_ms = int(time.time() * 1000.0)
         self.__requests_timeout = None
+        self.__page_source_count = 0
         self.__screenshot_count = 0
         self.__logs_data_count = 0
         self.__last_data_file = None
@@ -4512,6 +4513,40 @@ def save_screenshot_to_logs(
         sb_config._has_logs = True
         return page_actions.save_screenshot(self.driver, name, test_logpath)
 
+    def save_page_source_to_logs(self, name=None):
+        """Saves the page HTML to the "latest_logs/" folder.
+        Naming is automatic:
+            If NO NAME provided: "_1_source.html", "_2_source.html", etc.
+            If NAME IS provided, then: "_1_name.html", "_2_name.html", etc.
+        (The last_page / failure page_source is always "page_source.html")"""
+        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.__page_source_count += 1
+        if not name or len(name) == 0:
+            name = "_%s_source.html" % self.__page_source_count
+        else:
+            pre_name = "_%s_" % self.__page_source_count
+            if len(name) >= 4 and name[-4:].lower() == ".html":
+                name = name[:-4]
+                if len(name) == 0:
+                    name = "source"
+            name = "%s%s.html" % (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 = ["spstl", "", origin, time_stamp]
+                        self.__extra_actions.append(action)
+        sb_config._has_logs = True
+        return page_actions.save_page_source(self.driver, name, test_logpath)
+
     def save_data_to_logs(self, data, file_name=None):
         """Saves data to the "latest_logs/" data folder of the current test.
         If no file_name, file_name becomes: "data_1.txt", "data_2.txt", etc.
@@ -5470,6 +5505,7 @@ def __process_recorded_actions(self):
         ext_actions.append("s_scr")
         ext_actions.append("ss_tf")
         ext_actions.append("ss_tl")
+        ext_actions.append("spstl")
         ext_actions.append("da_el")
         ext_actions.append("da_ep")
         ext_actions.append("da_te")

Original file line number	Diff line number	Diff line change
`@@ -522,6 +522,8 @@ def generate_gherkin(srt_actions):`
`522`	`522`	`)`
`523`	`523`	`elif action[0] == "ss_tl":`
`524`	`524`	`sb_actions.append("Save screenshot to logs")`
	`525`	`+ elif action[0] == "spstl":`
	`526`	`+ sb_actions.append("Save page source to logs")`
`525`	`527`	`elif action[0] == "sh_fc":`
`526`	`528`	`sb_actions.append("Show file choosers")`
`527`	`529`	`elif action[0] == "pr_da":`