COMP: Place python shared libs as subpackage of itk

Variables that are automatically set should be present in the
CACHE for easier reviewing.

Add sanity check for required file needed for testing When testing, the WrapITK.pth file MUST exist.

Author: hjmjohnson

CMake/ITKModuleExternal.cmake

@@ -37,17 +37,19 @@ endif()
 
 # Setup build locations.
 if(NOT CMAKE_RUNTIME_OUTPUT_DIRECTORY)
-  set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${ITK_DIR}/bin)
+  set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${ITK_DIR}/bin CACHE PATH "Runtime output directory for ITK")
 endif()
 if(NOT CMAKE_LIBRARY_OUTPUT_DIRECTORY)
   if(ITK_WRAP_PYTHON)
-    set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${ITK_DIR}/Wrapping/Generators/Python/itk)
+    # If wrapping for python, then put all the shared libraries (both core shared libs,
+    # and python shared libs in the itk python package directory under swiglib.
+    set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${ITK_DIR}/Wrapping/Generators/Python/itk/swiglib CACHE PATH "Shared library directory, in wrapped directory.")
   else()
-    set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${ITK_DIR}/lib)
+    set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${ITK_DIR}/lib CACHE PATH "Shared library directory")
   endif()
 endif()
 if(NOT CMAKE_ARCHIVE_OUTPUT_DIRECTORY)
-  set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${ITK_DIR}/lib)
+  set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${ITK_DIR}/lib CACHE PATH "Static library install directory")
 endif()
 
 # ITK installation structure

CMake/ITKModuleTest.cmake

@@ -188,12 +188,20 @@ function(itk_python_add_test)
   else()
     set(itk_wrap_python_binary_dir "${ITK_BINARY_DIR}/Wrapping/Generators/Python")
   endif()
