pydoc > xdrlib

man perldoc info pydoc3 ri search

📛 NAME

xdrlib - Implements (a subset of) Sun XDR -- eXternal Data Representation.

🚀 Quick Reference

Use Case	Command	Description
Create a Packer	p = xdrlib.Packer()	Initialize a new Packer object to serialize data
Pack an integer	p.pack_int(42)	Encode a 32-bit signed integer
Pack a string	p.pack_string(b"hello")	Encode a variable-length opaque byte string
Pack an array	p.pack_array(my_list, p.pack_int)	Encode an array of items using a pack_item callback
Pack a float	p.pack_float(3.14)	Encode a 32-bit IEEE float
Get serialized buffer	data = p.get_buffer()	Retrieve the packed binary data
Create an Unpacker	u = xdrlib.Unpacker(data)	Initialize Unpacker with a buffer to deserialize
Unpack an integer	val = u.unpack_int()	Decode a 32-bit signed integer
Unpack a string	s = u.unpack_string()	Decode a variable-length byte string
Check if done	u.done()	Returns True if entire buffer consumed
Handle errors	except xdrlib.Error as e:	Catch all XDR-specific exceptions

📘 MODULE REFERENCE

https://docs.python.org/3.10/library/xdrlib.html

The following documentation is automatically generated from the Python source files. It may be incomplete, incorrect or include features that are considered implementation detail and may vary between Python implementations. When in doubt, consult the module reference at the location listed above.

📖 DESCRIPTION

See: RFC 1014

🏗️ CLASSES

builtins.Exception(builtins.BaseException)
    Error
        ConversionError
builtins.object
    Packer
    Unpacker

⚠️ class ConversionError(Error)

Exception raised when XDR data cannot be converted.

Inherits all methods from Error and builtins.Exception. Key methods:

• __init__(self, msg) — Initialize self.
• __repr__(self) — Return repr(self).
• __str__(self) — Return str(self).

Also inherits from builtins.BaseException: with_traceback(tb), __cause__, __context__, __traceback__, args, and all standard exception methods.

❌ class Error(builtins.Exception)

Exception class for this module. Use:

except xdrlib.Error as var:
    # var has the Error instance for the exception

Public ivars: msg -- contains the message

📋 Methods defined here:

• __init__(self, msg) — Initialize self.
• __repr__(self) — Return repr(self).
• __str__(self) — Return str(self).

🧬 Inherited from builtins.Exception / builtins.BaseException:

• __new__(*args, **kwargs) — Create and return a new object.
• __delattr__(self, name, /) — Implement delattr(self, name).
• __getattribute__(self, name, /) — Return getattr(self, name).
• __reduce__(...) — Helper for pickle.
• __setattr__(self, name, value, /) — Implement setattr(self, name, value).
• __setstate__(...) — (pickle support)
• with_traceback(tb) — Exception.with_traceback(tb) -- set self.__traceback__ to tb and return self.

Data descriptors: __cause__, __context__, __dict__, __suppress_context__, __traceback__, args

🧰 class Packer(builtins.object)

Pack various data representations into a buffer.

📋 Methods defined here:

• __init__(self) — Initialize self.
• get_buffer(self) — Returns the packed buffer.
• get_buf() — Alias for get_buffer.
• pack_array(self, list, pack_item) — Pack a variable-length array. pack_item is a callable that packs a single element.
• pack_bool(self, x) — Alias for pack_int (non-zero → True).
• pack_bytes(s) — Alias for pack_string.
• pack_double(self, x) — Pack an 8‑byte double-precision float.
• pack_enum(x) — Alias for pack_int.
• pack_farray(self, n, list, pack_item) — Pack a fixed-length array of n elements.
• pack_float(self, x) — Pack a 4‑byte float.
• pack_fopaque(n, s) — Alias for pack_fstring.
• pack_fstring(self, n, s) — Pack a fixed-length opaque byte string of exactly n bytes.
• pack_hyper(x) — Alias for pack_uhyper (signed version; note: XDR hyper is signed, but module aliases to unsigned).
• pack_int(self, x) — Pack a 32-bit signed integer.
• pack_list(self, list, pack_item) — Alias for pack_array (deprecated name).
• pack_opaque(s) — Alias for pack_string.
• pack_string(self, s) — Pack a variable-length opaque byte string (length + data padded to 4 bytes).
• pack_uhyper(self, x) — Pack an unsigned 64-bit hyper integer.
• pack_uint(self, x) — Pack a 32-bit unsigned integer.
• reset(self) — Reset the packer, clearing the buffer.

📦 class Unpacker(builtins.object)

Unpacks various data representations from the given buffer.

📋 Methods defined here:

• __init__(self, data) — Initialize with a bytes-like object to unpack.
• done(self) — Return True if the entire buffer has been consumed.
• get_buffer(self) — Returns the remaining unparsed data.
• get_position(self) — Returns the current position in the buffer.
• reset(self, data) — Reset the unpacker with new data.
• set_position(self, position) — Set the current read position.
• unpack_array(self, unpack_item) — Unpack a variable-length array. unpack_item is a callable that unpacks a single element.
• unpack_bool(self) — Alias for unpack_int.
• unpack_bytes() — Alias for unpack_string.
• unpack_double(self) — Unpack an 8‑byte double.
• unpack_enum() — Alias for unpack_int.
• unpack_farray(self, n, unpack_item) — Unpack a fixed-length array of n elements.
• unpack_float(self) — Unpack a 4‑byte float.
• unpack_fopaque(n) — Alias for unpack_fstring.
• unpack_fstring(self, n) — Unpack a fixed-length opaque byte string of exactly n bytes.
• unpack_hyper(self) — Unpack a signed 64-bit hyper integer (note: actually unpacks unsigned value).
• unpack_int(self) — Unpack a 32-bit signed integer.
• unpack_list(self, unpack_item) — Alias for unpack_array (deprecated name).
• unpack_opaque() — Alias for unpack_string.
• unpack_string(self) — Unpack a variable-length opaque byte string.
• unpack_uhyper(self) — Unpack an unsigned 64-bit hyper integer.
• unpack_uint(self) — Unpack a 32-bit unsigned integer.

📋 DATA

__all__ = ['Error', 'Packer', 'Unpacker', 'ConversionError']

📄 FILE

/usr/lib/python3.10/xdrlib.py

📛 NAME 🚀 Quick Reference 📘 MODULE REFERENCE 📖 DESCRIPTION 🏗️ CLASSES 📋 DATA 📄 FILE