PR: Improve renamed_tree method (Editor)

[juliangilbey]

Description of Changes

• Wrote at least one-line docstrings (for any new functions)
• Added unit test(s) covering the changes (if testable)

• Included a screenshot or animation (if affecting the UI, see Licecap)

This follows the discussion in PR #21692 and fixes the issue identified there. Turns out that count=1 is not needed as the regex is anchored to the start of the string.

Affirmation

By submitting this Pull Request or typing my (user)name below,
I affirm the Developer Certificate of Origin
with respect to all commits and content included in this PR,
and understand I am releasing the same under Spyder's MIT (Expat) license.

I certify the above statement is true and correct: @juliangilbey

[juliangilbey]

Ah, but this PR does assume that renamed_tree will always be called with absolute paths rather than relative paths. What if that is not the case? Could it ever be called with something like renamed_tree("test/dir1", "test/dir2") with relative paths?

[juliangilbey]

Ah, but this PR does assume that renamed_tree will always be called with absolute paths rather than relative paths. What if that is not the case? Could it ever be called with something like renamed_tree("test/dir1", "test/dir2") with relative paths?

Looking through the code more carefully, I see that this should never be the case. So it turns out that this patch is probably not needed, but it does no harm. In fact, assuming that source and dest are always absolute paths, as are the filenames returned by self.get_filenames(), the whole function could be significantly simplified to:

    def renamed_tree(self, source, dest):
        """Directory was renamed in file explorer or in project explorer."""
        for fname in self.get_filenames():
            if fname.startswith(source):
                source_re = "^" + re.escape(source)
                dest_quoted = dest.replace("\\", r"\\")
                new_filename = re.sub(source_re, dest_quoted, fname)
                self.renamed(source=fname, dest=new_filename)

But I wouldn't suggest doing this, in case there are cases I've not spotted where this assumption is invalid. But if this patch is not applied, the test test_renamed_tree will need to be adapted to test Windows and POSIX platforms differently. This might not be such a silly thing to do, anyway, as the method is called with filenames that look different on these two platforms ("/test/dir" versus "C:\\test\\dir").

[ccordoba12]

@juliangilbey, could you merge with 5.x or rebase on top of it to check if our test related to renamed_tree passes here after the changes you did to it in PR #21692? Thanks!

[ccordoba12]

Thanks @juliangilbey!

[juliangilbey]

Oh, I hadn't even had a chance to check if all the tests had passed!! Thanks for merging.