• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1:mod:`binhex` --- Encode and decode binhex4 files
2=================================================
3
4.. module:: binhex
5   :synopsis: Encode and decode files in binhex4 format.
6
7**Source code:** :source:`Lib/binhex.py`
8
9.. deprecated:: 3.9
10
11--------------
12
13This module encodes and decodes files in binhex4 format, a format allowing
14representation of Macintosh files in ASCII. Only the data fork is handled.
15
16The :mod:`binhex` module defines the following functions:
17
18
19.. function:: binhex(input, output)
20
21   Convert a binary file with filename *input* to binhex file *output*. The
22   *output* parameter can either be a filename or a file-like object (any object
23   supporting a :meth:`write` and :meth:`close` method).
24
25
26.. function:: hexbin(input, output)
27
28   Decode a binhex file *input*. *input* may be a filename or a file-like object
29   supporting :meth:`read` and :meth:`close` methods. The resulting file is written
30   to a file named *output*, unless the argument is ``None`` in which case the
31   output filename is read from the binhex file.
32
33The following exception is also defined:
34
35
36.. exception:: Error
37
38   Exception raised when something can't be encoded using the binhex format (for
39   example, a filename is too long to fit in the filename field), or when input is
40   not properly encoded binhex data.
41
42
43.. seealso::
44
45   Module :mod:`binascii`
46      Support module containing ASCII-to-binary and binary-to-ASCII conversions.
47
48
49.. _binhex-notes:
50
51Notes
52-----
53
54There is an alternative, more powerful interface to the coder and decoder, see
55the source for details.
56
57If you code or decode textfiles on non-Macintosh platforms they will still use
58the old Macintosh newline convention (carriage-return as end of line).
59
60