now bundling requests and cachecontrol modules

samizdatco · samizdatco · commit fe5ac83934dd · 2015-06-30T17:43:49.000-04:00
- they get copied into the Resources/python folder of the app
(alongside the plotdevice module)
- for pip installs of the stand-alone module, the http libs are listed
as requirements rather than handled explicitly in the build process
diff --git a/PlotDevice.xcodeproj/project.pbxproj b/PlotDevice.xcodeproj/project.pbxproj
@@ -458,7 +458,7 @@
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 			shellPath = /bin/sh;
-			shellScript = "# have the build fail if setup.py isn't successful\nset -e\n\n# let the setup script handle updating\n$PYTHON setup.py build\n\n# copy the up-to-date module contents into the app bundle\nEXT_DIR=\"$TARGET_BUILD_DIR/$UNLOCALIZED_RESOURCES_FOLDER_PATH/python/\"\nmkdir -p $EXT_DIR\nditto build/lib/plotdevice \"$EXT_DIR/plotdevice\"\n\n# make sure everything has a .pyc (so code-signing doesn't break on first run)\n$PYTHON -m compileall \"$EXT_DIR/plotdevice\"";
+			shellScript = "# have the build fail if setup.py isn't successful\nset -e\n\n# let the setup script handle updating\n$PYTHON setup.py build\n\n# copy the up-to-date module contents into the app bundle\nSITE_DIR=\"$TARGET_BUILD_DIR/$UNLOCALIZED_RESOURCES_FOLDER_PATH/python\"\nditto build/lib \"$SITE_DIR\"\n\n# make sure everything has a .pyc (so code-signing doesn't break on first run)\n$PYTHON -m compileall -q \"$SITE_DIR/plotdevice\"";
 			showEnvVarsInLog = 0;
 		};
 		2AF8981419953CA1005A49A5 /* Manually Update Examples */ = {
diff --git a/app/deps/PyObjC/Makefile b/app/deps/PyObjC/Makefile
diff --git a/app/deps/build.py b/app/deps/build.py
@@ -2,58 +2,90 @@
 import os
 import sys
 import errno
+from subprocess import call
 from glob import glob
-from os.path import dirname, basename, abspath, isdir, join, exists
+from os.path import dirname, basename, abspath, isdir, join
+from shutil import rmtree
 
-libs_root = dirname(abspath(__file__))
+DEPS = dirname(abspath(__file__))
+PYTHON = sys.executable
 
-def build_libraries(dst_root):
-    print("\nCompiling required c-extensions")
+## Helpers ##
+
+def build(extension):
+    """Run setup.py within a given c-extension's folder"""
+    result = call([PYTHON, 'setup.py', '-q', 'build'], cwd=join(DEPS, extension))
+    if result > 0:
+        raise OSError("Could not build %s" % extension)
+
+def make(target, **envvars):
+    """Build the specified target in the vendor Makefile"""
+    os.chdir('%s/vendor'%DEPS)
+    env = {"PYTHON":PYTHON, "PATH":os.environ['PATH']}
+    env.update(envvars)
+    result = call('make -s %s'%target, env=env, shell=True)
+    if result > 0:
+        raise OSError("Could not make %s" % target)
+    os.chdir(DEPS)
 
+def clean():
+    """Delete build folders in dependency subdirs"""
+    build_dirs = glob('%s/*/build'%DEPS)
+    for build_dir in build_dirs:
+        lib_name = dirname(build_dir)
+        print("Cleaning", lib_name)
+        call('rm -r "%s"' % build_dir)
+    make('clean')
+
+## Recipes ##
+
+def build_extensions():
     # Find all setup.py files in the current folder
-    setup_scripts = glob('%s/*/setup.py'%libs_root)
-    for setup_script in setup_scripts:
+    print("\nCompiling required c-extensions")
+    for setup_script in glob('%s/*/setup.py'%DEPS):
         lib_name = basename(dirname(setup_script))
         print("Building %s..."% lib_name)
-        os.chdir(dirname(setup_script))
-        result = os.system(sys.executable+' setup.py -q build') # call the lib's setup.py
-        if result > 0:
-            raise OSError("Could not build %s" % lib_name)
-        os.chdir(libs_root)
+        build(lib_name)
+
+    print("Building pyobjc...")
+    make('pyobjc')
 
+def install_extensions(ext_root):
+    """Install the c-extensions and PyObjC site dir within the plotdevice module"""
     # Make sure the destination folder exists.
-    if not isdir(dst_root):
-        os.makedirs(dst_root)
+    if not isdir(ext_root):
+        os.makedirs(ext_root)
 
-    # Copy all build results to the ../../build/deps folder.
-    build_dirs = glob("%s/*/build/lib*"%libs_root)
-    for build_dir in build_dirs:
-        lib_name = dirname(dirname(build_dir))
-        cmd = 'cp -R -p %s/* %s' % (build_dir, dst_root)
-        print(cmd)
-        result = os.system(cmd)
+    # Copy all build results to plotdevice/lib dir
+    for extension in glob("%s/*/build/lib*"%DEPS):
+        cmd = 'cp -R -p %s/* %s' % (extension, ext_root)
+        result = call(cmd, shell=True)
         if result > 0:
+            lib_name = dirname(dirname(extension))
             raise OSError("Could not copy %s" % lib_name)
     print()
 
-def clean_build_files():
-    print("Cleaning all library build files...")
-
-    build_dirs = glob('%s/*/build'%libs_root)
-    for build_dir in build_dirs:
-        lib_name = dirname(build_dir)
-        print("Cleaning", lib_name)
-        os.system('rm -r "%s"' % build_dir)
+def install_http_libs(mod_root):
+    """Install the http modules into the Resources/python subdir"""
+    if 'ACTION' not in os.environ:
+        # the ACTION env var will be defined for app and py2app builds, in which
+        # case we should install the http libs into Resources/python (for non-GUI
+        # builds, setup.py's install_requires will pull in dependencies automatically)
+        return
+    print("Bundling requests module...")
+    make('http', DSTROOT=mod_root) # makefile uses DSTROOT to target install
 
 if __name__=='__main__':
-    import sys
-
     if len(sys.argv)>1:
         arg = sys.argv[1]
         if arg=='clean':
-            clean_build_files()
+            print("Cleaning dependency build files...")
+            clean()
         else:
-            dst_root = join(arg, 'plotdevice/lib')
-            build_libraries(dst_root)
+            mod_root = arg
+            ext_root = join(mod_root, 'plotdevice/lib')
+            build_extensions()
+            install_http_libs(mod_root)
+            install_extensions(ext_root)
     else:
         print("usage: python build.py <destination-path>")
diff --git a/app/deps/vendor/Makefile b/app/deps/vendor/Makefile
@@ -2,6 +2,9 @@
 PYTHON ?= /usr/bin/python
 PY_VERSION = $(shell $(PYTHON) -c 'import sys; print("py%i%i"%sys.version_info[:2])')
 
+# dependencies to be fetched
+HTTP_MODULES = requests cachecontrol
+
 VENV_VERSION = 13.0.3
 VENV_SRC = virtualenv-$(VENV_VERSION).tar.gz
 VENV_URL = https://pypi.python.org/packages/source/v/virtualenv/$(VENV_SRC)
@@ -15,6 +18,7 @@ BUILD = build
 ENV = $(BUILD)/env
 WHEELHOUSE = $(BUILD)/wheelhouse
 PYOBJC = $(BUILD)/lib/PyObjC
+DSTROOT ?= $(BUILD)/HTTP
 
 # commands
 CURL = @curl -L --progress-bar -f
@@ -42,6 +46,11 @@ wheels: clean $(ENV)
 	$(PIP) wheel "pyobjc"==$(OBJC_VERSION) -w ${WHEELHOUSE}
 	tar czfv $(OBJC_SRC) -C $(BUILD) $(notdir ${WHEELHOUSE})
 
+# fetch the current versions of our helper modules
+http: $(ENV)
+	$(ENV)/bin/pip -q install --target=$(DSTROOT) $(HTTP_MODULES)
+	rm -rf $(DSTROOT)/*.dist-info
+
 # ---------------------------------------------------------------------------------------- #
 
 # fetch the current version of virtualenv (which we mostly use for its copy of pip)
diff --git a/setup.py b/setup.py
@@ -191,6 +191,7 @@ def run(self):
         self.spawn(['/usr/bin/ibtool','--compile', '%s/viewer.nib'%rsrc_dir, "app/Resources/English.lproj/PlotDeviceScript.xib"])
         self.copy_file("app/Resources/PlotDeviceFile.icns", '%s/viewer.icns'%rsrc_dir)
 
+
 class BuildAppCommand(Command):
     description = "Build PlotDevice.app with xcode"
     user_options = []
@@ -231,6 +232,8 @@ def initialize_options(self):
         def finalize_options(self):
             self.verbose=0
             build_py2app.finalize_options(self)
+            os.environ['ACTION'] = 'build' # flag for app/deps/build.py
+
         def run(self):
             build_py2app.run(self)
             if self.dry_run:
@@ -243,20 +246,19 @@ def run(self):
             # set up internal paths and ensure destination dirs exist
             RSRC = self.resdir
             BIN = join(dirname(RSRC), 'SharedSupport')
-            MODULE = join(self.bdist_base, 'lib/plotdevice')
-            PY = join(RSRC, 'python')
-            for pth in BIN, PY:
-                self.mkpath(pth)
+            LIB = join(RSRC, 'python')
+            MODULES = join(self.bdist_base, 'lib')
 
             # install the module in Resources/python
-            self.spawn(['/usr/bin/ditto', MODULE, join(PY, 'plotdevice')])
+            self.spawn(['/usr/bin/ditto', MODULES, LIB])
 
             # discard the eggery-pokery
             remove_tree(join(RSRC,'lib'), dry_run=self.dry_run)
             os.unlink(join(RSRC,'include'))
             os.unlink(join(RSRC,'site.pyc'))
 
             # place the command line tool in SharedSupport
+            self.mkpath(BIN)
             self.copy_file("app/plotdevice", BIN)
 
             # success!
@@ -302,7 +304,7 @@ def run(self):
         )
 
         # Download Sparkle (if necessary) and copy it into the bundle
-        ORIG = 'app/deps/Sparkle-%s/Sparkle.framework'%SPARKLE_VERSION
+        ORIG = 'app/deps/vendor/Sparkle-%s/Sparkle.framework'%SPARKLE_VERSION
         SPARKLE = join(APP,'Contents/Frameworks/Sparkle.framework')
         if not exists(ORIG):
             self.mkpath(dirname(ORIG))
@@ -385,7 +387,8 @@ def run(self):
             cmdclass={
                 'build_py': BuildCommand,
                 'py2app': BuildPy2AppCommand,
-            }
+            },
+            install_requires=[]
         ))
 
     # begin the build process
