Discrepancy between bpy.ops.object.mode_set() and bpy.context.mode #79122

New Issue

Sam Van Hulle · 2020-07-20T18:11:45+02:00

Sam Van Hulle commented

2020-07-20 18:11:45 +02:00

System Information
Operating system: Windows-10-10.0.19041-SP0 64 Bits
Graphics card: GeForce RTX 2060/PCIe/SSE2 NVIDIA Corporation 4.5.0 NVIDIA 451.67

Blender Version
Broken: version: 2.83.2, branch: master, commit date: 2020-07-09 05:50, hash: 239fbf7d93

Short description of error
Some of bpy.context.mode's values differ from bpy.ops.object.mode_set(mode)'s.
Not sure if this is intentional. I can see why the operator only needs a single enum value for Edit Mode, but the discrepancy between them concerning painting and particle modes is just annoying.

`bpy.context.mode`	`bpy.ops.object.mode_set(mode)`
EDIT_MESH	EDIT
EDIT_CURVE	EDIT
EDIT_SURFACE	EDIT
EDIT_TEXT	EDIT
EDIT_ARMATURE	EDIT
EDIT_METABALL	EDIT
EDIT_LATTICE	EDIT
PAINT_WEIGHT	WEIGHT_PAINT
PAINT_VERTEX	VERTEX_PAINT
PAINT_TEXTURE	TEXTURE_PAINT
PARTICLE	PARTICLE_EDIT

Sam Van Hulle commented

2020-07-20 18:11:45 +02:00

Added subscriber: @frameshift

Richard Antalik commented

2020-07-22 07:02:55 +02:00

Added subscriber: @iss

Richard Antalik commented

2020-07-22 07:02:55 +02:00

Changed status from 'Needs Triage' to: 'Archived'

Richard Antalik closed this issue

2020-07-22 07:02:55 +02:00

Richard Antalik self-assigned this 2020-07-22 07:02:55 +02:00

Richard Antalik commented

2020-07-22 07:02:55 +02:00

I don't think this is intentional, as in we want to use different strings on purpose. But this definitely isn't a bug.

Changing this probably isn't very hard, however there are implications that have to be considered, for example a lot of addons may stop working after this change.

I don't think this is intentional, as in we want to use different strings on purpose. But this definitely isn't a bug. Changing this probably isn't very hard, however there are implications that have to be considered, for example a lot of addons may stop working after this change.

Sam Van Hulle commented

2020-07-22 16:46:07 +02:00

In #79122#983270, @iss wrote:
I don't think this is intentional, as in we want to use different strings on purpose. But this definitely isn't a bug.

Changing this probably isn't very hard, however there are implications that have to be considered, for example a lot of addons may stop working after this change.

... like with most Python API changes? ;)
To me this just looks like an oversight. And I'd personally rather see addons updating their code according to an API change, than having to keep remapping these strings for all eternity because of something that wasn't intentional to begin with.

original_mode = bpy.context.mode
context_mode_remap = {
    'EDIT_MESH': 'EDIT',
    'PAINT_WEIGHT': 'WEIGHT_PAINT',
    'PAINT_VERTEX': 'VERTEX_PAINT',
    'PAINT_TEXTURE': 'TEXTURE_PAINT'
}

if context_mode_remap.get(original_mode):
    original_mode = context_mode_remap[original_mode]
bpy.ops.object.mode_set(mode=original_mode)

Anyway. It's a small thing, I just thought it was worth pointing out.

> In #79122#983270, @iss wrote: > I don't think this is intentional, as in we want to use different strings on purpose. But this definitely isn't a bug. > > Changing this probably isn't very hard, however there are implications that have to be considered, for example a lot of addons may stop working after this change. ... like with most Python API changes? ;) To me this just looks like an oversight. And I'd personally rather see addons updating their code according to an API change, than having to keep remapping these strings for all eternity because of something that wasn't intentional to begin with. ``` original_mode = bpy.context.mode context_mode_remap = { 'EDIT_MESH': 'EDIT', 'PAINT_WEIGHT': 'WEIGHT_PAINT', 'PAINT_VERTEX': 'VERTEX_PAINT', 'PAINT_TEXTURE': 'TEXTURE_PAINT' } ``` ``` if context_mode_remap.get(original_mode): original_mode = context_mode_remap[original_mode] bpy.ops.object.mode_set(mode=original_mode) ``` Anyway. It's a small thing, I just thought it was worth pointing out.

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

Discrepancy between bpy.ops.object.mode_set() and bpy.context.mode #79122