Implement __format__ for strings, improve __format__ for floats

Author: steve-s

graalpython/com.oracle.graal.python.test/src/tests/test_formatting.py

@@ -144,4 +144,14 @@ def test_formatting_errors(self):
         self.assertRaises(OverflowError, lambda: b"%c" % 260)
 
         self.assertRaises(ValueError, lambda: format(3+2j, "f=30,.4f"))
-        self.assertRaises(ValueError, lambda: format(3+2j, "0=30,.4f"))
+        self.assertRaises(ValueError, lambda: format(3+2j, "0=30,.4f"))
+
+
+class MyFloat(float):
+    def __str__(self):
+        return "__str__ overridden for float"
+
+
+def test_overridden_str():
+    assert "{}".format(MyFloat(2)) == "__str__ overridden for float"
+    assert "{0:10}".format(MyFloat(2)) == "       2.0"

graalpython/com.oracle.graal.python.test/src/tests/unittest_tags/test_fstring.txt

@@ -7,6 +7,7 @@
 *graalpython.lib-python.3.test.test_fstring.TestCase.test_compile_time_concat_errors
 *graalpython.lib-python.3.test.test_fstring.TestCase.test_unterminated_string
 *graalpython.lib-python.3.test.test_fstring.TestCase.test_mismatched_parens
+*graalpython.lib-python.3.test.test_fstring.TestCase.test_compile_time_concat
 *graalpython.lib-python.3.test.test_fstring.TestCase.test_comments
 *graalpython.lib-python.3.test.test_fstring.TestCase.test_del
 *graalpython.lib-python.3.test.test_fstring.TestCase.test_dict

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/floats/FloatBuiltins.java

@@ -60,7 +60,6 @@
 import static com.oracle.graal.python.nodes.SpecialMethodNames.__TRUEDIV__;
 import static com.oracle.graal.python.nodes.SpecialMethodNames.__TRUNC__;
 import static com.oracle.graal.python.runtime.formatting.FormattingUtils.prepareSpecForFloat;
-import static com.oracle.graal.python.runtime.formatting.FormattingUtils.shouldBeAsStr;
 
 import java.math.BigDecimal;
 import java.math.BigInteger;
@@ -85,6 +84,7 @@
 import com.oracle.graal.python.nodes.ErrorMessages;
 import com.oracle.graal.python.nodes.SpecialMethodNames;
 import com.oracle.graal.python.nodes.call.special.LookupAndCallTernaryNode;
+import com.oracle.graal.python.nodes.call.special.LookupAndCallUnaryNode;
 import com.oracle.graal.python.nodes.call.special.LookupAndCallVarargsNode;
 import com.oracle.graal.python.nodes.classes.IsSubtypeNode;
 import com.oracle.graal.python.nodes.function.PythonBuiltinBaseNode;
@@ -97,6 +97,7 @@
 import com.oracle.graal.python.runtime.PythonContext;
 import com.oracle.graal.python.runtime.exception.PythonErrorType;
 import com.oracle.graal.python.runtime.formatting.FloatFormatter;
+import com.oracle.graal.python.runtime.formatting.FormattingUtils;
 import com.oracle.graal.python.runtime.formatting.InternalFormat;
 import com.oracle.truffle.api.CompilerDirectives;
 import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
