From 6b36fb041d46406fd43119805dccc1e04e3550d1 Mon Sep 17 00:00:00 2001
From: Mikhail Golubev <mikhail.golubev@jetbrains.com>
Date: Thu, 9 Jan 2020 22:37:09 +0900
Subject: [PATCH] PY-24232 Remove escaping from "%" signs when converting
 printf-style formatted strings to f-strings

GitOrigin-RevId: bd19cad899cee5d93c518b76a990a51c7048442a
---
 .../BaseConvertToFStringProcessor.java             | 14 ++++++++------
 .../NewStyleConvertToFStringProcessor.java         |  9 +++++++--
 .../OldStyleConvertToFStringProcessor.java         |  7 ++++++-
 ...centOperatorRemovingEscapingFromPercentSigns.py |  1 +
 ...eratorRemovingEscapingFromPercentSigns_after.py |  1 +
 .../PyConvertToFStringIntentionTest.java           |  7 ++++++-
 6 files changed, 29 insertions(+), 10 deletions(-)
 create mode 100644 python/testData/intentions/PyConvertToFStringIntentionTest/percentOperatorRemovingEscapingFromPercentSigns.py
 create mode 100644 python/testData/intentions/PyConvertToFStringIntentionTest/percentOperatorRemovingEscapingFromPercentSigns_after.py

diff --git a/python/src/com/jetbrains/python/codeInsight/intentions/convertToFString/BaseConvertToFStringProcessor.java b/python/src/com/jetbrains/python/codeInsight/intentions/convertToFString/BaseConvertToFStringProcessor.java
index 8658687ad806..174160daadce 100644
--- a/python/src/com/jetbrains/python/codeInsight/intentions/convertToFString/BaseConvertToFStringProcessor.java
+++ b/python/src/com/jetbrains/python/codeInsight/intentions/convertToFString/BaseConvertToFStringProcessor.java
@@ -82,15 +82,15 @@ public abstract class BaseConvertToFStringProcessor<T extends PyStringFormatPars
     int offset = contentRange.getStartOffset();
 
     for (final T chunk : extractTopLevelSubstitutionChunks()) {
-      // Preceding literal text
-      fStringText.append(stringText, offset, chunk.getStartIndex());
+      processLiteralChunk(stringText.substring(offset, chunk.getStartIndex()), fStringText);
+      if (!processSubstitutionChunk(chunk, fStringText)) {
+        return;
+      }
       offset = chunk.getEndIndex();
-
-      if (!convertSubstitutionChunk(chunk, fStringText)) return;
     }
 
     if (offset < contentRange.getEndOffset()) {
-      fStringText.append(stringText, offset, contentRange.getEndOffset());
+      processLiteralChunk(stringText.substring(offset, contentRange.getEndOffset()), fStringText);
     }
 
     fStringText.append(myNodeInfo.getQuote());
@@ -115,7 +115,9 @@ public abstract class BaseConvertToFStringProcessor<T extends PyStringFormatPars
 
   protected abstract boolean checkChunk(@NotNull T chunk);
 
-  protected abstract boolean convertSubstitutionChunk(@NotNull T chunk, @NotNull StringBuilder fStringText);
+  protected abstract boolean processSubstitutionChunk(@NotNull T chunk, @NotNull StringBuilder fStringText);
+
+  protected abstract void processLiteralChunk(@NotNull String chunk, @NotNull StringBuilder fStringText);
 
   @Nullable
   protected PsiElement adjustQuotesInsideInjectedExpression(@NotNull PsiElement expression) {
diff --git a/python/src/com/jetbrains/python/codeInsight/intentions/convertToFString/NewStyleConvertToFStringProcessor.java b/python/src/com/jetbrains/python/codeInsight/intentions/convertToFString/NewStyleConvertToFStringProcessor.java
index 235c27079bc7..6c1f8a38739a 100644
--- a/python/src/com/jetbrains/python/codeInsight/intentions/convertToFString/NewStyleConvertToFStringProcessor.java
+++ b/python/src/com/jetbrains/python/codeInsight/intentions/convertToFString/NewStyleConvertToFStringProcessor.java
@@ -91,7 +91,7 @@ public class NewStyleConvertToFStringProcessor extends BaseConvertToFStringProce
   }
 
   @Override
