Missing escape of backslashes in prompt.sub

[assaftibm]

Version Information

• Package Version: 0.1.19
• Operating System: MacOS 13.3.1

What is the expected behavior?

Support for backslashes in prompt field values

What is the actual behavior?

Backslashes are unsupported

Please provide a unit test that demonstrates the bug.

  prompt = PromptPattern.from_str("{{context}}\nquestion: {{question}}\nanswer:")
  prompt.sub("context", "Copy the file to \Conf")

Other notes on how to reproduce the issue?

The above code causes re.sub() to raise an exception as it attempts to interpret the \C as a regex meta-character.
The user isn't aware of prompt.sub() using re.sub() so he/she is not aware of the need to escape backslashes.

Any possible solutions?

In prompt_template.py, line 204, add escaping of backslashes as described at the bottom of the documentation of re.escape() in the Python docs .

This means that line 204:

        self.dump = re.sub(pattern, value, prompt)

Should be changed into:

        self.dump = re.sub(pattern, value.replace('\\', r'\\'), prompt)

Can you identify the location in the GENAI source code where the problem exists?

In prompt_template.py, line 204

If the bug is confirmed, would you be willing to submit a PR?

Yes

[onkarbhardwaj]

@assaftibm : Thanks for your willingness to submit a PR! Assigning this issue to you. Our guidelines are here: link

[assaftibm]

@onkarbhardwaj I created the PR. Thanks.

[Tomas2D]

Released in v0.2.6 🚀

Thanks! 🥇