Cleanup: use staticmethod where appropriate
[blender.git] / release / scripts / templates_py / operator_file_import.py
1 import bpy
2
3
4 def read_some_data(context, filepath, use_some_setting):
5     print("running read_some_data...")
6     f = open(filepath, 'r', encoding='utf-8')
7     data = f.read()
8     f.close()
9
10     # would normally load the data here
11     print(data)
12
13     return {'FINISHED'}
14
15
16 # ImportHelper is a helper class, defines filename and
17 # invoke() function which calls the file selector.
18 from bpy_extras.io_utils import ImportHelper
19 from bpy.props import StringProperty, BoolProperty, EnumProperty
20 from bpy.types import Operator
21
22
23 class ImportSomeData(Operator, ImportHelper):
24     """This appears in the tooltip of the operator and in the generated docs"""
25     bl_idname = "import_test.some_data"  # important since its how bpy.ops.import_test.some_data is constructed
26     bl_label = "Import Some Data"
27
28     # ImportHelper mixin class uses this
29     filename_ext = ".txt"
30
31     filter_glob: StringProperty(
32         default="*.txt",
33         options={'HIDDEN'},
34         maxlen=255,  # Max internal buffer length, longer would be clamped.
35     )
36
37     # List of operator properties, the attributes will be assigned
38     # to the class instance from the operator settings before calling.
39     use_setting: BoolProperty(
40         name="Example Boolean",
41         description="Example Tooltip",
42         default=True,
43     )
44
45     type: EnumProperty(
46         name="Example Enum",
47         description="Choose between two items",
48         items=(
49             ('OPT_A', "First Option", "Description one"),
50             ('OPT_B', "Second Option", "Description two"),
51         ),
52         default='OPT_A',
53     )
54
55     def execute(self, context):
56         return read_some_data(context, self.filepath, self.use_setting)
57
58
59 # Only needed if you want to add into a dynamic menu
60 def menu_func_import(self, context):
61     self.layout.operator(ImportSomeData.bl_idname, text="Text Import Operator")
62
63
64 def register():
65     bpy.utils.register_class(ImportSomeData)
66     bpy.types.TOPBAR_MT_file_import.append(menu_func_import)
67
68
69 def unregister():
70     bpy.utils.unregister_class(ImportSomeData)
71     bpy.types.TOPBAR_MT_file_import.remove(menu_func_import)
72
73
74 if __name__ == "__main__":
75     register()
76
77     # test call
78     bpy.ops.import_test.some_data('INVOKE_DEFAULT')