Change of params of `anim_utils.bake_action` to datacass introduced in 4.1 isn't documented as breaking change #121036

New Issue

Closed

opened 2024-04-24 17:10:08 +02:00 by Zdenek Dolezal · 3 comments

Zdenek Dolezal commented

2024-04-24 17:10:08 +02:00

There was a refactor in #112865

That changed the keyword arguments passed to anim_utils.bake_action to a dataclass. This is a API breaking change and it isn't documented in the release log of 4.1 Python API. One has to construct the BakeOptions from 4.1 and the old method doesn't work. This is definitely a good change, but it should be documented.

There was a refactor in https://projects.blender.org/blender/blender/pulls/112865 That changed the keyword arguments passed to [anim_utils.bake_action](https://docs.blender.org/api/current/bpy_extras.anim_utils.html#bpy_extras.anim_utils.bake_action) to a `dataclass`. This is a API breaking change and it isn't documented in the release log of [4.1 Python API](https://developer.blender.org/docs/release_notes/4.1/python_api/). One has to construct the `BakeOptions` from 4.1 and the old method doesn't work. This is definitely a good change, but it should be **documented**.

Zdenek Dolezal added the

labels 2024-04-24 17:10:09 +02:00

Zdenek Dolezal changed title from ~~Change of params of `anim_utils.bake_action` from 4.0 to 4.1 to datacass isn't documented as breaking change~~ to Change of params of `anim_utils.bake_action` introduced in 4.1 to datacass isn't documented as breaking change

2024-04-24 17:10:31 +02:00

Zdenek Dolezal changed title from ~~Change of params of `anim_utils.bake_action` introduced in 4.1 to datacass isn't documented as breaking change~~ to Change of params of `anim_utils.bake_action` to datacass introduced in 4.1 isn't documented as breaking change

2024-04-24 17:10:45 +02:00

Iliya Katushenock added the

Animation & Rigging

label 2024-04-24 17:16:32 +02:00

YimingWu commented

2024-04-25 04:21:25 +02:00

Member

@dr.sybren @nrupsis Any idea guys?

@dr.sybren @nrupsis Any idea guys?

YimingWu added

Animation & Rigging

Needs Info from Developers

and removed

labels 2024-04-25 04:21:40 +02:00

Sybren A. Stüvel commented

2024-04-25 10:44:01 +02:00

Member

I didn't expect people using this function directly. As I see it, just because it's callable Python code doesn't mean it's "an API". But then again, there is no clear distinction in Blender's Python code about this, so my opinion doesn't mean much here ;-)

I definitely don't see an issue adding this to the documentation, as it is indeed a change that people calling this code need to be aware of.

I didn't expect people using this function directly. As I see it, just because it's callable Python code doesn't mean it's "an API". But then again, there is no clear distinction in Blender's Python code about this, so my opinion doesn't mean much here ;-) I definitely don't see an issue adding this to the documentation, as it is indeed a change that people calling this code need to be aware of.

Sybren A. Stüvel commented

2024-04-25 10:55:54 +02:00

Member

It was actually introduced in 4.0 already, but there also undocumented. I've added the documentation in cc7cf4296d49.

Thanks for the report!

It was actually introduced in 4.0 already, but there also undocumented. I've added the documentation in [cc7cf4296d49](https://projects.blender.org/blender/blender-developer-docs/commit/cc7cf4296d490535d36f163bf051ebb657ea0f8f). Thanks for the report!

Sybren A. Stüvel closed this issue

2024-04-25 10:55:58 +02:00

Blender Bot added

and removed

Needs Info from Developers

labels 2024-04-25 10:55:59 +02:00

Sign in to join this conversation.

No Label

Animation & Rigging

Asset Browser Project Overview

Automated Testing

Blender Asset Bundle

Dependency Graph

Development Management

EEVEE & Viewport

Images & Movies

Motion Tracking

Nodes & Physics

Pipeline, Assets & IO

Platforms, Builds & Tests

Render & Cycles

Render Pipeline

Sculpt, Paint & Texture

Video Sequencer

Virtual Reality

Blender 2.8 Project

Milestone 1: Basic, Local Asset Browser

Good First Issue

Animation & Rigging

Development Management

EEVEE & Viewport

Nodes & Physics

Pipeline, Assets & IO

Platforms, Builds & Tests

Render & Cycles

Sculpt, Paint & Texture

Needs Info from Developers

Needs Information from User

No Milestone

No project

No Assignees

3 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender#121036

No description provided.