Jython 2.7.4 · org.python.modules.binascii · APIdia, the JavaDoc alternative

The binascii.java module contains a number of methods to convert between binary and various ASCII-encoded binary representations. Normally, you will not use these modules directly but use wrapper modules like uu or hexbin instead, this module solely exists because bit-manipulation of large amounts of data is slow in Python.

The binascii.java module defines the following functions:

a2b_uu (string): Convert a single line of uuencoded data back to binary and return the binary data. Lines normally contain 45 (binary) bytes, except for the last line. Line data may be followed by whitespace.
b2a_uu (data): Convert binary data to a line of ASCII characters, the return value is the converted line, including a newline char. The length of data should be at most 45.
a2b_base64 (string): Convert a block of base64 data back to binary and return the binary data. More than one line may be passed at a time.
b2a_base64 (data): Convert binary data to a line of ASCII characters in base64 coding. The return value is the converted line, including a newline char. The length of data should be at most 57 to adhere to the base64 standard.
a2b_hqx (string): Convert binhex4 formatted ASCII data to binary, without doing RLE-decompression. The string should contain a complete number of binary bytes, or (in case of the last portion of the binhex4 data) have the remaining bits zero.
rledecode_hqx (data): Perform RLE-decompression on the data, as per the binhex4 standard. The algorithm uses 0x90 after a byte as a repeat indicator, followed by a count. A count of 0 specifies a byte value of 0x90. The routine returns the decompressed data, unless data input data ends in an orphaned repeat indicator, in which case the Incomplete exception is raised.
rlecode_hqx (data): Perform binhex4 style RLE-compression on data and return the result.
b2a_hqx (data): Perform hexbin4 binary-to-ASCII translation and return the resulting string. The argument should already be RLE-coded, and have a length divisible by 3 (except possibly the last fragment).
crc_hqx (data, crc): Compute the binhex4 crc value of data, starting with an initial crc and returning the result.
Error: Exception raised on errors. These are usually programming errors.
Incomplete: Exception raised on incomplete data. These are usually not programming errors, but may be handled by reading a little more data and trying again.

The module is a line-by-line conversion of the original binasciimodule.c written by Jack Jansen, except that all mistakes and errors are my own.

Field Summary

Modifier and Type	Field and Description
public static String	__doc__
public static PyString	__doc__a2b_base64
public static PyString	__doc__a2b_hqx
public static final PyString	__doc__a2b_qp
public static PyString	__doc__a2b_uu
public static PyString	__doc__b2a_base64
public static PyString	__doc__b2a_hex
public static PyString	__doc__b2a_hqx
public static final PyString	__doc__b2a_qp
public static PyString	__doc__b2a_uu
public static PyString	__doc__crc_hqx
public static PyString	__doc__rlecode_hqx
public static PyString	__doc__rledecode_hqx
public static PyString	a2b_hex$doc
private static int	BASE64_MAXBIN
private static char	BASE64_PAD
pack-priv static int[]	crc_32_tab
private static int[]	crctab_hqx
private static byte	DONE
public static final PyObject	Error
private static byte	FAIL
private static char[]	hexdigit
public static final PyObject	Incomplete
private static char	RUNCHAR
private static byte	SKIP
private static byte[]	table_a2b_base64
private static byte[]	table_a2b_hqx
private static char[]	table_b2a_base64
private static char[]	table_b2a_hqx
private static final char[]	upper_hexdigit

Constructor Summary

Access	Constructor and Description
public	binascii()

Method Summary

