[GR-11787] extensible builtins

PullRequest: graalpython/200

Author: cosminbasca

graalpython/com.oracle.graal.python.test/src/META-INF/services/com.oracle.graal.python.builtins.PythonBuiltins

@@ -0,0 +1 @@
+com.oracle.graal.python.test.advance.CustomModule

graalpython/com.oracle.graal.python.test/src/com/oracle/graal/python/test/advance/CustomBuiltinsTest.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * The Universal Permissive License (UPL), Version 1.0
+ *
+ * Subject to the condition set forth below, permission is hereby granted to any
+ * person obtaining a copy of this software, associated documentation and/or
+ * data (collectively the "Software"), free of charge and under any and all
+ * copyright rights in the Software, and any and all patent rights owned or
+ * freely licensable by each licensor hereunder covering either (i) the
+ * unmodified Software as contributed to or provided by such licensor, or (ii)
+ * the Larger Works (as defined below), to deal in both
+ *
+ * (a) the Software, and
+ *
+ * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+ * one is included with the Software each a "Larger Work" to which the Software
+ * is contributed by such licensors),
+ *
+ * without restriction, including without limitation the rights to copy, create
+ * derivative works of, display, perform, and distribute the Software and make,
+ * use, sell, offer for sale, import, export, have made, and have sold the
+ * Software and the Larger Work(s), and to sublicense the foregoing rights on
+ * either these or other terms.
+ *
+ * This license is subject to the following condition:
+ *
+ * The above copyright notice and either this complete permission notice or at a
+ * minimum a reference to the UPL must be included in all copies or substantial
+ * portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package com.oracle.graal.python.test.advance;
+
+import org.junit.Test;
+
+import com.oracle.graal.python.test.PythonTests;
+
+public class CustomBuiltinsTest extends PythonTests {
+    @Test
+    public void testCustomBuiltinModule() {
+        assertPrints("success\n", "import CustomModule; print(CustomModule.success)");
+    }
+}

graalpython/com.oracle.graal.python.test/src/com/oracle/graal/python/test/advance/CustomModule.java

@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * The Universal Permissive License (UPL), Version 1.0
+ *
+ * Subject to the condition set forth below, permission is hereby granted to any
+ * person obtaining a copy of this software, associated documentation and/or
+ * data (collectively the "Software"), free of charge and under any and all
+ * copyright rights in the Software, and any and all patent rights owned or
+ * freely licensable by each licensor hereunder covering either (i) the
+ * unmodified Software as contributed to or provided by such licensor, or (ii)
+ * the Larger Works (as defined below), to deal in both
+ *
+ * (a) the Software, and
+ *
+ * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+ * one is included with the Software each a "Larger Work" to which the Software
+ * is contributed by such licensors),
+ *
+ * without restriction, including without limitation the rights to copy, create
+ * derivative works of, display, perform, and distribute the Software and make,
+ * use, sell, offer for sale, import, export, have made, and have sold the
+ * Software and the Larger Work(s), and to sublicense the foregoing rights on
+ * either these or other terms.
+ *
+ * This license is subject to the following condition:
+ *
+ * The above copyright notice and either this complete permission notice or at a
+ * minimum a reference to the UPL must be included in all copies or substantial
+ * portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package com.oracle.graal.python.test.advance;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import com.oracle.graal.python.builtins.CoreFunctions;
+import com.oracle.graal.python.builtins.PythonBuiltins;
+import com.oracle.graal.python.nodes.function.PythonBuiltinBaseNode;
+import com.oracle.graal.python.runtime.PythonCore;
+import com.oracle.truffle.api.dsl.NodeFactory;
+
+@CoreFunctions(defineModule = "CustomModule")
+public class CustomModule extends PythonBuiltins {
+
+    @Override
+    protected List<? extends NodeFactory<? extends PythonBuiltinBaseNode>> getNodeFactories() {
+        return new ArrayList<>();
+    }
+
+    @Override
+    public void initialize(PythonCore core) {
+        super.initialize(core);
+        this.builtinConstants.put("success", "success");
+    }
+}

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/Python3Core.java

