From 657ae189564245e56e5d796d56bf8f65bdec36b3 Mon Sep 17 00:00:00 2001
From: Isaac Muse <faceless.shop@gmail.com>
Date: Mon, 30 Sep 2024 14:10:26 -0600
Subject: [PATCH] Fix re replace issue (#468)

* Fix re replace issue

Fixes #467

* Re-generate docs

* Bump version
---
 docs/src/markdown/about/changelog.md          |   4 +
 docs/src/markdown/preferences.md              |   4 +-
 docs/src/markdown/usage.md                    |   2 +-
 rummage/lib/__meta__.py                       |   2 +-
 rummage/lib/gui/controls/custom_statusbar.py  |   2 +-
 rummage/lib/gui/controls/dynamic_lists.py     |   2 +-
 rummage/lib/gui/controls/result_lists.py      |   2 +-
 rummage/lib/gui/data/docs/.dochash            |   2 +-
 .../lib/gui/data/docs/about/changelog.html    |   4 +
 rummage/lib/gui/data/docs/preferences.html    |   4 +-
 rummage/lib/gui/data/docs/usage.html          |   2 +-
 rummage/lib/gui/dialogs/rummage_dialog.py     |   2 +-
 rummage/lib/gui/util/colors.py                |   2 +-
 rummage/lib/rumcore/__init__.py               |  12 +-
 tests/test_rumcore.py                         | 131 ++++++++++++++++++
 15 files changed, 154 insertions(+), 23 deletions(-)

diff --git a/docs/src/markdown/about/changelog.md b/docs/src/markdown/about/changelog.md
index db5cc6d7..d9833ab7 100644
--- a/docs/src/markdown/about/changelog.md
+++ b/docs/src/markdown/about/changelog.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 4.21.1
+
+-   **FIX**: Fix issue with `re` replace in Python 3.12 and Python 3.13.
+
 ## 4.21
 
 -   **NEW**: Officially support Python 3.12 and Python 3.13, requires latest wxPython (4.2.2).
diff --git a/docs/src/markdown/preferences.md b/docs/src/markdown/preferences.md
index 0f698fb9..6dc0e76b 100644
--- a/docs/src/markdown/preferences.md
+++ b/docs/src/markdown/preferences.md
@@ -15,8 +15,8 @@ The **General** tab contains a couple of useful settings.
 Single Instance
 
 -   By default, Rummage will allow for multiple windows to be open.  If this option is enabled, the first window will be
-    be the only window to open.  All subsequent instances will pass their arguments to the first and close without
-    showing a window.
+    the only window to open.  All subsequent instances will pass their arguments to the first and close without showing
+    a window.
 
 Language
 
diff --git a/docs/src/markdown/usage.md b/docs/src/markdown/usage.md
index 395e5c45..4c271e68 100755
--- a/docs/src/markdown/usage.md
+++ b/docs/src/markdown/usage.md
@@ -108,7 +108,7 @@ options.
 
 /// tip | Column Options
 You can hide/show columns by right clicking the list header to get a special context menu. You can then deselect or
-select the the column(s) you wish to hide/show respectively. You can also reorder the columns if desired.
+select the column(s) you wish to hide/show respectively. You can also reorder the columns if desired.
 ///
 
 ## Regular Expression Tester
diff --git a/rummage/lib/__meta__.py b/rummage/lib/__meta__.py
index b0718397..73728348 100644
--- a/rummage/lib/__meta__.py
+++ b/rummage/lib/__meta__.py
@@ -189,7 +189,7 @@ def parse_version(ver):
 
 
 #   (major, minor, micro, release type, pre-release build, post-release build, development-release)
-__version_info__ = Version(4, 21, 0, 'final')
+__version_info__ = Version(4, 21, 1, 'final')
 __version__ = __version_info__._get_canonical()
 __app__ = "Rummage"
 __status__ = __version_info__[3]
diff --git a/rummage/lib/gui/controls/custom_statusbar.py b/rummage/lib/gui/controls/custom_statusbar.py
index 8377639d..f16ddd97 100644
--- a/rummage/lib/gui/controls/custom_statusbar.py
+++ b/rummage/lib/gui/controls/custom_statusbar.py
@@ -29,7 +29,7 @@ class ContextMenu(wx.Menu):
     """Context Menu."""
 
     def __init__(self, menu):
-        """Attach the context menu to to the parent with the defined items."""
+        """Attach the context menu to the parent with the defined items."""
 
         wx.Menu.__init__(self)
         self._callbacks = {}
diff --git a/rummage/lib/gui/controls/dynamic_lists.py b/rummage/lib/gui/controls/dynamic_lists.py
index 644e368f..ec4221a1 100644
--- a/rummage/lib/gui/controls/dynamic_lists.py
+++ b/rummage/lib/gui/controls/dynamic_lists.py
@@ -298,7 +298,7 @@ def set_item_map(self, idx, *args):
             self.size_sample -= 1
 
     def get_map_item(self, idx, col=0, absolute=False):
-        """Get attribute in in item map entry and the given index."""
+        """Get attribute in item map entry and the given index."""
 
         return self.itemDataMap[self.itemIndexMap[idx] if not absolute else idx][self.get_real_col(col)]
 
diff --git a/rummage/lib/gui/controls/result_lists.py b/rummage/lib/gui/controls/result_lists.py
index 7aecef7b..2a35004a 100644
--- a/rummage/lib/gui/controls/result_lists.py
+++ b/rummage/lib/gui/controls/result_lists.py
@@ -64,7 +64,7 @@ class ContextMenu(wx.Menu):
     """Context Menu."""
 
     def __init__(self, menu):
-        """Attach the context menu to to the parent with the defined items."""
+        """Attach the context menu to the parent with the defined items."""
 
         wx.Menu.__init__(self)
         self.create_menu(self, menu)
diff --git a/rummage/lib/gui/data/docs/.dochash b/rummage/lib/gui/data/docs/.dochash
index 5ce7eb7b..799c3516 100644
--- a/rummage/lib/gui/data/docs/.dochash
+++ b/rummage/lib/gui/data/docs/.dochash
@@ -1 +1 @@
-0cd58713b67eafdcd920f80223baa5dc
\ No newline at end of file
+ff7edfad8ee90d27d9cbc711c759338c
\ No newline at end of file
diff --git a/rummage/lib/gui/data/docs/about/changelog.html b/rummage/lib/gui/data/docs/about/changelog.html
index 338bb707..3d3a1746 100644
--- a/rummage/lib/gui/data/docs/about/changelog.html
+++ b/rummage/lib/gui/data/docs/about/changelog.html
@@ -25,6 +25,10 @@
 
   <!-- Table of Content (Don't show for static sites) -->
     <h1 id="changelog">Changelog</h1>
+<h2 id="4211">4.21.1</h2>
+<ul>
+<li><strong>FIX</strong>: Fix issue with <code>re</code> replace in Python 3.12 and Python 3.13.</li>
+</ul>
 <h2 id="421">4.21</h2>
 <ul>
 <li><strong>NEW</strong>: Officially support Python 3.12 and Python 3.13, requires latest wxPython (4.2.2).</li>
diff --git a/rummage/lib/gui/data/docs/preferences.html b/rummage/lib/gui/data/docs/preferences.html
index 256437a6..0877c0cd 100644
--- a/rummage/lib/gui/data/docs/preferences.html
+++ b/rummage/lib/gui/data/docs/preferences.html
@@ -84,8 +84,8 @@ <h2 id="general">General</h2>
 <dl>
 <dt>Single Instance</dt>
 <dd>By default, Rummage will allow for multiple windows to be open.  If this option is enabled, the first window will be
-    be the only window to open.  All subsequent instances will pass their arguments to the first and close without
-    showing a window.</dd>
+    the only window to open.  All subsequent instances will pass their arguments to the first and close without showing
+    a window.</dd>
 <dt>Language</dt>
 <dd>Rummage has internal support to display dialog labels in different languages. Currently Rummage has English. Russian
     is outdated but includes a fair bit of the needed translations. See <a href="extras.html#localization">Localization</a> to
diff --git a/rummage/lib/gui/data/docs/usage.html b/rummage/lib/gui/data/docs/usage.html
index c76e5a72..1b57a30d 100644
--- a/rummage/lib/gui/data/docs/usage.html
+++ b/rummage/lib/gui/data/docs/usage.html
@@ -162,7 +162,7 @@ <h3 id="results">Results</h3>
 <div class="admonition tip">
 <p class="admonition-title">Column Options</p>
 <p>You can hide/show columns by right clicking the list header to get a special context menu. You can then deselect or
-select the the column(s) you wish to hide/show respectively. You can also reorder the columns if desired.</p>
+select the column(s) you wish to hide/show respectively. You can also reorder the columns if desired.</p>
 </div>
 <h2 id="regular-expression-tester">Regular Expression Tester</h2>
 <p><img alt="Regex Tester" src="images/regex_tester.png" /></p>
diff --git a/rummage/lib/gui/dialogs/rummage_dialog.py b/rummage/lib/gui/dialogs/rummage_dialog.py
index 56eb974a..5ed31593 100644
--- a/rummage/lib/gui/dialogs/rummage_dialog.py
+++ b/rummage/lib/gui/dialogs/rummage_dialog.py
@@ -531,7 +531,7 @@ def localize(self):
         self.ERR_UPDATE = _("There was an error checking for updates!")
         self.ERR_INVALID_SEARCH_PTH = _("Please enter a valid search path!")
         self.ERR_INVALID_SEARCH = _("Please enter a valid search!")
-        self.ERR_EMPTY_CHAIN = _("There are no searches in this this chain!")
+        self.ERR_EMPTY_CHAIN = _("There are no searches in this chain!")
         self.ERR_MISSING_SEARCH = _("'%s' is not found in saved searches!")
         self.ERR_INVALID_CHAIN = _("Please enter a valid chain!")
         self.ERR_INVALID_CHAIN_SEARCH = _("Saved search '%s' does not contain a valid search pattern!")
diff --git a/rummage/lib/gui/util/colors.py b/rummage/lib/gui/util/colors.py
index 300f1d40..dfe832df 100644
--- a/rummage/lib/gui/util/colors.py
+++ b/rummage/lib/gui/util/colors.py
@@ -18,7 +18,7 @@ class Color(Base):
     """Color object."""
 
     def to_wxbgr(self, alpha=True):
-        """Get the the wxPython RGB value."""
+        """Get the wxPython RGB value."""
 
         r, g, b = [alg.clamp(int(alg.round_half_up(c * 255)), 0, 255) for c in self.convert('srgb').coords(nans=False)]
         a = alg.clamp(int(alg.round_half_up(self.alpha(nans=False)))) if alpha else 0xFF
diff --git a/rummage/lib/rumcore/__init__.py b/rummage/lib/rumcore/__init__.py
index 3ad4c71a..4628a755 100644
--- a/rummage/lib/rumcore/__init__.py
+++ b/rummage/lib/rumcore/__init__.py
@@ -39,11 +39,6 @@
 except ImportError:  # pragma: no cover
     REGEX_SUPPORT = False
 
-if sys.version_info >= (3, 11):
-    import re._parser as _parser
-else:
-    import sre_parse as _parser
-
 # Common regex flags (re|regex)
 IGNORECASE = 0x1  # (?i)
 DOTALL = 0x2      # (?s)
@@ -309,7 +304,7 @@ class Search:
     """Search setup object."""
 
     def __init__(self, replace=False):
-        """Setup search object as as a search only or search and replace object."""
+        """Setup search object as a search only or search and replace object."""
 
         self._entry = []
         self._is_replace = replace
@@ -747,9 +742,6 @@ def _findall(self, file_content, search_pattern, replace_pattern, flags, file_in
                         self.expand = pattern.compile(replace, (bre.FORMAT if bool(flags & FORMATREPLACE) else 0))
                 else:
                     pattern = _re_pattern(pattern, flags, self.is_binary)
-                    if replace is not None and not self.is_plugin_replace:
-                        template = _parser.parse_template(replace, pattern)
-                        self.expand = lambda m, t=template: _parser.expand_template(t, m)
 
             if REGEX_SUPPORT and isinstance(pattern, (bregex._REGEX_TYPE, bregex.Bregex)):
                 self.reverse = bool(pattern.flags & regex.REVERSE)
@@ -981,7 +973,7 @@ def search_and_replace(self):
 
                 if not self.abort and text:
                     # Update the file or buffer depending on what is being used.
-                    # For a buffer, we will actually return the the content via a `BufferRecord`.
+                    # For a buffer, we will actually return the content via a `BufferRecord`.
                     if is_buffer:
                         yield self._update_buffer(text)
                         file_record_sent = True
diff --git a/tests/test_rumcore.py b/tests/test_rumcore.py
index 62a425af..85e356f9 100644
--- a/tests/test_rumcore.py
+++ b/tests/test_rumcore.py
@@ -956,6 +956,137 @@ def test_literal_chain_search(self):
         print(results)
         self.assertEqual(len(results), 4)
 
+    def test_re_chain_replace(self):
+        """Test for `re` search and replace."""
+
+        self.mktemp(
+            'searches.txt',
+            content=self.dedent(
+                '''
+                search1
+                search1
+
+                search2
+                search2
+
+                search3
+                search3
+
+                search1, search2, search3
+                '''
+            ).encode('utf-8')
+        )
+
+        after = self.dedent(
+            '''
+            replace1
+            replace1
+
+            replace2
+            replace2
+
+            search3
+            search3
+
+            replace1, replace2, search3
+            '''
+        )
+
+        search_params = rc.Search(True)
+        search_params.add('search1', 'replace1', rc.IGNORECASE)
+        search_params.add('search2', 'replace2', rc.IGNORECASE)
+
+        file_id = 0
+        encoding = None
+        context = (0, 0)
+        flags = 0
+        backup_ext = 'rum-bak',
+        max_count = None
+
+        fs = rc._FileSearch(
+            search_params,
+            self.get_file_attr('searches.txt'),
+            file_id,
+            flags,
+            context,
+            encoding,
+            backup_ext,
+            max_count
+        )
+
+        for result in fs.run():
+            if result.error is not None:
+                print(''.join(result.error))
+
+        with codecs.open(self.norm('searches.txt'), 'r', encoding='utf-8') as f:
+            self.assertEqual(f.read(), after)
+
+    def test_regex_chain_replace(self):
+        """Test for `regex` search and replace."""
+
+        self.mktemp(
+            'searches.txt',
+            content=self.dedent(
+                '''
+                search1
+                search1
+
+                search2
+                search2
+
+                search3
+                search3
+
+                search1, search2, search3
+                '''
+            ).encode('utf-8')
+        )
+
+        after = self.dedent(
+            '''
+            replace1
+            replace1
+
+            replace2
+            replace2
+
+            search3
+            search3
+
+            replace1, replace2, search3
+            '''
+        )
+
+        search_params = rc.Search(True)
+        search_params.add('search1', 'replace1', rc.IGNORECASE)
+        search_params.add('search2', 'replace2', rc.IGNORECASE)
+
+        file_id = 0
+        encoding = None
+        context = (0, 0)
+        flags = 0
+        backup_ext = 'rum-bak',
+        max_count = None
+
+        fs = rc._FileSearch(
+            search_params,
+            self.get_file_attr('searches.txt'),
+            file_id,
+            flags,
+            context,
+            encoding,
+            backup_ext,
+            max_count,
+            regex_mode=rc.REGEX_MODE
+        )
+
+        for result in fs.run():
+            if result.error is not None:
+                print(''.join(result.error))
+
+        with codecs.open(self.norm('searches.txt'), 'r', encoding='utf-8') as f:
+            self.assertEqual(f.read(), after)
+
     def test_literal_chain_replace(self):
         """Test for literal search and replace."""