Commit 17bef673 authored by Sergei Lebedev's avatar Sergei Lebedev

Allowed importing pyx files from ZIP archives

parent 0d27e211
""" """
Import hooks; when installed with the install() function, these hooks Import hooks; when installed with the install() function, these hooks
allow importing .pyx files as if they were Python modules. allow importing .pyx files as if they were Python modules.
If you want the hook installed every time you run Python If you want the hook installed every time you run Python
you can add it to your Python version by adding these lines to you can add it to your Python version by adding these lines to
sitecustomize.py (which you can create from scratch in site-packages sitecustomize.py (which you can create from scratch in site-packages
if it doesn't exist there or somewhere else on your python path):: if it doesn't exist there or somewhere else on your python path)::
import pyximport import pyximport
...@@ -47,10 +47,11 @@ the documentation. ...@@ -47,10 +47,11 @@ the documentation.
This code is based on the Py2.3+ import protocol as described in PEP 302. This code is based on the Py2.3+ import protocol as described in PEP 302.
""" """
import sys
import os
import glob import glob
import imp import imp
import os
import sys
from zipimport import zipimporter, ZipImportError
mod_name = "pyximport" mod_name = "pyximport"
...@@ -79,8 +80,8 @@ def _info(message, *args): ...@@ -79,8 +80,8 @@ def _info(message, *args):
# Performance problem: for every PYX file that is imported, we will # Performance problem: for every PYX file that is imported, we will
# invoke the whole distutils infrastructure even if the module is # invoke the whole distutils infrastructure even if the module is
# already built. It might be more efficient to only do it when the # already built. It might be more efficient to only do it when the
# mod time of the .pyx is newer than the mod time of the .so but # mod time of the .pyx is newer than the mod time of the .so but
# the question is how to get distutils to tell me the name of the .so # the question is how to get distutils to tell me the name of the .so
# before it builds it. Maybe it is easy...but maybe the peformance # before it builds it. Maybe it is easy...but maybe the peformance
...@@ -94,7 +95,7 @@ def get_distutils_extension(modname, pyxfilename, language_level=None): ...@@ -94,7 +95,7 @@ def get_distutils_extension(modname, pyxfilename, language_level=None):
# import hashlib # import hashlib
# except ImportError: # except ImportError:
# import md5 as hashlib # import md5 as hashlib
# extra = "_" + hashlib.md5(open(pyxfilename).read()).hexdigest() # extra = "_" + hashlib.md5(open(pyxfilename).read()).hexdigest()
# modname = modname + extra # modname = modname + extra
extension_mod,setup_args = handle_special_build(modname, pyxfilename) extension_mod,setup_args = handle_special_build(modname, pyxfilename)
if not extension_mod: if not extension_mod:
...@@ -113,7 +114,7 @@ def handle_special_build(modname, pyxfilename): ...@@ -113,7 +114,7 @@ def handle_special_build(modname, pyxfilename):
special_build = os.path.splitext(pyxfilename)[0] + PYXBLD_EXT special_build = os.path.splitext(pyxfilename)[0] + PYXBLD_EXT
ext = None ext = None
setup_args={} setup_args={}
if os.path.exists(special_build): if os.path.exists(special_build):
# globls = {} # globls = {}
# locs = {} # locs = {}
# execfile(special_build, globls, locs) # execfile(special_build, globls, locs)
...@@ -126,11 +127,11 @@ def handle_special_build(modname, pyxfilename): ...@@ -126,11 +127,11 @@ def handle_special_build(modname, pyxfilename):
make_setup_args = getattr(mod, 'make_setup_args',None) make_setup_args = getattr(mod, 'make_setup_args',None)
if make_setup_args: if make_setup_args:
setup_args = make_setup_args() setup_args = make_setup_args()
assert isinstance(setup_args,dict), ("make_setup_args in %s did not return a dict" assert isinstance(setup_args,dict), ("make_setup_args in %s did not return a dict"
% special_build) % special_build)
assert set or setup_args, ("neither make_ext nor make_setup_args %s" assert set or setup_args, ("neither make_ext nor make_setup_args %s"
% special_build) % special_build)
ext.sources = [os.path.join(os.path.dirname(special_build), source) ext.sources = [os.path.join(os.path.dirname(special_build), source)
for source in ext.sources] for source in ext.sources]
return ext, setup_args return ext, setup_args
...@@ -142,7 +143,7 @@ def handle_dependencies(pyxfilename): ...@@ -142,7 +143,7 @@ def handle_dependencies(pyxfilename):
# by default let distutils decide whether to rebuild on its own # by default let distutils decide whether to rebuild on its own
# (it has a better idea of what the output file will be) # (it has a better idea of what the output file will be)
# but we know more about dependencies so force a rebuild if # but we know more about dependencies so force a rebuild if
# some of the dependencies are newer than the pyxfile. # some of the dependencies are newer than the pyxfile.
if os.path.exists(dependfile): if os.path.exists(dependfile):
depends = open(dependfile).readlines() depends = open(dependfile).readlines()
...@@ -153,7 +154,7 @@ def handle_dependencies(pyxfilename): ...@@ -153,7 +154,7 @@ def handle_dependencies(pyxfilename):
files = [dependfile] files = [dependfile]
for depend in depends: for depend in depends:
fullpath = os.path.join(os.path.dirname(dependfile), fullpath = os.path.join(os.path.dirname(dependfile),
depend) depend)
files.extend(glob.glob(fullpath)) files.extend(glob.glob(fullpath))
# only for unit testing to see we did the right thing # only for unit testing to see we did the right thing
...@@ -191,7 +192,7 @@ def build_module(name, pyxfilename, pyxbuild_dir=None, inplace=False, language_l ...@@ -191,7 +192,7 @@ def build_module(name, pyxfilename, pyxbuild_dir=None, inplace=False, language_l
inplace=inplace, inplace=inplace,
reload_support=pyxargs.reload_support) reload_support=pyxargs.reload_support)
assert os.path.exists(so_path), "Cannot find: %s" % so_path assert os.path.exists(so_path), "Cannot find: %s" % so_path
junkpath = os.path.join(os.path.dirname(so_path), name+"_*") #very dangerous with --inplace ? yes, indeed, trying to eat my files ;) junkpath = os.path.join(os.path.dirname(so_path), name+"_*") #very dangerous with --inplace ? yes, indeed, trying to eat my files ;)
junkstuff = glob.glob(junkpath) junkstuff = glob.glob(junkpath)
for path in junkstuff: for path in junkstuff:
...@@ -249,7 +250,7 @@ class PyxImporter(object): ...@@ -249,7 +250,7 @@ class PyxImporter(object):
def find_module(self, fullname, package_path=None): def find_module(self, fullname, package_path=None):
if fullname in sys.modules and not pyxargs.reload_support: if fullname in sys.modules and not pyxargs.reload_support:
return None # only here when reload() return None # only here when reload()
try: try:
fp, pathname, (ext,mode,ty) = imp.find_module(fullname,package_path) fp, pathname, (ext,mode,ty) = imp.find_module(fullname,package_path)
if fp: fp.close() # Python should offer a Default-Loader to avoid this double find/open! if fp: fp.close() # Python should offer a Default-Loader to avoid this double find/open!
...@@ -300,19 +301,31 @@ class PyxImporter(object): ...@@ -300,19 +301,31 @@ class PyxImporter(object):
paths = package_path paths = package_path
else: else:
paths = sys.path paths = sys.path
join_path = os.path.join
is_file = os.path.isfile
is_abs = os.path.isabs
abspath = os.path.abspath
#is_dir = os.path.isdir
sep = os.path.sep
for path in paths: for path in paths:
if not path: if not path:
path = os.getcwd() path = os.getcwd()
elif not is_abs(path): elif not os.path.isabs(path):
path = abspath(path) path = os.path.abspath(path)
if is_file(path+sep+pyx_module_name):
return PyxLoader(fullname, join_path(path, pyx_module_name), try:
zi = zipimporter(path)
data = zi.get_data(pyx_module_name)
except (ZipImportError, IOError):
pyx_module_path = os.path.join(path, pyx_module_name)
else:
# XXX unzip the imported file into the build dir. A bit
# hacky, but it works!
if not os.path.exists(self.pyxbuild_dir):
os.makedirs(self.pyxbuild_dir)
pyx_module_path = os.path.join(self.pyxbuild_dir,
pyx_module_name)
with open(pyx_module_path, "wb") as handle:
handle.write(data)
if os.path.isfile(pyx_module_path):
return PyxLoader(fullname, pyx_module_path,
pyxbuild_dir=self.pyxbuild_dir, pyxbuild_dir=self.pyxbuild_dir,
inplace=self.inplace, inplace=self.inplace,
language_level=self.language_level) language_level=self.language_level)
...@@ -520,7 +533,7 @@ def install(pyximport=True, pyimport=False, build_dir=None, build_in_temp=True, ...@@ -520,7 +533,7 @@ def install(pyximport=True, pyimport=False, build_dir=None, build_in_temp=True,
setup_args = {} setup_args = {}
if not build_dir: if not build_dir:
build_dir = os.path.join(os.path.expanduser('~'), '.pyxbld') build_dir = os.path.join(os.path.expanduser('~'), '.pyxbld')
global pyxargs global pyxargs
pyxargs = PyxArgs() #$pycheck_no pyxargs = PyxArgs() #$pycheck_no
pyxargs.build_dir = build_dir pyxargs.build_dir = build_dir
......
from __future__ import absolute_import, print_function from __future__ import absolute_import, print_function
from pyximport import pyximport; pyximport.install(reload_support=True) from pyximport import pyximport
pyximport.install(reload_support=True)
import os, sys import os
import time, shutil import shutil
import sys
import tempfile import tempfile
import time
from zipfile import ZipFile
try:
from __builtin__ import reload
except ImportError:
from importlib import reload
def make_tempdir(): def make_tempdir():
...@@ -27,7 +36,7 @@ def on_remove_file_error(func, path, excinfo): ...@@ -27,7 +36,7 @@ def on_remove_file_error(func, path, excinfo):
print("You may want to delete this yourself when you get a chance.") print("You may want to delete this yourself when you get a chance.")
def test(): def test_with_reload():
pyximport._test_files = [] pyximport._test_files = []
tempdir = make_tempdir() tempdir = make_tempdir()
sys.path.append(tempdir) sys.path.append(tempdir)
...@@ -46,7 +55,7 @@ def test(): ...@@ -46,7 +55,7 @@ def test():
build_file.write(""" build_file.write("""
from distutils.extension import Extension from distutils.extension import Extension
def make_ext(name, filename): def make_ext(name, filename):
return Extension(name=name, sources=[filename]) return Extension(name=name, sources=[filename])
""") """)
build_file.close() build_file.close()
...@@ -68,5 +77,27 @@ def make_ext(name, filename): ...@@ -68,5 +77,27 @@ def make_ext(name, filename):
remove_tempdir(tempdir) remove_tempdir(tempdir)
if __name__=="__main__": def test_zip():
test() try:
import test_zip_module
except ImportError:
pass
else:
assert False, "test_zip_module already exists"
fd, zip_path = tempfile.mkstemp(suffix=".zip")
os.close(fd)
try:
with ZipFile(zip_path, "w") as zf:
zf.writestr("test_zip_module.pyx", b"x = 42")
sys.path.insert(0, zip_path)
import test_zip_module
assert test_zip_module.x == 42
finally:
os.remove(zip_path)
if __name__== "__main__":
test_with_reload()
test_zip()
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment