Use 'empty' option for clearing factory settings
[blender.git] / tests / python / 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 tests/python/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 tests/python/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 ./blender.bin --background --addons io_curve_svg --python tests/python/batch_import.py -- \
39     --operator="bpy.ops.import_curve.svg" \
40     --path="/usr/" \
41     --match="*.svg" \
42     --start=0 --end=1000 \
43     --save_path=/tmp/test
44
45 """
46
47 import os
48 import sys
49
50
51 def batch_import(
52     operator="",
53     path="",
54     save_path="",
55     match="",
56     start=0,
57     end=sys.maxsize,
58 ):
59     import addon_utils
60     _reset_all = addon_utils.reset_all  # XXX, hack
61     _disable_all = addon_utils.disable_all  # XXX, hack
62
63     import fnmatch
64
65     path = os.path.normpath(path)
66     path = os.path.abspath(path)
67
68     match_upper = match.upper()
69
70     def pattern_match(a):
71         return 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     import bpy
97     op = eval(operator)
98
99     tot_done = 0
100     tot_fail = 0
101
102     for i, f in enumerate(files):
103         print("    %s(filepath=%r) # %d of %d" % (operator, f, i + start, len(files)))
104
105         # hack so loading the new file doesn't undo our loaded addons
106         addon_utils.reset_all = lambda: None  # XXX, hack
107         addon_utils.disable_all = lambda: None  # XXX, hack
108
109         bpy.ops.wm.read_factory_settings(use_empty=True)
110
111         addon_utils.reset_all = _reset_all  # XXX, hack
112         addon_utils.disable_all = _disable_all  # XXX, hack
113
114         result = op(filepath=f)
115
116         if 'FINISHED' in result:
117             tot_done += 1
118         else:
119             tot_fail += 1
120
121         if save_path:
122             fout = os.path.join(save_path, os.path.relpath(f, path))
123             fout_blend = os.path.splitext(fout)[0] + ".blend"
124
125             print("\tSaving: %r" % fout_blend)
126
127             fout_dir = os.path.dirname(fout_blend)
128             os.makedirs(fout_dir, exist_ok=True)
129
130             bpy.ops.wm.save_as_mainfile(filepath=fout_blend)
131
132     print("finished, done:%d,  fail:%d" % (tot_done, tot_fail))
133
134
135 def main():
136     import optparse
137
138     # get the args passed to blender after "--", all of which are ignored by blender specifically
139     # so python may receive its own arguments
140     argv = sys.argv
141
142     if "--" not in argv:
143         argv = []  # as if no args are passed
144     else:
145         argv = argv[argv.index("--") + 1:]  # get all args after "--"
146
147     # When --help or no args are given, print this help
148     usage_text = "Run blender in background mode with this script:"
149     usage_text += "  blender --background --python " + __file__ + " -- [options]"
150
151     parser = optparse.OptionParser(usage=usage_text)
152
153     # Example background utility, add some text and renders or saves it (with options)
154     # Possible types are: string, int, long, choice, float and complex.
155     parser.add_option("-o", "--operator", dest="operator", help="This text will be used to render an image", type="string")
156     parser.add_option("-p", "--path", dest="path", help="Path to use for searching for files", type='string')
157     parser.add_option("-m", "--match", dest="match", help="Wildcard to match filename", type="string")
158     parser.add_option("-s", "--save_path", dest="save_path", help="Save the input file to a blend file in a new location", metavar='string')
159     parser.add_option("-S", "--start", dest="start", help="From collected files, start with this index", metavar='int')
160     parser.add_option("-E", "--end", dest="end", help="From collected files, end with this index", metavar='int')
161
162     options, args = parser.parse_args(argv)  # In this example we wont use the args
163
164     if not argv:
165         parser.print_help()
166         return
167
168     if not options.operator:
169         print("Error: --operator=\"some string\" argument not given, aborting.")
170         parser.print_help()
171         return
172
173     if options.start is None:
174         options.start = 0
175
176     if options.end is None:
177         options.end = sys.maxsize
178
179     # Run the example function
180     batch_import(operator=options.operator,
181                  path=options.path,
182                  save_path=options.save_path,
183                  match=options.match,
184                  start=int(options.start),
185                  end=int(options.end),
186                  )
187
188     print("batch job finished, exiting")
189
190
191 if __name__ == "__main__":
192     main()