Modifier and Type	Method and Description
public static PyString	a2b_base64(PyObject text) Convert a block of base64 data back to binary and return the binary data.
public static PyString	a2b_hex(PyObject hexstr)
public static PyTuple	a2b_hqx(PyObject text) Convert binhex4 formatted ASCII data to binary, without doing RLE-decompression.
public static PyString	a2b_qp(PyObject[] arg, String[] kws)
public static PyString	a2b_uu(PyObject text) Convert a single line of uuencoded data back to binary and return the binary data.
private static PyException	Returns: TypeError to throw argMustBeBytes(String name of function of error (or could be any text) f, PyObject argument provided from which actual type will be reported arg) Convenience method providing the exception when an argument is not the expected type, in the format "f() argument 1 must bytes or unicode, not `type(arg)`."
public static PyString	b2a_base64(PyObject data) Convert binary data to a line of ASCII characters in base64 coding.
public static PyString	b2a_hex(PyObject data)
public static PyString	b2a_hqx(PyObject data) Perform hexbin4 binary-to-ASCII translation and return the resulting string.
public static PyString	b2a_qp(PyObject[] arg, String[] kws)
public static PyString	b2a_uu(PyObject data) Convert binary data to a line of ASCII characters, the return value is the converted line, including a newline char.
private static int	binascii_find_valid(PyBuffer b, int offset, int num) Finds & returns the (num+1)th valid character for base64, or -1 if none.
public static int	crc32(PyObject bp)
public static int	crc32(PyObject data, long long_crc)
public static int	crc_hqx(PyObject data, int crc) Compute the binhex4 crc value of data, starting with an initial crc and returning the result.
public static PyObject	exceptionNamespace()
private static PyBuffer	Returns: a byte-buffer view of argument (or default decoding if `unicode`) getByteBuffer(PyObject an object with the buffer protocol (or `unicode`) text) We use this when the argument given to a conversion method is to be interpreted as text.
private static boolean	getIntFlagAsBool(ArgParser ap, int index, int dflt, String errMsg)
public static PyString	hexlify(PyObject argbuf)
private static StringBuilder	qpEscape(StringBuilder sb, char c)
public static PyString	rlecode_hqx(PyObject data) Perform binhex4 style RLE-compression on data and return the result.
public static PyString	rledecode_hqx(PyObject data) Perform RLE-decompression on the data, as per the binhex4 standard.
public static PyString	unhexlify(PyObject argbuf)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

__doc__	back to summary
public static String __doc__

__doc__a2b_base64	back to summary
public static PyString __doc__a2b_base64

__doc__a2b_hqx	back to summary
public static PyString __doc__a2b_hqx

__doc__a2b_qp	back to summary
public static final PyString __doc__a2b_qp

__doc__a2b_uu	back to summary
public static PyString __doc__a2b_uu

__doc__b2a_base64	back to summary
public static PyString __doc__b2a_base64

__doc__b2a_hex	back to summary
public static PyString __doc__b2a_hex

__doc__b2a_hqx	back to summary
public static PyString __doc__b2a_hqx

__doc__b2a_qp	back to summary
public static final PyString __doc__b2a_qp

__doc__b2a_uu	back to summary
public static PyString __doc__b2a_uu

__doc__crc_hqx	back to summary
public static PyString __doc__crc_hqx

__doc__rlecode_hqx	back to summary
public static PyString __doc__rlecode_hqx

__doc__rledecode_hqx	back to summary
public static PyString __doc__rledecode_hqx

a2b_hex$doc	back to summary
public static PyString a2b_hex$doc

BASE64_MAXBIN	back to summary
private static int BASE64_MAXBIN

BASE64_PAD	back to summary
private static char BASE64_PAD

crc_32_tab	back to summary
pack-priv static int[] crc_32_tab

crctab_hqx	back to summary
private static int[] crctab_hqx

DONE	back to summary
private static byte DONE

Error	back to summary
public static final PyObject Error

FAIL	back to summary
private static byte FAIL

hexdigit	back to summary
private static char[] hexdigit

Incomplete	back to summary
public static final PyObject Incomplete

RUNCHAR	back to summary
private static char RUNCHAR

SKIP	back to summary
private static byte SKIP

table_a2b_base64	back to summary
private static byte[] table_a2b_base64

table_a2b_hqx	back to summary
private static byte[] table_a2b_hqx

table_b2a_base64	back to summary
private static char[] table_b2a_base64

table_b2a_hqx	back to summary
private static char[] table_b2a_hqx

upper_hexdigit	back to summary
private static final char[] upper_hexdigit

Constructor Detail

binascii	back to summary
public binascii()

Method Detail

a2b_base64	back to summary
public static PyString a2b_base64(PyObject text) Convert a block of base64 data back to binary and return the binary data. More than one line may be passed at a time.

