blender/blender

RNA paths from python tooltip/operator for viewport settings are wrong #124527

New Issue

Closed

opened 2024-07-11 15:09:19 +02:00 by Simon Thommes · 6 comments

Simon Thommes commented

2024-07-11 15:09:19 +02:00

Member

System Information
Operating system: Linux-6.8.12-gentoo-x86_64-AMD_Ryzen_9_5950X_16-Core_Processor-with-glibc2.39 64 Bits, X11 UI
Graphics card: NVIDIA RTX A6000/PCIe/SSE2 NVIDIA Corporation 4.6.0 NVIDIA 550.90.07

Blender Version
Broken: version: 4.2.0 Beta, branch: blender-v4.2-release, commit date: 2024-07-08 19:36, hash: d527e3a6bd78
Worked: (newest version of Blender that worked as expected)

Short description of error
The RNA path that is generated for the python tooltip and by the Copy Full Data Path operator are incorrect for several settings, for example those of the viewport display.

The path is missing the components that navigate to the correct area + space within the screen

Wrong bpy.data.screens["Layout"].overlay.show_stats
Correct bpy.data.screens["Layout"].areas[3].spaces[0].overlay.show_stats

Exact steps for others to reproduce the error

hover over Statistics overlay toggle
right click and press Copy Full Data Path
paste in python console and hit enter

**System Information** Operating system: Linux-6.8.12-gentoo-x86_64-AMD_Ryzen_9_5950X_16-Core_Processor-with-glibc2.39 64 Bits, X11 UI Graphics card: NVIDIA RTX A6000/PCIe/SSE2 NVIDIA Corporation 4.6.0 NVIDIA 550.90.07 **Blender Version** Broken: version: 4.2.0 Beta, branch: blender-v4.2-release, commit date: 2024-07-08 19:36, hash: `d527e3a6bd78` Worked: (newest version of Blender that worked as expected) **Short description of error** The RNA path that is generated for the python tooltip and by the `Copy Full Data Path` operator are incorrect for several settings, for example those of the viewport display. ![image](/attachments/1a8b40b9-1dbb-4288-81f8-355865f1a5fd) ![image](/attachments/c5155b69-4960-4b85-9778-42274a2b3aa3) The path is missing the components that navigate to the correct area + space within the screen Wrong `bpy.data.screens["Layout"].overlay.show_stats` Correct `bpy.data.screens["Layout"].areas[3].spaces[0].overlay.show_stats` **Exact steps for others to reproduce the error** - hover over `Statistics` overlay toggle - right click and press `Copy Full Data Path` - paste in python console and hit enter

9.0 KiB

40 KiB

Simon Thommes added the

labels 2024-07-11 15:09:20 +02:00

YimingWu commented

2024-07-12 05:04:21 +02:00

Member

I think this might be the limitation of RNA get path... however in this situation I would expect it to have ... in the middle

I _think_ this might be the limitation of RNA get path... however in this situation I would expect it to have `...` in the middle

Philipp Oeser commented

2024-07-12 14:22:18 +02:00

Member

Yeah, space paths are broken (also see a37ff68334).

Will confirm anyways

Yeah, space paths are broken (also see a37ff683348f7a1122e3a742da0e6219aed9c7c5). Will confirm anyways

Philipp Oeser added

and removed

labels 2024-07-12 14:22:57 +02:00

Philipp Oeser commented

2024-07-12 15:24:05 +02:00

Member

This has been bugging me for ages, will put on my desk to check on

This has been bugging me for ages, will put on my desk to check on

Philipp Oeser self-assigned this 2024-07-12 15:24:29 +02:00

Philipp Oeser commented

2024-07-12 16:49:24 +02:00

Member

Something like the following will do the trick.
Can probably be used for a lot ore places/spaces.
Will try to check these and create a PR next week

