Merge pull request #9 from STIXProject/python3

Python3

.travis.yml

@@ -2,6 +2,9 @@ language: python
 python:
   - "2.6"
   - "2.7"
+  - "3.3"
+  - "3.4"
+  - "3.5"
 
 install:
   - pip install .

ramrod/base.py

@@ -6,6 +6,7 @@
 
 # external
 from lxml import etree
+from six import iteritems
 
 # relative
 from . import errors, utils, xmlconst, results
@@ -171,7 +172,7 @@ def _translate_attributes(cls, old, new):
         if cls.COPY_ATTRIBUTES:
             new.attrib.update(source.attrib)
 
-        for name, val in cls.OVERRIDE_ATTRIBUTES.iteritems():
+        for name, val in iteritems(cls.OVERRIDE_ATTRIBUTES):
             if name not in source.attrib:
                 continue
             new.attrib[name] = val
@@ -521,7 +522,7 @@ def _get_duplicates(self, root):
             id_nodes[id_].append(desc)
 
         filtered = {}
-        for id_, nodes in id_nodes.iteritems():
+        for id_, nodes in iteritems(id_nodes):
             if len(nodes) > 1:
                 filtered[id_] = nodes
 
@@ -700,7 +701,7 @@ def _remap_namespaces(self, node):
 
         """
         remapped = {}
-        for alias, ns in node.nsmap.iteritems():
+        for alias, ns in iteritems(node.nsmap):
             if ns in self.DISALLOWED_NAMESPACES:
                 continue
 
@@ -844,14 +845,14 @@ def clean(self, root, options=None):
         return value:
 
         >>> results = updater.clean(root)
-        >>> print results.removed
+        >>> print(results.removed)
         (<Element at 0xffdcf234>, <Element at 0xffdcf284>)
 
         Items which have been reassigned IDs can be retrieved via the
         ``remapped_ids`` attribute on the return value:
 
         >>> results = updater.clean(root)
-        >>> print results.remapped_ids
+        >>> print(results.remapped_ids)
         {'example:Observable-duplicate': [<Element {http://cybox.mitre.org...
 
         Note:
@@ -935,14 +936,14 @@ def update(self, root, options=None, force=False):
         return value:
 
         >>> results = updater.update(root, force=True)
-        >>> print results.removed
+        >>> print(results.removed)
         (<Element at 0xffdcf234>, <Element at 0xffdcf284>)
 
         Items which have been reassigned IDs can be retrieved via the
         ``remappped_ids`` attribute on the return value:
 
         >>> results = updater.update(root, force=True)
-        >>> print results.remapped_ids
+        >>> print(results.remapped_ids)
         {'example:Observable-duplicate-id-1': [<Element {http://cybox.mitre...
 
         Args:

ramrod/cybox/cybox_2_0_1.py

@@ -5,12 +5,14 @@
 from ramrod import base, errors, utils
 from ramrod.options import DEFAULT_UPDATE_OPTIONS
 
+# external
+from six import iteritems
+
 # relative imports
 from . import common
 from . import register_updater
 from .base import BaseCyboxUpdater, CyboxVocab
 
-
 class ObjectRelationshipVocab(CyboxVocab):
     OLD_TYPES = ('ObjectRelationshipVocab-1.0',)
     NEW_TYPE = 'ObjectRelationshipVocab-1.1'
@@ -606,7 +608,7 @@ def _clean_duplicates(self, duplicates, options):
 
         """
         new_id = options.new_id_func
-        for _, nodes in duplicates.iteritems():
+        for _, nodes in iteritems(duplicates):
             for node in nodes:
                 new_id(node)
 

ramrod/results.py

@@ -1,13 +1,12 @@
 # Copyright (c) 2015, The MITRE Corporation. All rights reserved.
 # See LICENSE.txt for complete terms.
 
-# stdlib
-import StringIO
-
 # external
 from lxml import etree
