ENH: Remove circular module dependancy

The itk/__init.py__ depends on itkExtras.py which
in turn depends on itk/__init.py.

Remove those circular dependancies by directly
importing from primary modules.

Introduce new file to more cleanly break circular dependencies

The itkInitHelpers.py is dedicated to functions needed
during the initialization of the itk module.

Author: hjmjohnson

Wrapping/Generators/Python/CMakeLists.txt

@@ -150,6 +150,7 @@ if(NOT EXTERNAL_WRAP_ITK_PROJECT)
     itkLazy
     itkHelpers
     itk/__init__
+    itk/itkInitHelpers
     )
   # Done listing files.
 

Wrapping/Generators/Python/itk/__init__.py

@@ -48,8 +48,7 @@ def _get_lazy_attributes(local_lazy_attributes, l_module, l_data):
     import itkBase
     import itkConfig
     import itkLazy
-    import itkTypes
-    import itkExtras
+    import itkInitHelpers
     import os
     import sys
 
@@ -76,17 +75,27 @@ def _get_lazy_attributes(local_lazy_attributes, l_module, l_data):
     else:
         # We're not lazy-loading. Just load the modules in the order specified in
         # the known_modules list for consistency.
-        for module in itkBase.itk_base_global_known_modules:
+        for module in itkBase.itk_base_global_module_data.keys():
             itkBase.itk_load_swig_module(module, this_module.__dict__)
 
     # Regardless of how it was loaded, fill up the itk module with the ITK types
     # and extras.
+    import itkTypes
+
     for k, v in itkTypes.__dict__.items():
         if k != "itkCType" and not k.startswith("_"):
             setattr(this_module, k, v)
+    del itkTypes
+    for k, v in itkInitHelpers.__dict__.items():
+        if not k.startswith("_"):
+            setattr(this_module, k, v)
+
+    import itkExtras
+
     for k, v in itkExtras.__dict__.items():
         if not k.startswith("_"):
             setattr(this_module, k, v)
+    del itkExtras
 
     # --
     # Needed to propagate symbol to itk.image from itkTemplate.image
@@ -116,7 +125,7 @@ def _get_lazy_attributes(local_lazy_attributes, l_module, l_data):
     else:
         # do some cleanup
         del module, this_module, itk_module
-        del itkBase, itkConfig, itkLazy, itkTypes, itkExtras, os, sys
+        del itkBase, itkConfig, itkLazy, itkInitHelpers, os, sys
 
 
 # Now do the initialization

Wrapping/Generators/Python/itk/itkInitHelpers.py

@@ -0,0 +1,93 @@
+from sys import stderr as _system_error_stream
+
+# The following line defines an ascii string used for dynamically refreshing
+# the import and progress callbacks on the same terminal line.
+# See http://www.termsys.demon.co.uk/vtansi.htm
+# \033 is the C-style octal code for an escape character
+# [2000D moves the cursor back 2000 columns, this is a brute force way of
+# getting to the start of the line.
+# [K erases the end of the line
+clrLine = "\033[2000D\033[K"
+
+
+def auto_not_in_place(v=True):
+    """Force it to not run in place"""
+    import itkConfig
+
+    itkConfig.NotInPlace = v
+
+
+def auto_progress(progress_type=1):
+    """Set up auto progress report
+
+    progress_type:
+        1 or True -> auto progress be used in a terminal
+        2 -> simple auto progress (without special characters)
+        0 or False -> disable auto progress
+    """
+    import itkConfig
+
+    if progress_type is True or progress_type == 1:
+        itkConfig.ImportCallback = terminal_import_callback
+        itkConfig.ProgressCallback = terminal_progress_callback
+
+    elif progress_type == 2:
+        itkConfig.ImportCallback = simple_import_callback
+        itkConfig.ProgressCallback = simple_progress_callback
+
+    elif progress_type is False or progress_type == 0:
+        itkConfig.ImportCallback = None
+        itkConfig.ProgressCallback = None
+
+    else:
+        raise ValueError("Invalid auto progress type: " + repr(progress_type))
+
+
+def terminal_progress_callback(name, p):
+    """Display the progress of an object and clean the display once complete
+
+    This function can be used with itkConfig.ProgressCallback
+    """
+    print(clrLine + "%s: %f" % (name, p), file=_system_error_stream, end="")
+    if p == 1:
+        print(clrLine, file=_system_error_stream, end="")
+
+
+def terminal_import_callback(name, p):
+    """Display the loading of a module and clean the display once complete
+
+    This function can be used with itkConfig.ImportCallback
+    """
+    print(clrLine + "Loading %s... " % name, file=_system_error_stream, end="")
+    if p == 1:
+        print(clrLine, file=_system_error_stream, end="")
+
+
+def simple_import_callback(name, p):
+    """Print a message when a module is loading
+
+    This function can be used with itkConfig.ImportCallback
+    """
+    if p == 0:
+        print("Loading %s... " % name, file=_system_error_stream, end="")
+    elif p == 1:
+        print("done", file=_system_error_stream)
+
+
+def simple_progress_callback(name, p):
+    """Print a message when an object is running
+
+    This function can be used with itkConfig.ProgressCallback
+    """
+    if p == 0:
+        print("Running %s... " % name, file=_system_error_stream, end="")
+    elif p == 1:
+        print("done", file=_system_error_stream)
+
+
+def force_load():
+    """force itk to load all the submodules"""
+    import itk
+
+    for k in dir(itk):
+        getattr(itk, k)