diff --git a/source/blender/blenkernel/BKE_screen.hh b/source/blender/blenkernel/BKE_screen.hh
index 06889d474b5..61a015bfe48 100644
--- a/source/blender/blenkernel/BKE_screen.hh
+++ b/source/blender/blenkernel/BKE_screen.hh
@@ -675,6 +675,10 @@ ARegion *BKE_screen_find_main_region_at_xy(const bScreen *screen, int space_type
 ScrArea *BKE_screen_find_area_from_space(const bScreen *screen,
                                          const SpaceLink *sl) ATTR_WARN_UNUSED_RESULT
     ATTR_NONNULL(1, 2);
+/**
+ * \note used to get proper RNA paths for spaces.
+ */
+std::optional<std::string> BKE_screen_path_from_screen_to_space(const PointerRNA *ptr);
 /**
  * \note Using this function is generally a last resort, you really want to be
  * using the context when you can - campbell
diff --git a/source/blender/blenkernel/intern/screen.cc b/source/blender/blenkernel/intern/screen.cc
index 5f2b8504acf..2f5e687344d 100644
--- a/source/blender/blenkernel/intern/screen.cc
+++ b/source/blender/blenkernel/intern/screen.cc
@@ -13,6 +13,8 @@
 #  include "BLI_winstuff.h"
 #endif
 
+#include <fmt/format.h>
+
 #include <cmath>
 #include <cstdio>
 #include <cstring>
@@ -868,6 +870,22 @@ ScrArea *BKE_screen_find_area_from_space(const bScreen *screen, const SpaceLink
   return nullptr;
 }
 
+std::optional<std::string> BKE_screen_path_from_screen_to_space(const PointerRNA *ptr)
+{
+  bScreen *screen = (bScreen *)ptr->owner_id;
+  SpaceLink *link = (SpaceLink *)ptr->data;
+
+  int area_index;
+  LISTBASE_FOREACH_INDEX (ScrArea *, area, &screen->areabase, area_index) {
+    const int space_index = BLI_findindex(&area->spacedata, link);
+    if (space_index != -1) {
+      return fmt::format("areas[{}].spaces[{}].", area_index, space_index);
+    }
+  }
+
+  return nullptr;
+}
+
 ScrArea *BKE_screen_find_big_area(const bScreen *screen, const int spacetype, const short min)
 {
   ScrArea *big = nullptr;
diff --git a/source/blender/makesrna/intern/rna_space.cc b/source/blender/makesrna/intern/rna_space.cc
index e31d702087b..99f1cf7ef74 100644
--- a/source/blender/makesrna/intern/rna_space.cc
+++ b/source/blender/makesrna/intern/rna_space.cc
@@ -536,6 +536,7 @@ static const EnumPropertyItem rna_enum_curve_display_handle_items[] = {
 #ifdef RNA_RUNTIME
 
 #  include <algorithm>
+#  include <fmt/format.h>
 
 #  include "AS_asset_representation.hh"
 
@@ -1591,9 +1592,9 @@ static PointerRNA rna_SpaceView3D_overlay_get(PointerRNA *ptr)
   return rna_pointer_inherit_refine(ptr, &RNA_View3DOverlay, ptr->data);
 }
 
-static std::optional<std::string> rna_View3DOverlay_path(const PointerRNA * /*ptr*/)
+static std::optional<std::string> rna_View3DOverlay_path(const PointerRNA *ptr)
 {
-  return "overlay";
+  return fmt::format("{}{}", BKE_screen_path_from_screen_to_space(ptr).value_or(""), "overlay");
 }
 
 /* Space Image Editor */

