Merge pull request #7 from psavery/python-site-packages

Ensure tomviz built-in Python libraries get installed correctly

Author: celiafish

CMakeLists.txt

@@ -32,8 +32,18 @@ if(UNIX AND NOT APPLE)
   endif()
 endif()
 
+find_package(Python3 COMPONENTS Interpreter Development)
+
+# Just add these to the cache so we can check them more easily...
+set(PYTHON_INCLUDE_DIR ${Python3_INCLUDE_DIR} CACHE PATH "Tomviz")
+set(PYTHON_LIBRARY ${Python3_LIBRARY} CACHE PATH "Tomviz")
+set(PYTHON_EXECUTABLE ${Python3_EXECUTABLE} CACHE PATH "Tomviz")
+
+# This will be used by tomvizPythonConfig.h.in
+add_definitions(-DPYTHON_VERSION_MINOR="${Python3_VERSION_MINOR}")
+
 # Location where Python modules will be installed.
-set(tomviz_python_install_dir "${INSTALL_LIBRARY_DIR}/tomviz/site-packages")
+set(tomviz_python_install_dir "${INSTALL_LIBRARY_DIR}/python3.${Python3_VERSION_MINOR}/site-packages")
 # Location where Python modules will be copied to in binary tree.
 set(tomviz_python_binary_dir "${tomviz_BINARY_DIR}/lib/site-packages")
 # Location where sample data will be installed.
@@ -55,12 +65,14 @@ if(APPLE)
   set(INSTALL_DATA_DIR    "${prefix}/${INSTALL_DATA_DIR}")
   set(INSTALL_DOC_DIR     "${prefix}/${INSTALL_DOC_DIR}")
   set(INSTALL_CMAKE_DIR   "${prefix}/Resources")
-  set(tomviz_python_install_dir "${prefix}/Python")
   set(tomviz_data_install_dir "${prefix}/share/tomviz")
   set(tomviz_web_install_dir "${prefix}/share/tomviz/web")
   if(NOT CMAKE_INSTALL_NAME_DIR)
     set(CMAKE_INSTALL_NAME_DIR "${CMAKE_INSTALL_PREFIX}/${INSTALL_LIBRARY_DIR}")
   endif()
+elseif(WIN32)
+  # Windows is a little different...
+  set(tomviz_python_install_dir "lib/site-packages")
 endif()
 
 # Get the relative path from the tomviz executable install location
@@ -134,17 +146,6 @@ endif()
 
 find_package(ITK 4.9)
 
-# Many things changed in the find Python logic and ParaView's willingness to
-# share what version of Python it built against. In the end it wasn't worth
-# trying to support doing this automatically - try to feed everything the same
-# version of Python, using a superbuild will make this easier for you.
-find_package(Python3 COMPONENTS Interpreter Development)
-
-# Just add these to the cache so we can check them more easily...
-set(PYTHON_INCLUDE_DIR ${Python3_INCLUDE_DIR} CACHE PATH "Tomviz")
-set(PYTHON_LIBRARY ${Python3_LIBRARY} CACHE PATH "Tomviz")
-set(PYTHON_EXECUTABLE ${Python3_EXECUTABLE} CACHE PATH "Tomviz")
-
 set(PYBIND11_CPP_STANDARD "-std=c++11" CACHE STRING "")
 add_subdirectory(${PROJECT_SOURCE_DIR}/thirdparty/pybind11)
 

tomviz/python/tomviz/state/_schemata.py

@@ -212,11 +212,11 @@ def remove_empty(self, data, **kwargs):
 
 
 class DataSourceSchema(Schema):
-    operators = fields.List(OperatorField, missing=lambda: [])
+    operators = fields.List(OperatorField)
     colorMap2DBox = fields.Nested(ColorMap2DBoxSchema)
     colorOpacityMap = fields.Nested(ColorOpacityMap)
     gradientOpacityMap = fields.Nested(GradientOpacityMap)
-    modules = fields.List(ModuleField, missing=lambda: [])
+    modules = fields.List(ModuleField)
     useDetachedColorMap = fields.Boolean()
     spacing = fields.List(fields.Float)
     units = fields.String()

tomviz/tomvizPythonConfig.h.in