@@ -33,10 +33,13 @@
 import java.math.BigInteger;
 import java.net.MalformedURLException;
 import java.net.URL;
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
+import java.util.ServiceLoader;
 
 import com.oracle.graal.python.PythonLanguage;
 import com.oracle.graal.python.builtins.modules.ArrayModuleBuiltins;
@@ -138,6 +141,7 @@
 import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
 import com.oracle.truffle.api.TruffleFile;
 import com.oracle.truffle.api.TruffleLanguage.Env;
+import com.oracle.truffle.api.TruffleOptions;
 import com.oracle.truffle.api.nodes.Node;
 import com.oracle.truffle.api.source.Source;
 import com.oracle.truffle.api.source.SourceSection;
@@ -185,86 +189,96 @@ public final class Python3Core implements PythonCore {
                     "_sre",
     };
 
-    private final PythonBuiltins[] BUILTINS = new PythonBuiltins[]{
-                    new BuiltinConstructors(),
-                    new BuiltinFunctions(),
-                    new InteropModuleBuiltins(),
-                    new ObjectBuiltins(),
-                    new CellBuiltins(),
-                    new BoolBuiltins(),
-                    new FloatBuiltins(),
-                    new BytesBuiltins(),
-                    new ComplexBuiltins(),
-                    new ByteArrayBuiltins(),
-                    new TypeBuiltins(),
-                    new IntBuiltins(),
-                    new TruffleObjectBuiltins(),
-                    new ListBuiltins(),
-                    new DictBuiltins(),
-                    new DictViewBuiltins(),
-                    new DictValuesBuiltins(),
-                    new DictKeysIteratorBuiltins(),
-                    new DictValuesIteratorBuiltins(),
-                    new DictItemsIteratorBuiltins(),
-                    new RangeBuiltins(),
-                    new SliceBuiltins(),
-                    new TupleBuiltins(),
-                    new StringBuiltins(),
-                    new SetBuiltins(),
-                    new FrozenSetBuiltins(),
-                    new IteratorBuiltins(),
-                    new ReversedBuiltins(),
-                    new PZipBuiltins(),
-                    new EnumerateBuiltins(),
-                    new SentinelIteratorBuiltins(),
-                    new ForeignIteratorBuiltins(),
-                    new GeneratorBuiltins(),
-                    new AbstractFunctionBuiltins(),
-                    new FunctionBuiltins(),
-                    new BuiltinFunctionBuiltins(),
-                    new AbstractMethodBuiltins(),
-                    new MethodBuiltins(),
-                    new BuiltinMethodBuiltins(),
-                    new CodeBuiltins(),
-                    new FrameBuiltins(),
-                    new MappingproxyBuiltins(),
-                    new GetSetDescriptorTypeBuiltins(),
-                    new BaseExceptionBuiltins(),
-                    new PosixModuleBuiltins(),
-                    new ImpModuleBuiltins(),
-                    new ArrayModuleBuiltins(),
-                    new ArrayBuiltins(),
-                    new TimeModuleBuiltins(),
-                    new MathModuleBuiltins(),
-                    new MarshalModuleBuiltins(),
-                    new RandomModuleBuiltins(),
-                    new RandomBuiltins(),
-                    new TruffleCextBuiltins(),
-                    new WeakRefModuleBuiltins(),
-                    new ReferenceTypeBuiltins(),
-                    new IOModuleBuiltins(),
-                    new StringModuleBuiltins(),
-                    new ItertoolsModuleBuiltins(),
-                    new FunctoolsModuleBuiltins(),
-                    new ErrnoModuleBuiltins(),
-                    new CodecsModuleBuiltins(),
-                    new CollectionsModuleBuiltins(),
-                    new JavaModuleBuiltins(),
-                    new SREModuleBuiltins(),
-                    new AstModuleBuiltins(),
-                    new SelectModuleBuiltins(),
-                    new SignalModuleBuiltins(),
-                    new TracebackBuiltins(),
-                    new GcModuleBuiltins(),
-                    new AtexitModuleBuiltins(),
-                    new FaulthandlerModuleBuiltins(),
-                    new UnicodeDataModuleBuiltins(),
-                    new LocaleModuleBuiltins(),
-                    new SysModuleBuiltins(),
-                    new BufferBuiltins(),
-                    new MemoryviewBuiltins(),
-                    new SuperBuiltins(),
-    };
+    private final PythonBuiltins[] builtins;
+
+    private static final PythonBuiltins[] initializeBuiltins() {
+        List<PythonBuiltins> builtins = new ArrayList<>(Arrays.asList(
+                        new BuiltinConstructors(),
+                        new BuiltinFunctions(),
+                        new InteropModuleBuiltins(),
+                        new ObjectBuiltins(),
+                        new CellBuiltins(),
+                        new BoolBuiltins(),
+                        new FloatBuiltins(),
+                        new BytesBuiltins(),
+                        new ComplexBuiltins(),
+                        new ByteArrayBuiltins(),
+                        new TypeBuiltins(),
+                        new IntBuiltins(),
+                        new TruffleObjectBuiltins(),
+                        new ListBuiltins(),
+                        new DictBuiltins(),
+                        new DictViewBuiltins(),
+                        new DictValuesBuiltins(),
+                        new DictKeysIteratorBuiltins(),
+                        new DictValuesIteratorBuiltins(),
+                        new DictItemsIteratorBuiltins(),
+                        new RangeBuiltins(),
+                        new SliceBuiltins(),
+                        new TupleBuiltins(),
+                        new StringBuiltins(),
+                        new SetBuiltins(),
+                        new FrozenSetBuiltins(),
+                        new IteratorBuiltins(),
+                        new ReversedBuiltins(),
+                        new PZipBuiltins(),
+                        new EnumerateBuiltins(),
+                        new SentinelIteratorBuiltins(),
+                        new ForeignIteratorBuiltins(),
+                        new GeneratorBuiltins(),
+                        new AbstractFunctionBuiltins(),
+                        new FunctionBuiltins(),
+                        new BuiltinFunctionBuiltins(),
+                        new AbstractMethodBuiltins(),
+                        new MethodBuiltins(),
+                        new BuiltinMethodBuiltins(),
+                        new CodeBuiltins(),
+                        new FrameBuiltins(),
+                        new MappingproxyBuiltins(),
+                        new GetSetDescriptorTypeBuiltins(),
+                        new BaseExceptionBuiltins(),
+                        new PosixModuleBuiltins(),
+                        new ImpModuleBuiltins(),
+                        new ArrayModuleBuiltins(),
+                        new ArrayBuiltins(),
+                        new TimeModuleBuiltins(),
+                        new MathModuleBuiltins(),
+                        new MarshalModuleBuiltins(),
+                        new RandomModuleBuiltins(),
+                        new RandomBuiltins(),
+                        new TruffleCextBuiltins(),
+                        new WeakRefModuleBuiltins(),
+                        new ReferenceTypeBuiltins(),
+                        new IOModuleBuiltins(),
+                        new StringModuleBuiltins(),
+                        new ItertoolsModuleBuiltins(),
+                        new FunctoolsModuleBuiltins(),
+                        new ErrnoModuleBuiltins(),
+                        new CodecsModuleBuiltins(),
+                        new CollectionsModuleBuiltins(),
+                        new JavaModuleBuiltins(),
+                        new SREModuleBuiltins(),
+                        new AstModuleBuiltins(),
+                        new SelectModuleBuiltins(),
+                        new SignalModuleBuiltins(),
+                        new TracebackBuiltins(),
+                        new GcModuleBuiltins(),
+                        new AtexitModuleBuiltins(),
+                        new FaulthandlerModuleBuiltins(),
+                        new UnicodeDataModuleBuiltins(),
+                        new LocaleModuleBuiltins(),
+                        new SysModuleBuiltins(),
+                        new BufferBuiltins(),
+                        new MemoryviewBuiltins(),
+                        new SuperBuiltins()));
+        if (!TruffleOptions.AOT) {
+            ServiceLoader<PythonBuiltins> providers = ServiceLoader.load(PythonBuiltins.class);
+            for (PythonBuiltins builtin : providers) {
+                builtins.add(builtin);
+            }
+        }
+        return builtins.toArray(new PythonBuiltins[builtins.size()]);
+    }
 
     // not using EnumMap, HashMap, etc. to allow this to fold away during partial evaluation
     @CompilationFinal(dimensions = 1) private final PythonBuiltinClass[] builtinTypes = new PythonBuiltinClass[PythonBuiltinClassType.VALUES.length];