a2b_hex	back to summary
public static PyString a2b_hex(PyObject hexstr)

a2b_hqx	back to summary
public static PyTuple a2b_hqx(PyObject text) Convert binhex4 formatted ASCII data to binary, without doing RLE-decompression. The string should contain a complete number of binary bytes, or (in case of the last portion of the binhex4 data) have the remaining bits zero.

a2b_qp	back to summary
public static PyString a2b_qp(PyObject[] arg, String[] kws)

a2b_uu	back to summary
public static PyString a2b_uu(PyObject text) Convert a single line of uuencoded data back to binary and return the binary data. Lines normally contain 45 (binary) bytes, except for the last line. Line data may be followed by whitespace.

argMustBeBytes back to summary

argMustBeBytes	back to summary
private static PyException argMustBeBytes(String f, PyObject arg) Convenience method providing the exception when an argument is not the expected type, in the format "f() argument 1 must bytes or unicode, not `type(arg)`." Parameters f:String name of function of error (or could be any text) arg:PyObject argument provided from which actual type will be reported Returns:PyException TypeError to throw

private static PyException argMustBeBytes(String f, PyObject arg)

Convenience method providing the exception when an argument is not the expected type, in the format "f() argument 1 must bytes or unicode, not type(arg)."

Parameters

f:String: name of function of error (or could be any text)
arg:PyObject: argument provided from which actual type will be reported

Returns:PyException

TypeError to throw

b2a_base64	back to summary
public static PyString b2a_base64(PyObject data) Convert binary data to a line of ASCII characters in base64 coding. The return value is the converted line, including a newline char.

b2a_hex	back to summary
public static PyString b2a_hex(PyObject data)

b2a_hqx	back to summary
public static PyString b2a_hqx(PyObject data) Perform hexbin4 binary-to-ASCII translation and return the resulting string. The argument should already be RLE-coded, and have a length divisible by 3 (except possibly the last fragment).

b2a_qp	back to summary
public static PyString b2a_qp(PyObject[] arg, String[] kws)

b2a_uu	back to summary
public static PyString b2a_uu(PyObject data) Convert binary data to a line of ASCII characters, the return value is the converted line, including a newline char. The length of data should be at most 45.

binascii_find_valid	back to summary
private static int binascii_find_valid(PyBuffer b, int offset, int num) Finds & returns the (num+1)th valid character for base64, or -1 if none.

crc32	back to summary
public static int crc32(PyObject bp)

crc32	back to summary
public static int crc32(PyObject data, long long_crc)

crc_hqx	back to summary
public static int crc_hqx(PyObject data, int crc) Compute the binhex4 crc value of data, starting with an initial crc and returning the result.

exceptionNamespace	back to summary
public static PyObject exceptionNamespace()

getByteBuffer back to summary

private static PyBuffer getByteBuffer(PyObject text) throws ClassCastException

We use this when the argument given to a conversion method is to be interpreted as text. If it is byte-like, the bytes are used unchanged, assumed in the "intended" character set. It may be a PyUnicode, in which case the it will be decoded to bytes using the default encoding (sys.getdefaultencoding().

Parameters

text:PyObject: an object with the buffer protocol (or unicode)

Returns:PyBuffer

a byte-buffer view of argument (or default decoding if unicode)

Exceptions

ClassCastException:: where the text object does not implement the buffer protocol

getIntFlagAsBool	back to summary
private static boolean getIntFlagAsBool(ArgParser ap, int index, int dflt, String errMsg)

hexlify	back to summary
public static PyString hexlify(PyObject argbuf)

qpEscape	back to summary
private static StringBuilder qpEscape(StringBuilder sb, char c)

rlecode_hqx	back to summary
public static PyString rlecode_hqx(PyObject data) Perform binhex4 style RLE-compression on data and return the result.

rledecode_hqx back to summary

public static PyString rledecode_hqx(PyObject data)

Perform RLE-decompression on the data, as per the binhex4 standard. The algorithm uses 0x90 after a byte as a repeat indicator, followed by a count. A count of 0 specifies a byte value of 0x90. The routine returns the decompressed data, unless data input data ends in an orphaned repeat indicator, in which case the Incomplete exception is raised.