@@ -18,11 +18,15 @@
 #define TOMVIZ_DATA_INSTALL_DIR "@tomviz_data_install_dir@/Data"
 #define TOMVIZ_PATH_FROM_EXE_TO_PYTHON_INSTALL_DIR "@tomviz_path_from_exe_to_python_install_dir@"
 
+#include <cstdlib>
 #include <string>
 #include <vtksys/SystemTools.hxx>
 
 #include "PythonUtilities.h"
 
+// Used for determining paths to the site packages
+static const std::string PYTHON_VER = "3." PYTHON_VERSION_MINOR;
+
 namespace tomviz {
 void PythonAppInitPrependPythonPath(const std::string& dir)
 {
@@ -62,6 +66,16 @@ void PythonAppInitPrependPathWindows(const std::string& exe_dir)
     PythonAppInitPrependPythonPath(exe_dir +
                                    "/../lib/paraview/site-packages/vtk");
     PythonAppInitPrependPythonPath(exe_dir + "/../lib/itk/site-packages");
+    PythonAppInitPrependPythonPath(exe_dir +
+                                   "/../lib/python" +
+                                   PYTHON_VER +
+                                   "/site-packages");
+  }
+
+  // Prepend conda prefix site packages if available
+  std::string conda_prefix = std::getenv("CONDA_PREFIX");
+  if (!conda_prefix.empty()) {
+    PythonAppInitPrependPythonPath(conda_prefix + "/Lib/site-packages");
   }
 }
 
@@ -87,14 +101,27 @@ void PythonAppInitPrependPathLinux(const std::string& exe_dir)
     // since exe_dir in <PREFiX>/bin, we do a  /../
     PythonAppInitPrependPythonPath(exe_dir + "/../" TOMVIZ_PYTHON_INSTALL_DIR);
 
-    // Add the location for numpy and scipy
-    PythonAppInitPrependPythonPath(exe_dir + "/../lib/python3.7/site-packages");
+    auto python_path = exe_dir + "/../lib/python" + PYTHON_VER;
 
-    // Add root python3.7 dir
-    PythonAppInitPrependPythonPath(exe_dir + "/../lib/python3.7");
+    // Add root python dir
+    PythonAppInitPrependPythonPath(python_path);
+
+    // Add the location for numpy and scipy
+    PythonAppInitPrependPythonPath(python_path + "/site-packages");
 
     // Add the location of python .so libraries
-    PythonAppInitPrependPythonPath(exe_dir + "/../lib/python3.7/lib-dynload");
+    PythonAppInitPrependPythonPath(python_path + "/lib-dynload");
+  }
+
+  // Prepend conda prefix site packages if available
+  std::string conda_prefix = std::getenv("CONDA_PREFIX");
+  if (!conda_prefix.empty()) {
+    PythonAppInitPrependPythonPath(
+        conda_prefix +
+        "/lib/python" +
+        PYTHON_VER +
+        "/site-packages"
+    );
   }
 }
 
@@ -119,11 +146,24 @@ void PythonAppInitPrependPathOsX(const std::string& exe_dir)
     // we don't add anything for ParaView since, ParaView takes care of that.
     PythonAppInitPrependPythonPath(exe_dir + "/../Libraries/");
     PythonAppInitPrependPythonPath(exe_dir +
-                                   "/../Libraries/python3.7/site-packages");
+                                   "/../Libraries/python" +
+                                   PYTHON_VER +
+                                   "/site-packages");
     PythonAppInitPrependPythonPath(exe_dir + "/../Python");
     PythonAppInitPrependPythonPath(exe_dir + "/../Python/lib-dynload");
     PythonAppInitPrependPythonPath(exe_dir + "/../Python/site-packages");
   }
+
+  // Prepend conda prefix site packages if available
+  std::string conda_prefix = std::getenv("CONDA_PREFIX");
+  if (!conda_prefix.empty()) {
+    PythonAppInitPrependPythonPath(
+        conda_prefix +
+        "/lib/python" +
+        PYTHON_VER +
+        "/site-packages"
+    );
+  }
 }
 
 bool isApplicationBundle(const std::string& exeDir)
@@ -147,7 +187,7 @@ std::string bundlePythonPath(const std::string& exeDir)
 #elif defined(_WIN32)
   return "";
 #else
-  return exeDir + "/../lib/python3.7";
+  return exeDir + "/../lib/python" + PYTHON_VER;
 #endif
 }