PyCod 0.2.1

Author: Scobalula

pycod/__init__.py

@@ -1,5 +1,7 @@
+# <pep8 compliant>
+
 from .xmodel import Model
 from .xanim import Anim
 from .sanim import SiegeAnim
 
-version = (0, 1, 5)  # Version specifier for PyCoD
+version = (0, 2, 1)  # Version specifier for PyCoD

pycod/_lz4.py

@@ -1,20 +1,26 @@
 try:
     # Try to import the python-lz4 package
-    import lz4
+    import lz4.block
 
-except:
+except ImportError:
     # If python-lz4 isn't present, fallback to using pure python
-    import sys
     from io import BytesIO
 
     try:
         from six import byte2int
         from six.moves import xrange
-    except:
+    except ImportError:
         xrange = range
 
-        def byte2int(bytes):
-            return int(bytes[0])
+        # If we're running Python 3 or newer, we must
+        #  define byte2int differently than with Python 2
+        import sys
+        if sys.version_info[0] >= 3:
+            import operator
+            byte2int = operator.itemgetter(0)
+        else:
+            def byte2int(_bytes):
+                return ord(_bytes[0])
 
     class CorruptError(Exception):
         pass
@@ -123,7 +129,10 @@ def compress(data):
 else:
     # Use python-lz4 if present
     __support_mode__ = 'python-lz4'
-    compress = lz4.block.compress
+
+    def compress(data):
+        return lz4.block.compress(data, store_size=False)
+
     uncompress = lz4.block.decompress
 
 support_info = 'LZ4: Using %s' % __support_mode__

pycod/sanim.py

@@ -1,13 +1,23 @@
+# <pep8 compliant>
+
 import json
 import zipfile
 import struct
 
 '''
-    -------------------
+    ---------------------------
     ---< SIEGE_ANIM_SOURCE >---
-    -------------------
+    ---------------------------
 '''
 
+# buffer() is required for file.writestr in Python 2.x but
+#  is no longer required (and doesn't exist) in Python 3.x
+try:
+    buffer
+except NameError:
+    def buffer(data):
+        return data
+
 
 class Frame(object):
     __slots__ = ('index', 'position', 'rotation')

pycod/xanim.py

@@ -1,7 +1,9 @@
+# <pep8 compliant>
+
 from time import strftime
 import os
 
-from .xbin import XBinIO
+from .xbin import XBinIO, validate_version
 
 # Can be int or float
 #  Changes the internal type for frames indices
@@ -75,6 +77,7 @@ def WriteFile_Raw(self, filepath):
     The following are just accessors for various properties of the notetrack
     file
     """
+
     # Literally the first keyed frame in the XANIM_EXPORT file
     def FirstFrame(self):
         return self.first_frame
@@ -95,12 +98,12 @@ def NumKeys(self):
 '''
 
 
-def __clamp_float__(value, clamp=(-1.0, 1.0)):
-    return max(min(value, clamp[1]), clamp[0])
+def __clamp_float__(value, clamp_range=(-1.0, 1.0)):
+    return max(min(value, clamp_range[1]), clamp_range[0])
 
 
-def __clamp_multi__(value, clamp=(-1.0, 1.0)):
-    return tuple([max(min(v, clamp[1]), clamp[0]) for v in value])
+def __clamp_multi__(value, clamp_range=(-1.0, 1.0)):
+    return tuple([max(min(v, clamp_range[1]), clamp_range[0]) for v in value])
 
 
 def __clean_float2str__(value):
@@ -110,7 +113,7 @@ def __clean_float2str__(value):
 class PartInfo(object):
     '''In the context of an XANIM_EXPORT file, a 'part' is essentially a
     bone'''
-    __slots__ = ('name')
+    __slots__ = ('name',)
 
     def __init__(self, name):
         self.name = name
@@ -170,7 +173,9 @@ def __load_part__(self, file, part_count):
                 part = self.parts[part_index]
                 state = 2
             elif state == 2 and line_split[0] == "SCALE":
-                # Scales are not required and not used anymore, so we share state 2
+                # Scales are now deprecated and, in some cases
+                #  aren't actually required; so we reuse state 2
+                #  to do soft check for the SCALE block
                 scale = (float(line_split[1]),
                          float(line_split[2]),
                          float(line_split[3]))
@@ -201,17 +206,16 @@ def _load_parts_(self, file, part_count):
         self.parts = [FramePart()] * part_count
 
         lines_read = 0
-        for part in range(part_count):
+        for _ in range(part_count):
             lines_read += self.__load_part__(file, part_count)
         return lines_read
 
 
 class Anim(XBinIO, object):
-    __slots__ = ('version', 'framerate', 'parts', 'frames', 'notes')
+    __slots__ = ('framerate', 'parts', 'frames', 'notes')
 
     def __init__(self):
-        super(Anim, self).__init__()
-        self.version = None
+        super(XBinIO, self).__init__()
         self.framerate = None
         self.parts = []
         self.frames = []
@@ -278,6 +282,13 @@ def __load_frames__(self, file):
             elif line_split[0] == "FRAME":
                 frame_number = FRAME_TYPE(line_split[1])
 
+                # Don't enable this until anims that don't start on frame 0 are
+                #  sorted out
+                # if frame_number >= frame_count:
+                #   fmt = ("frame_count does not index frame_number -- "
+                #          "%d not in [0, %d)")
+                #   raise ValueError(fmt % (frame_number, frame_count))
+
                 lines_read += self.__load_frame__(file,
                                                   frame_index, frame_number)
                 frame_index += 1
@@ -376,16 +387,15 @@ def WriteFile_Raw(self, path, version=3,
         if last_frame - first_frame != len(self.frames):
             fmt = ("The keyed frame count and number of frames do not match"
                    " (%d != %d)")
-            err = (	fmt % (last_frame - first_frame, len(self.frames)))
+            err = (fmt % (last_frame - first_frame, len(self.frames)))
             raise ValueError(err)
 
         file = open(path, "w")
         file.write(header_message)
         file.write("// Export time: %s\n\n" % strftime("%a %b %d %H:%M:%S %Y"))
 
         # If there is no current version, fallback to the argument
-        if self.version is None:
-            self.version = version
+        version = validate_version(self, version)
 
         file.write("ANIMATION\n")
         file.write("VERSION %d\n\n" % self.version)
@@ -401,7 +411,7 @@ def WriteFile_Raw(self, path, version=3,
             file.write("FRAME %s\n" % __clean_float2str__(frame.frame))
             for part_index, part in enumerate(frame.parts):
                 file.write("PART %d\n" % part_index)
-                # Investigate precision options?
+                # TODO: Investigate precision options?
                 offset = (part.offset[0], part.offset[1], part.offset[2])
                 scale = (part.scale[0], part.scale[1], part.scale[2])
                 file.write("OFFSET %f %f %f\n" % offset)
@@ -474,8 +484,7 @@ def LoadFile_Bin(self, path, is_compressed=True, dump=False):
 
     def WriteFile_Bin(self, path, version=3, header_message=""):
         # If there is no current version, fallback to the argument
-        if self.version is None:
-            self.version = version
+        version = validate_version(self, version)
         return self.__xbin_writefile_anim_internal__(path,
                                                      self.version,
                                                      header_message)