VERSION: Bump version number up to 4.0.4.

[samba.git] / source4 / scripting / python / samba / ndr.py

diff --git a/source4/scripting/python/samba/ndr.py b/source4/scripting/python/samba/ndr.py
index e718ff3422d69fd1655aec6fa1b4142b825b5e55..39e4a482efbf32f47ff27f3a536e158a909c2722 100644 (file)
--- a/source4/scripting/python/samba/ndr.py
+++ b/source4/scripting/python/samba/ndr.py
@@ -1,28 +1,50 @@
-#!/usr/bin/python
 # -*- coding: utf-8 -*-
 
 # Unix SMB/CIFS implementation.
 # Copyright © Jelmer Vernooij <jelmer@samba.org> 2008
-#   
+#
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation; either version 3 of the License, or
 # (at your option) any later version.
-#   
+#
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
-#   
+#
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
+
+"""Network Data Representation (NDR) marshalling and unmarshalling."""
+
+
 def ndr_pack(object):
-    return object.__ndr_pack__()
+    """Pack a NDR object.
+
+    :param object: Object to pack
+    :return: String object with marshalled object.
+    """
+    ndr_pack = getattr(object, "__ndr_pack__", None)
+    if ndr_pack is None:
+        raise TypeError("%r is not a NDR object" % object)
+    return ndr_pack()
+
 
+def ndr_unpack(cls, data, allow_remaining=False):
+    """NDR unpack an object.
 
-def ndr_unpack(cls, data):
+    :param cls: Class of the object to unpack
+    :param data: Buffer to unpack
+    :param allow_remaining: allows remaining data at the end (default=False)
+    :return: Unpacked object
+    """
     object = cls()
-    object.__ndr_unpack__(data)
+    object.__ndr_unpack__(data, allow_remaining=allow_remaining)
     return object
+
+
+def ndr_print(object):
+    return object.__ndr_print__()