MONAI/tests/utils/test_optional_import.py at 53958488cbb30a63a18d7f4b3e3ed9e0f109c852 · Project-MONAI/MONAI · GitHub

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
# Copyright (c) MONAI Consortium
# 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
# 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.

from __future__ import annotations

import gc
import unittest
import weakref

from parameterized import parameterized

from monai.utils import OptionalImportError, exact_version, optional_import


class TestOptionalImport(unittest.TestCase):

    @parameterized.expand(["not_a_module", "torch.randint"])
    def test_default(self, import_module):
        my_module, flag = optional_import(import_module)
        self.assertFalse(flag)
        with self.assertRaises(OptionalImportError):
            my_module.test

    def test_import_valid(self):
        my_module, flag = optional_import("torch")
        self.assertTrue(flag)
        print(my_module.randint(1, 2, (1, 2)))

    def test_import_wrong_number(self):
        my_module, flag = optional_import("torch", "42")
        with self.assertRaisesRegex(OptionalImportError, "version"):
            my_module.nn
        self.assertFalse(flag)
        with self.assertRaisesRegex(OptionalImportError, "version"):
            my_module.randint(1, 2, (1, 2))
        with self.assertRaisesRegex(ValueError, "invalid literal"):
            my_module, flag = optional_import("torch", "test")  # version should be number.number
            my_module.nn
            self.assertTrue(flag)
            print(my_module.randint(1, 2, (1, 2)))

    @parameterized.expand(["0", "0.0.0.1", "1.1.0"])
    def test_import_good_number(self, version_number):
        my_module, flag = optional_import("torch", version_number)
        my_module.nn
        self.assertTrue(flag)
        print(my_module.randint(1, 2, (1, 2)))

    def test_import_exact(self):
        my_module, flag = optional_import("torch", "0", exact_version)
        with self.assertRaisesRegex(OptionalImportError, "exact_version"):
            my_module.nn
        self.assertFalse(flag)
        with self.assertRaisesRegex(OptionalImportError, "exact_version"):
            my_module.randint(1, 2, (1, 2))

    def test_import_method(self):
        nn, flag = optional_import("torch", "1.1", name="nn")
        self.assertTrue(flag)
        print(nn.functional)

    def test_additional(self):
        test_args = {"a": "test", "b": "test"}

        def versioning(module, ver, a):
            self.assertEqual(a, test_args)
            return True

        nn, flag = optional_import("torch", "1.1", version_checker=versioning, name="nn", version_args=test_args)
        self.assertTrue(flag)

    def test_no_traceback_leak(self):
        """Verify optional_import does not retain references to stack frames (issue #7480)."""

        class _Marker:
            pass

        def _do_import():
            marker = _Marker()
            ref = weakref.ref(marker)
            # Call optional_import for a module that does not exist.
            # If the traceback is leaked, `marker` stays alive via frame references.
            mod, flag = optional_import("nonexistent_module_for_leak_test")
            self.assertFalse(flag)
            return ref

        ref = _do_import()
        gc.collect()
        self.assertIsNone(ref(), "optional_import is leaking frame references via traceback")

    def test_failed_import_shows_traceback_string(self):
        """Verify the error message includes the original traceback as a string."""
        mod, flag = optional_import("nonexistent_module_for_tb_test")
        self.assertFalse(flag)
        with self.assertRaises(OptionalImportError) as ctx:
            mod.something
        self.assertIn("Original traceback", str(ctx.exception))
        self.assertIn("ModuleNotFoundError", str(ctx.exception))


if __name__ == "__main__":
    unittest.main()