UnitTesting/unittesting/reloader.py at 9e21f0feabeab2584cdf1cb13d7f1e1da95028f2 · SublimeText/UnitTesting · 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
111
112
113
114
115
116
117
118
119
import functools
import importlib
import os
import posixpath
import sublime
import sublime_plugin
import sys
from time import sleep


def path_contains(a, b):
    return a == b or b.startswith(a + os.sep)


def get_package_modules(pkg_name):
    # (str) -> Dict[str, ModuleType]
    in_installed_path = functools.partial(
        path_contains,
        os.path.join(sublime.installed_packages_path(), pkg_name + ".sublime-package"),
    )

    in_package_path = functools.partial(
        path_contains, os.path.join(sublime.packages_path(), pkg_name)
    )

    def module_in_package(module):
        # Other (extracted) ST plugins using python 3.8 have this set to
        # `None` surprisingly.
        file = getattr(module, "__file__", None) or ""
        paths = getattr(module, "__path__", ())
        return (
            in_installed_path(file)
            or any(map(in_installed_path, paths))
            or in_package_path(file)
            or any(map(in_package_path, paths))
        )

    return [
        name
        for name, module in sys.modules.items()
        if module_in_package(module)
    ]


def package_plugins(pkg_name):
    return [
        pkg_name + "." + posixpath.basename(posixpath.splitext(path)[0])
        for path in sublime.find_resources("*.py")
        if posixpath.dirname(path) == "Packages/" + pkg_name
    ]


def reload_package(pkg_name, on_done=None):
    if pkg_name not in sys.modules:
        if on_done:
            sublime.set_timeout(on_done)
        return

    dummy_name, dummy_py = _reload_package(pkg_name)

    def check_loaded():
        if dummy_name not in sys.modules:
            sublime.set_timeout(check_loaded, 100)
            return

        os.remove(dummy_py)
        if on_done:
            sublime.set_timeout(on_done, 200)

    sublime.set_timeout(check_loaded, 100)


def async_reload_package(pkg_name):
    if pkg_name not in sys.modules:
        return

    dummy_name, dummy_py = _reload_package(pkg_name)

    while dummy_name not in sys.modules:
        sleep(0.1)

    os.remove(dummy_py)


def _reload_package(pkg_name):
    plugins = package_plugins(pkg_name)

    # Tell Sublime to unload plugins
    for plugin in plugins:
        module = sys.modules.get(plugin)
        if module:
            sublime_plugin.unload_module(module)

    # Unload modules
    for module_name in get_package_modules(pkg_name):
        sys.modules.pop(module_name)

    sys.modules[pkg_name] = importlib.import_module(pkg_name)

    # After all (sub-)modules have been removed from modules cache,
    # reloading top-level plugins will automatically re-import them
    # in correct order without any further action needed.
    for plugin in plugins:
        sublime_plugin.reload_plugin(plugin)

    # Hack to trigger automatic "reloading plugins".
    # This is needed to ensure TextCommand's and WindowCommand's are ready.
    if sys.version_info >= (3, 8):
        # in ST 4, User package is always loaded in python 3.8
        dummy_name = "User._dummy"
        dummy_py = os.path.join(sublime.packages_path(), "User", "_dummy.py")
    else:
        # in ST 4, packages under Packages are always loaded in python 3.3
        dummy_name = "_dummy"
        dummy_py = os.path.join(sublime.packages_path(), "_dummy.py")

    open(dummy_py, "a").close()

    return dummy_name, dummy_py