Moving zip_directory_cache to ZipModuleBuiltins.

Adding checks if a zipimporter was initialized.
Correcting licences.

Author: ppisl

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

@@ -1,41 +1,28 @@
-# Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
-# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+# Copyright (c) 2018, Oracle and/or its affiliates.
+# Copyright (c) 2013, Regents of the University of California
 #
-# The Universal Permissive License (UPL), Version 1.0
+# All rights reserved.
 #
-# 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
+# Redistribution and use in source and binary forms, with or without modification, are
+# permitted provided that the following conditions are met:
 #
-# (a) the Software, and
+# 1. Redistributions of source code must retain the above copyright notice, this list of
+# conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice, this list of
+# conditions and the following disclaimer in the documentation and/or other materials provided
+# with the distribution.
 #
-# (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.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
+# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+# COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+# GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+# OF THE POSSIBILITY OF SUCH DAMAGE.
+# Qunaibit 02/05/2014
+# With Statement
 
 import sys
 import os
@@ -46,11 +33,9 @@
 import zipimport
 from zipimport import ZipImportError
 
-
 from test import support
 from zipfile import ZipFile, ZipInfo, ZIP_STORED, ZIP_DEFLATED
 
-
 test_src = """\
 def get_name():
     return __name__
@@ -63,7 +48,6 @@ def get_file():
 ZIP_PATH = os.path.join(DIR_PATH, ZIP_FILE_NAME)
 ZIP_ABS_PATH = os.path.abspath(ZIP_PATH);
 
-
 class ZipImportBaseTestCase(unittest.TestCase):
 
     def setUp(self):
@@ -82,12 +66,11 @@ def tearDown(self):
         support.modules_cleanup(*self.modules_before)
 
 class BasicZipImportTests(ZipImportBaseTestCase):
-    
+
     def setUp(self):
         ZipImportBaseTestCase.setUp(self)
         self.z = zipimport.zipimporter(ZIP_PATH)
 
-
     def test_zipimporter_attribute(self):
         self.assertTrue(self.z.prefix == "")
         self.assertTrue(self.z.archive == ZIP_ABS_PATH)
@@ -98,7 +81,7 @@ def test_zipimporter_attribute(self):
         self.assertTrue(self.z._files["cesta/moduleA.py"] is not None)
 
     def test_create_zipimport_from_string(self):
-        zipimport._zip_directory_cache.clear()        
+        zipimport._zip_directory_cache.clear()
         z = zipimport.zipimporter(ZIP_PATH)
         self.assertTrue(zipimport._zip_directory_cache[ZIP_ABS_PATH] is not None)
 
@@ -114,12 +97,12 @@ def __init__(self, path):
                 self.value = path
             def __fspath__(self):
                 return self.value
-                
+
         zipimport._zip_directory_cache.clear()
         mp = MyPath(ZIP_PATH)
         z = zipimport.zipimporter(mp)
         self.assertTrue(zipimport._zip_directory_cache[os.path.abspath(ZIP_PATH)] is not None)
-        
+
     def test_zipimporter_find_module(self):
         self.assertTrue(self.z is self.z.find_module("MyTestModule"))
         self.assertTrue(self.z is self.z.find_module("packageA"))
@@ -175,11 +158,11 @@ def test_zipimporter_load_module(self):
         self.assertTrue(self.z.load_module("packageA/moduleC").__loader__ is self.z)
         self.assertTrue(self.z.load_module("cesta/moduleA").__loader__ is self.z)
         self.assertRaises(ZipImportError, self.z.load_module, "packageA.moduleC")
-    
+
 class ZipImportWithPrefixTests(ZipImportBaseTestCase):
 
     def setUp(self):
-        ZipImportBaseTestCase.setUp(self)        
+        ZipImportBaseTestCase.setUp(self)
         self.z = zipimport.zipimporter(ZIP_PATH + "/cesta")
 
     def tearDown(self):
@@ -202,15 +185,13 @@ def test_zipimporter_with_prefix_find_module(self):
         self.assertTrue(self.z is self.z.find_module("moduleA"))
 
 class ImportTests(ZipImportBaseTestCase):
-    
+
     def setUp(self):
         ZipImportBaseTestCase.setUp(self)
         sys.path.insert(0, ZIP_PATH)
-    
+
     def test_module_import(self):
         m = importlib.import_module("MyTestModule")
         self.assertTrue (m.get_file() == ZIP_ABS_PATH + "/MyTestModule.py")
         p = importlib.import_module("packageA.moduleC")
         self.assertTrue (p.get_file() == ZIP_ABS_PATH + "/packageA/moduleC.py")
-        
-    

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

@@ -211,7 +211,8 @@ private static final String[] initializeCoreFiles() {
                         "function",
                         "_sysconfig",
                         "_socket",
-                        "_thread"));
+                        "_thread",
+                        "zipimport"));
 
         return coreFiles.toArray(new String[coreFiles.size()]);
     }
@@ -304,7 +305,7 @@ private static final PythonBuiltins[] initializeBuiltins() {
                         new CtypesModuleBuiltins(),
                         new ReadlineModuleBuiltins(),
                         new PyExpatModuleBuiltins(),
-                        new SysConfigModuleBuiltins()));
+                        new SysConfigModuleBuiltins(),
                         new ZipImporterBuiltins(),
                         new ZipImportModuleBuiltins()));
         if (!TruffleOptions.AOT) {

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/modules/ZipImportModuleBuiltins.java

@@ -46,19 +46,27 @@
 import com.oracle.graal.python.builtins.CoreFunctions;
 import com.oracle.graal.python.builtins.PythonBuiltinClassType;
 import com.oracle.graal.python.builtins.PythonBuiltins;
+import com.oracle.graal.python.builtins.objects.dict.PDict;
+import com.oracle.graal.python.builtins.objects.module.PythonModule;
 import com.oracle.graal.python.builtins.objects.type.PythonClass;
 import com.oracle.graal.python.builtins.objects.zipimporter.PZipImporter;
 import com.oracle.graal.python.builtins.objects.zipimporter.ZipImporterBuiltins;
+import com.oracle.graal.python.nodes.attributes.ReadAttributeFromObjectNode;
 import com.oracle.graal.python.nodes.function.PythonBuiltinBaseNode;
 import com.oracle.graal.python.nodes.function.builtins.PythonBinaryBuiltinNode;
 import com.oracle.graal.python.runtime.PythonCore;
+import com.oracle.truffle.api.dsl.Cached;
 import com.oracle.truffle.api.dsl.GenerateNodeFactory;
 import com.oracle.truffle.api.dsl.NodeFactory;
 import com.oracle.truffle.api.dsl.Specialization;
 
-@CoreFunctions(defineModule = "zipimport")
+@CoreFunctions(defineModule = ZipImportModuleBuiltins.ZIPIMPORT_MODULE_NAME)
 public class ZipImportModuleBuiltins extends PythonBuiltins {
 
+    protected static final String ZIPIMPORT_MODULE_NAME = "zipimport";
+
+    private static final String ZIP_DIRECTORY_CACHE_NAME = "_zip_directory_cache";
+
     private static final String ZIPIMPORTER_DOC = "zipimporter(archivepath) -> zipimporter object\n" +
                     "\n" +
                     "Create a new zipimporter instance. 'archivepath' must be a path to\n" +
@@ -76,7 +84,7 @@ public ZipImportModuleBuiltins() {
     @Override
     public void initialize(PythonCore core) {
         super.initialize(core);
-        builtinConstants.put("_zip_directory_cache", ZipImporterBuiltins.getCache(core.factory()));
+        builtinConstants.put(ZIP_DIRECTORY_CACHE_NAME, core.factory().createDict());
 
     }
 
@@ -85,8 +93,10 @@ public void initialize(PythonCore core) {
     public abstract static class ZipImporterNode extends PythonBinaryBuiltinNode {
 
         @Specialization
-        public PZipImporter createNew(PythonClass cls, @SuppressWarnings("unused") Object path) {
-            return factory().createZipImporter(cls);
+        public PZipImporter createNew(PythonClass cls, @SuppressWarnings("unused") Object path,
+                        @Cached("create()") ReadAttributeFromObjectNode readNode) {
+            PythonModule module = getCore().lookupBuiltinModule(ZIPIMPORT_MODULE_NAME);
+            return factory().createZipImporter(cls, (PDict) readNode.execute(module, ZIP_DIRECTORY_CACHE_NAME));
         }
 
     }

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/zipimporter/PZipImporter.java

@@ -58,6 +58,11 @@ public class PZipImporter extends PythonBuiltinObject {
      */
     private PDict files;
 
+    /**
+     * Cache of the files in the zipfile. Exported in ZipimportModuleBuiltins
+     */
+    private final PDict moduleZipDirectoryCache;
+
     /**
      * Is the entry source or package
      */
@@ -105,9 +110,11 @@ public static enum ModuleInfo {
         PACKAGE
     }
 
-    public PZipImporter(LazyPythonClass cls) {
+    public PZipImporter(LazyPythonClass cls, PDict zipDirectoryCache) {
         super(cls);
         this.archive = null;
+        this.prefix = null;
+        this.moduleZipDirectoryCache = zipDirectoryCache;
         if (searchOrder == null) { // define the order once
             searchOrder = defineSearchOrder();
         }
@@ -121,6 +128,10 @@ private static SearchOrderEntry[] defineSearchOrder() {
         };
     }
 
+    public PDict getZipDirectoryCache() {
+        return moduleZipDirectoryCache;
+    }
+
     /**
      *
      * @return pathname of the Zip archive

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/zipimporter/ZipImporterBuiltins.java

@@ -78,21 +78,17 @@
 @CoreFunctions(extendClasses = PythonBuiltinClassType.PZipImporter)
 public class ZipImporterBuiltins extends PythonBuiltins {
 
-    /**
-     * cache of the interesting files in the zipfile. exported in ZipimportModuleBuiltins
-     */
-    private static PDict zip_directory_cache;
+    private static final String INIT_WAS_NOT_CALLED = "zipimporter.__init__() wasn't called";
 
     @Override
     protected List<? extends NodeFactory<? extends PythonBuiltinBaseNode>> getNodeFactories() {
         return ZipImporterBuiltinsFactory.getFactories();
     }
 
-    public static PDict getCache(PythonObjectFactory factory) {
-        if (zip_directory_cache == null) {
-            zip_directory_cache = factory.createDict();
+    private static void checkInitCalled(PZipImporter self) {
+        if (self.getPrefix() == null) {
+
         }
-        return zip_directory_cache;
     }
 
     @Builtin(name = __INIT__, fixedNumOfPositionalArgs = 1)
@@ -144,7 +140,7 @@ private void initZipImporter(PZipImporter self, String path) {
             if (zipFile == null) {
                 throw raise(PythonErrorType.ZipImportError, "not a Zip file");
             }
-            Object files = zip_directory_cache.getItem(path);
+            Object files = self.getZipDirectoryCache().getItem(path);
             if (files == null) {
                 PDict filesDict = factory().createDict();
                 Enumeration<? extends ZipEntry> entries = zipFile.entries();
@@ -163,7 +159,7 @@ private void initZipImporter(PZipImporter self, String path) {
                     filesDict.setItem(entry.getName(), tuple);
                 }
                 files = filesDict;
-                zip_directory_cache.setItem(path, files);
+                self.getZipDirectoryCache().setItem(path, files);
             }
             self.setArchive(archive);
             self.setPrefix(prefix);
@@ -263,7 +259,11 @@ public abstract static class FindModuleNode extends PythonTernaryBuiltinNode {
          * @return the zipimporter or none, if the module is not found
          */
         @Specialization
-        public Object doit(PZipImporter self, String fullname, @SuppressWarnings("unused") Object path) {
+        public Object doit(PZipImporter self, String fullname, @SuppressWarnings("unused") Object path,
+                        @Cached("createBinaryProfile()") ConditionProfile initWasNotCalled) {
+            if (initWasNotCalled.profile(self.getPrefix() == null)) {
+                throw raise(PythonErrorType.ValueError, INIT_WAS_NOT_CALLED);
+            }
             return self.findModule(fullname) == null ? PNone.NONE : self;
         }
 
@@ -278,7 +278,11 @@ public abstract static class GetCodeNode extends PythonBinaryBuiltinNode {
 
         @Specialization
         public PCode doit(PZipImporter self, String fullname,
-                        @Cached("createBinaryProfile()") ConditionProfile canNotFind) {
+                        @Cached("createBinaryProfile()") ConditionProfile canNotFind,
+                        @Cached("createBinaryProfile()") ConditionProfile initWasNotCalled) {
+            if (initWasNotCalled.profile(self.getPrefix() == null)) {
+                throw raise(PythonErrorType.ValueError, INIT_WAS_NOT_CALLED);
+            }
             if (compileNode == null) {
                 CompilerDirectives.transferToInterpreterAndInvalidate();
                 compileNode = insert(CompileNode.create());
@@ -304,6 +308,9 @@ public abstract static class GetDataNode extends PythonBinaryBuiltinNode {
         @Specialization
         @CompilerDirectives.TruffleBoundary
         public PBytes doit(PZipImporter self, String pathname) {
+            if (self.getPrefix() == null) {
+                throw raise(PythonErrorType.ValueError, INIT_WAS_NOT_CALLED);
+            }
             String archive = self.getArchive();
             int len = archive.length();
             int index = 0;
@@ -344,7 +351,11 @@ public abstract static class GetFileNameNode extends PythonBinaryBuiltinNode {
 
         @Specialization
         public Object doit(PZipImporter self, String fullname,
-                        @Cached("createBinaryProfile()") ConditionProfile canNotFind) {
+                        @Cached("createBinaryProfile()") ConditionProfile canNotFind,
+                        @Cached("createBinaryProfile()") ConditionProfile initWasNotCalled) {
+            if (initWasNotCalled.profile(self.getPrefix() == null)) {
+                throw raise(PythonErrorType.ValueError, INIT_WAS_NOT_CALLED);
+            }
             ModuleCodeData moduleCodeData = self.getModuleCode(fullname);
             if (canNotFind.profile(moduleCodeData == null)) {
                 throw raise(PythonErrorType.ZipImportError, " can't find module '%s'", fullname);
@@ -361,7 +372,11 @@ public abstract static class GetSourceNode extends PythonBinaryBuiltinNode {
 
         @Specialization
         public String doit(PZipImporter self, String fullname,
-                        @Cached("createBinaryProfile()") ConditionProfile canNotFind) {
+                        @Cached("createBinaryProfile()") ConditionProfile canNotFind,
+                        @Cached("createBinaryProfile()") ConditionProfile initWasNotCalled) {
+            if (initWasNotCalled.profile(self.getPrefix() == null)) {
+                throw raise(PythonErrorType.ValueError, INIT_WAS_NOT_CALLED);
+            }
             ModuleCodeData md = self.getModuleCode(fullname);
             if (canNotFind.profile(md == null)) {
                 throw raise(PythonErrorType.ZipImportError, "can't find module '%s'", fullname);
@@ -378,7 +393,11 @@ public abstract static class IsPackageNode extends PythonBinaryBuiltinNode {
 
         @Specialization
         public boolean doit(PZipImporter self, String fullname,
-                        @Cached("createBinaryProfile()") ConditionProfile canNotFind) {
+                        @Cached("createBinaryProfile()") ConditionProfile canNotFind,
+                        @Cached("createBinaryProfile()") ConditionProfile initWasNotCalled) {
+            if (initWasNotCalled.profile(self.getPrefix() == null)) {
+                throw raise(PythonErrorType.ValueError, INIT_WAS_NOT_CALLED);
+            }
             ModuleInfo moduleInfo = self.getModuleInfo(fullname);
             if (canNotFind.profile(moduleInfo == ModuleInfo.NOT_FOUND)) {
                 throw raise(PythonErrorType.ZipImportError, "can't find module '%s'", fullname);
@@ -396,7 +415,9 @@ public abstract static class LoadModuleNode extends PythonBinaryBuiltinNode {
         @Specialization
         public Object doit(PZipImporter self, String fullname,
                         @Cached("create()") GetCodeNode getCodeNode,
-                        @Cached("createBinaryProfile()") ConditionProfile canNotFind) {
+                        @Cached("createBinaryProfile()") ConditionProfile canNotFind,
+                        @Cached("createBinaryProfile()") ConditionProfile initWasNotCalled) {
+            PCode code = getCodeNode.doit(self, fullname, canNotFind, initWasNotCalled);
 
             PythonModule sysModule = getCore().lookupBuiltinModule("sys");
             PDict sysModules = (PDict) sysModule.getAttribute("modules");
@@ -405,7 +426,7 @@ public Object doit(PZipImporter self, String fullname,
                 module = getCore().factory().createPythonModule(fullname);
                 sysModules.setItem(fullname, module);
             }
-            PCode code = getCodeNode.doit(self, fullname, canNotFind);
+
             module.setAttribute(SpecialAttributeNames.__LOADER__, self);
             module.setAttribute(SpecialAttributeNames.__FILE__, code.getFilename());
             if (ModuleInfo.PACKAGE == self.getModuleInfo(fullname)) {