diff options
| author | Douglas Bagnall <douglas.bagnall@catalyst.net.nz> | 2025-07-09 12:50:31 +1200 |
|---|---|---|
| committer | Douglas Bagnall <dbagnall@samba.org> | 2025-08-08 00:29:00 +0000 |
| commit | 58f5ad63f3a3c070e10157c305331fb0eeda57be (patch) | |
| tree | e98e0ffb71e9478d7b406a2d672aecc1e37e73a7 /python | |
| parent | 49e7f2e981a30d99029b6a3cf1a42f879ae9b0e7 (diff) | |
| download | samba-58f5ad63f3a3c070e10157c305331fb0eeda57be.tar.gz samba-58f5ad63f3a3c070e10157c305331fb0eeda57be.tar.bz2 samba-58f5ad63f3a3c070e10157c305331fb0eeda57be.zip | |
python:ndr: improve type annotation and docs for pack/unpack
Signed-off-by: Douglas Bagnall <douglas.bagnall@catalyst.net.nz>
Reviewed-by: Gary Lockyer <gary@catalyst.net.nz>
Autobuild-User(master): Douglas Bagnall <dbagnall@samba.org>
Autobuild-Date(master): Fri Aug 8 00:29:00 UTC 2025 on atb-devel-224
Diffstat (limited to 'python')
| -rw-r--r-- | python/samba/ndr.py | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/python/samba/ndr.py b/python/samba/ndr.py index 6973b94604d..8941e853d53 100644 --- a/python/samba/ndr.py +++ b/python/samba/ndr.py @@ -21,11 +21,11 @@ """Network Data Representation (NDR) marshalling and unmarshalling.""" -def ndr_pack(object): +def ndr_pack(object) -> bytes: """Pack a NDR object. :param object: Object to pack - :return: String object with marshalled object. + :return: bytes object with marshalled object. """ ndr_pack = getattr(object, "__ndr_pack__", None) if ndr_pack is None: @@ -33,7 +33,7 @@ def ndr_pack(object): return ndr_pack() -def ndr_unpack(cls, data, allow_remaining=False): +def ndr_unpack(cls, data:bytes, allow_remaining=False): """NDR unpack an object. :param cls: Class of the object to unpack @@ -75,13 +75,13 @@ def ndr_deepcopy(object): return copy -def ndr_pack_in(object, bigendian=False, ndr64=False): +def ndr_pack_in(object, bigendian=False, ndr64=False) -> bytes: """Pack the input of an NDR function object. :param object: Object to pack :param bigendian: use LIBNDR_FLAG_BIGENDIAN (default=False) :param ndr64: use LIBNDR_FLAG_NDR64 (default=False) - :return: String object with marshalled object. + :return: bytes object with marshalled object. """ ndr_pack_in_fn = getattr(object, "__ndr_pack_in__", None) if ndr_pack_in_fn is None: @@ -89,7 +89,11 @@ def ndr_pack_in(object, bigendian=False, ndr64=False): return ndr_pack_in_fn(bigendian=bigendian, ndr64=ndr64) -def ndr_unpack_in(object, data, bigendian=False, ndr64=False, allow_remaining=False): +def ndr_unpack_in(object, + data: bytes, + bigendian=False, + ndr64=False, + allow_remaining=False): """Unpack the input of an NDR function object. :param cls: Class of the object to unpack |