Page MenuHome
Create Task
Maniphest T89013

Bmesh: removed deform parameter of from_object still in PyDoc
Closed, ResolvedPublicBUG
Actions

Description

System Information
Operating system: Ubuntu 18.04.5 LTS
Graphics card: nvidia GTX 1050 Ti

Blender Version
Broken: 3.0.0, 93fd07e19cf, master, 2021-06-09
Worked: 2.93.0 LTS

Short description of error
The deform parameter for from_object method of BMesh object was deprecated in 2.93 and removed in 3.0 (task D10086). The latest code in master branch has indeed removed deform from kwlist, and attempting to use in Python console results in TypeError: 'deform' is an invalid keyword argument for from_object() (expected), but deform argument info still exists in PyDoc.

Related, the depsgraph argument was never added to PyDoc (since task D4065).

Exact steps for others to reproduce the error
From starting blend file, open Python console and type:

import bmesh
bm = bmesh.new()
bm.from_object( # press tab to see deform in list, but not depsgraph
bm.from_object(bpy.data.objects['Cube'], bpy.context.evaluated_depsgraph_get(), deform=True) # fails

Note to devs
I have a patch to update PyDoc to exclude deform and include depsgraph. I haven't built Blender from source in many months, so once I have finished installing all deps, rebuilt blender, and have tested the patch, I can submit the patch.

Revisions and Commits

rB Blender
rBba7f11075354 Docs: remove deprecated parameter from bmesh docs
rBaa0bd29546d4 Docs: remove deprecated parameter from bmesh docs

Related Objects

Event Timeline

Jon Denning (gfxcoder) created this task.Wed, Jun 9, 11:40 PM
Aaron Carlisle (Blendify) added a subscriber: Aaron Carlisle (Blendify).Thu, Jun 10, 2:10 AM
This comment was removed by Aaron Carlisle (Blendify).
Aaron Carlisle (Blendify) changed the task status from Needs Triage to Confirmed.Thu, Jun 10, 2:12 AM
Aaron Carlisle (Blendify) assigned this task to Jon Denning (gfxcoder).
Aaron Carlisle (Blendify) added projects: Documentation, Python API.
Aaron Carlisle (Blendify) changed the subtype of this task from "Report" to "Bug".
Aaron Carlisle (Blendify) moved this task from Backlog to Documentation on the Python API board.
Aaron Carlisle (Blendify) moved this task from Backlog to Blender Python/C API on the Documentation board.
Aaron Carlisle (Blendify) added a comment.Thu, Jun 10, 2:14 AM

I have a patch to update PyDoc to exclude deform and include depsgraph. I haven't built Blender from source in many months, so once I have finished installing all deps, rebuilt blender, and have tested the patch, I can submit the patch.

Let us know if you need any help, feel free to reach out on https://blender.chat/channel/blender-coders

Campbell Barton (campbellbarton) closed this task as Resolved by committing rBaa0bd29546d4: Docs: remove deprecated parameter from bmesh docs.Thu, Jun 10, 1:34 PM
Campbell Barton (campbellbarton) added a commit: rBaa0bd29546d4: Docs: remove deprecated parameter from bmesh docs.
Campbell Barton (campbellbarton) mentioned this in T88449: Blender LTS: Maintenance Task 2.93.Thu, Jun 10, 1:37 PM
Jeroen Bakker (jbakker) added a commit: rBba7f11075354: Docs: remove deprecated parameter from bmesh docs.Wed, Jun 16, 9:32 AM