Package docutils :: Module io :: Class FileOutput
[show private | hide private]
[frames | no frames]

Class FileOutput

TransformSpec --+    
                |    
           Output --+
                    |
                   FileOutput


Output for single, simple file-like objects.
Method Summary
  __init__(self, destination, destination_path, encoding, error_handler, autoclose)
  close(self)
  open(self)
  write(self, data)
Encode data, write it to a single file, and return it.
    Inherited from Output
  __repr__(self)
  encode(self, data)

Class Variable Summary
    Inherited from Output
str component_type = 'output'
NoneType default_destination_path = None                                                                  
    Inherited from TransformSpec
tuple default_transforms = ()

Method Details

__init__(self, destination=None, destination_path=None, encoding=None, error_handler='strict', autoclose=1)
(Constructor)

Parameters:
destination - either a file-like object (which is written directly) or None (which implies sys.stdout if no destination_path given).
destination_path - a path to a file, which is opened and then written.
autoclose - close automatically after write (boolean); always false if sys.stdout is the destination.
Overrides:
docutils.io.Output.__init__

write(self, data)

Encode data, write it to a single file, and return it.
Overrides:
docutils.io.Output.write

Generated by Epydoc 2.0 on Tue Jul 22 05:30:39 2003 http://epydoc.sf.net