PyAPI: remove operator methods that leak memory
[blender.git] / release / scripts / modules / bpy / ops.py
1 # ##### BEGIN GPL LICENSE BLOCK #####
2 #
3 #  This program is free software; you can redistribute it and/or
4 #  modify it under the terms of the GNU General Public License
5 #  as published by the Free Software Foundation; either version 2
6 #  of the License, or (at your option) any later version.
7 #
8 #  This program is distributed in the hope that it will be useful,
9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 #  GNU General Public License for more details.
12 #
13 #  You should have received a copy of the GNU General Public License
14 #  along with this program; if not, write to the Free Software Foundation,
15 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 #
17 # ##### END GPL LICENSE BLOCK #####
18
19 # <pep8-80 compliant>
20
21 # for slightly faster access
22 from _bpy import ops as ops_module
23
24 # op_add = ops_module.add
25 op_dir = ops_module.dir
26 op_poll = ops_module.poll
27 op_call = ops_module.call
28 op_as_string = ops_module.as_string
29 op_get_rna_type = ops_module.get_rna_type
30
31
32 class BPyOps:
33     """
34     Fake module like class.
35
36      bpy.ops
37     """
38     __slots__ = ()
39
40     def __getattr__(self, module):
41         """
42         gets a bpy.ops submodule
43         """
44         if module.startswith('__'):
45             raise AttributeError(module)
46         return BPyOpsSubMod(module)
47
48     def __dir__(self):
49
50         submodules = set()
51
52         # add this classes functions
53         for id_name in dir(self.__class__):
54             if not id_name.startswith('__'):
55                 submodules.add(id_name)
56
57         for id_name in op_dir():
58             id_split = id_name.split('_OT_', 1)
59
60             if len(id_split) == 2:
61                 submodules.add(id_split[0].lower())
62             else:
63                 submodules.add(id_split[0])
64
65         return list(submodules)
66
67     def __repr__(self):
68         return "<module like class 'bpy.ops'>"
69
70
71 class BPyOpsSubMod:
72     """
73     Utility class to fake submodules.
74
75     eg. bpy.ops.object
76     """
77     __slots__ = ("_module",)
78
79     def __init__(self, module):
80         self._module = module
81
82     def __getattr__(self, func):
83         """
84         gets a bpy.ops.submodule function
85         """
86         if func.startswith('__'):
87             raise AttributeError(func)
88         return BPyOpsSubModOp(self._module, func)
89
90     def __dir__(self):
91
92         functions = set()
93
94         module_upper = self._module.upper()
95
96         for id_name in op_dir():
97             id_split = id_name.split('_OT_', 1)
98             if len(id_split) == 2 and module_upper == id_split[0]:
99                 functions.add(id_split[1])
100
101         return list(functions)
102
103     def __repr__(self):
104         return "<module like class 'bpy.ops.%s'>" % self._module
105
106
107 class BPyOpsSubModOp:
108     """
109     Utility class to fake submodule operators.
110
111     eg. bpy.ops.object.somefunc
112     """
113
114     __slots__ = ("_module", "_func")
115
116     def _get_doc(self):
117         idname = self.idname()
118         sig = op_as_string(self.idname())
119         # XXX You never quite know what you get from bpy.types,
120         # with operators... Operator and OperatorProperties
121         # are shadowing each other, and not in the same way for
122         # native ops and py ones! See T39158.
123         # op_class = getattr(bpy.types, idname)
124         op_class = op_get_rna_type(idname)
125         descr = op_class.description
126         return f"{sig}\n{descr}"
127
128     @staticmethod
129     def _parse_args(args):
130         C_dict = None
131         C_exec = 'EXEC_DEFAULT'
132         C_undo = False
133
134         is_dict = is_exec = is_undo = False
135
136         for i, arg in enumerate(args):
137             if is_dict is False and isinstance(arg, dict):
138                 if is_exec is True or is_undo is True:
139                     raise ValueError("dict arg must come first")
140                 C_dict = arg
141                 is_dict = True
142             elif is_exec is False and isinstance(arg, str):
143                 if is_undo is True:
144                     raise ValueError("string arg must come before the boolean")
145                 C_exec = arg
146                 is_exec = True
147             elif is_undo is False and isinstance(arg, int):
148                 C_undo = arg
149                 is_undo = True
150             else:
151                 raise ValueError("1-3 args execution context is supported")
152
153         return C_dict, C_exec, C_undo
154
155     @staticmethod
156     def _scene_update(context):
157         scene = context.scene
158         if scene:  # None in background mode
159             scene.update()
160         else:
161             import bpy
162             for scene in bpy.data.scenes:
163                 scene.update()
164
165     __doc__ = property(_get_doc)
166
167     def __init__(self, module, func):
168         self._module = module
169         self._func = func
170
171     def poll(self, *args):
172         C_dict, C_exec, C_undo = BPyOpsSubModOp._parse_args(args)
173         return op_poll(self.idname_py(), C_dict, C_exec)
174
175     def idname(self):
176         # submod.foo -> SUBMOD_OT_foo
177         return self._module.upper() + "_OT_" + self._func
178
179     def idname_py(self):
180         # submod.foo -> SUBMOD_OT_foo
181         return self._module + "." + self._func
182
183     def __call__(self, *args, **kw):
184         import bpy
185         context = bpy.context
186
187         # Get the operator from blender
188         wm = context.window_manager
189
190         # run to account for any rna values the user changes.
191         BPyOpsSubModOp._scene_update(context)
192
193         if args:
194             C_dict, C_exec, C_undo = BPyOpsSubModOp._parse_args(args)
195             ret = op_call(self.idname_py(), C_dict, kw, C_exec, C_undo)
196         else:
197             ret = op_call(self.idname_py(), None, kw)
198
199         if 'FINISHED' in ret and context.window_manager == wm:
200             BPyOpsSubModOp._scene_update(context)
201
202         return ret
203
204     def get_rna_type(self):
205         """Internal function for introspection"""
206         return op_get_rna_type(self.idname())
207
208     def __repr__(self):  # useful display, repr(op)
209         # import bpy
210         return op_as_string(self.idname())
211
212     def __str__(self):  # used for print(...)
213         return ("<function bpy.ops.%s.%s at 0x%x'>" %
214                 (self._module, self._func, id(self)))
215
216
217 ops_fake_module = BPyOps()