.. include:: headings.inc

.. currentmodule:: py.document

.. highlight:: python



.. _py.document.Document:

==========================================================================================================================================
|phoenix_title|  **Document**
==========================================================================================================================================

Document class.



|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **Document**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/py.document.Document_inheritance.png" alt="Inheritance diagram of Document" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="py.document.Document.html" title="Document class." alt="" coords="7,5,177,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~py.document.Document.__init__`                                           Create a Document instance.
:meth:`~py.document.Document.read`                                               Return contents of file.
:meth:`~py.document.Document.write`                                              Write text to file.
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: Document

   Document class.

   .. method:: __init__(self, filename=None)

      Create a Document instance.


   .. method:: read(self)

      Return contents of file.


   .. method:: write(self, text)

      Write text to file.