bpy.utils.unregister_module doesn't unregister classes of submodules #50052

New Issue

Alexander Romanov · 2016-11-16T17:58:05+01:00

Alexander Romanov commented

2016-11-16 17:58:05 +01:00

Short description of error
bpy.utils.register_module register classes from submodules correctly, but bpy.utils.unregister_module doesn't unregister them.

I've attached example of a simple addon to check this.

Exact steps for others to reproduce the error

Download and unpack custom_scripts.zip

Set Scripts path to point to the root directory called custom_scripts press Save User Settings
Press F8
Enable Addon called Test
Clear Scripts field and Save User Settings
Press F8
You will see that the Test panel on the Render tab is still present. You also can find the corresponding class in bpy.types

If you will uncomment `bpy.utils.unregister_class(RenderTestPanel)` in `ui_render.py` and retry all steps, you will see the correct behavior

Probably it's an expected behavior

**Short description of error** `bpy.utils.register_module` register classes from submodules correctly, but `bpy.utils.unregister_module` doesn't unregister them. I've attached example of a simple addon to check this. **Exact steps for others to reproduce the error** Download and unpack [custom_scripts.zip](https://archive.blender.org/developer/F401769/custom_scripts.zip) - Set `Scripts` path to point to the root directory called `custom_scripts` press `Save User Settings` - Press F8 - Enable Addon called `Test` - Clear `Scripts` field and `Save User Settings` - Press F8 - You will see that the `Test` panel on the `Render` tab is still present. You also can find the corresponding class in bpy.types # If you will uncomment `bpy.utils.unregister_class(RenderTestPanel)` in `ui_render.py` and retry all steps, you will see the correct behavior Probably it's an expected behavior

Alexander Romanov commented

2016-11-16 17:58:05 +01:00

Changed status to: 'Open'

Alexander Romanov commented

2016-11-16 17:58:05 +01:00

Added subscriber: @AlexanderRomanov

Bastien Montagne commented

2016-11-18 12:46:54 +01:00

Added subscriber: @mont29

Bastien Montagne commented

2016-11-18 12:46:54 +01:00

Changed status from 'Open' to: 'Archived'

Bastien Montagne closed this issue

2016-11-18 12:46:54 +01:00

Bastien Montagne self-assigned this 2016-11-18 12:46:54 +01:00

Bastien Montagne commented

2016-11-18 12:46:54 +01:00

I do not see any unexpected behavior here? When you clear script field, you just prevents Blender any further access to that addon, so it obviously cannot unregister or re-register that addon correctly anymore. Henceforth, all classes it defined during its last registration remain alive until next start of Blender.

Alexander Romanov commented

2016-11-18 13:07:59 +01:00

If bpy.utils.register_module calls register_class for each submodule class, bpy.utils.unregister_module must call unregister_class for that submodules. This is what I am expecting. After clearing Scripts unregister_class must be invoked from unregister_module, which is in memory currently; and yes, register will fail. But we see, that unregister_class is not called by unregister_module, because the pannel is still present.

def unregister_module(module, verbose=False):
    if verbose:
        print("bpy.utils.unregister_module(%r): ..." % module)
    for cls in _bpy_module_classes(module, is_registered=True):
        if verbose:
            print("    %r" % cls)
        try:
            unregister_class(cls)
        except:
            print("bpy.utils.unregister_module(): "
                  "failed to unregistering class %r" % cls)
            import traceback
            traceback.print_exc()
    if verbose:
        print("done.\n")

You can see invocation of unregister_class, but generator _bpy_module_classes returns nothing. Seems that the issue is in _bpy_types.TypeMap, or I missed something.

PS Now it seems that you don't have to call register_class for all your classes, but you have to call unregister_class

If `bpy.utils.register_module` calls `register_class` for each submodule class, `bpy.utils.unregister_module` must call `unregister_class` for that submodules. This is what I am expecting. After clearing `Scripts` `unregister_class` must be invoked from `unregister_module`, which is in memory currently; and yes, register will fail. But we see, that `unregister_class` is not called by `unregister_module`, because the pannel is still present. ``` def unregister_module(module, verbose=False): if verbose: print("bpy.utils.unregister_module(%r): ..." % module) for cls in _bpy_module_classes(module, is_registered=True): if verbose: print(" %r" % cls) try: unregister_class(cls) except: print("bpy.utils.unregister_module(): " "failed to unregistering class %r" % cls) import traceback traceback.print_exc() if verbose: print("done.\n") ``` You can see invocation of `unregister_class`, but generator `_bpy_module_classes` returns nothing. Seems that the issue is in _bpy_types.TypeMap, or I missed something. PS Now it seems that you don't have to call `register_class` for all your classes, but you have to call `unregister_class`

Bastien Montagne commented

2016-11-18 15:12:25 +01:00

Changed status from 'Archived' to: 'Open'

Bastien Montagne reopened this issue

2016-11-18 15:12:25 +01:00

Bastien Montagne commented

2016-11-18 15:12:25 +01:00

OK, confirmed the issue and found the culprit: in reload case (F8), TypeMap is cleared before calling unregister for all active addons, which means all calls to unregister_module will fail.

This was not a visible issue, because reloading that happens immediately after would silently unregister classes already existing, so could only be detected when an addon had gone missing in between.

Will just clear TypeMap after unregistering all addons, see no reason to do it before hand anyway.

OK, confirmed the issue and found the culprit: in reload case (F8), TypeMap is cleared before calling unregister for all active addons, which means all calls to unregister_module will fail. This was not a visible issue, because reloading that happens immediately after would silently unregister classes already existing, so could only be detected when an addon had gone missing in between. Will just clear TypeMap after unregistering all addons, see no reason to do it before hand anyway.

blender-admin commented

2016-11-18 15:14:22 +01:00

This issue was referenced by blender/blender@8f0dc3cef6

This issue was referenced by blender/blender@8f0dc3cef6c3f3e02a0a4322cd241cf379e52552

Bastien Montagne commented

2016-11-18 15:53:45 +01:00

Changed status from 'Open' to: 'Resolved'

Bastien Montagne closed this issue

2016-11-18 15:53:45 +01:00

Sign in to join this conversation.

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

bpy.utils.unregister_module doesn't unregister classes of submodules #50052

If you will uncomment bpy.utils.unregister_class(RenderTestPanel) in ui_render.py and retry all steps, you will see the correct behavior

If you will uncomment `bpy.utils.unregister_class(RenderTestPanel)` in `ui_render.py` and retry all steps, you will see the correct behavior