Face sets operators not working from python console #76324

New Issue

Daniel Grauer · 2020-05-02T11:54:52+02:00

Daniel Grauer commented

2020-05-02 11:54:52 +02:00

System Information
Operating system: Windows-10-10.0.18362-SP0 64 Bits
Graphics card: Radeon (TM) RX 480 Graphics ATI Technologies Inc. 4.5.13587 Core Profile Context 20.4.2 26.20.15029.27016

Blender Version
Broken: version: 2.90 (sub 0), branch: master, commit date: 2020-05-01 21:55, hash: 83304e4c22
Worked: (newest version of Blender that worked as expected)

Short description of error
i tried to apply face sets via a addon and noticed that when i run any of the face sets operators it does nothing. i then tried to run them from the python console within blender and it just returns a {PASS_THROUGH} but nothing is applied to the model.

Exact steps for others to reproduce the error

add suzanne to your scene and make sure its active
enter sculpt mode
use the Face Maps > Init Faces Set > By Loose parts
note how all loose parts get a face set, this is what is expected.
now undo the face sets again and try the same via the python console
go to the python console and enter

bpy.ops.sculpt.face_sets_init(mode='LOOSE_PARTS')

i would expect the same result but instead nothing happens and no face sets are created

**System Information** Operating system: Windows-10-10.0.18362-SP0 64 Bits Graphics card: Radeon (TM) RX 480 Graphics ATI Technologies Inc. 4.5.13587 Core Profile Context 20.4.2 26.20.15029.27016 **Blender Version** Broken: version: 2.90 (sub 0), branch: master, commit date: 2020-05-01 21:55, hash: `83304e4c22` Worked: (newest version of Blender that worked as expected) **Short description of error** i tried to apply face sets via a addon and noticed that when i run any of the face sets operators it does nothing. i then tried to run them from the python console within blender and it just returns a {PASS_THROUGH} but nothing is applied to the model. **Exact steps for others to reproduce the error** 1. add suzanne to your scene and make sure its active 2. enter sculpt mode 3. use the Face Maps > Init Faces Set > By Loose parts ![image.png](https://archive.blender.org/developer/F8507301/image.png) 4. note how all loose parts get a face set, this is what is expected. ![image.png](https://archive.blender.org/developer/F8507304/image.png) 5. now undo the face sets again and try the same via the python console 6. go to the python console and enter ``` bpy.ops.sculpt.face_sets_init(mode='LOOSE_PARTS') ``` 7. i would expect the same result but instead nothing happens and no face sets are created ![image.png](https://archive.blender.org/developer/F8507309/image.png)

Daniel Grauer commented

2020-05-02 11:54:52 +02:00

Added subscriber: @DanielGrauer

Ankit Meel commented

2020-05-02 12:18:04 +02:00

Added subscriber: @ankitm

Ankit Meel commented

2020-05-02 12:18:04 +02:00

i would expect the same result but instead nothing happens and no face sets are created

https://docs.blender.org/api/current/bpy.ops.sculpt.html
Is that supported by the API ?

Also, since you asked it on support channel, I'm tempted to close it as support request.

> i would expect the same result but instead nothing happens and no face sets are created https://docs.blender.org/api/current/bpy.ops.sculpt.html Is that supported by the API ? Also, since you asked it on support channel, I'm tempted to close it as support request.

Rodger Davis commented

2020-05-02 16:55:31 +02:00

Added subscriber: @RodDavis

Rodger Davis commented

2020-05-02 16:55:31 +02:00

https://docs.blender.org/api/2.83/bpy.ops.sculpt.html

Facesets should be supported in the 2.83 api. I'm guessing there is something stopping it for the time being.

https://docs.blender.org/api/2.83/bpy.ops.sculpt.html Facesets should be supported in the 2.83 api. I'm guessing there is something stopping it for the time being.

Richard Antalik commented

2020-05-04 09:47:22 +02:00

Added subscriber: @iss

Richard Antalik commented

2020-05-04 09:47:22 +02:00

@DanielGrauer I think what you need to do is override context of operator. It is probably "confused" by instruction to select face masks in console https://docs.blender.org/api/current/bpy.ops.html#overriding-context

Richard Antalik commented

2020-05-04 09:50:30 +02:00

Changed status from 'Needs Triage' to: 'Needs User Info'

Richard Antalik commented

2020-05-04 09:50:30 +02:00

I will change status and ask you to check if my info helped you to resolve this issue

Daniel Grauer commented

2020-05-04 18:16:22 +02:00

@iss
i was looking into the context and when i print the mode and the active obejct it gives me the correct context. i have not tried overriding it since it seems to be correct. might there be some other context that confuses the operator?

import bpy
print(bpy.context.active_object) > <bpy_struct, Object("FrontCasing")> (the correct active object)
print(bpy.context.mode) > SCULPT
bpy.ops.sculpt.face_sets_init(mode='LOOSE_PARTS')

@iss i was looking into the context and when i print the mode and the active obejct it gives me the correct context. i have not tried overriding it since it seems to be correct. might there be some other context that confuses the operator? import bpy print(bpy.context.active_object) > <bpy_struct, Object("FrontCasing")> (the correct active object) print(bpy.context.mode) > SCULPT bpy.ops.sculpt.face_sets_init(mode='LOOSE_PARTS')

Rodger Davis commented

2020-05-04 19:33:28 +02:00

Faces sets Pass through.blend
Here is a short demo file using facesets. It has a text file using loose parts. Just to make it a little more clear and quick.

[Faces sets Pass through.blend](https://archive.blender.org/developer/F8512352/Faces_sets_Pass_through.blend) Here is a short demo file using facesets. It has a text file using loose parts. Just to make it a little more clear and quick.

Richard Antalik commented

2020-05-05 09:53:39 +02:00

In #76324#923996, @DanielGrauer wrote:
@iss
i was looking into the context and when i print the mode and the active obejct it gives me the correct context. i have not tried overriding it since it seems to be correct. might there be some other context that confuses the operator?

import bpy
print(bpy.context.active_object) > <bpy_struct, Object("FrontCasing")> (the correct active object)
print(bpy.context.mode) > SCULPT
bpy.ops.sculpt.face_sets_init(mode='LOOSE_PARTS')

Yes, selected object and mode are "global". Problem is that editor from within you run operator is not.

The idea of overriding context is that you want to trick operator that it is executed from different editor

you nedd to do something like bpy.ops.transform.seq_slide({'area':editor_area}, value = (0,distance)) and you have to search for editor_area.

> In #76324#923996, @DanielGrauer wrote: > @iss > i was looking into the context and when i print the mode and the active obejct it gives me the correct context. i have not tried overriding it since it seems to be correct. might there be some other context that confuses the operator? > > import bpy > print(bpy.context.active_object) > <bpy_struct, Object("FrontCasing")> (the correct active object) > print(bpy.context.mode) > SCULPT > bpy.ops.sculpt.face_sets_init(mode='LOOSE_PARTS') Yes, selected object and mode are "global". Problem is that editor from within you run operator is not. The idea of overriding context is that you want to trick operator that it is executed from different editor you nedd to do something like `bpy.ops.transform.seq_slide({'area':editor_area}, value = (0,distance))` and you have to search for `editor_area`.

Daniel Grauer commented

2020-05-07 22:50:40 +02:00

i tried to override the context as in the documentation ( https://docs.blender.org/api/current/bpy.ops.html#overriding-context ) and also the way you described but i can not get it to work.

import bpy
bpy.ops.object.mode_set(mode='SCULPT')  ## **is working**

for window in bpy.context.window_manager.windows:
    screen = window.screen

    for area in screen.areas:
        if area.type == 'VIEW_3D':
            override = {'window': window, 'screen': screen, 'area': area}
            #bpy.ops.screen.screen_full_area(override)         
            bpy.ops.sculpt.face_sets_create(override, mode='VISIBLE') ## **not working**

            #bpy.ops.paint.mask_flood_fill(mode='VALUE', value=1)    ## **is working**
            bpy.ops.sculpt.dirty_mask()                              ## **is working**
            break

i tried to override the context as in the documentation ( https://docs.blender.org/api/current/bpy.ops.html#overriding-context ) and also the way you described but i can not get it to work. ``` import bpy bpy.ops.object.mode_set(mode='SCULPT') ## **is working** for window in bpy.context.window_manager.windows: screen = window.screen for area in screen.areas: if area.type == 'VIEW_3D': override = {'window': window, 'screen': screen, 'area': area} #bpy.ops.screen.screen_full_area(override) bpy.ops.sculpt.face_sets_create(override, mode='VISIBLE') ## **not working** #bpy.ops.paint.mask_flood_fill(mode='VALUE', value=1) ## **is working** bpy.ops.sculpt.dirty_mask() ## **is working** break ```

Richard Antalik commented

2020-05-08 01:52:32 +02:00

In #76324#926389, @DanielGrauer wrote:
i tried to override the context as in the documentation ( https://docs.blender.org/api/current/bpy.ops.html#overriding-context ) and also the way you described but i can not get it to work.

import bpy
bpy.ops.object.mode_set(mode='SCULPT')  ## **is working**

for window in bpy.context.window_manager.windows:
    screen = window.screen

    for area in screen.areas:
        if area.type == 'VIEW_3D':
            override = {'window': window, 'screen': screen, 'area': area}
            #bpy.ops.screen.screen_full_area(override)         
            bpy.ops.sculpt.face_sets_create(override, mode='VISIBLE') ## **not working**

            #bpy.ops.paint.mask_flood_fill(mode='VALUE', value=1)    ## **is working**
            bpy.ops.sculpt.dirty_mask()                              ## **is working**
            break

I thought there may be some issue, but after digging in code it seems, that there isn't.
Turns out, that you don't even need to override context, but rather execution context https://docs.blender.org/api/current/bpy.ops.html#execution-context

Pass 'INVOKE_DEFAULT' as first parameter.
bpy.ops.sculpt.face_sets_create('INVOKE_DEFAULT', mode='VISIBLE')

I have done this only 2 times really so I don't know much about this off top of my head. Sorry for misleading you.

Unfortunately unless you look at operator code, you don't really know if you want to call invoke() or exec() function and this is kinda low-level even for quite advanced users.
Sometimes you may need to override both contexts I guess.

> In #76324#926389, @DanielGrauer wrote: > i tried to override the context as in the documentation ( https://docs.blender.org/api/current/bpy.ops.html#overriding-context ) and also the way you described but i can not get it to work. > > > ``` > import bpy > bpy.ops.object.mode_set(mode='SCULPT') ## **is working** > > for window in bpy.context.window_manager.windows: > screen = window.screen > > for area in screen.areas: > if area.type == 'VIEW_3D': > override = {'window': window, 'screen': screen, 'area': area} > #bpy.ops.screen.screen_full_area(override) > bpy.ops.sculpt.face_sets_create(override, mode='VISIBLE') ## **not working** > > #bpy.ops.paint.mask_flood_fill(mode='VALUE', value=1) ## **is working** > bpy.ops.sculpt.dirty_mask() ## **is working** > break > ``` I thought there may be some issue, but after digging in code it seems, that there isn't. Turns out, that you don't even need to override context, but rather execution context https://docs.blender.org/api/current/bpy.ops.html#execution-context Pass `'INVOKE_DEFAULT'` as first parameter. `bpy.ops.sculpt.face_sets_create('INVOKE_DEFAULT', mode='VISIBLE')` I have done this only 2 times really so I don't know much about this off top of my head. Sorry for misleading you. Unfortunately unless you look at operator code, you don't really know if you want to call `invoke()` or `exec()` function and this is kinda low-level even for quite advanced users. Sometimes you may need to override both contexts I guess.

Richard Antalik commented

2020-05-08 01:52:51 +02:00

Changed status from 'Needs User Info' to: 'Archived'

Richard Antalik closed this issue

2020-05-08 01:52:51 +02:00

Richard Antalik self-assigned this 2020-05-08 01:52:51 +02:00

blender-admin commented

2020-05-08 02:02:49 +02:00

This issue was referenced by 7f5570ceff

This issue was referenced by 7f5570ceff7f74621268dba9268c603eccce435f

Brecht Van Lommel commented

2020-05-08 02:05:24 +02:00

Changed status from 'Archived' to: 'Resolved'

Brecht Van Lommel commented

2020-05-08 02:07:18 +02:00

Added subscriber: @brecht

Brecht Van Lommel commented

2020-05-08 02:07:18 +02:00

There actually was a bug here, though the operator API is not strictly defined enough for it to be clear. By convention operators should always implement exec() for non-interactive execution, with only a few exceptions.

There actually was a bug here, though the operator API is not strictly defined enough for it to be clear. By convention operators should always implement `exec()` for non-interactive execution, with only a few exceptions.

Richard Antalik commented

2020-05-08 02:47:37 +02:00

In #76324#926525, @brecht wrote:
There actually was a bug here, though the operator API is not strictly defined enough for it to be clear. By convention operators should always implement exec() for non-interactive execution, with only a few exceptions.

Thanks for clarification. I have seen quite a few operators without exec function, so I probably wouldn't consider this a bug (not working as designed)
Makes sense to consider this a bug though, so I will keep it in mind.

> In #76324#926525, @brecht wrote: > There actually was a bug here, though the operator API is not strictly defined enough for it to be clear. By convention operators should always implement `exec()` for non-interactive execution, with only a few exceptions. Thanks for clarification. I have seen quite a few operators without exec function, so I probably wouldn't consider this a bug (not working as designed) Makes sense to consider this a bug though, so I will keep it in mind.

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

Face sets operators not working from python console #76324