ImportHelper: Common methods for FileHandler drag and drop support #119774

Jesse Yurkovich · 2024-03-22T09:46:53+01:00

Jesse Yurkovich commented

2024-03-22 09:46:53 +01:00

Provide common implementations for two operations that all Python
FileHandlers will typically use.

poll_file_object_drop To be used inside the FileHandler poll_drop callback
invoke_popup To be used inside the Operator invoke callback

The above code closely mirrors what is currently done inside the existing Blender c++ FileHandlers.

Provide common implementations for two operations that all Python FileHandlers will typically use. - `poll_file_object_drop` To be used inside the FileHandler `poll_drop` callback - `invoke_popup` To be used inside the Operator `invoke` callback The above code closely mirrors what is currently done inside the existing Blender c++ FileHandlers.

👍 1

Jesse Yurkovich added 1 commit 2024-03-22 09:47:02 +01:00

22e203e9cc ImportHelper: Provide common methods for drag and drop

Jesse Yurkovich referenced this pull request

2024-03-22 09:50:47 +01:00

Complete File Handler support #119488

Jesse Yurkovich requested review from Bastien Montagne 2024-03-22 09:51:49 +01:00

Jesse Yurkovich commented

2024-03-22 09:53:55 +01:00

CC @guishe as FYI

Damien Picard reviewed 2024-03-25 01:54:21 +01:00

Damien Picard left a comment

I’ve got a few remarks in addition to the ones noted inline:

The filepath property should have the 'HIDDEN' option to prevent it from being shown in the file handler popup.
I think it would be nice to show how to use this in the docs. Here is an updated example file:
bpy.types.FileHandler.2.py

I’ve got a few remarks in addition to the ones noted inline: - The `filepath` property should have the 'HIDDEN' option to prevent it from being shown in the file handler popup. - I think it would be nice to show how to use this in the docs. Here is an updated example file: [bpy.types.FileHandler.2.py](/attachments/ed54f9bf-db1e-413a-9598-35b56ba37672)

bpy.types.FileHandler.2.py

3.6 KiB

scripts/modules/bpy_extras/io_utils.py Outdated

						
				@ -102,6 +102,16 @@ class ImportHelper:

				        context.window_manager.fileselect_add(self)

				        return {'RUNNING_MODAL'}

				    def invoke_popup(self, context, confirm_text="Ok"):

Damien Picard commented

2024-03-25 01:44:37 +01:00

I think it would be better to follow the c++ implementation and use bl_label as confirmation text by default rather than “Ok”:

    def invoke_popup(self, context, confirm_text=""):
        if not confirm_text:
            confirm_text = self.bl_label

I think it would be better to follow the c++ implementation and use `bl_label` as confirmation text by default rather than “Ok”: ```python def invoke_popup(self, context, confirm_text=""): if not confirm_text: confirm_text = self.bl_label ```

deadpin marked this conversation as resolved

scripts/modules/bpy_extras/io_utils.py Outdated

						
				@ -105,0 +106,4 @@

				        if self.properties.is_property_set("filepath"):

				            title = self.filepath

				            if len(self.files) > 1:

				                title = "Import %d files" % len(self.files)

Damien Picard commented

2024-03-25 01:38:39 +01:00

This should be translated:

@@ -23,7 +23,10 @@ from bpy.props import (
     EnumProperty,
     StringProperty,
 )
-from bpy.app.translations import pgettext_data as data_
+from bpy.app.translations import (
+    pgettext_iface as iface_,
+    pgettext_data as data_,
+    )
 
 
 def _check_axis_conversion(op):
@@ -106,9 +109,11 @@ class ImportHelper:
         if self.properties.is_property_set("filepath"):
             title = self.filepath
             if len(self.files) > 1:
-                title = "Import %d files" % len(self.files)
-            context.window_manager.invoke_props_dialog(self, confirm_text=confirm_text, title=title)
-            return {'RUNNING_MODAL'}
+                title = iface_("Import {} files").format(len(self.files))
+            confirm_text = iface_(confirm_text)
+            return context.window_manager.invoke_props_dialog(
+                self, confirm_text=confirm_text, title=title, translate=False
+            )
         context.window_manager.fileselect_add(self)
         return {'RUNNING_MODAL'}

I’m using str.format() simply to reuse the existing translation message from the c++ implementation.

This should be translated: ```diff @@ -23,7 +23,10 @@ from bpy.props import ( EnumProperty, StringProperty, ) -from bpy.app.translations import pgettext_data as data_ +from bpy.app.translations import ( + pgettext_iface as iface_, + pgettext_data as data_, + ) def _check_axis_conversion(op): @@ -106,9 +109,11 @@ class ImportHelper: if self.properties.is_property_set("filepath"): title = self.filepath if len(self.files) > 1: - title = "Import %d files" % len(self.files) - context.window_manager.invoke_props_dialog(self, confirm_text=confirm_text, title=title) - return {'RUNNING_MODAL'} + title = iface_("Import {} files").format(len(self.files)) + confirm_text = iface_(confirm_text) + return context.window_manager.invoke_props_dialog( + self, confirm_text=confirm_text, title=title, translate=False + ) context.window_manager.fileselect_add(self) return {'RUNNING_MODAL'} ``` I’m using `str.format()` simply to reuse the existing translation message from the c++ implementation.

deadpin marked this conversation as resolved

Jesse Yurkovich added 1 commit 2024-03-25 03:53:50 +01:00

5df89af457 Feedback

Jesse Yurkovich commented

2024-03-25 03:54:44 +01:00

Aye, thanks for the feedback. I've added a slightly modified variation of bpy.types.FileHandler.2.py now too.

Aye, thanks for the feedback. I've added a slightly modified variation of `bpy.types.FileHandler.2.py` now too.

👍 1

Bastien Montagne approved these changes 2024-03-28 03:50:55 +01:00

Bastien Montagne left a comment

LGTM

Jesse Yurkovich merged commit af7a34dee7 into main