Merged changes in the trunk up to revision 34670.
[blender.git] / source / tests / batch_import.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 """
22 Example Usage:
23
24 ./blender.bin --background --python source/tests/batch_import.py -- \
25     --operator="bpy.ops.import_scene.obj" \
26     --path="/fe/obj" \
27     --match="*.obj" \
28     --start=0 --end=10 \
29     --save_path=/tmp/test
30
31 ./blender.bin --background --python source/tests/batch_import.py -- \
32     --operator="bpy.ops.import_scene.autodesk_3ds" \
33     --path="/fe/" \
34     --match="*.3ds" \
35     --start=0 --end=1000 \
36     --save_path=/tmp/test
37 """
38
39 import os
40 import sys
41
42 def clear_scene():
43     import bpy
44     unique_obs = set()
45     for scene in bpy.data.scenes:
46         for obj in scene.objects[:]:
47             scene.objects.unlink(obj)
48             unique_obs.add(obj)
49
50     # remove obdata, for now only worry about the startup scene
51     for bpy_data_iter in (bpy.data.objects, bpy.data.meshes, bpy.data.lamps, bpy.data.cameras):
52         for id_data in bpy_data_iter:
53             bpy_data_iter.remove(id_data)
54
55
56 def batch_import(operator="",
57                    path="",
58                    save_path="",
59                    match="",
60                    start=0,
61                    end=sys.maxsize,
62                    ):
63
64     print(list(globals().keys()))
65     import fnmatch
66
67     path = os.path.normpath(path)
68     path = os.path.abspath(path)
69
70     match_upper = match.upper()
71     pattern_match = lambda a: fnmatch.fnmatchcase(a.upper(), match_upper)
72
73     def file_generator(path):
74         for dirpath, dirnames, filenames in os.walk(path):
75
76             # skip '.svn'
77             if dirpath.startswith("."):
78                 continue
79
80             for filename in filenames:
81                 if pattern_match(filename):
82                     yield os.path.join(dirpath, filename)
83
84     print("Collecting %r files in %s" % (match, path), end="")
85
86     files = list(file_generator(path))
87     files_len = len(files)
88     end = min(end, len(files))
89     print(" found %d" % files_len, end="")
90
91     files.sort()
92     files = files[start:end]
93     if len(files) != files_len:
94         print(" using a subset in (%d, %d), total %d" % (start, end, len(files)), end="")
95
96     print("")
97
98     import bpy
99     op = eval(operator)
100     for i, f in enumerate(files):
101         print("    %s(filepath=%r) # %d of %d" % (operator, f, i + start, len(files)))
102         bpy.ops.wm.read_factory_settings()
103         clear_scene()
104
105         op(filepath=f)
106
107         if save_path:
108             fout = os.path.join(save_path, os.path.relpath(f, path))
109             fout_blend = os.path.splitext(fout)[0] + ".blend"
110
111             print("\tSaving: %r" % fout_blend)
112
113             fout_dir = os.path.dirname(fout_blend)
114             if not os.path.exists(fout_dir):
115                 os.makedirs(fout_dir)
116
117             bpy.ops.wm.save_as_mainfile(filepath=fout_blend)
118
119
120 def main():
121     import optparse
122
123     # get the args passed to blender after "--", all of which are ignored by blender specifically
124     # so python may receive its own arguments
125     argv = sys.argv
126
127     if "--" not in argv:
128         argv = []  # as if no args are passed
129     else:
130         argv = argv[argv.index("--") + 1:]  # get all args after "--"
131
132     # When --help or no args are given, print this help
133     usage_text = "Run blender in background mode with this script:"
134     usage_text += "  blender --background --python " + __file__ + " -- [options]"
135
136     parser = optparse.OptionParser(usage=usage_text)
137
138     # Example background utility, add some text and renders or saves it (with options)
139     # Possible types are: string, int, long, choice, float and complex.
140     parser.add_option("-o", "--operator", dest="operator", help="This text will be used to render an image", type="string")
141     parser.add_option("-p", "--path", dest="path", help="Path to use for searching for files", type='string')
142     parser.add_option("-m", "--match", dest="match", help="Wildcard to match filename", type="string")
143     parser.add_option("-s", "--save_path", dest="save_path", help="Save the input file to a blend file in a new location", metavar='string')
144     parser.add_option("-S", "--start", dest="start", help="From collected files, start with this index", metavar='int')
145     parser.add_option("-E", "--end", dest="end", help="From collected files, end with this index", metavar='int')
146
147     options, args = parser.parse_args(argv)  # In this example we wont use the args
148
149     if not argv:
150         parser.print_help()
151         return
152
153     if not options.operator:
154         print("Error: --operator=\"some string\" argument not given, aborting.")
155         parser.print_help()
156         return
157
158     if options.start is None:
159         options.start = 0
160
161     if options.end is None:
162         options.end = sys.maxsize
163
164     # Run the example function
165     batch_import(operator=options.operator,
166                  path=options.path,
167                  save_path=options.save_path,
168                  match=options.match,
169                  start=int(options.start),
170                  end=int(options.end),
171                  )
172
173     print("batch job finished, exiting")
174
175
176 if __name__ == "__main__":
177     main()