Tricky bug: if a script is loading before cnet extension is loaded, importing external code API will fail

[OedoSoldier]

I'm working with a script using cnet, and trying to import external code API following the wiki:

import importlib
external_code = importlib.import_module('extensions.sd-webui-controlnet.scripts.external_code', 'external_code')

Then it gave me this:

Traceback (most recent call last):
  File "E:\python\diffusion\stable-diffusion-webui\modules\scripts.py", line 257, in load_scripts
    script_module = script_loading.load_module(scriptfile.path)
  File "E:\python\diffusion\stable-diffusion-webui\modules\script_loading.py", line 11, in load_module
    module_spec.loader.exec_module(module)
  File "<frozen importlib._bootstrap_external>", line 883, in exec_module
  File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
  File "E:\python\diffusion\stable-diffusion-webui\extensions\enhanced-img2img\scripts\enhanced_img2img.py", line 13, in <module>
    external_code = importlib.import_module('extensions.sd-webui-controlnet.scripts.external_code', 'external_code')
  File "C:\Users\OedoSoldier\anaconda3\envs\py310\lib\importlib\__init__.py", line 126, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 1050, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1027, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1006, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 688, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 883, in exec_module
  File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
  File "E:\python\diffusion\stable-diffusion-webui\extensions\sd-webui-controlnet\scripts\external_code.py", line 5, in <module>
    from scripts import global_state
ImportError: cannot import name 'global_state' from 'scripts' (unknown location)

I'm confused with this and trying to debug, and it turned out that my script was loading before the cnet extension was loaded; then I changed my script's name and made sure it loaded after the cnet extension was loaded (in A1111's WebUI, extensions are loaded alphabetically) and it works just fine.

[catboxanon]

I haven't taken a peek at how yet, but the adetailer extension has been able to work around this. https://github.com/Bing-su/adetailer

[OedoSoldier]

It seems he just named his script with a "!" at the start so that it loaded after all other extensions loaded

[catboxanon]

According to the wiki it's quite the opposite -- it's loaded first. https://github.com/Bing-su/adetailer/wiki#why-is-there-a--at-the-beginning-of-the-name

My console on startup indeed does indicate it loads before ControlNet too.

[-] ADetailer initialized. version: 23.5.16, num models: 7
ControlNet v1.1.186

[catboxanon]

This is the original PR that implemented ControlNet support w/o having to worry about loading order if that helps: Bing-su/adetailer#4

[ljleb]

They are importing controlnet in process the first generation, so controlnet has all the time it needs to initialize before it is imported. One way to fix would be to add controlnet's dir to sys.path when not imported as a .py file

[OedoSoldier]

They are importing controlnet in process the first generation, so controlnet has all the time it needs to initialize before it is imported. One way to fix would be to add controlnet's dir to sys.path when not imported as a .py file

Ah I see, that's good idea