-  protected boolean convertSubstitutionChunk(@NotNull Field field, @NotNull StringBuilder fStringText) {
+  protected boolean processSubstitutionChunk(@NotNull Field field, @NotNull StringBuilder fStringText) {
 
     final String stringText = myPyString.getText();
 
@@ -128,7 +128,7 @@ public class NewStyleConvertToFStringProcessor extends BaseConvertToFStringProce
           specOffset = nestedField.getFieldEnd();
 
           // recursively format nested field
-          if (!convertSubstitutionChunk(nestedField, fStringText)) {
+          if (!processSubstitutionChunk(nestedField, fStringText)) {
             return false;
           }
         }
@@ -142,6 +142,11 @@ public class NewStyleConvertToFStringProcessor extends BaseConvertToFStringProce
     return true;
   }
 
+  @Override
+  protected void processLiteralChunk(@NotNull String chunk, @NotNull StringBuilder fStringText) {
+    fStringText.append(chunk);
+  }
+
   @Nullable
   private String quoteItemsInFragments(@NotNull Field field) {
     final List<String> escaped = new ArrayList<>();
diff --git a/python/src/com/jetbrains/python/codeInsight/intentions/convertToFString/OldStyleConvertToFStringProcessor.java b/python/src/com/jetbrains/python/codeInsight/intentions/convertToFString/OldStyleConvertToFStringProcessor.java
index 9ab21f23f6bf..2dfd0a6b12c1 100644
--- a/python/src/com/jetbrains/python/codeInsight/intentions/convertToFString/OldStyleConvertToFStringProcessor.java
+++ b/python/src/com/jetbrains/python/codeInsight/intentions/convertToFString/OldStyleConvertToFStringProcessor.java
@@ -85,7 +85,7 @@ public class OldStyleConvertToFStringProcessor extends BaseConvertToFStringProce
   }
 
   @Override
-  protected boolean convertSubstitutionChunk(@NotNull SubstitutionChunk subsChunk, @NotNull StringBuilder fStringText) {
+  protected boolean processSubstitutionChunk(@NotNull SubstitutionChunk subsChunk, @NotNull StringBuilder fStringText) {
     final char conversionChar = subsChunk.getConversionType();
 
     String widthAndPrecision = StringUtil.notNullize(subsChunk.getWidth());
@@ -133,4 +133,9 @@ public class OldStyleConvertToFStringProcessor extends BaseConvertToFStringProce
     fStringText.append("}");
     return true;
   }
+
+  @Override
+  protected void processLiteralChunk(@NotNull String chunk, @NotNull StringBuilder fStringText) {
+    fStringText.append(chunk.replace("%%", "%"));
+  }
 }
diff --git a/python/testData/intentions/PyConvertToFStringIntentionTest/percentOperatorRemovingEscapingFromPercentSigns.py b/python/testData/intentions/PyConvertToFStringIntentionTest/percentOperatorRemovingEscapingFromPercentSigns.py
new file mode 100644
index 000000000000..fc6218a52e35
--- /dev/null
+++ b/python/testData/intentions/PyConvertToFStringIntentionTest/percentOperatorRemovingEscapingFromPercentSigns.py
@@ -0,0 +1 @@
+'%%%d%%' % 42
\ No newline at end of file
diff --git a/python/testData/intentions/PyConvertToFStringIntentionTest/percentOperatorRemovingEscapingFromPercentSigns_after.py b/python/testData/intentions/PyConvertToFStringIntentionTest/percentOperatorRemovingEscapingFromPercentSigns_after.py
new file mode 100644
index 000000000000..01d9916a09f5
--- /dev/null
+++ b/python/testData/intentions/PyConvertToFStringIntentionTest/percentOperatorRemovingEscapingFromPercentSigns_after.py
@@ -0,0 +1 @@
+f'%{42:d}%'
\ No newline at end of file
diff --git a/python/testSrc/com/jetbrains/python/intentions/PyConvertToFStringIntentionTest.java b/python/testSrc/com/jetbrains/python/intentions/PyConvertToFStringIntentionTest.java
index f74673d9a033..62b49bbde252 100644
--- a/python/testSrc/com/jetbrains/python/intentions/PyConvertToFStringIntentionTest.java
+++ b/python/testSrc/com/jetbrains/python/intentions/PyConvertToFStringIntentionTest.java
@@ -88,11 +88,16 @@ public class PyConvertToFStringIntentionTest extends PyIntentionTestCase {
   public void testPercentOperatorExpressionContainsOriginalHostQuote() {
     doNegativeTest();
   }
-  
+
   public void testPercentOperatorExpressionContainsAlternativeHostQuote() {
     doNegativeTest();
   }
 
+  // PY-24232
+  public void testPercentOperatorRemovingEscapingFromPercentSigns() {
+    doTest();
+  }
+
   public void testFormatMethodSimple() {
     doTest();
   }