Trying to use python function replace

[jwes]

Trying to use Python function replace to change strings from all caps to title case. This is the regular expression that I use and it appears to find what I want, but when I click on replace, nothing changes. This is the search that I use:

1\Name=title case
1\Find="(?<=>)([\\w —’]*)(?=</a)"
1\Replace=\\F<titlecase>
1\Controls=RX DN CF

Also, where are the Python functions stored on Windows 11?

[KevinH]

They are stored in your Sigil Preferences folder.

I will run this test on my 2.7.0 build to see if I can replicate what you are seeing.

[KevinH]

Yes a recently introduced bug of some sort. The titlecase python function is somehow getting lost which breaks the apply_func_to_match_groups routine.

I will get you a fix or a workaround.

[jwes]

Originally Posted by KevinH

They are stored in your Sigil Preferences folder.

If that is the folder I get when I click on Open preferences location, then there are no Python scripts but there is a file named replace_functions.json.

[DiapDealer]

Yes. The user defined Python functions are stored in the json file in the user's preference directory. They are not kept in a Python script. The builtins like titlecase are part of the Sigil program directory. Namely titlecase.py, fr_utils.py and functionrep.py in the python3lib directory

[jwes]

I put some logging code in titlecase.py and it's never called.

[KevinH]

Yes because the routine that invokes it is broken. Somehow the SigilMatch object end() access method is being confused with the end attribute of the match object.

I do not know why that is showing up now and not earlier.

Either way, make the following change in functionsearch.py inside the SigilMatch object changing its "beg" and "end" attributes to mtchbeg and mtchend and updating the accessor methods which should prevent the name collision with the end() method and all should work.

So after modifications it should look like the following:

class SigilMatch(object):

    def __init__(self, text, groupslist):
        self.string = text
        self.groupslist = groupslist
        self.mtchbeg, self.mtchend = groupslist[0]

    def start(self):
        return self.mtchbeg

    def end(self):
        return self.mtchend

    def span(self, i):
        if i < 0 or i >= len(self.groupslist):
            raise IndexError("match group index not valid");
        return self.groupslist[i][0], self.groupslist[i][1]

    def group(self, i=0):
        if i < 0 or i >= len(self.groupslist):
            raise IndexError("match group index not valid");
        return self.string[self.groupslist[i][0] : self.groupslist[i][1]]

    def groups(self):
        results = []
        for i, v in enumerate(self.groupslist):
            if i > 0:
                results.append(self.string[v[0]: v[1]])
        return results

[KevinH]

Please give that a try and let me know how it goes.

[jwes]

Originally Posted by KevinH

Please give that a try and let me know how it goes.

Still nothing. Here is the changed function:

class SigilMatch(object):

    def __init__(self, text, groupslist):
        self.string = text
        self.groupslist = groupslist
        self.mtchbeg, self.mtchend = groupslist[0]

    def start(self):
        return self.mtchbeg

    def end(self):
        return self.mtchend

    def span(self, i):
        if i < 0 or i >= len(self.groupslist):
            raise IndexError("match group index not valid");
        return self.groupslist[i][0], self.groupslist[i][1]

    def group(self, i=0):
        if i < 0 or i >= len(self.groupslist):
            raise IndexError("match group index not valid");
        return self.string[self.groupslist[i][0] : self.groupslist[i][1]]

    def groups(self):
        results = []
        for i, v in enumerate(self.groupslist):
            if i > 0:
                results.append(self.string[v[0]: v[1]])
        return results

[KevinH]

That is strange, as this change allows all my tests with sub match groups in python function replace for titlecase to now work. Are you sure you are using this new functionsearch.py file?

Please try the simple example shown in the following images. The goal is to capture the text inside the h1 tag and run titlecase on it. Clicking the find button results in the following:

See before.png

Then click on the replace button and the fixed version of Sigil nicely titlecases the contents of the h1 tag.

See the after.png

This simple test did not work without the change I posted earlier. No idea why that attribute name and accessor function name collision did not happen in earlier testing but it did now until this fix.

I am going to push this change to master so it appears in the next release.

So please try a trivial test case like this one with your modified functionsearch.py put in the right place in the python3lib inside Sigil's program. It should all now work.

[KevinH]

The above is with the builtin titlecase function unmodified.

[jwes]

It works now. I had to close and reopen sigil. Many thanks.

[KevinH]

Glad to hear it works! Thanks for your bug report!