Initial Python 3 support

Author: clenk

.travis.yml

@@ -1,11 +1,18 @@
 language: python
+
+python:
+  - 3.5
+
 env:
   - TOXENV=py26
   - TOXENV=py27
+  - TOXENV=py33
+  - TOXENV=py34
+  - TOXENV=py35
   - TOXENV=rhel6
 
 install:
-  - pip install tox
+  - pip install -U tox
 
 script:
   - tox

docs/api_vs_bindings/api_snippet.rst

@@ -32,4 +32,4 @@
   b.add_action(a)
   
   # Output the Bundle to stdout
-  print b.to_xml(include_namespaces = False)
+  print(b.to_xml(include_namespaces = False))

docs/examples.rst

@@ -41,7 +41,7 @@ different types of analysis.
     ms = MalwareSubject()
     p.add_malware_subject(ms)
 
-    print p.to_xml(include_namespaces=False)
+    print(p.to_xml(include_namespaces=False, encoding=None))
 
 Which outputs:
 
@@ -77,7 +77,7 @@ that it is characterizing.
     ms.malware_instance_object_attributes.properties = File()
     ms.malware_instance_object_attributes.properties.file_name = "malware.exe"
     ms.malware_instance_object_attributes.properties.file_path = "C:\Windows\Temp\malware.exe"
-    print ms.to_xml(include_namespaces=False)
+    print(ms.to_xml(include_namespaces=False, encoding=None))
 
 Which outputs:
 
@@ -125,7 +125,7 @@ instance that it is characterizing.
     b.malware_instance_object_attributes.properties.file_name = "malware.exe"
     b.malware_instance_object_attributes.properties.file_path = "C:\Windows\Temp\malware.exe"
 
-    print b.to_xml(include_namespaces=False)
+    print(b.to_xml(include_namespaces=False, encoding=None))
 
 Which outputs:
 
@@ -168,7 +168,7 @@ be defined in their parent Malware Subject.
     b = Bundle()
     ms.add_findings_bundle(b)
 
-    print ms.to_xml(include_namespaces=False)
+    print(ms.to_xml(include_namespaces=False, encoding=None))
 
 Which outputs:
 
@@ -227,7 +227,7 @@ needed.
 
     b.add_action(a)
 
-    print b.to_xml(include_namespaces = False)
+    print(b.to_xml(include_namespaces = False, encoding=None))
 
 .. testoutput::
 

maec/__init__.py

@@ -1,13 +1,15 @@
 # Copyright (c) 2015, The MITRE Corporation. All rights reserved.
 # See LICENSE.txt for complete terms.
 
+from __future__ import absolute_import
 from mixbox.entities import Entity as cyboxEntity
 from mixbox.entities import EntityList
 from mixbox.namespaces import (Namespace, get_xmlns_string,
         get_schemaloc_string, lookup_name, lookup_prefix)
+from mixbox.vendor.six import iteritems, string_types
 
-import bindings.maec_bundle as bundle_binding
-import bindings.maec_package as package_binding
+from .bindings import maec_bundle as bundle_binding
+from .bindings import maec_package as package_binding
 import maec
 from maec.utils import flip_dict, EntityParser
 
@@ -42,14 +44,14 @@ def to_xml_file(self, file, namespace_dict=None, custom_header=None):
             namespace_dict = {}
         else:
             # Make a copy so we don't pollute the source
-            namespace_dict = dict(namespace_dict.iteritems())
+            namespace_dict = dict(iteritems(namespace_dict))
 
         # Update the namespace dictionary with namespaces found upon import
         input_namespaces = self._ns_to_prefix_input_namespaces()
         namespace_dict.update(input_namespaces)
 
         # Check whether we're dealing with a filename or file-like Object
-        if isinstance(file, basestring):
+        if isinstance(file, string_types):
             out_file  = open(file, 'w')
         else:
             out_file = file
@@ -62,12 +64,12 @@ def to_xml_file(self, file, namespace_dict=None, custom_header=None):
             out_file.write("-->\n")
         elif isinstance(custom_header, dict):
             out_file.write("<!--\n")
