docutils.io.FileInput

class documentation

class FileInput(Input): (source)

Input for single, simple file-like objects.

Method	`__init__`	: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...
Method	`close`	Undocumented
Method	`read`	Read and decode a single file and return the data (Unicode string).
Method	`readlines`	Return lines of a single file as list of Unicode strings.
Instance Variable	`autoclose`	Undocumented
Instance Variable	`source`	The source of input data.
Instance Variable	`source_path`	A text reference to the source.
Instance Variable	`_stderr`	Undocumented

Inherited from Input:

Method	`__repr__`	Undocumented
Method	`decode`	Decode `data` if required.
Method	`determine_encoding_from_data`	Try to determine the encoding of `data` by looking in `data`. Check for a byte order mark (BOM) or an encoding declaration.
Method	`isatty`	Undocumented
Class Variable	`byte_order_marks`	Sequence of (start_bytes, encoding) tuples for encoding detection. The first bytes of input data are checked against the start_bytes strings. A match indicates the given encoding.
Class Variable	`coding_slug`	Encoding declaration pattern.
Class Variable	`component_type`	Undocumented
Class Variable	`default_source_path`	Undocumented
Instance Variable	`encoding`	Text encoding for the input source.
Instance Variable	`error_handler`	Text decoding error handler.
Instance Variable	`successful_encoding`	The encoding that successfully decoded the source data.

Inherited from TransformSpec (via Input):

Method	`get_transforms`	Transforms required by this class. Override in subclasses.
Class Variable	`default_transforms`	Undocumented
Class Variable	`unknown_reference_resolvers`	List of functions to try to resolve unknown references. Unknown references have a 'refname' attribute which doesn't correspond to any target in the document. Called when the transforms in `docutils.transforms...

def __init__(self, source=None, source_path=None, encoding=None, error_handler='strict', autoclose=True, mode='r'): (source)

overrides docutils.io.Input.__init__

: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. - `encoding`: the expected text encoding of the input file. - `error_handler`: the encoding error handler to use. - `autoclose`: close automatically after read (except when `sys.stdin` is the source). - `mode`: how the file is to be opened (see standard function `open`). The default is read only ('r').

def close(self): (source)

Undocumented

def read(self): (source)

overrides docutils.io.Input.read

Read and decode a single file and return the data (Unicode string).

def readlines(self): (source)

Return lines of a single file as list of Unicode strings.

autoclose = (source)

Undocumented

source = (source)

overrides docutils.io.Input.source

The source of input data.

source_path = (source)

overrides docutils.io.Input.source_path

A text reference to the source.

_stderr = (source)

Undocumented