Anim: Unit Tests for "Insert Available" #116327

Christoph Lendenfeld · 2023-12-19T11:01:33+01:00

2023-12-19 11:01:33 +01:00

In preparation to the upcoming refactor of the keying set code,
extend the unit tests with more sophisticated
tests for "Insert Available".

This PR tests

key available using the preference setting with autokeying on an object and a bone
key available using the keyingset "Available"

In preparation to the upcoming refactor of the keying set code, extend the unit tests with more sophisticated tests for "Insert Available". This PR tests * key available using the preference setting with autokeying on an object and a bone * key available using the keyingset "Available"

Christoph Lendenfeld added the

Module

Animation & Rigging

label 2023-12-19 11:01:33 +01:00

Christoph Lendenfeld added 1 commit 2023-12-19 11:01:42 +01:00

594d3c03e1 insert available test

Christoph Lendenfeld requested review from Sybren A. Stüvel 2023-12-19 13:22:57 +01:00

Sybren A. Stüvel requested changes 2023-12-19 14:29:19 +01:00

tests/python/bl_animation_keyframing.py

						
				@ -319,0 +303,4 @@

				        bpy.context.scene.tool_settings.use_keyframe_insert_auto = True

				        bpy.context.preferences.edit.use_keyframe_insert_available = True

				        with bpy.context.temp_override(**_get_view3d_context()):

Sybren A. Stüvel commented

2023-12-19 14:15:21 +01:00

It would be nice if this could use something like:

with override_view3d_context():
    ...

Probably not for this PR, though ;-)

It would be nice if this could use something like: ```python with override_view3d_context(): ... ``` Probably not for this PR, though ;-)

Christoph Lendenfeld commented

2023-12-19 14:36:52 +01:00

is this a function that exists in bpy or would I have to create that?

Sybren A. Stüvel commented

2023-12-19 17:55:20 +01:00

I don't think it's there, it would just be:

def override_view3d_context():
    return bpy.context.temp_override(**_get_view3d_context())

At least I think that would work. If not Python is stupid and this can be ignored ;-)

I don't think it's there, it would just be: ```py def override_view3d_context(): return bpy.context.temp_override(**_get_view3d_context()) ``` At least I *think* that would work. If not Python is stupid and this can be ignored ;-)

tests/python/bl_animation_keyframing.py Outdated

						
				@ -319,0 +324,4 @@

				        for fcurve in action.fcurves:

				            if "location" in fcurve.data_path:

				                self.assertEqual(len(fcurve.keyframe_points), 2)

Sybren A. Stüvel commented

2023-12-19 14:28:34 +01:00

Is the distinction between the 'rotation' and 'location' cases relevant here? Or could these two cases be merged with if any(substring in fcurve.data_path for substring in {'location', 'rotation'}) (or a more boring "location" in fcurve.data_path or "rotation" in fcurve.data_path)?

(same for the identical construct below)

Is the distinction between the 'rotation' and 'location' cases relevant here? Or could these two cases be merged with `if any(substring in fcurve.data_path for substring in {'location', 'rotation'})` (or a more boring `"location" in fcurve.data_path or "rotation" in fcurve.data_path`)? (same for the identical construct below)

Christoph Lendenfeld commented

2023-12-19 14:42:41 +01:00

did the boring way, I find that easier to read

👍 1

tests/python/bl_animation_keyframing.py

						
				@ -319,0 +326,4 @@

				            if "location" in fcurve.data_path:

				                self.assertEqual(len(fcurve.keyframe_points), 2)

				            elif "rotation" in fcurve.data_path:

				                # Moving the bone would also add rotation keys as long as "Only Insert Needed" is off.

Sybren A. Stüvel commented

2023-12-19 14:19:31 +01:00

Avoid the word "moving" in situations where there's a distinction between "translating" and "rotating". If this ambiguity is intentional, I'd write something like "Any transformation of the bone would ..."

👍 1

dr.sybren marked this conversation as resolved

tests/python/bl_animation_keyframing.py Outdated

						
				@ -319,0 +329,4 @@

				                # Moving the bone would also add rotation keys as long as "Only Insert Needed" is off.

				                self.assertEqual(len(fcurve.keyframe_points), 2)

				            else:

				                raise AssertionError("Did not expect keys other than location and rotation")

Sybren A. Stüvel commented

2023-12-19 14:28:55 +01:00

Include the data_path in this error, to help debug the situation when it occurs.

👍 1

tests/python/bl_animation_keyframing.py

						
				@ -319,0 +381,4 @@

				        with bpy.context.temp_override(**_get_view3d_context()):

				            self.assertRaises(RuntimeError, bpy.ops.anim.keyframe_insert_by_name, type="Available")

				        self.assertTrue(keyed_object.animation_data is None)