+from six import StringIO, text_type, python_2_unicode_compatible
 
 
+@python_2_unicode_compatible
 class UpdateResults(object):
     """Returned from :meth:`ramrod.update`, :meth:`ramrod.cybox.update`, and
     :meth:`ramrod.stix.update` methods.
@@ -42,20 +41,14 @@ def document(self, value):
             self._document = ResultDocument(value)
 
 
-    def __unicode__(self):
-        if not self.document:
-            return u''
-
-        return unicode(self.document)
-
-
     def __str__(self):
         if not self.document:
             return ''
 
-        return str(self.document)
+        return text_type(self.document)
 
 
+@python_2_unicode_compatible
 class ResultDocument(object):
     """Used to encapsulate an updated XML document. This is the type of the
     ``document`` attribute on :class:`ramrod.UpdateResults`
@@ -80,12 +73,8 @@ def __init__(self, document):
             self._document = document
 
 
-    def __unicode__(self):
-        return unicode(self.as_stringio().getvalue())
-
-
     def __str__(self):
-        return unicode(self).encode('utf-8')
+        return text_type(self.as_stringio().getvalue())
 
 
     def as_element(self):
@@ -103,12 +92,12 @@ def as_element_tree(self):
         return self._document
 
     def as_stringio(self):
-        """Returns a ``StringIO.StringIO`` representation of the
+        """Returns a ``StringIO`` representation of the
         ``ResultDocument`` instance.
 
         """
         buf = etree.tounicode(self._document, pretty_print=True)
-        return StringIO.StringIO(buf)
+        return StringIO(buf)
 
 
 __all__ = [

ramrod/scripts/ramrod_update.py

@@ -12,6 +12,9 @@
 import ramrod
 import ramrod.errors as errors
 
+# external
+from six import iteritems, PY2
+
 
 EXIT_SUCCESS = 0
 EXIT_FAILURE = 1
@@ -41,7 +44,12 @@ def _write_xml(document, outfn=None):
         tree: A :class:`ramrod.ResultDocument` instance.
 
     """
-    out = outfn or sys.stdout
+    if PY2:
+        bin_stdout = sys.stdout
+    else:
+        bin_stdout = sys.stdout.buffer
+
+    out = outfn or bin_stdout
     tree = document.as_element_tree()
     tree.write(out, pretty_print=True)
 
@@ -64,8 +72,8 @@ def _print_update_error(err):
            _print_error("  Line %s: %s", node.sourceline, node.tag)
 
     if duplicates:
-        print "[!] Found items with duplicate ids:"
-        for id_, nodes in duplicates.iteritems():
+        print("[!] Found items with duplicate ids:")
+        for id_, nodes in iteritems(duplicates):
             _print_error("  '%s' on lines %s", id_, [x.sourceline for x in nodes])
 
 
@@ -111,11 +119,11 @@ def _write_removed(removed):
     if not removed:
         return
 