@@ -166,16 +167,18 @@ abstract static class ReprNode extends StrNode {
     @Builtin(name = __FORMAT__, minNumOfPositionalArgs = 2)
     @GenerateNodeFactory
     @TypeSystemReference(PythonArithmeticTypes.class)
+    @ImportStatic(FormattingUtils.class)
     abstract static class FormatNode extends PythonBinaryBuiltinNode {
 
-        @Specialization
+        @Specialization(guards = "shouldBeAsStr(formatString)")
+        Object emptyFormat(VirtualFrame frame, Object self, @SuppressWarnings("unused") String formatString,
+                        @Cached("create(__STR__)") LookupAndCallUnaryNode strCall) {
+            return strCall.executeObject(frame, self);
+        }
+
+        @Specialization(guards = "!shouldBeAsStr(formatString)")
         @TruffleBoundary
-        String format(double self, String formatString,
-                        @Cached("create()") StrNode strNode,
-                        @Cached("createBinaryProfile()") ConditionProfile strProfile) {
-            if (strProfile.profile(shouldBeAsStr(formatString))) {
-                return strNode.str(self);
-            }
+        String format(double self, String formatString) {
             InternalFormat.Spec spec = InternalFormat.fromText(getCore(), formatString, __FORMAT__);
             FloatFormatter formatter = new FloatFormatter(getCore(), prepareSpecForFloat(spec, getCore(), "float"));
             formatter.format(self);

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/str/StringBuiltins.java

@@ -28,6 +28,7 @@
 import static com.oracle.graal.python.nodes.SpecialMethodNames.__ADD__;
 import static com.oracle.graal.python.nodes.SpecialMethodNames.__CONTAINS__;
 import static com.oracle.graal.python.nodes.SpecialMethodNames.__EQ__;
+import static com.oracle.graal.python.nodes.SpecialMethodNames.__FORMAT__;
 import static com.oracle.graal.python.nodes.SpecialMethodNames.__GETITEM__;
 import static com.oracle.graal.python.nodes.SpecialMethodNames.__GE__;
 import static com.oracle.graal.python.nodes.SpecialMethodNames.__GT__;
@@ -95,6 +96,7 @@
 import com.oracle.graal.python.nodes.SpecialMethodNames;
 import com.oracle.graal.python.nodes.builtins.ListNodes.AppendNode;
 import com.oracle.graal.python.nodes.call.special.LookupAndCallBinaryNode;
+import com.oracle.graal.python.nodes.call.special.LookupAndCallUnaryNode;
 import com.oracle.graal.python.nodes.classes.IsSubtypeNode;
 import com.oracle.graal.python.nodes.function.PythonBuiltinBaseNode;
 import com.oracle.graal.python.nodes.function.PythonBuiltinNode;
@@ -112,9 +114,13 @@
 import com.oracle.graal.python.nodes.util.CastToJavaStringNodeGen;
 import com.oracle.graal.python.runtime.ExecutionContext.IndirectCallContext;
 import com.oracle.graal.python.runtime.PythonContext;
+import com.oracle.graal.python.runtime.PythonCore;
 import com.oracle.graal.python.runtime.PythonOptions;
 import com.oracle.graal.python.runtime.exception.PException;
+import com.oracle.graal.python.runtime.formatting.InternalFormat;
+import com.oracle.graal.python.runtime.formatting.InternalFormat.Spec;
 import com.oracle.graal.python.runtime.formatting.StringFormatProcessor;
+import com.oracle.graal.python.runtime.formatting.TextFormatter;
 import com.oracle.truffle.api.CompilerAsserts;
 import com.oracle.truffle.api.CompilerDirectives;
 import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
@@ -153,6 +159,38 @@ static String doGeneric(Object self,
         }
     }
 
+    @Builtin(name = __FORMAT__, minNumOfPositionalArgs = 2)
+    @GenerateNodeFactory
+    @TypeSystemReference(PythonArithmeticTypes.class)
+    abstract static class FormatNode extends PythonBinaryBuiltinNode {
+
+        @Specialization(guards = "formatString.isEmpty()")
+        Object emptyFormat(VirtualFrame frame, Object self, @SuppressWarnings("unused") String formatString,
+                        @Cached("create(__STR__)") LookupAndCallUnaryNode strCall) {
+            return strCall.executeObject(frame, self);
+        }
+
+        @Specialization(guards = "!formatString.isEmpty()")
+        Object format(Object self, String formatString,
+                        @Cached CastToJavaStringCheckedNode castToJavaStringNode) {
+            String str = castToJavaStringNode.cast(self, INVALID_RECEIVER, __STR__, self);
+            return formatString(getCore(), formatString, str);
+        }
+
+        @Fallback
+        Object other(@SuppressWarnings("unused") Object self, Object formatString) {
+            throw raise(PythonBuiltinClassType.TypeError, ErrorMessages.ARG_D_MUST_BE_S_NOT_P, "format()", 2, "str", formatString);
+        }
+
+        @TruffleBoundary
+        private static Object formatString(PythonCore core, String formatString, String str) {
+            Spec spec = InternalFormat.fromText(core, formatString, __FORMAT__);
+            TextFormatter formatter = new TextFormatter(core, spec.withDefaults(Spec.STRING));
+            formatter.format(str);
+            return formatter.pad().getResult();
+        }
+    }
+
     @Builtin(name = __REPR__, minNumOfPositionalArgs = 1)
     @GenerateNodeFactory
     public abstract static class ReprNode extends PythonUnaryBuiltinNode {

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/formatting/TextFormatter.java

@@ -7,6 +7,7 @@
 package com.oracle.graal.python.runtime.formatting;
 
 import com.oracle.graal.python.runtime.PythonCore;
+import com.oracle.graal.python.runtime.formatting.FormattingBuffer.StringFormattingBuffer;
 import com.oracle.graal.python.runtime.formatting.InternalFormat.Spec;
 
 /**
@@ -28,6 +29,10 @@ public TextFormatter(PythonCore core, FormattingBuffer result, Spec spec) {
         super(core, result, spec);
     }
 
+    public TextFormatter(PythonCore core, Spec spec) {
+        super(core, new StringFormattingBuffer(32), spec);
+    }
+
     /*
      * Re-implement the text appends so they return the right type.
      */