docutils.io.FileInput

Package docutils :: Module io :: Class FileInput

[show private | hide private]

Class FileInput

TransformSpec --+    
                |    
            Input --+
                    |
                   FileInput

Input for single, simple file-like objects.

Method Summary
	`__init__(self, source, source_path, encoding, autoclose)`
	`close(self)`
	`read(self)` Read and decode a single file and return the data.
Inherited from Input
	`__repr__(self)`
	`decode(self, data)` Decode a string, `data`, heuristically.

Class Variable Summary
Inherited from Input
`str`	`component_type` = `'input'`
`NoneType`	`default_source_path` = None
Inherited from TransformSpec
`tuple`	`default_transforms` = `()`

Method Details

Parameters:: source - either a file-like object (which is read directly), or None (which implies sys.stdin if no source_path given).; source_path - a path to a file, which is opened and then read.; autoclose - close automatically after read (boolean); always false if sys.stdin is the source.

Read and decode a single file and return the data.

Generated by Epydoc 2.0 on Tue Jul 22 05:30:25 2003