Merge branch 'master' into blender2.8
[blender.git] / tests / python / rna_info_dump.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 compliant>
20
21 # Used for generating API diffs between releases
22 #  ./blender.bin --background -noaudio --python tests/python/rna_info_dump.py
23
24 import bpy
25
26
27 def api_dump(use_properties=True, use_functions=True):
28
29     def prop_type(prop):
30         if prop.type == "pointer":
31             return prop.fixed_type.identifier
32         else:
33             return prop.type
34
35     def func_to_str(struct_id_str, func_id, func):
36
37         args = []
38         for prop in func.args:
39             data_str = "%s %s" % (prop_type(prop), prop.identifier)
40             if prop.array_length:
41                 data_str += "[%d]" % prop.array_length
42             if not prop.is_required:
43                 data_str += "=%s" % prop.default_str
44             args.append(data_str)
45
46         data_str = "%s.%s(%s)" % (struct_id_str, func_id, ", ".join(args))
47         if func.return_values:
48             return_args = ", ".join(prop_type(arg) for arg in func.return_values)
49             if len(func.return_values) > 1:
50                 data_str += "  -->  (%s)" % return_args
51             else:
52                 data_str += "  -->  %s" % return_args
53         return data_str
54
55     def prop_to_str(struct_id_str, prop_id, prop):
56
57         prop_str = "  <--  %s" % prop_type(prop)
58         if prop.array_length:
59             prop_str += "[%d]" % prop.array_length
60
61         data_str = "%s.%s %s" % (struct_id_str, prop_id, prop_str)
62         return data_str
63
64     def struct_full_id(v):
65         struct_id_str = v.identifier  # "".join(sid for sid in struct_id if struct_id)
66
67         for base in v.get_bases():
68             struct_id_str = base.identifier + "|" + struct_id_str
69
70         return struct_id_str
71
72     def dump_funcs():
73         data = []
74         for _struct_id, v in sorted(struct.items()):
75             struct_id_str = struct_full_id(v)
76
77             funcs = [(func.identifier, func) for func in v.functions]
78
79             for func_id, func in funcs:
80                 data.append(func_to_str(struct_id_str, func_id, func))
81
82             for prop in v.properties:
83                 if prop.collection_type:
84                     funcs = [(prop.identifier + "." + func.identifier, func) for func in prop.collection_type.functions]
85                     for func_id, func in funcs:
86                         data.append(func_to_str(struct_id_str, func_id, func))
87         data.sort()
88         data.append("# * functions *")
89         return data
90
91     def dump_props():
92         data = []
93         for _struct_id, v in sorted(struct.items()):
94             struct_id_str = struct_full_id(v)
95
96             props = [(prop.identifier, prop) for prop in v.properties]
97
98             for prop_id, prop in props:
99                 data.append(prop_to_str(struct_id_str, prop_id, prop))
100
101             for prop in v.properties:
102                 if prop.collection_type:
103                     props = [(prop.identifier + "." + prop_sub.identifier, prop_sub) for prop_sub in prop.collection_type.properties]
104                     for prop_sub_id, prop_sub in props:
105                         data.append(prop_to_str(struct_id_str, prop_sub_id, prop_sub))
106         data.sort()
107         data.insert(0, "# * properties *")
108         return data
109
110     import rna_info
111     struct = rna_info.BuildRNAInfo()[0]
112     data = []
113
114     if use_functions:
115         data.extend(dump_funcs())
116
117     if use_properties:
118         data.extend(dump_props())
119
120     if bpy.app.background:
121         import sys
122         sys.stderr.write("\n".join(data))
123         sys.stderr.write("\n\nEOF\n")
124     else:
125         text = bpy.data.texts.new(name="api.py")
126         text.from_string(data)
127
128     print("END")
129
130
131 if __name__ == "__main__":
132     api_dump()