binascii (Jython API documentation)

java.lang.Object
- org.python.modules.binascii

```
public class binascii
extends Object
```
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-manipuation 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.

Version:

binascii.java,v 1.6 1999/02/20 11:37:07 fb Exp

Author:

Finn Bock, [email protected]

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`__doc__`
`static PyString`	`__doc__a2b_base64`
`static PyString`	`__doc__a2b_hqx`
`static PyString`	`__doc__a2b_qp`
`static PyString`	`__doc__a2b_uu`
`static PyString`	`__doc__b2a_base64`
`static PyString`	`__doc__b2a_hex`
`static PyString`	`__doc__b2a_hqx`
`static PyString`	`__doc__b2a_qp`
`static PyString`	`__doc__b2a_uu`
`static PyString`	`__doc__crc_hqx`
`static PyString`	`__doc__rlecode_hqx`
`static PyString`	`__doc__rledecode_hqx`
`static PyString`	`a2b_hex$doc`
`static PyObject`	`Error`
`static PyObject`	`Incomplete`

Constructor Summary

Constructors
Constructor and Description

binascii()

Constructors
Constructor and Description
`binascii()`

Method Summary

Methods
Modifier and Type	Method and Description
`static PyString`	`a2b_base64(BufferProtocol bp)` Convert a block of base64 data back to binary and return the binary data.
`static PyString`	`a2b_hex(BufferProtocol bp)`
`static PyTuple`	`a2b_hqx(BufferProtocol bp)` Convert binhex4 formatted ASCII data to binary, without doing RLE-decompression.
`static PyString`	`a2b_qp(PyObject[] arg, String[] kws)`
`static PyString`	`a2b_uu(BufferProtocol bp)` Convert a single line of uuencoded data back to binary and return the binary data.
`static PyString`	`b2a_base64(BufferProtocol bp)` Convert binary data to a line of ASCII characters in base64 coding.
`static PyString`	`b2a_hex(BufferProtocol bp)`
`static PyString`	`b2a_hqx(BufferProtocol bp)` Perform hexbin4 binary-to-ASCII translation and return the resulting string.
`static PyString`	`b2a_qp(PyObject[] arg, String[] kws)`
`static PyString`	`b2a_uu(BufferProtocol bp)` Convert binary data to a line of ASCII characters, the return value is the converted line, including a newline char.
`static int`	`crc_hqx(BufferProtocol bp, int crc)` Compute the binhex4 crc value of data, starting with an initial crc and returning the result.
`static int`	`crc32(BufferProtocol bp)`
`static int`	`crc32(BufferProtocol bp, long crc)`
`static PyObject`	`exceptionNamespace()`
`static boolean`	`getIntFlagAsBool(ArgParser ap, int index, int dflt, String errMsg)`
`static PyString`	`hexlify(BufferProtocol argbuf)`
`static PyString`	`rlecode_hqx(BufferProtocol bp)` Perform binhex4 style RLE-compression on data and return the result.
`static PyString`	`rledecode_hqx(BufferProtocol bp)` Perform RLE-decompression on the data, as per the binhex4 standard.
`static PyString`	`unhexlify(BufferProtocol argbuf)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

__doc__
```
public static String __doc__
```

Error
```
public static final PyObject Error
```

Incomplete

public static final PyObject Incomplete

__doc__a2b_uu
```
public static PyString __doc__a2b_uu
```

__doc__b2a_uu
```
public static PyString __doc__b2a_uu
```

doca2b_base64

public static PyString __doc__a2b_base64

docb2a_base64

public static PyString __doc__b2a_base64

__doc__a2b_hqx
```
public static PyString __doc__a2b_hqx
```

docrlecode_hqx

public static PyString __doc__rlecode_hqx

__doc__b2a_hqx
```
public static PyString __doc__b2a_hqx
```

docrledecode_hqx

public static PyString __doc__rledecode_hqx

__doc__crc_hqx
```
public static PyString __doc__crc_hqx
```

__doc__b2a_hex
```
public static PyString __doc__b2a_hex
```

a2b_hex$doc
```
public static PyString a2b_hex$doc
```

doca2b_qp

public static final PyString __doc__a2b_qp

docb2a_qp

public static final PyString __doc__b2a_qp

Constructor Detail
- binascii
```
public binascii()
```

Method Detail
- exceptionNamespace
```
public static PyObject exceptionNamespace()
```
- a2b_uu
```
public static PyString a2b_uu(BufferProtocol bp)
```
  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
```
public static PyString b2a_uu(BufferProtocol bp)
```
  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
```
public static PyString a2b_base64(BufferProtocol bp)
```
  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
```
public static PyString b2a_base64(BufferProtocol bp)
```
  Convert binary data to a line of ASCII characters in base64 coding. The return value is the converted line, including a newline char.
- a2b_hqx
```
public static PyTuple a2b_hqx(BufferProtocol bp)
```
  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.
- rlecode_hqx
```
public static PyString rlecode_hqx(BufferProtocol bp)
```
  Perform binhex4 style RLE-compression on data and return the result.
- b2a_hqx
```
public static PyString b2a_hqx(BufferProtocol bp)
```
  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).
- rledecode_hqx
```
public static PyString rledecode_hqx(BufferProtocol bp)
```
  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.
- crc_hqx
```
public static int crc_hqx(BufferProtocol bp,
          int crc)
```
  Compute the binhex4 crc value of data, starting with an initial crc and returning the result.
- crc32
```
public static int crc32(BufferProtocol bp)
```
- crc32
```
public static int crc32(BufferProtocol bp,
        long crc)
```
- b2a_hex
```
public static PyString b2a_hex(BufferProtocol bp)
```
- hexlify
```
public static PyString hexlify(BufferProtocol argbuf)
```
- a2b_hex
```
public static PyString a2b_hex(BufferProtocol bp)
```
- unhexlify
```
public static PyString unhexlify(BufferProtocol argbuf)
```
- getIntFlagAsBool
```
public static boolean getIntFlagAsBool(ArgParser ap,
                       int index,
                       int dflt,
                       String errMsg)
```
- a2b_qp
```
public static PyString a2b_qp(PyObject[] arg,
              String[] kws)
```
- b2a_qp
```
public static PyString b2a_qp(PyObject[] arg,
              String[] kws)
```

Class binascii

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__doc__

Error

Incomplete

__doc__a2b_uu

__doc__b2a_uu

__doc__a2b_base64

__doc__b2a_base64

__doc__a2b_hqx

__doc__rlecode_hqx

__doc__b2a_hqx

__doc__rledecode_hqx

__doc__crc_hqx

__doc__b2a_hex

a2b_hex$doc

__doc__a2b_qp

__doc__b2a_qp

Constructor Detail

binascii

Method Detail

exceptionNamespace

a2b_uu

b2a_uu

a2b_base64

b2a_base64

a2b_hqx

rlecode_hqx

b2a_hqx

rledecode_hqx

crc_hqx

crc32

crc32

b2a_hex

hexlify

a2b_hex

unhexlify

getIntFlagAsBool

a2b_qp

b2a_qp

doc

doca2b_uu

docb2a_uu

doca2b_base64

docb2a_base64

doca2b_hqx

docrlecode_hqx

docb2a_hqx

docrledecode_hqx

doccrc_hqx

docb2a_hex

doca2b_qp

docb2a_qp