File: itkConfig.py.in

package info (click to toggle)
insighttoolkit5 5.2.1-5%2Bdeb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 550,276 kB
  • sloc: cpp: 757,652; ansic: 586,696; xml: 43,107; fortran: 34,788; python: 20,439; sh: 4,167; lisp: 2,158; tcl: 993; java: 362; yacc: 338; asm: 208; perl: 200; makefile: 197; csh: 195; lex: 184; javascript: 98; pascal: 71; ruby: 10
file content (157 lines) | stat: -rw-r--r-- 5,960 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
# ==========================================================================
#
#   Copyright NumFOCUS
#
#   Licensed under the Apache License, Version 2.0 (the "License");
#   you may not use this file except in compliance with the License.
#   You may obtain a copy of the License at
#
#          http://www.apache.org/licenses/LICENSE-2.0.txt
#
#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS,
#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#   See the License for the specific language governing permissions and
#   limitations under the License.
#
# ==========================================================================*/

"""Insight Toolkit (itk) configuration module.

This module contains user options and paths to libraries and language support
files used internally.

User options can be set by importing itkConfig and changing the option values.

Currently-supported options are:
  DebugLevel: must be one of SILENT, WARN, or ERROR (these values are defined
    in itkConfig). Default is WARN.
  ImportCallback: importing itk libraries can take a while. ImportCallback will
    be called when each new library is imported in the import process.
    ImportCallback must be a function that takes two parameters: the name of
    the library being imported, and a float (between 0 and 1) reflecting the
    fraction of the import that is completed.
  LazyLoading: Only load an itk library when needed. Before the library is
    loaded, the namespace will be inhabited with dummy objects."""

from typing import Dict, List, Optional, Type, Union

# User options
SILENT: int = 0
WARN: int = 1
ERROR: int = 2
DebugLevel: int = WARN
ImportCallback = None
ProgressCallback = None


def _get_environment_boolean(environment_var: str, default_string: str) -> bool:
    # Use defaults if not available as environmental overrides
    # True values are y, yes, t, true, on and 1;
    # False values are n, no, f, false, off and 0.
    # Raises ValueError if val is anything else.
    from os import environ as _environ
    from distutils.util import strtobool as _strtobool

    try:
        _StringDefault: str = _environ.get(environment_var, default_string)
        return bool(_strtobool(_StringDefault))
    except ValueError:
        print(
            f"{environment_var} environment variable has invalid value {_StringDefault}"
        )
        print(
            "   Valid True values are (case insensitive): 'y', 'yes', 't', 'true', 'on', and '1'"
        )
        print(
            "   Valid False values are (case insensitive): 'n', 'no', 'f', 'false', 'off', and '0'"
        )
    return bool(_strtobool(default_string))


LazyLoading: bool = _get_environment_boolean("ITK_PYTHON_LAZYLOADING", "True")
NotInPlace: bool = _get_environment_boolean("ITK_PYTHON_NOTINPLACE", "False")
del _get_environment_boolean

# Internal settings


def _itk_format_warning(
    message: Union[Warning, str],
    category: Type[Warning],  # Ignore category
    filename: str,  # Ignore filename
    lineno: int,  # Ignore lineno
    line: Optional[str] = None,  # Ignore line
) -> str:
    """"Format the warnings issued by itk to display only the message.

    This will ignore the filename and the line number where the warning was
    triggered. The message is returned to the warnings module.

    Ignore the category, filename, lineno, and line elements of a standard warning message
    """
    return str(message) + "\n"


import warnings

# Redefine the format of the warnings
warnings.formatwarning = _itk_format_warning


def _initialize():
    import os

    _this_file_dir: str = os.path.dirname(__file__)

    def _normalized_path(relative_posix_path: str, message) -> str:
        norm_path: str = "None"
        if relative_posix_path != "None":
            relative_path = relative_posix_path.replace("/", os.sep)
            norm_path = os.path.normpath(os.path.join(_this_file_dir, relative_path))
            if not os.path.exists(norm_path):
                print(f"WARNING: Internal configuration path is invalid: {norm_path}")
                print(f"WARNING: Invalid: {message}")
        return norm_path

    _swig_lib: str = _normalized_path(
        "@CONFIG_PYTHON_SWIGLIB_DIR@",
        "swig_lib: location of the swig-generated shared libraries",
    )
    _swig_py: str = _normalized_path(
        "@CONFIG_PYTHON_SWIGPY_DIR@",
        "swig_py: location of the xxxPython.py swig-generated python interfaces",
    )
    _config_py: str = _normalized_path(
        "@CONFIG_PYTHON_CONFIGPY_DIR@",
        "config_py: location of xxxConfig.py CMake-generated library descriptions",
    )

    _config_py_root: str = os.path.dirname(_config_py)

    # put the itkConfig.py path in the path list
    _path = _config_py_root

    # NOT IMPLEMENTED:
    # _doxygen_root = _normalized_path("../Doc", "doxygen_root: location of the doxygen xml files.")
    _doxygen_root: str = "None"

    return _swig_lib, _swig_py, _config_py, _doxygen_root, _path


ITK_GLOBAL_VERSION_STRING: str = "@ITK_VERSION_MAJOR@.@ITK_VERSION_MINOR@.@ITK_VERSION_PATCH@"
ITK_GLOBAL_WRAPPING_BUILD_OPTIONS: Dict[str, List[str]] = {
    "ITK_WRAP_IMAGE_DIMS": "@ITK_WRAP_IMAGE_DIMS@".split(";"),
    "WRAP_ITK_USIGN_INT": "@WRAP_ITK_USIGN_INT@".split(";"),
    "WRAP_ITK_SIGN_INT": "@WRAP_ITK_SIGN_INT@".split(";"),
    "WRAP_ITK_REAL": "@WRAP_ITK_REAL@".split(";"),
    "ITK_WRAP_PYTHON_VECTOR_REAL": "@ITK_WRAP_PYTHON_VECTOR_REAL@".split(";"),
    "ITK_WRAP_PYTHON_COV_VECTOR_REAL": "@ITK_WRAP_PYTHON_COV_VECTOR_REAL@".split(";"),
    "ITK_WRAP_PYTHON_RGB": "@ITK_WRAP_PYTHON_RGB@".split(";"),
    "ITK_WRAP_PYTHON_RGBA": "@ITK_WRAP_PYTHON_RGBA@".split(";"),
    "ITK_WRAP_PYTHON_COMPLEX_REAL": "@ITK_WRAP_PYTHON_COMPLEX_REAL@".split(";"),
}

(swig_lib, swig_py, config_py, doxygen_root, path) = _initialize()
del _initialize
del warnings