Merged changes in the trunk up to revision 50607.
[blender.git] / source / tests / bl_rna_wiki_reference.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 # Use for validating our wiki interlinking.
22 #  ./blender.bin --background -noaudio --python source/tests/bl_rna_wiki_reference.py
23 #
24 # 1) test_lookup_coverage()   -- ensure that we have lookups for _every_ RNA path
25 # 2) test_urls()              -- ensure all the URL's are correct
26 # 3) test_language_coverage() -- ensure language lookup table is complete
27 #
28
29 import bpy
30
31 # a stripped down version of api_dump() in rna_info_dump.py
32
33
34 def test_lookup_coverage():
35
36     def rna_ids():
37         
38         import rna_info
39         struct = rna_info.BuildRNAInfo()[0]
40         for struct_id, v in sorted(struct.items()):
41             props = [(prop.identifier, prop) for prop in v.properties]
42             for prop_id, prop in props:
43                 yield "bpy.types.%s.%s" % (struct_id[1], prop_id)
44
45         for submod_id in dir(bpy.ops):
46             for op_id in dir(getattr(bpy.ops, submod_id)):
47                 yield "bpy.ops.%s.%s" % (submod_id, op_id)
48
49     # check coverage
50     from bl_operators import wm
51
52     for rna_id in rna_ids():
53         url = wm.WM_OT_doc_view_manual._lookup_rna_url(rna_id, verbose=False)
54         print(rna_id, "->", url)
55
56
57 def test_urls():
58     pass  # TODO
59
60
61 def test_language_coverage():
62     pass  # TODO
63
64
65 def main():
66     test_lookup_coverage()
67     test_language_coverage()
68
69 if __name__ == "__main__":
70     main()