@@ -289,6 +303,7 @@ public final class Python3Core implements PythonCore {
 
     public Python3Core(PythonParser parser) {
         this.parser = parser;
+        this.builtins = initializeBuiltins();
     }
 
     @Override
@@ -482,7 +497,7 @@ private void initializeTypes() {
         // n.b.: the builtin modules and classes and their constructors are initialized first here,
         // so we have the mapping from java classes to python classes and builtin names to modules
         // available.
-        for (PythonBuiltins builtin : BUILTINS) {
+        for (PythonBuiltins builtin : builtins) {
             CoreFunctions annotation = builtin.getClass().getAnnotation(CoreFunctions.class);
             if (annotation.defineModule().length() > 0) {
                 createModule(annotation.defineModule());
@@ -501,7 +516,7 @@ private void initializeTypes() {
     }
 
     private void populateBuiltins() {
-        for (PythonBuiltins builtin : BUILTINS) {
+        for (PythonBuiltins builtin : builtins) {
             builtin.initialize(this);
             CoreFunctions annotation = builtin.getClass().getAnnotation(CoreFunctions.class);
             if (annotation.defineModule().length() > 0) {
@@ -532,14 +547,14 @@ private PythonModule createModule(String name) {
         return mod;
     }
 
-    private void addBuiltinsTo(PythonObject obj, PythonBuiltins builtins) {
-        Map<String, Object> builtinConstants = builtins.getBuiltinConstants();
+    private void addBuiltinsTo(PythonObject obj, PythonBuiltins builtinsForObj) {
+        Map<String, Object> builtinConstants = builtinsForObj.getBuiltinConstants();
         for (Map.Entry<String, Object> entry : builtinConstants.entrySet()) {
             String constantName = entry.getKey();
             obj.setAttribute(constantName, entry.getValue());
         }
 
-        Map<String, BoundBuiltinCallable<?>> builtinFunctions = builtins.getBuiltinFunctions();
+        Map<String, BoundBuiltinCallable<?>> builtinFunctions = builtinsForObj.getBuiltinFunctions();
         for (Entry<String, BoundBuiltinCallable<?>> entry : builtinFunctions.entrySet()) {
             String methodName = entry.getKey();
             Object value;
@@ -552,7 +567,7 @@ private void addBuiltinsTo(PythonObject obj, PythonBuiltins builtins) {
             obj.setAttribute(methodName, value);
         }
 
-        Map<PythonBuiltinClass, Entry<PythonBuiltinClassType[], Boolean>> builtinClasses = builtins.getBuiltinClasses();
+        Map<PythonBuiltinClass, Entry<PythonBuiltinClassType[], Boolean>> builtinClasses = builtinsForObj.getBuiltinClasses();
         for (Entry<PythonBuiltinClass, Entry<PythonBuiltinClassType[], Boolean>> entry : builtinClasses.entrySet()) {
             boolean isPublic = entry.getValue().getValue();
             if (isPublic) {