Something like the following will do the trick. Can probably be used for a lot ore places/spaces. Will try to check these and create a PR next week ```C diff --git a/source/blender/blenkernel/BKE_screen.hh b/source/blender/blenkernel/BKE_screen.hh index 06889d474b5..61a015bfe48 100644 --- a/source/blender/blenkernel/BKE_screen.hh +++ b/source/blender/blenkernel/BKE_screen.hh @@ -675,6 +675,10 @@ ARegion *BKE_screen_find_main_region_at_xy(const bScreen *screen, int space_type ScrArea *BKE_screen_find_area_from_space(const bScreen *screen, const SpaceLink *sl) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 2); +/** + * \note used to get proper RNA paths for spaces. + */ +std::optional<std::string> BKE_screen_path_from_screen_to_space(const PointerRNA *ptr); /** * \note Using this function is generally a last resort, you really want to be * using the context when you can - campbell diff --git a/source/blender/blenkernel/intern/screen.cc b/source/blender/blenkernel/intern/screen.cc index 5f2b8504acf..2f5e687344d 100644 --- a/source/blender/blenkernel/intern/screen.cc +++ b/source/blender/blenkernel/intern/screen.cc @@ -13,6 +13,8 @@ # include "BLI_winstuff.h" #endif +#include <fmt/format.h> + #include <cmath> #include <cstdio> #include <cstring> @@ -868,6 +870,22 @@ ScrArea *BKE_screen_find_area_from_space(const bScreen *screen, const SpaceLink return nullptr; } +std::optional<std::string> BKE_screen_path_from_screen_to_space(const PointerRNA *ptr) +{ + bScreen *screen = (bScreen *)ptr->owner_id; + SpaceLink *link = (SpaceLink *)ptr->data; + + int area_index; + LISTBASE_FOREACH_INDEX (ScrArea *, area, &screen->areabase, area_index) { + const int space_index = BLI_findindex(&area->spacedata, link); + if (space_index != -1) { + return fmt::format("areas[{}].spaces[{}].", area_index, space_index); + } + } + + return nullptr; +} + ScrArea *BKE_screen_find_big_area(const bScreen *screen, const int spacetype, const short min) { ScrArea *big = nullptr; diff --git a/source/blender/makesrna/intern/rna_space.cc b/source/blender/makesrna/intern/rna_space.cc index e31d702087b..99f1cf7ef74 100644 --- a/source/blender/makesrna/intern/rna_space.cc +++ b/source/blender/makesrna/intern/rna_space.cc @@ -536,6 +536,7 @@ static const EnumPropertyItem rna_enum_curve_display_handle_items[] = { #ifdef RNA_RUNTIME # include <algorithm> +# include <fmt/format.h> # include "AS_asset_representation.hh" @@ -1591,9 +1592,9 @@ static PointerRNA rna_SpaceView3D_overlay_get(PointerRNA *ptr) return rna_pointer_inherit_refine(ptr, &RNA_View3DOverlay, ptr->data); } -static std::optional<std::string> rna_View3DOverlay_path(const PointerRNA * /*ptr*/) +static std::optional<std::string> rna_View3DOverlay_path(const PointerRNA *ptr) { - return "overlay"; + return fmt::format("{}{}", BKE_screen_path_from_screen_to_space(ptr).value_or(""), "overlay"); } /* Space Image Editor */ ```

Bastien Montagne commented

2024-07-18 11:46:39 +02:00

Owner

General approach LGTM from a quick look, yes. :)

General approach LGTM from a quick look, yes. :)

Philipp Oeser referenced a pull request that will close this issue

2024-07-24 12:22:30 +02:00

Fix: Editor related RNA paths incomplete/wrong #125365

Philipp Oeser commented

2024-07-24 12:25:05 +02:00

Member

Fix is up, see !125365

Fix is up, see !125365

Philipp Oeser referenced this issue from a commit

2024-08-05 16:54:53 +02:00

Fix: Editor related RNA paths incomplete/wrong

Philipp Oeser closed this issue

2024-08-05 16:54:55 +02:00

Blender Bot added

and removed

labels 2024-08-05 16:54:57 +02:00

Sign in to join this conversation.

No Label

Animation & Rigging

Automated Testing

Blender Asset Bundle

Dependency Graph

Development Management

Images & Movies

Motion Tracking

Nodes & Physics

Pipeline, Assets & IO

Platforms, Builds & Tests

Render & Cycles

Render Pipeline

Sculpt, Paint & Texture

Video Sequencer

Viewport & EEVEE

Virtual Reality

Asset Browser Project

Blender 2.8 Project

Milestone 1: Basic, Local Asset Browser

Good First Issue

Animation & Rigging

Development Management

Nodes & Physics

Pipeline, Assets & IO

Platforms, Builds & Tests

Render & Cycles

Sculpt, Paint & Texture

Viewport & EEVEE

Needs Info from Developers

Needs Information from User

No Milestone

No project

No Assignees

4 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#124527

No description provided.