Fix invalid escape sequences in gpMgmt Python sources

Python 3.12 promoted "invalid escape sequence" from a DeprecationWarning
(hidden by default) to a SyntaxWarning that is printed whenever the
module is compiled. On distributions shipping Python 3.12 or newer --
Rocky Linux 10, Fedora 40+, Ubuntu 24.10+ -- the management utilities
therefore print warnings before doing any work:

  /usr/local/cloudberry-db/lib/python/gppylib/util/ssh_utils.py:268:
    SyntaxWarning: invalid escape sequence '\ '
  /usr/local/cloudberry-db/bin/lib/pexpect/pxssh.py:105:
    SyntaxWarning: invalid escape sequence '\['
  /usr/local/cloudberry-db/bin/lib/pexpect/pxssh.py:109:
    SyntaxWarning: invalid escape sequence '\$'
  /usr/local/cloudberry-db/bin/lib/pexpect/pxssh.py:110:
    SyntaxWarning: invalid escape sequence '\$'

The four above come from gpsync/gpssh/gpssh-exkeys and are the ones
users see; compiling everything under gpMgmt/ turns up 41 such literals
in 16 files.  Nothing misbehaves today -- CPython leaves an unrecognised
escape in the string as-is, which happens to be what a regex or a shell
snippet wants -- but the warnings are noise on stderr, and the Python
docs say these sequences will become a SyntaxError in a future release.

Fix the literals rather than silencing the warning:

  * a literal whose every backslash escape is invalid gets an r prefix
  * a literal that mixes valid and invalid escapes has the invalid
    backslash doubled instead, since r would also change the meaning
    of the valid ones

Both transformations leave the literal's runtime value byte-for-byte
identical, which was verified mechanically: for each touched file the
ordered list of str/bytes constants in the AST is unchanged against the
parent commit, and compiling the file under -W error::SyntaxWarning is
now clean.

Two of the rewrites are worth a reviewer's eye:

  * gpstate_utils.py:79 and replication_slots_utils.py:31 are the
    mixed-escape case, so they read '\\%' and '\\A' now.
  * the '\A' in replication_slots_utils.py looks like a stray keystroke
    in a run of shell line continuations -- the shell it is handed sees
    "&& A ./demo_cluster.sh" and tries to run A.  That is pre-existing
    behaviour, so this commit preserves it exactly rather than quietly
    changing what the behave step does; it wants a separate fix.

gpMgmt/bin/lib/pexpect is a vendored copy of pexpect 3.3; upstream
pexpect made these same literals raw long ago.

27 more files under src/ and contrib/ (mostly gporca and try_convert
developer scripts) have the same problem and are left for a follow-up.

Author: tuhaihe

gpMgmt/bin/gpload.py

@@ -717,7 +717,7 @@ def quote_unident(val):
 
 def match_notice_obj(notice):
     # match the formatting errors in notice
-    r = re.compile("^NOTICE:  found (\d+) data formatting errors.*")
+    r = re.compile(r"^NOTICE:  found (\d+) data formatting errors.*")
     m = r.match(notice)
     if m:
         return int(m.group(1))
@@ -2527,7 +2527,7 @@ def create_staging_table(self):
         # should not explicitly specify the DISTRIBUTED BY clause.
         # Only the DISTRIBUTED BY clause can take effect if all selected fields 
         # exist in the CREATE TABLE statement.
-        dist_column_list = re.match(".*\((.*)\).*", distcols).group(1).split(",")
+        dist_column_list = re.match(r".*\((.*)\).*", distcols).group(1).split(",")
         target_column_set = set(element[0] for element in target_columns)
         if set(dist_column_list) <= target_column_set:
             quoted_dist_column = convertListToDelimited(dist_column_list)
@@ -2672,7 +2672,7 @@ def do_update(self,fromname,index):
             #
             update_condition = ' ' + update_condition + ' '
             for name, colType, mapto, seq in self.into_columns:
-                regexp = '(?<=[^\w])%s(?=[^\w])' % name
+                regexp = r'(?<=[^\w])%s(?=[^\w])' % name
                 self.log(self.DEBUG, 'update_condition re: ' + regexp)
                 temp_update_condition = update_condition
                 updateConditionList = splitIntoLiteralsAndNonLiterals(update_condition)
@@ -2686,7 +2686,7 @@ def do_update(self,fromname,index):
                 if update_condition == temp_update_condition:
                    # see if column can be undelimited, and try again.
                    if len(name) > 2 and name[1:-1] == name[1:-1].lower():