+  # itk_wrap_python_binary_dir *MUST* contain the WrapITK.pth file
+  set(WrapITK_PTH_FILE "${itk_wrap_python_binary_dir}/WrapITK.pth")
+  if(NOT EXISTS ${WrapITK_PTH_FILE})
+    # Final installed version of ITK will leverage the WrapITK.pth paths, so
+    # the test environment should also use those same paths.
+    message(FATAL_ERROR "The sys.path must be updated with the WrapITK.pth file content.")
+  endif()
+  unset(WrapITK_PTH_FILE)
 
   if(CMAKE_CONFIGURATION_TYPES)
     itk_add_test(NAME ${PYTHON_ADD_TEST_NAME}
       COMMAND itkTestDriver
       --add-before-env PYTHONPATH "${itk_wrap_python_binary_dir}/$<CONFIG>"          # parent directory of the itk package
-      --add-before-env PYTHONPATH "${itk_wrap_python_binary_dir}/$<CONFIG>/itk"      # directory of the itk package ( contains __init__.py)
+      # NOT NEEDED --add-before-env PYTHONPATH "${itk_wrap_python_binary_dir}/$<CONFIG>/itk"      # directory of the itk package ( contains __init__.py)
       --add-before-env PYTHONPATH "${itk_wrap_python_binary_dir}/$<CONFIG>/itk/conf" # directory of the itkConfig module
       --add-before-env PYTHONPATH "${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/$<CONFIG>"      # directory of shared  libraries + swig artifacts
       --add-before-libpath "${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/$<CONFIG>"             # itk non-wrapping shared libs
@@ -207,7 +215,7 @@ function(itk_python_add_test)
     itk_add_test(NAME ${PYTHON_ADD_TEST_NAME}
       COMMAND itkTestDriver
       --add-before-env PYTHONPATH "${itk_wrap_python_binary_dir}"          # parent directory of the itk package
-      --add-before-env PYTHONPATH "${itk_wrap_python_binary_dir}/itk"      # directory of the itk package ( contains __init__.py)
+      # NOT NEEDED --add-before-env PYTHONPATH "${itk_wrap_python_binary_dir}/itk"      # directory of the itk package ( contains __init__.py)
       --add-before-env PYTHONPATH "${itk_wrap_python_binary_dir}/itk/conf" # directory of the itkConfig module
       --add-before-env PYTHONPATH "${CMAKE_LIBRARY_OUTPUT_DIRECTORY}"      # directory of shared  libraries + swig artifacts
       --add-before-libpath "${CMAKE_LIBRARY_OUTPUT_DIRECTORY}"             # itk non-wrapping shared libs

Wrapping/Generators/Python/CMakeLists.txt

@@ -129,7 +129,7 @@ if(NOT EXTERNAL_WRAP_ITK_PROJECT)
   foreach(t ${WRAP_ITK_COMPLEX_REAL})
     list(APPEND ITK_WRAP_PYTHON_COMPLEX_REAL ${ITKT_${t}})
   endforeach()
-  configure_file("${CMAKE_CURRENT_SOURCE_DIR}/itk/conf/itkBuildOptions.py.in"
+  configure_file("${CMAKE_CURRENT_SOURCE_DIR}/itk/support/itkBuildOptions.py.in"
                  "${ITK_PYTHON_PACKAGE_CONFIG_SUPPORT_DIR}/itkBuildOptions.py"
                 @ONLY)
   WRAP_ITK_PYTHON_BINDINGS_INSTALL(/ "ITKCommon" "${ITK_PYTHON_PACKAGE_CONFIG_SUPPORT_DIR}/itkBuildOptions.py")
@@ -144,13 +144,13 @@ if(NOT EXTERNAL_WRAP_ITK_PROJECT)
   # Create a list of Python files.
   # WrapITK/Python/*.py
   set(ITK_PYTHON_FILES
-    itk/conf/itkBase
-    itk/conf/itkTemplate
-    itk/conf/itkTypes
-    itk/conf/itkExtras
-    itk/conf/itkLazy
-    itk/conf/itkHelpers
-    itk/conf/itkInitHelpers
+    itk/support/itkBase
+    itk/support/itkTemplate
+    itk/support/itkTypes
+    itk/support/itkExtras
+    itk/support/itkLazy
+    itk/support/itkHelpers
+    itk/support/itkInitHelpers
     itk/__init__
     itk/itkInitHelpers
     )
@@ -262,8 +262,8 @@ macro(itk_setup_swig_python type base_name interface_file python_file cpp_file d
     "${_swig_depend}")
 
   if(NOT EXTERNAL_WRAP_ITK_PROJECT)
-    file(COPY ${WrapITK_SOURCE_DIR}/Generators/Python/PyBase/pyBase.i
-      DESTINATION "${WRAP_ITK_TYPEDEFS_DIRECTORY}")
+    configure_file(${WrapITK_SOURCE_DIR}/Generators/Python/PyBase/pyBase.i
+      "${WRAP_ITK_TYPEDEFS_DIRECTORY}" COPYONLY)
     list(APPEND dependencies "${WRAP_ITK_TYPEDEFS_DIRECTORY}/pyBase.i")
   endif()
 
@@ -353,7 +353,7 @@ macro(itk_end_wrap_module_python)
 
   # and create the file, with the var ITK_WRAP_PYTHON_CONFIGURATION_TEMPLATES and
   # ITK_WRAP_PYTHON_CONFIGURATION_DEPENDS created earlier
-  configure_file("${ITK_WRAP_PYTHON_SOURCE_DIR}/itk/conf/ModuleConfig.py.in"
+  configure_file("${ITK_WRAP_PYTHON_SOURCE_DIR}/itk/support/ModuleConfig.py.in"
     "${ITK_WRAP_PYTHON_LIBRARY_CONFIG_FILE}"
     @ONLY)
 

Wrapping/Generators/Python/PyBase/pyBase.i

@@ -301,7 +301,7 @@ str = str
                 return the first up-to-date output of a filter with multiple
                 outputs.
                 """
-                import itkHelpers
+                from itk.support import itkHelpers
                 import warnings
 
                 name = self.GetNameOfClass()
@@ -423,7 +423,7 @@ str = str
                 """Cast the image to the provided itk pixel type or equivalent NumPy dtype."""
                 import itk
                 import numpy as np
-                import itkTypes
+                from itk.support import itkTypes
 
                 # if both a numpy dtype and a ctype exist, use the latter.
                 if type(pixel_type) is type:
@@ -441,7 +441,7 @@ str = str
                 return cast
 
             def SetDirection(self, direction):
-                import itkHelpers
+                from itk.support import itkHelpers
                 if itkHelpers.is_arraylike(direction):
                     import itk
                     import numpy as np

Wrapping/Generators/Python/Tests/findEmptyClasses.py

@@ -18,7 +18,7 @@
 
 import itk
 import sys
-from itkTemplate import itkTemplate
+from itk.support.itkTemplate import itkTemplate
 
 itk.auto_progress(2)
 

Wrapping/Generators/Python/Tests/helpers.py

@@ -15,7 +15,7 @@
 #   limitations under the License.
 #
 # ==========================================================================*/
-import itkHelpers
+from itk.support import itkHelpers
 
 name = "MedianImageFilter"
 

Wrapping/Generators/Python/Tests/returnedTypeCoverage.py

@@ -19,7 +19,7 @@
 import itk
 import re
 import sys
-from itkTemplate import itkTemplate
+from itk.support.itkTemplate import itkTemplate
 from optparse import OptionParser
 
 

Wrapping/Generators/Python/Tests/verifyGetOutputAPIConsistency.py

@@ -20,7 +20,7 @@
 
 import itk
 import sys
-import itkTemplate
+from itk.support.itkTemplate import itkTemplate
 
 itk.auto_progress(2)
 
@@ -91,7 +91,7 @@ def checkGetOutputConsistency(o, t):
     if t not in exclude:
         T = itk.__dict__[t]
         # first case - that's a templated class
-        if isinstance(T, itkTemplate.itkTemplate) and len(T) > 0:
+        if isinstance(T, itkTemplate) and len(T) > 0:
             # Most templated object would simply instantiate the first type
             # listed if `New()` is called directly on the template type, but
             # this is not the case for all templates

Wrapping/Generators/Python/Tests/verifyTTypeAPIConsistency.py

@@ -20,7 +20,7 @@
 
 import itk
 import sys
-import itkTemplate
+from itk.support.itkTemplate import itkTemplate
 
 itk.auto_progress(2)
 
@@ -76,7 +76,7 @@ def checkTTypeConsistency(o, t):
     if t not in exclude:
         T = itk.__dict__[t]
         # Only check template classes.
-        if isinstance(T, itkTemplate.itkTemplate) and len(T) > 0:
+        if isinstance(T, itkTemplate) and len(T) > 0:
             # Most templated object would simply instantiate the first type
             # listed if `New()` is called directly on the template type, but
             # this is not the case for all templates

Wrapping/Generators/Python/itk/__init__.py

@@ -20,11 +20,9 @@
 
 from .conf.itkConfig import ITK_GLOBAL_VERSION_STRING as __version__
 
-from .conf.itkTemplate import image
-from .conf.itkTemplate import output
-from .conf.itkExtras import *
-from .conf.itkInitHelpers import *
-from itkTypes import *
+from .support.itkExtras import *
+from .support.itkInitHelpers import *
+from .support.itkTypes import *
 
 
 def _initialize_module():
@@ -48,8 +46,8 @@ def _get_lazy_attributes(local_lazy_attributes, l_module, l_data):
                 # snake case always appended to end
                 local_lazy_attributes.setdefault(function, []).append(l_module)
 
-    from .conf import itkBase as _itkBase
-    from .conf import itkLazy as _itkLazy
+    from .support import itkBase as _itkBase
+    from .support import itkLazy as _itkLazy
     from .conf import itkConfig as _itkConfig
     import sys
 

Wrapping/Generators/Python/itk/conf/ModuleConfig.py.in Wrapping/Generators/Python/itk/support/ModuleConfig.py.in

@@ -23,8 +23,8 @@
 # Required to work around weird import error with xarray
 import pkg_resources
 
-import itkConfig
-import itkTemplate
+from itk.conf import itkConfig
+from itk.support.itkTemplate import itkTemplate
 
 
 def create_itk_module(name):

Wrapping/Generators/Python/itk/conf/itkBase.py Wrapping/Generators/Python/itk/support/itkBase.py

@@ -1,5 +1,5 @@
-import itkTemplate
-import itkTypes
+from itk.support import itkTypes
+from itk.support.itkTemplate import itkTemplate
 
 DIMS = [int(s) for s in "@ITK_WRAP_IMAGE_DIMS@".split(";") if s]
 USIGN_INTS = [getattr(itkTypes, s) for s in "@WRAP_ITK_USIGN_INT@".split(";") if s]