Update for release.
[python/dscho.git] / Lib / encodings / hex_codec.py
blob5c6e4a4e198c6eb0af87396bd039d8bf6e611838
1 """ Python 'hex_codec' Codec - 2-digit hex content transfer encoding
3 Unlike most of the other codecs which target Unicode, this codec
4 will return Python string objects for both encode and decode.
6 Written by Marc-Andre Lemburg (mal@lemburg.com).
8 """
9 import codecs, binascii
11 ### Codec APIs
13 def hex_encode(input,errors='strict'):
15 """ Encodes the object input and returns a tuple (output
16 object, length consumed).
18 errors defines the error handling to apply. It defaults to
19 'strict' handling which is the only currently supported
20 error handling for this codec.
22 """
23 assert errors == 'strict'
24 output = binascii.b2a_hex(input)
25 return (output, len(input))
27 def hex_decode(input,errors='strict'):
29 """ Decodes the object input and returns a tuple (output
30 object, length consumed).
32 input must be an object which provides the bf_getreadbuf
33 buffer slot. Python strings, buffer objects and memory
34 mapped files are examples of objects providing this slot.
36 errors defines the error handling to apply. It defaults to
37 'strict' handling which is the only currently supported
38 error handling for this codec.
40 """
41 assert errors == 'strict'
42 output = binascii.a2b_hex(input)
43 return (output, len(input))
45 class Codec(codecs.Codec):
47 def encode(self, input,errors='strict'):
48 return hex_encode(input,errors)
49 def decode(self, input,errors='strict'):
50 return hex_decode(input,errors)
52 class StreamWriter(Codec,codecs.StreamWriter):
53 pass
55 class StreamReader(Codec,codecs.StreamReader):
56 pass
58 ### encodings module API
60 def getregentry():
62 return (hex_encode,hex_decode,StreamReader,StreamWriter)