-                      regexp = '(?<=[^\w])%s(?=[^\w])' % name[1:-1]
+                      regexp = r'(?<=[^\w])%s(?=[^\w])' % name[1:-1]
                       self.log(self.DEBUG, 'update_condition undelimited re: ' + regexp)
                       update_condition = re.sub( regexp
                                                , self.fix_update_cond

gpMgmt/bin/gpload_test/gpload/TEST.py

@@ -319,20 +319,20 @@ def modify_sql_file(num):
     if os.path.isfile(file):
         for line in fileinput.FileInput(file,inplace=1):
             if platform.system() in ['Windows', 'Microsoft']:
-                line = line.replace("\!gpload ","\!gpload.py")
+                line = line.replace(r"\!gpload ",r"\!gpload.py")
                 line = line.replace("gpload ","gpload.py ")
             else:
                 line = line.replace("gpload.py ","gpload ")
             # using absolute path
             line = re.sub('-h WinnBook.local', '-h '+get_hostname(), line)
             line = line.replace("-h localhost",'-h '+get_hostname())
-            line = re.sub('-p \d+', '-p '+get_port(), line)
+            line = re.sub(r'-p \d+', '-p '+get_port(), line)
             line = re.sub('-p$', '-p '+get_port(), line)
-            line = re.sub('-h (\d+)\.(\d+)\.(\d+)\.(\d+)', '-h '+get_hostname(), line)
+            line = re.sub(r'-h (\d+)\.(\d+)\.(\d+)\.(\d+)', '-h '+get_hostname(), line)
             if num == 12 or num == 13 or num == 14 or num == 15 or num == 176:
-                line = re.sub('-U \w+', '-U fake_user', line)
+                line = re.sub(r'-U \w+', '-U fake_user', line)
             else:
-                line = re.sub('-U \w+', '-U '+user, line)
+                line = re.sub(r'-U \w+', '-U '+user, line)
             print((str(re.sub('\n','',line))))
 
 def windows_path(command):
@@ -350,9 +350,9 @@ def get_port():
     if os.path.isfile(file):
         f = open(file)
         for line in f:
-            match = re.search('port=\d+',line)
+            match = re.search(r'port=\d+',line)
             if match:
-                match1 = re.search('\d+', match.group())
+                match1 = re.search(r'\d+', match.group())
                 if match1:
                     return match1.group()
         f.close()
@@ -407,7 +407,7 @@ def testQuery00(self):
         "0  gpload setup"
         for num in range(1,6):
            f = open(mkpath('query%d.sql' % num),'w')
-           f.write("\! gpload -f "+mkpath('config/config_file')+ " -d gptest")
+           f.write(r"\! gpload -f "+mkpath('config/config_file')+ " -d gptest")
            f.close()
 
     def testQuery01(self):

gpMgmt/bin/gppylib/programs/test/unit/test_cluster_clsrecoversegment_triples.py

@@ -294,14 +294,14 @@ def test_RecoveryTripletsInPlaceAndNewHosts_getMirrorTriples_should_fail(self):
                 "gparray": self.three_failedover_segs_gparray_str,
                 "new_hosts": ['new_1', 'new_2'],
                 "unreachable_hosts": ['new_1', 'new_2'],
-                "expected": "Cannot recover. The following recovery target hosts are unreachable: \['new_1', 'new_2'\]"
+                "expected": r"Cannot recover. The following recovery target hosts are unreachable: \['new_1', 'new_2'\]"
             },
             {
                 "name": "some_hosts_unreachable",
                 "gparray": self.three_failedover_segs_gparray_str,
                 "new_hosts": ['new_1', 'new_2'],
                 "unreachable_hosts": ['new_2'],
-                "expected": "Cannot recover. The following recovery target hosts are unreachable: \['new_2'\]"
+                "expected": r"Cannot recover. The following recovery target hosts are unreachable: \['new_2'\]"
             },
             {
                 "name": "no_peer_for_failed_seg",
@@ -329,7 +329,7 @@ def test_RecoveryTripletsInPlaceAndNewHosts_getMirrorTriples_should_fail(self):
                 "gparray": self.three_failedover_segs_gparray_str,
                 "new_hosts": ['new_1','new_2'],
                 "unreachable_existing_hosts": ['sdw2'],
-                "expected": "The recovery source segment sdw2 \(content 0\) is unreachable"
+                "expected": r"The recovery source segment sdw2 \(content 0\) is unreachable"
             },
             {
             "name": "failed_and_live_same_dbid",

gpMgmt/bin/gppylib/test/unit/test_unit_database_segment_guc.py

@@ -23,6 +23,6 @@ def test_report_fail_format_database(self):
 
     def test_init_with_insufficient_database_values_raises(self):
         row = ['contentid', 'guc_name']
-        with self.assertRaisesRegex(Exception, "must provide \['context', 'guc name', 'value'\]"):
+        with self.assertRaisesRegex(Exception, r"must provide \['context', 'guc name', 'value'\]"):
             DatabaseSegmentGuc(row)
 

gpMgmt/bin/gppylib/test/unit/test_unit_file_segment_guc.py

@@ -28,7 +28,7 @@ def test_report_fail_format_file_when_unset(self):
 
     def test_init_with_insufficient_file_values_raises(self):
         row = ['contentid', 'guc_name', 'value_from_file']
-        with self.assertRaisesRegex(Exception, "must provide \['context', 'guc name', 'value', 'dbid'\]"):
+        with self.assertRaisesRegex(Exception, r"must provide \['context', 'guc name', 'value', 'dbid'\]"):
             FileSegmentGuc(row)
 
     def test_when_coordinator_when_integer_dbid_report_success_format_file(self):

gpMgmt/bin/gppylib/test/unit/test_unit_gppkg.py

@@ -69,7 +69,7 @@ def test__input_matches_multiple_packages(self):
         options, args = parser.parse_args()
         self.subject = GpPkgProgram(options, args)
         with self.assertRaisesRegex(Exception, "Remove request 'sampl' too broad. "
-                                                "Multiple packages match remove request: \( sample.gppkg, sample2.gppkg \)."):
+                                                r"Multiple packages match remove request: \( sample.gppkg, sample2.gppkg \)."):
             self.subject.run()
 
         self.assertFalse(self.mock_uninstall_package.run.called)