Wrapping/Generators/Python/itkBase.py

@@ -293,7 +293,6 @@ def _initialize(l_module_data):
 
 
 itk_base_global_lazy_attributes = {}
-itk_base_global_known_modules = []
 itk_base_global_module_data = {}
 _initialize(itk_base_global_module_data)
 del _initialize

Wrapping/Generators/Python/itkExtras.py

@@ -24,14 +24,7 @@
 
 from itkTemplate import output
 
-# The following line defines an ascii string used for dynamically refreshing
-# the import and progress callbacks on the same terminal line.
-# See http://www.termsys.demon.co.uk/vtansi.htm
-# \033 is the C-style octal code for an escape character
-# [2000D moves the cursor back 2000 columns, this is a brute force way of
-# getting to the start of the line.
-# [K erases the end of the line
-clrLine = "\033[2000D\033[K"
+from sys import stderr as system_error_stream
 
 
 def set_nthreads(number_of_threads):
@@ -61,90 +54,6 @@ def get_nthreads():
     return threader.GetGlobalDefaultNumberOfThreads()
 
 
-def auto_not_in_place(v=True):
-    """Force it to not run in place
-    """
-    import itkConfig
-
-    itkConfig.NotInPlace = v
-
-
-def auto_progress(progress_type=1):
-    """Set up auto progress report
-
-    progress_type:
-        1 or True -> auto progress be used in a terminal
-        2 -> simple auto progress (without special characters)
-        0 or False -> disable auto progress
-    """
-    import itkConfig
-
-    if progress_type is True or progress_type == 1:
-        itkConfig.ImportCallback = terminal_import_callback
-        itkConfig.ProgressCallback = terminal_progress_callback
-
-    elif progress_type == 2:
-        itkConfig.ImportCallback = simple_import_callback
-        itkConfig.ProgressCallback = simple_progress_callback
-
-    elif progress_type is False or progress_type == 0:
-        itkConfig.ImportCallback = None
-        itkConfig.ProgressCallback = None
-
-    else:
-        raise ValueError("Invalid auto progress type: " + repr(progress_type))
-
-
-def terminal_progress_callback(name, p):
-    """Display the progress of an object and clean the display once complete
-
-    This function can be used with itkConfig.ProgressCallback
-    """
-    print(clrLine + "%s: %f" % (name, p), file=system_error_stream, end="")
-    if p == 1:
-        print(clrLine, file=system_error_stream, end="")
-
-
-def terminal_import_callback(name, p):
-    """Display the loading of a module and clean the display once complete
-
-    This function can be used with itkConfig.ImportCallback
-    """
-    print(clrLine + "Loading %s... " % name, file=system_error_stream, end="")
-    if p == 1:
-        print(clrLine, file=system_error_stream, end="")
-
-
-def simple_import_callback(name, p):
-    """Print a message when a module is loading
-
-    This function can be used with itkConfig.ImportCallback
-    """
-    if p == 0:
-        print("Loading %s... " % name, file=system_error_stream, end="")
-    elif p == 1:
-        print("done", file=system_error_stream)
-
-
-def simple_progress_callback(name, p):
-    """Print a message when an object is running
-
-    This function can be used with itkConfig.ProgressCallback
-    """
-    if p == 0:
-        print("Running %s... " % name, file=system_error_stream, end="")
-    elif p == 1:
-        print("done", file=system_error_stream)
-
-
-def force_load():
-    """force itk to load all the submodules"""
-    import itk
-
-    for k in dir(itk):
-        getattr(itk, k)
-
-
 def echo(obj, f=system_error_stream):
     """Print an object to stream
 
@@ -255,8 +164,7 @@ def _get_itk_pixelid(numpy_array_type):
 
 
 def _GetArrayFromImage(image_or_filter, function, keep_axes, update):
-    """Get an Array with the content of the image buffer
-    """
+    """Get an Array with the content of the image buffer"""
     # Finds the image type
     import itk
 
@@ -269,17 +177,15 @@ def _GetArrayFromImage(image_or_filter, function, keep_axes, update):
 
 
 def GetArrayFromImage(image_or_filter, keep_axes=False, update=True):
-    """Get an array with the content of the image buffer
-    """
+    """Get an array with the content of the image buffer"""
     return _GetArrayFromImage(image_or_filter, "GetArrayFromImage", keep_axes, update)
 
 
 array_from_image = GetArrayFromImage
 
 
 def GetArrayViewFromImage(image_or_filter, keep_axes=False, update=True):
-    """Get an array view with the content of the image buffer
-    """
+    """Get an array view with the content of the image buffer"""
     return _GetArrayFromImage(
         image_or_filter, "GetArrayViewFromImage", keep_axes, update
     )
@@ -1038,7 +944,7 @@ def New(self, *args, **kargs):
         # extract the types from the arguments to instantiate the class
         import itk
 
-        types = tuple(itk.class_(o) for o in args)
+        types = tuple(class_(o) for o in args)
         return self[types].New(*args, **kargs)
 
     def __getitem__(self, template_parameters):

Wrapping/Generators/Python/itkTemplate.py

@@ -45,7 +45,7 @@ def normalizeName(name):
     """Normalize the class name to remove ambiguity
 
     This function removes the white spaces in the name, and also