-            for key, value in custom_header.iteritems():
+            for key, value in iteritems(custom_header):
                 sanitized_key = str(key).replace("-->", "\\-\\->")
                 sanitized_value = str(value).replace("-->", "\\-\\->")
                 out_file.write(sanitized_key + ": " + sanitized_value + "\n")
             out_file.write("-->\n")
-        elif isinstance(custom_header, basestring):
+        elif isinstance(custom_header, string_types):
             out_file.write("<!--\n")
             out_file.write(custom_header.replace("-->", "\\-\\->") + "\n")
             out_file.write("-->\n")
@@ -87,7 +89,7 @@ def _get_namespace_def(self, additional_ns_dict=None):
 
         if namespaces and additional_ns_dict:
             namespace_list = [x.name for x in namespaces if x]
-            for ns, prefix in additional_ns_dict.iteritems():
+            for ns, prefix in iteritems(additional_ns_dict):
                 if ns not in namespace_list:
                     namespaces.update([Namespace(ns, prefix, '')])
 
@@ -119,7 +121,7 @@ def _get_namespaces(self, recurse=True):
 
         # Add any additional namespaces that may be included in the entity
         input_ns = self._ns_to_prefix_input_namespaces()
-        for namespace, alias in input_ns.iteritems():
+        for namespace, alias in iteritems(input_ns):
             if not lookup_name(namespace):
                 nsset.add(Namespace(namespace, alias, ''))
 

maec/bindings/maec_bundle.py