gpMgmt/bin/gppylib/test/unit/test_unit_gpsegrecovery.py

@@ -301,7 +301,7 @@ def test_complete_workflow(self, mock_pgbasebackup_run, mock_pgbasebackup_init,
         self.assertEqual(1, mock_pgrewind_init.call_count)
         self.assertEqual(1, mock_pgbasebackup_run.call_count)
         self.assertEqual(1, mock_pgbasebackup_init.call_count)
-        self.assertRegex(gplog.get_logfile(), '/gpsegrecovery.py_\d+\.log')
+        self.assertRegex(gplog.get_logfile(), r'/gpsegrecovery.py_\d+\.log')
 
     @patch('gppylib.commands.pg.PgRewind.__init__', return_value=None)
     @patch('gppylib.commands.pg.PgRewind.run')
@@ -330,7 +330,7 @@ def test_complete_workflow_exception(self, mock_pgbasebackup_run, mock_pgbasebac
         self.assertEqual(1, mock_pgrewind_init.call_count)
         self.assertEqual(2, mock_pgbasebackup_run.call_count)
         self.assertEqual(2, mock_pgbasebackup_init.call_count)
-        self.assertRegex(gplog.get_logfile(), '/gpsegrecovery.py_\d+\.log')
+        self.assertRegex(gplog.get_logfile(), r'/gpsegrecovery.py_\d+\.log')
 
     @patch('recovery_base.gplog.setup_tool_logging')
     @patch('recovery_base.RecoveryBase.main')

gpMgmt/bin/gppylib/test/unit/test_unit_gpsegsetuprecovery.py

@@ -259,7 +259,7 @@ def test_complete_workflow(self, mock_execsql, mock_dburl, mock_connect, mock_va
         mock_connect.assert_called_once()
         mock_execsql.assert_called_once()
         #TODO use regex pattern
-        self.assertRegex(gplog.get_logfile(), '/gpsegsetuprecovery.py_\d+\.log')
+        self.assertRegex(gplog.get_logfile(), r'/gpsegsetuprecovery.py_\d+\.log')
 
     @patch('gpsegsetuprecovery.ValidationForFullRecovery.validate_failover_data_directory')
     @patch('gpsegsetuprecovery.dbconn.connect')
@@ -284,7 +284,7 @@ def test_complete_workflow_exception(self, mock_execsql, mock_dburl, mock_connec
         mock_validate_datadir.assert_called_once()
         mock_dburl.assert_called_once()
         mock_connect.assert_called_once()
-        self.assertRegex(gplog.get_logfile(), '/gpsegsetuprecovery.py_\d+\.log')
+        self.assertRegex(gplog.get_logfile(), r'/gpsegsetuprecovery.py_\d+\.log')
 
 
     @patch('recovery_base.gplog.setup_tool_logging')

gpMgmt/bin/gppylib/test/unit/test_unit_package.py

@@ -119,7 +119,7 @@ def test__execute_target_gphome_mismatch_raises(self):
         self.args['to_gphome'] = '/wrong/gphome'
         subject = MigratePackages(**self.args)
 
-        expected_raise = "The target GPHOME, %s, must match the current \$GPHOME used to launch gppkg." % self.args['to_gphome']
+        expected_raise = r"The target GPHOME, %s, must match the current \$GPHOME used to launch gppkg." % self.args['to_gphome']
         with self.assertRaisesRegex(ExceptionNoStackTraceNeeded, expected_raise):
             subject.execute()
 

gpMgmt/bin/gppylib/util/ssh_utils.py

@@ -265,7 +265,7 @@ def emptyline(self):
         pass
 
     def escapeLine(self, line):
-        '''Escape occurrences of \ and $ as needed and package the line as an "eval" shell command'''
+        r'''Escape occurrences of \ and $ as needed and package the line as an "eval" shell command'''
         line = line.strip()
         if line == 'EOF' or line == 'exit' or line == 'quit':
             raise self.SessionCmdExit()