-    print ("\n[!] The following nodes were removed from the source document "
+    print("\n[!] The following nodes were removed from the source document "
            "during the update process:")
 
     for node in removed:
-        print "    Line %s: %s" % (node.sourceline, node.tag)
+        print("    Line %s: %s" % (node.sourceline, node.tag))
 
 
 def _write_remapped_ids(remapped):
@@ -130,11 +138,11 @@ def _write_remapped_ids(remapped):
     if not remapped:
         return
 
-    print ("\n[!] The following ids were duplicated in the source document and "
+    print("\n[!] The following ids were duplicated in the source document and "
            "remapped during the update process:")
 
-    for orig_id, nodes in remapped.iteritems():
-        print "'%s': %s" % (orig_id, [x.attrib['id'] for x in nodes])
+    for orig_id, nodes in iteritems(remapped):
+        print("'%s': %s" % (orig_id, [x.attrib['id'] for x in nodes]))
 
 
 def _get_options(args):

ramrod/scripts/update_ns.py

@@ -14,8 +14,8 @@
 from __future__ import print_function
 import argparse
 import lxml.etree as ET
-import six
 import sys
+from six import iteritems, itervalues, PY2
 
 STIX_NS_1_2 = [
     # "Core" stuff
@@ -127,15 +127,15 @@ def update_namespaces(elt, ns_mapping):
     # Wholesale replacement is only necessary when we need to modify
     # nsmap.
     need_replace_elt = False
-    for ns in six.itervalues(elt.nsmap):
+    for ns in itervalues(elt.nsmap):
         if ns in ns_mapping:
             need_replace_elt = True
             break
 
     if need_replace_elt:
         # Update nsmap
         new_ns_map = {}
-        for pfx, old_ns in six.iteritems(elt.nsmap):
+        for pfx, old_ns in iteritems(elt.nsmap):
             new_ns_map[pfx] = ns_mapping.get(old_ns, old_ns)
 
         # Must update the element and attribute names when we update nsmap,
@@ -292,7 +292,7 @@ def parse_args():
     Pretty-print output.
     """)
 
-    if six.PY2:
+    if PY2:
         bin_stdin = sys.stdin
     else:
         bin_stdin = sys.stdin.buffer
@@ -348,7 +348,7 @@ def main(tree, from_id, to_id):
 
     output_encoding = "utf-8"
 
-    if six.PY2:
+    if PY2:
         bin_stdout = sys.stdout
     else:
         bin_stdout = sys.stdout.buffer

ramrod/stix/base.py

@@ -7,6 +7,9 @@
 # internal
 from ramrod import base, errors, utils
 
+# external
+from six import iteritems
+
 
 class BaseSTIXUpdater(base.BaseUpdater):
     """Base class for STIX updating code. Sets default values for
@@ -63,8 +66,8 @@ def _init_cybox_updater(self):
 
         updater.NSMAP = dict(
             itertools.chain(
-                self.NSMAP.iteritems(),
-                self.CYBOX_UPDATER.NSMAP.iteritems()
+                iteritems(self.NSMAP),
+                iteritems(self.CYBOX_UPDATER.NSMAP)
             )
         )
 

ramrod/stix/stix_1_0_1.py

@@ -3,6 +3,7 @@
 
 # external
 from lxml import etree
+from six import itervalues
 
 # internal
 from ramrod import base, errors, utils
@@ -444,7 +445,7 @@ def _get_duplicates(self, root):
         """
         duplicates = super(STIX_1_0_1_Updater, self)._get_duplicates(root)
         cybox = self._cybox_updater._get_duplicates(root)  # noqa
-        return dict(duplicates.items() + cybox.items())
+        return dict(list(duplicates.items()) + list(cybox.items()))
 
     def _update_versions(self, root):
         """Updates the versions of versioned nodes under `root` to align with
@@ -502,7 +503,7 @@ def _clean_duplicates(self, duplicates, options):
         """
         new_id = options.new_id_func
 
-        for nodes in duplicates.itervalues():
+        for nodes in itervalues(duplicates):
             for node in nodes:
                 new_id(node)
 

ramrod/test/__init__.py

@@ -2,7 +2,7 @@
 # See LICENSE.txt for complete terms.
 
 import unittest
-from StringIO import StringIO
+from six import StringIO
 import ramrod.utils as utils
 
 class _BaseOptional(unittest.TestCase):

ramrod/test/cybox/cybox_2_0_1_test.py

@@ -2,7 +2,7 @@
 # See LICENSE.txt for complete terms.
 
 import unittest
-from StringIO import StringIO
+from six import StringIO
 
 import ramrod
 import ramrod.cybox

ramrod/test/cybox/cybox_2_0_test.py

@@ -2,7 +2,7 @@
 # See LICENSE.txt for complete terms.
 
 import unittest
-from StringIO import StringIO
+from six import StringIO
 
 import ramrod
 import ramrod.cybox