Add subunit.Content python class for serialisation.

1 files changed, 41 insertions, 0 deletions

diff --git a/python/subunit/content.py b/python/subunit/content.py
new file mode 100644
index 0000000..517862a
--- /dev/null
+++ b/python/subunit/content.py
@@ -0,0 +1,41 @@
+#
+#  subunit: extensions to Python unittest to get test results from subprocesses.
+#  Copyright (C) 2009  Robert Collins <robertc@robertcollins.net>
+#
+#  Licensed under either the Apache License, Version 2.0 or the BSD 3-clause
+#  license at the users choice. A copy of both licenses are available in the
+#  project source as Apache-2.0 and BSD. You may not use this file except in
+#  compliance with one of these two licences.
+#  
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under these licenses is distributed on an "AS IS" BASIS, WITHOUT
+#  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+#  license you chose for the specific language governing permissions and
+#  limitations under that license.
+#
+
+"""Content - a MIME-like Content object."""
+
+class Content(object):
+    """A MIME-like Content object.
+    
+    Content objects can be serialised to bytes using the iter_bytes method.
+    If the Content-Type is recognised by other code, they are welcome to 
+    look for richer contents that mere byte serialisation - for example in
+    memory object graphs etc. However, such code MUST be prepared to receive
+    a generic Content object that has been reconstructed from a byte stream.
+    
+    :ivar content_type: The content type of this Content.
+    """
+
+    def __init__(self, content_type, get_bytes):
+        """Create a ContentType."""
+        if None in (content_type, get_bytes):
+            raise ValueError("None not permitted in %r, %r" % (
+                content_type, get_bytes))
+        self.content_type = content_type
+        self._get_bytes = get_bytes
+
+    def iter_bytes(self):
+        """Iterate over bytestrings of the serialised content."""
+        return self._get_bytes()