Merge pull request #162 from delira-dev/refactor_init

Refactor __init__.py

delira/__init__.py

@@ -1,126 +1,13 @@
+from delira._debug_mode import get_current_debug_mode, switch_debug_mode, \
+    set_debug_mode
+from delira._backends import get_backends
+
 from ._version import get_versions
 import json
 import os
 import warnings
 warnings.simplefilter('default', DeprecationWarning)
 warnings.simplefilter('ignore', ImportWarning)
 
-# to register new possible backends, they have to be added to this list.
-# each backend should consist of a tuple of length 2 with the first entry
-# being the package import name and the second being the backend abbreviation.
-# E.g. TensorFlow's package is named 'tensorflow' but if the package is found,
-# it will be considered as 'tf' later on
-__POSSIBLE_BACKENDS = [("torch", "torch"), ("tensorflow", "tf")]
-__BACKENDS = []
-
-__DEBUG_MODE = False
-
-
-def _determine_backends():
-
-    _config_file = __file__.replace("__init__.py", ".delira")
-    # look for config file to determine backend
-    # if file exists: load config into environment variables
-
-    if not os.path.isfile(_config_file):
-        _backends = {}
-        # try to import all possible backends to determine valid backends
-
-        import importlib
-        for curr_backend in __POSSIBLE_BACKENDS:
-            try:
-                assert len(curr_backend) == 2
-                assert all([isinstance(_tmp, str) for _tmp in curr_backend]), \
-                    "All entries in current backend must be strings"
-
-                # check if backend can be imported
-                bcknd = importlib.util.find_spec(curr_backend[0])
-
-                if bcknd is not None:
-                    _backends[curr_backend[1]] = True
-                else:
-                    _backends[curr_backend[1]] = False
-                del bcknd
-
-            except ValueError:
-                _backends[curr_backend[1]] = False
-
-        with open(_config_file, "w") as f:
-            json.dump({"version": __version__, "backend": _backends},
-                      f, sort_keys=True, indent=4)
-
-        del _backends
-
-    # set values from config file to variable
-    with open(_config_file) as f:
-        _config_dict = json.load(f)
-    for key, val in _config_dict.pop("backend").items():
-        if val:
-            __BACKENDS.append(key.upper())
-    del _config_dict
-
-    del _config_file
-
-
-def get_backends():
-    """
-    Return List of currently available backends
-
-    Returns
-    -------
-    list
-        list of strings containing the currently installed backends
-
-    """
-
-    if not __BACKENDS:
-        _determine_backends()
-    return __BACKENDS
-
-
-# Functions to get and set the internal __DEBUG_MODE variable. This variable
-# currently only defines whether to use multiprocessing or not. At the moment
-# this is only used inside the BaseDataManager, which either returns a
-# MultiThreadedAugmenter or a SingleThreadedAugmenter depending on the current
-# debug mode.
-# All other functions using multiprocessing should be aware of this and
-# implement a functionality without multiprocessing
-# (even if this slows down things a lot!).
-
-def get_current_debug_mode():
-    """
-    Getter function for the current debug mode
-
-    Returns
-    -------
-    bool
-        current debug mode
-
-    """
-    return __DEBUG_MODE
-
-
-def switch_debug_mode():
-    """
-    Alternates the current debug mode
-
-    """
-    set_debug_mode(not get_current_debug_mode())
-
-
-def set_debug_mode(mode: bool):
-    """
-    Sets a new debug mode
-
-    Parameters
-    ----------
-    mode : bool
-        the new debug mode
-
-    """
-    global __DEBUG_MODE
-    __DEBUG_MODE = mode
-
-
 __version__ = get_versions()['version']
 del get_versions

delira/_backends.py

@@ -0,0 +1,85 @@
+import os
+import json
+from delira._version import get_versions as _get_versions
+
+# to register new possible backends, they have to be added to this list.
+# each backend should consist of a tuple of length 2 with the first entry
+# being the package import name and the second being the backend abbreviation.
+# E.g. TensorFlow's package is named 'tensorflow' but if the package is found,
+# it will be considered as 'tf' later on
+__POSSIBLE_BACKENDS = (("torch", "torch"), ("tensorflow", "tf"))
+__BACKENDS = ()
+
+
+def _determine_backends():
+    """
+    Internal Helper Function to determine the currently valid backends by
+    trying to import them. The valid backends are not returned, but appended
+    to the global ``__BACKENDS`` variable
+
+    """
+
+    _config_file = __file__.replace("_backends.py", ".delira")
+    # look for config file to determine backend
+    # if file exists: load config into environment variables
+
+    if not os.path.isfile(_config_file):
+        _backends = {}
+        # try to import all possible backends to determine valid backends
+
+        import importlib
+        for curr_backend in __POSSIBLE_BACKENDS:
+            try:
+                assert len(curr_backend) == 2
+                assert all([isinstance(_tmp, str) for _tmp in curr_backend]), \
+                    "All entries in current backend must be strings"
+
+                # check if backend can be imported
+                bcknd = importlib.util.find_spec(curr_backend[0])
+
+                if bcknd is not None:
+                    _backends[curr_backend[1]] = True
+                else:
+                    _backends[curr_backend[1]] = False
+                del bcknd
+
+            except ValueError:
+                _backends[curr_backend[1]] = False
+
+        with open(_config_file, "w") as f:
+            json.dump({"version": _get_versions()['version'],
+                       "backend": _backends},
+                      f, sort_keys=True, indent=4)
+
+        del _backends
+
+    # set values from config file to variable and empty Backend-List before
+    global __BACKENDS
+    __BACKENDS = []
+    with open(_config_file) as f:
+        _config_dict = json.load(f)
+    for key, val in _config_dict.pop("backend").items():
+        if val:
+            __BACKENDS.append(key.upper())
+    del _config_dict
+
+    del _config_file
+
+    # make __BACKENDS non mutable
+    __BACKENDS = tuple(__BACKENDS)
+
+
+def get_backends():
+    """
+    Return List of currently available backends
+
+    Returns
+    -------
+    list
+        list of strings containing the currently installed backends
+    """
+    global __BACKENDS
+
+    if not __BACKENDS:
+        _determine_backends()
+    return __BACKENDS

delira/_debug_mode.py

@@ -0,0 +1,40 @@
+__DEBUG_MODE = False
+
+# Functions to get and set the internal __DEBUG_MODE variable. This variable
+# currently only defines whether to use multiprocessing or not. At the moment
+# this is only used inside the BaseDataManager, which either returns a
+# MultiThreadedAugmenter or a SingleThreadedAugmenter depending on the current
+# debug mode.
+# All other functions using multiprocessing should be aware of this and
+# implement a functionality without multiprocessing
+# (even if this slows down things a lot!).
+
+
+def get_current_debug_mode():
+    """
+    Getter function for the current debug mode
+    Returns
+    -------
+    bool
+        current debug mode
+    """
+    return __DEBUG_MODE
+
+
+def switch_debug_mode():
+    """
+    Alternates the current debug mode
+    """
+    set_debug_mode(not get_current_debug_mode())
+
+
+def set_debug_mode(mode: bool):
+    """
+    Sets a new debug mode
+    Parameters
+    ----------
+    mode : bool
+        the new debug mode
+    """
+    global __DEBUG_MODE
+    __DEBUG_MODE = mode

delira/_version.py

@@ -1,4 +1,3 @@
-
 # This file helps to compute a version number in source trees obtained from
 # git-archive tarball (such as those provided by githubs download-from-tag
 # feature). Distribution tarballs (built by setup.py sdist) and build