<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><title>Python: module olefile2</title> </head><body bgcolor="#f0f0f8"> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> <tr bgcolor="#7799ee"> <td valign=bottom>    <big><big>olefile2</big></big> (version 0.40py2, 2014-10-01)</td ><td align=right valign=bottom ><a href=".">index</a> <a href="file:./olefile2.py">.\olefile2.py</a></td></tr></table> <tt>olefile2 (formerly OleFileIO_PL2) version 0.40py2 2014-10-01   Module to read Microsoft OLE2 files (also called Structured Storage or Microsoft Compound Document File Format), such as Microsoft Office documents, Image Composer and FlashPix files, Outlook messages, ...   IMPORTANT NOTE: olefile2 is an old version of olefile meant to be used as fallback for Python 2.5 and older. For Python 2.6, 2.7 and 3.x, please use olefile which is more up-to-date. The improvements in olefile might not always be backported to olefile2.   Project website: <a href="http://www.decalage.info/python/olefileio">http://www.decalage.info/python/olefileio</a>   olefile2 is copyright (c) 2005-2014 Philippe Lagadec (<a href="http://www.decalage.info">http://www.decalage.info</a>)   olefile2 is based on the <a href="#OleFileIO">OleFileIO</a> module from the PIL library v1.1.6 See: <a href="http://www.pythonware.com/products/pil/index.htm">http://www.pythonware.com/products/pil/index.htm</a>   The Python Imaging Library (PIL) is     Copyright (c) 1997-2005 by Secret Labs AB     Copyright (c) 1995-2005 by Fredrik Lundh   See source code and LICENSE.txt for information on usage and redistribution.</tt> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#aa55cc"> <td colspan=3 valign=bottom>  <big>Modules</big></td></tr> <tr><td bgcolor="#aa55cc"><tt>      </tt></td><td> </td> <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="StringIO.html">StringIO</a> <a href="array.html">array</a> </td><td width="25%" valign=top><a href="datetime.html">datetime</a> <a href="os.html">os</a> </td><td width="25%" valign=top><a href="string.html">string</a> <a href="struct.html">struct</a> </td><td width="25%" valign=top><a href="sys.html">sys</a> </td></tr></table></td></tr></table> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ee77aa"> <td colspan=3 valign=bottom>  <big>Classes</big></td></tr> <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td> </td> <td width="100%"><dl> <dt><a href="olefile2.html#OleFileIO">OleFileIO</a> </dt></dl> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ffc8d8"> <td colspan=3 valign=bottom>  <a name="OleFileIO">class OleFileIO</a></td></tr> <tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td> <td colspan=2><tt>OLE container object   This class encapsulates the interface to an OLE 2 structured storage file.  Use the {@link listdir} and {@link openstream} methods to access the contents of this file.   Object names are given as a list of strings, one for each subentry level.  The root entry should be omitted.  For example, the following code extracts all image streams from a Microsoft Image Composer file:       ole = <a href="#OleFileIO">OleFileIO</a>("fan.mic")       for entry in ole.<a href="#OleFileIO-listdir">listdir</a>():         if entry[1:2] == "Image":             fin = ole.<a href="#OleFileIO-openstream">openstream</a>(entry)             fout = <a href="#OleFileIO-open">open</a>(entry[0:1], "wb")             while True:                 s = fin.read(8192)                 if not s:                     break                 fout.write(s)   You can use the viewer application provided with the Python Imaging Library to view the resulting files (which happens to be standard TIFF files).  </tt></td></tr> <tr><td> </td> <td width="100%">Methods defined here: <dl><dt><a name="OleFileIO-__init__">__init__</a>(self, filename=None, raise_defects=40)</dt><dd><tt>Constructor for <a href="#OleFileIO">OleFileIO</a> class.   filename: file to open. raise_defects: minimal level for defects to be raised as exceptions. (use DEFECT_FATAL for a typical application, DEFECT_INCORRECT for a security-oriented application, see source code for details)</tt></dd></dl> <dl><dt><a name="OleFileIO-close">close</a>(self)</dt><dd><tt>close the OLE file, to release the file object</tt></dd></dl> <dl><dt><a name="OleFileIO-dumpdirectory">dumpdirectory</a>(self)</dt><dd><tt>Dump directory (for debugging only)</tt></dd></dl> <dl><dt><a name="OleFileIO-dumpfat">dumpfat</a>(self, fat, firstindex=0)</dt><dd><tt>Displays a part of FAT in human-readable form for debugging purpose</tt></dd></dl> <dl><dt><a name="OleFileIO-dumpsect">dumpsect</a>(self, sector, firstindex=0)</dt><dd><tt>Displays a sector in a human-readable form, for debugging purpose.</tt></dd></dl> <dl><dt><a name="OleFileIO-exists">exists</a>(self, filename)</dt><dd><tt>Test if given filename exists as a stream or a storage in the OLE container.   filename: path of stream in storage tree. (see openstream for syntax) return: True if object exist, else False.</tt></dd></dl> <dl><dt><a name="OleFileIO-get_metadata">get_metadata</a>(self)</dt><dd><tt>Parse standard properties streams, return an OleMetadata object containing all the available metadata. (also stored in the metadata attribute of the <a href="#OleFileIO">OleFileIO</a> object)   new in version 0.25</tt></dd></dl> <dl><dt><a name="OleFileIO-get_rootentry_name">get_rootentry_name</a>(self)</dt><dd><tt>Return root entry name. Should usually be 'Root Entry' or 'R' in most implementations.</tt></dd></dl> <dl><dt><a name="OleFileIO-get_size">get_size</a>(self, filename)</dt><dd><tt>Return size of a stream in the OLE container, in bytes.   filename: path of stream in storage tree (see openstream for syntax) return: size in bytes (long integer) raise: IOError if file not found, TypeError if this is not a stream.</tt></dd></dl> <dl><dt><a name="OleFileIO-get_type">get_type</a>(self, filename)</dt><dd><tt>Test if given filename exists as a stream or a storage in the OLE container, and return its type.   filename: path of stream in storage tree. (see openstream for syntax) return: False if object does not exist, its entry type (>0) otherwise:     - STGTY_STREAM: a stream     - STGTY_STORAGE: a storage     - STGTY_ROOT: the root entry</tt></dd></dl> <dl><dt><a name="OleFileIO-getctime">getctime</a>(self, filename)</dt><dd><tt>Return creation time of a stream/storage.   filename: path of stream/storage in storage tree. (see openstream for syntax) return: None if creation time is null, a python datetime object otherwise (UTC timezone)   new in version 0.26</tt></dd></dl> <dl><dt><a name="OleFileIO-getmtime">getmtime</a>(self, filename)</dt><dd><tt>Return modification time of a stream/storage.   filename: path of stream/storage in storage tree. (see openstream for syntax) return: None if modification time is null, a python datetime object otherwise (UTC timezone)   new in version 0.26</tt></dd></dl> <dl><dt><a name="OleFileIO-getproperties">getproperties</a>(self, filename, convert_time=False, no_conversion=None)</dt><dd><tt>Return properties described in substream.   filename: path of stream in storage tree (see openstream for syntax) convert_time: bool, if True timestamps will be converted to Python datetime no_conversion: None or list of int, timestamps not to be converted                (for example total editing time is not a real timestamp) return: a dictionary of values indexed by id (integer)</tt></dd></dl> <dl><dt><a name="OleFileIO-getsect">getsect</a>(self, sect)</dt><dd><tt>Read given sector from file on disk. sect: sector index returns a string containing the sector data.</tt></dd></dl> <dl><dt><a name="OleFileIO-listdir">listdir</a>(self, streams=True, storages=False)</dt><dd><tt>Return a list of streams stored in this file   streams: bool, include streams if True (True by default) - new in v0.26 storages: bool, include storages if True (False by default) - new in v0.26 (note: the root storage is never included)</tt></dd></dl> <dl><dt><a name="OleFileIO-loaddirectory">loaddirectory</a>(self, sect)</dt><dd><tt>Load the directory. sect: sector index of directory stream.</tt></dd></dl> <dl><dt><a name="OleFileIO-loadfat">loadfat</a>(self, header)</dt><dd><tt>Load the FAT table.</tt></dd></dl> <dl><dt><a name="OleFileIO-loadfat_sect">loadfat_sect</a>(self, sect)</dt><dd><tt>Adds the indexes of the given sector to the FAT sect: string containing the first FAT sector, or array of long integers return: index of last FAT sector.</tt></dd></dl> <dl><dt><a name="OleFileIO-loadminifat">loadminifat</a>(self)</dt><dd><tt>Load the MiniFAT table.</tt></dd></dl> <dl><dt><a name="OleFileIO-open">open</a>(self, filename)</dt><dd><tt>Open an OLE2 file. Reads the header, FAT and directory.   filename: string-like or file-like object</tt></dd></dl> <dl><dt><a name="OleFileIO-openstream">openstream</a>(self, filename)</dt><dd><tt>Open a stream as a read-only file object (StringIO).   filename: path of stream in storage tree (except root entry), either:     - a string using Unix path syntax, for example:       'storage_1/storage_1.2/stream'     - a list of storage filenames, path to the desired stream/storage.       Example: ['storage_1', 'storage_1.2', 'stream'] return: file object (read-only) raise IOError if filename not found, or if this is not a stream.</tt></dd></dl> <dl><dt><a name="OleFileIO-sect2array">sect2array</a>(self, sect)</dt><dd><tt>convert a sector to an array of 32 bits unsigned integers, swapping bytes on big endian CPUs such as PowerPC (old Macs)</tt></dd></dl> </td></tr></table></td></tr></table> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#eeaa77"> <td colspan=3 valign=bottom>  <big>Functions</big></td></tr> <tr><td bgcolor="#eeaa77"><tt>      </tt></td><td> </td> <td width="100%"><dl><dt><a name="-isOleFile">isOleFile</a>(filename)</dt><dd><tt>Test if file is an OLE container (according to its header). filename: file name or path (str, unicode) return: True if OLE, False otherwise.</tt></dd></dl> </td></tr></table> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#55aa55"> <td colspan=3 valign=bottom>  <big>Data</big></td></tr> <tr><td bgcolor="#55aa55"><tt>      </tt></td><td> </td> <td width="100%">DEFECT_FATAL = 40 DEFECT_INCORRECT = 30 DEFECT_POTENTIAL = 20 DEFECT_UNSURE = 10 STGTY_EMPTY = 0 STGTY_LOCKBYTES = 3 STGTY_PROPERTY = 4 STGTY_ROOT = 5 STGTY_STORAGE = 1 STGTY_STREAM = 2 __all__ = ['OleFileIO', 'isOleFile', 'DEFECT_UNSURE', 'STGTY_STREAM', 'DEFECT_FATAL', 'STGTY_EMPTY', 'STGTY_LOCKBYTES', 'STGTY_STORAGE', 'STGTY_PROPERTY', 'DEFECT_INCORRECT', 'DEFECT_POTENTIAL', 'STGTY_ROOT'] __author__ = 'Philippe Lagadec' __date__ = '2014-10-01' __version__ = '0.40py2'</td></tr></table> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#7799ee"> <td colspan=3 valign=bottom>  <big>Author</big></td></tr> <tr><td bgcolor="#7799ee"><tt>      </tt></td><td> </td> <td width="100%">Philippe Lagadec</td></tr></table> </body></html>