-    remove the pointer declaration "*" (it have no sense in python) """
+    remove the pointer declaration "*" (it have no sense in python)"""
 
     name = name.replace(" ", "")
     name = name.replace("*", "")
@@ -55,11 +55,13 @@ def normalizeName(name):
 
 class TemplateTypeError(TypeError):
     def __init__(self, template_type, input_type):
+        import itkExtras
+
         def tuple_to_string_type(t):
             if type(t) == tuple:
-                return ", ".join(itk.python_type(x) for x in t)
+                return ", ".join(itkExtras.python_type(x) for x in t)
             else:
-                itk.python_type(t)
+                itkExtras.python_type(t)
 
         import itk
 
@@ -77,10 +79,14 @@ def tuple_to_string_type(t):
     e.g.: image = itk.imread(my_input_filename, itk.F)
 """
 
-        python_template_type = itk.python_type(template_type)
+        python_template_type = itkExtras.python_type(template_type)
         python_input_type = tuple_to_string_type(input_type)
-        type_list = "\n".join([itk.python_type(x[0]) for x in template_type.keys()])
-        eg_type = ", ".join([itk.python_type(x) for x in list(template_type.keys())[0]])
+        type_list = "\n".join(
+            [itkExtras.python_type(x[0]) for x in template_type.keys()]
+        )
+        eg_type = ", ".join(
+            [itkExtras.python_type(x) for x in list(template_type.keys())[0]]
+        )
         msg = """{template_type} is not wrapped for input type `{input_type}`.
 
 To limit the size of the package, only a limited number of

Wrapping/Generators/Python/itkTypes.py

@@ -111,3 +111,5 @@ def initialize_c_types_once():
     SLL,
     B,
 ) = itkCType.initialize_c_types_once()
+
+del Dict, Any