@@ -103,7 +103,7 @@ def exportAttributes(self, write, level, already_processed, namespace_='maecBund
             write(' status=%s' % (quote_attrib(self.status), ))
         if self.duration is not None and 'duration' not in already_processed:
             already_processed.add('duration')
-            write(' duration=%s' % (quote_attrib(self.duration).encode(ExternalEncoding)))
+            write(' duration=%s' % (quote_attrib(self.duration)))
         if self.ordinal_position is not None and 'ordinal_position' not in already_processed:
             already_processed.add('ordinal_position')
             write(' ordinal_position="%s"' % self.gds_format_integer(self.ordinal_position, input_name='ordinal_position'))
@@ -148,7 +148,7 @@ def buildAttributes(self, node, attrs, already_processed):
             already_processed.add('ordinal_position')
             try:
                 self.ordinal_position = int(value)
-            except ValueError, exp:
+            except ValueError as exp:
                 raise_parse_error(node, 'Bad integer attribute: %s' % exp)
             if self.ordinal_position <= 0:
                 raise_parse_error(node, 'Invalid PositiveInteger')
@@ -355,7 +355,7 @@ def buildAttributes(self, node, attrs, already_processed):
             already_processed.add('timestamp')
             try:
                 self.timestamp = self.gds_parse_datetime(value, node, 'timestamp')
-            except ValueError, exp:
+            except ValueError as exp:
                 raise ValueError('Bad date-time attribute (timestamp): %s' % exp)
     def buildChildren(self, child_, node, nodeName_, fromsubclass_=False):
         if nodeName_ == 'Malware_Instance_Object_Attributes':
@@ -1007,7 +1007,7 @@ def buildAttributes(self, node, attrs, already_processed):
             already_processed.add('ordinal_position')
             try:
                 self.ordinal_position = int(value)
-            except ValueError, exp:
+            except ValueError as exp:
                 raise_parse_error(node, 'Bad integer attribute: %s' % exp)
             if self.ordinal_position <= 0:
                 raise_parse_error(node, 'Invalid PositiveInteger')
@@ -1980,7 +1980,7 @@ def buildAttributes(self, node, attrs, already_processed):
             already_processed.add('behavioral_ordering')
             try:
                 self.behavioral_ordering = int(value)
-            except ValueError, exp:
+            except ValueError as exp:
                 raise_parse_error(node, 'Bad integer attribute: %s' % exp)
             if self.behavioral_ordering <= 0:
                 raise_parse_error(node, 'Invalid PositiveInteger')
@@ -2316,7 +2316,7 @@ def buildAttributes(self, node, attrs, already_processed):
             already_processed.add('creation_datetime')
             try:
                 self.creation_datetime = value
-            except ValueError, exp:
+            except ValueError as exp:
                 raise ValueError('Bad date-time attribute (creation_datetime): %s' % exp)
         value = find_attr_value_('id', node)
         if value is not None and 'id' not in already_processed:
@@ -2327,7 +2327,7 @@ def buildAttributes(self, node, attrs, already_processed):
             already_processed.add('lastupdate_datetime')
             try:
                 self.lastupdate_datetime = value
-            except ValueError, exp:
+            except ValueError as exp:
                 raise ValueError('Bad date-time attribute (lastupdate_datetime): %s' % exp)
     def buildChildren(self, child_, node, nodeName_, fromsubclass_=False):
         if nodeName_ == 'Importance':
@@ -2338,7 +2338,7 @@ def buildChildren(self, child_, node, nodeName_, fromsubclass_=False):
             sval_ = child_.text
             try:
                 ival_ = int(sval_)
-            except (TypeError, ValueError), exp:
+            except (TypeError, ValueError) as exp:
                 raise_parse_error(child_, 'requires integer: %s' % exp)
             if ival_ <= 0:
                 raise_parse_error(child_, 'requires positiveInteger')
@@ -3482,7 +3482,7 @@ def buildAttributes(self, node, attrs, already_processed):
             already_processed.add('behavioral_ordering')
             try:
                 self.behavioral_ordering = int(value)
-            except ValueError, exp:
+            except ValueError as exp:
                 raise_parse_error(node, 'Bad integer attribute: %s' % exp)
             if self.behavioral_ordering <= 0:
                 raise_parse_error(node, 'Invalid PositiveInteger')
@@ -3890,7 +3890,7 @@ def buildAttributes(self, node, attrs, already_processed):
             already_processed.add('behavioral_ordering')
             try:
                 self.behavioral_ordering = int(value)
-            except ValueError, exp:
+            except ValueError as exp:
                 raise_parse_error(node, 'Bad integer attribute: %s' % exp)
             if self.behavioral_ordering <= 0:
                 raise_parse_error(node, 'Invalid PositiveInteger')
@@ -4628,7 +4628,7 @@ def buildChildren(self, child_, node, nodeName_, fromsubclass_=False):
 """
 
 def usage():
-    print USAGE_TEXT
+    print(USAGE_TEXT)
     sys.exit(1)
 
 def get_root_tag(node):
@@ -4668,7 +4668,7 @@ def parseEtree(inFileName):
     return rootObj, rootElement
 
 def parseString(inString):
-    from StringIO import StringIO
+    from mixbox.vendor.six import StringIO
     doc = parsexml_(StringIO(inString))
     rootNode = doc.getroot()
     rootTag, rootClass = get_root_tag(rootNode)

maec/bindings/maec_container.py

@@ -89,7 +89,7 @@ def buildAttributes(self, node, attrs, already_processed):
             already_processed.add('timestamp')
             try:
                 self.timestamp = value
-            except ValueError, exp:
+            except ValueError as exp:
                 raise ValueError('Bad date-time attribute (timestamp): %s' % exp)
         value = find_attr_value_('id', node)
         if value is not None and 'id' not in already_processed:
@@ -177,7 +177,7 @@ def buildChildren(self, child_, node, nodeName_, fromsubclass_=False):
 """
 
 def usage():
-    print USAGE_TEXT
+    print(USAGE_TEXT)
     sys.exit(1)
 
 def get_root_tag(node):
@@ -217,7 +217,7 @@ def parseEtree(inFileName):
     return rootObj, rootElement
 
 def parseString(inString):
-    from StringIO import StringIO
+    from mixbox.vendor.six import StringIO
     doc = parsexml_(StringIO(inString))
     rootNode = doc.getroot()
     rootTag, rootClass = get_root_tag(rootNode)