stable-diffusion-webui/modules/script_loading.py

import os
import importlib.util

from modules import errors
import sys

def load_module(path):
    module_spec = importlib.util.spec_from_file_location(os.path.basename(path), path)
    module = importlib.util.module_from_spec(module_spec)
    module_spec.loader.exec_module(module)
    if os.path.isfile(path):
        sp = os.path.splitext(path)
        module_name = sp[0]
    else:
        module_name = os.path.basename(path)
    sys.modules[module_name] = module
    return module


def preload_extensions(extensions_dir, parser, extension_list=None):
    if not os.path.isdir(extensions_dir):
        return

    extensions = extension_list if extension_list is not None else os.listdir(extensions_dir)
    for dirname in sorted(extensions):
        preload_script = os.path.join(extensions_dir, dirname, "preload.py")
        if not os.path.isfile(preload_script):
            continue

        try:
            module = load_module(preload_script)
            if hasattr(module, 'preload'):
                module.preload(parser)

        except Exception:
            errors.report(f"Error running preload() for {preload_script}", exc_info=True)
make existing script loading and new preload code use same code for loading modules limit extension preload scripts to just one file named preload.py 2022-11-12 15:56:06 +08:00			`import os`
use python importlib to load and execute extension modules previously module attributes like __file__ where not set correctly, leading to scripts getting the directory of the stable-diffusion repo location instead of their own script. This causes problem when loading user data from an external location using the --data-dir flag, as extensions would look for their own code in the stable-diffusion repo location instead of the data dir location. Using pythons importlib functions sets the modules specs correctly and executes them. But this will break extensions if they build paths based on the previously incorrect __file__ attribute. 2023-01-26 00:55:59 +08:00			`import importlib.util`
make existing script loading and new preload code use same code for loading modules limit extension preload scripts to just one file named preload.py 2022-11-12 15:56:06 +08:00
rename print_error to report, use it with together with package name 2023-06-01 00:56:37 +08:00			`from modules import errors`
feat: ensure the indexability of dynamically imported packages Signed-off-by: storyicon <storyicon@foxmail.com> 2024-04-01 17:13:07 +08:00			`import sys`
make existing script loading and new preload code use same code for loading modules limit extension preload scripts to just one file named preload.py 2022-11-12 15:56:06 +08:00
			`def load_module(path):`
use python importlib to load and execute extension modules previously module attributes like __file__ where not set correctly, leading to scripts getting the directory of the stable-diffusion repo location instead of their own script. This causes problem when loading user data from an external location using the --data-dir flag, as extensions would look for their own code in the stable-diffusion repo location instead of the data dir location. Using pythons importlib functions sets the modules specs correctly and executes them. But this will break extensions if they build paths based on the previously incorrect __file__ attribute. 2023-01-26 00:55:59 +08:00			`module_spec = importlib.util.spec_from_file_location(os.path.basename(path), path)`
			`module = importlib.util.module_from_spec(module_spec)`
			`module_spec.loader.exec_module(module)`
feat: ensure the indexability of dynamically imported packages Signed-off-by: storyicon <storyicon@foxmail.com> 2024-04-01 17:13:07 +08:00			`if os.path.isfile(path):`
			`sp = os.path.splitext(path)`
			`module_name = sp[0]`
			`else:`
			`module_name = os.path.basename(path)`
			`sys.modules[module_name] = module`
make existing script loading and new preload code use same code for loading modules limit extension preload scripts to just one file named preload.py 2022-11-12 15:56:06 +08:00			`return module`


add backwards compatibility --lyco-dir-backcompat option, use that for LyCORIS directory instead of hardcoded value prevent running preload.py for disabled extensions 2023-07-19 01:11:30 +08:00			`def preload_extensions(extensions_dir, parser, extension_list=None):`
make existing script loading and new preload code use same code for loading modules limit extension preload scripts to just one file named preload.py 2022-11-12 15:56:06 +08:00			`if not os.path.isdir(extensions_dir):`
			`return`

add backwards compatibility --lyco-dir-backcompat option, use that for LyCORIS directory instead of hardcoded value prevent running preload.py for disabled extensions 2023-07-19 01:11:30 +08:00			`extensions = extension_list if extension_list is not None else os.listdir(extensions_dir)`
			`for dirname in sorted(extensions):`
make existing script loading and new preload code use same code for loading modules limit extension preload scripts to just one file named preload.py 2022-11-12 15:56:06 +08:00			`preload_script = os.path.join(extensions_dir, dirname, "preload.py")`
			`if not os.path.isfile(preload_script):`
			`continue`

			`try:`
			`module = load_module(preload_script)`
			`if hasattr(module, 'preload'):`
			`module.preload(parser)`

			`except Exception:`
rename print_error to report, use it with together with package name 2023-06-01 00:56:37 +08:00			`errors.report(f"Error running preload() for {preload_script}", exc_info=True)`