Otiostat program: validate and print information about your .otio file.

bin/otiostat.py

@@ -0,0 +1,138 @@
+#!/usr/bin/env python
+#
+# Copyright 2017 Pixar Animation Studios
+#
+# Licensed under the Apache License, Version 2.0 (the "Apache License")
+# with the following modification; you may not use this file except in
+# compliance with the Apache License and the following modification to it:
+# Section 6. Trademarks. is deleted and replaced with:
+#
+# 6. Trademarks. This License does not grant permission to use the trade
+#    names, trademarks, service marks, or product names of the Licensor
+#    and its affiliates, except as required to comply with Section 4(c) of
+#    the License and to reproduce the content of the NOTICE file.
+#
+# You may obtain a copy of the Apache License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the Apache License with the above modification is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the Apache License for the specific
+# language governing permissions and limitations under the Apache License.
+#
+
+"""Print statistics about the otio file, including validation information."""
+
+import argparse
+import sys
+
+import opentimelineio as otio
+
+
+def _parsed_args():
+    """ parse commandline arguments with argparse """
+
+    parser = argparse.ArgumentParser(
+        description=__doc__,
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter
+    )
+    parser.add_argument(
+        'filepath',
+        type=str,
+        nargs='+',
+        help='files to operate on'
+    )
+
+    return parser.parse_args()
+
+
+TESTS = []
+
+
+def stat_check(name):
+    def real_stat_check(fn):
+        TESTS.append((name, fn))
+        return fn
+    return real_stat_check
+
+
+@stat_check("parsed")
+def _did_parse(input):
+    return input and True or False
+
+
+@stat_check("top level object")
+def _top_level_object(input):
+    return input._serializable_label
+
+
+@stat_check("number of tracks")
+def _num_tracks(input):
+    return len(input.tracks)
+
+
+@stat_check("number of clips")
+def _num_clips(input):
+    return len(list(input.each_clip()))
+
+
+@stat_check("total duration")
+def _total_duration(input):
+    return input.tracks.duration()
+
+
+@stat_check("clips with cdl data")
+def _clips_with_cdl_data(input):
+    return len(list(c for c in input.each_clip() if 'cdl' in c.metadata))
+
+
+@stat_check("Sequences with non standard types")
+def _sequences_with_non_standard_types(input):
+    return len(
+        list(
+            c
+            for c in input.each_child(descended_from_type=otio.schema.Sequence)
+            if c.kind not in (otio.schema.SequenceKind.__dict__)
+        )
+    )
+
+
+def _stat_otio(input_otio):
+    for (test, testfunc) in TESTS:
+        try:
+            print("{}: {}".format(test, testfunc(input_otio)))
+        except (otio.exceptions.OTIOError) as e:
+            sys.stderr.write(
+                "There was an OTIO Error: "
+                " {}\n".format(e),
+            )
+            continue
+        except (Exception) as e:
+            sys.stderr.write("There was a system error: {}\n".format(e))
+            continue
+
+
+def main():
+    """  main entry point  """
+    args = _parsed_args()
+
+    for fp in args.filepath:
+        try:
+            parsed_otio = otio.adapters.read_from_file(fp)
+        except (otio.exceptions.OTIOError) as e:
+            sys.stderr.write(
+                "The file did not successfully parse, with error:"
+                " {}\n".format(e),
+            )
+            continue
+        except (Exception) as e:
+            sys.stderr.write("There was a system error: {}\n".format(e))
+            continue
+
+        _stat_otio(parsed_otio)
+
+
+if __name__ == '__main__':
+    main()