Inheritance diagram for docutils.io.FileInput:

Collaboration diagram for docutils.io.FileInput:

Public Member Functions
	__init__ (self, source=None, source_path=None, encoding=None, error_handler='strict', autoclose=True, mode='r')

	read (self)

	readlines (self)

	close (self)

Public Member Functions inherited from docutils.io.Input
	__repr__ (self)

	decode (self, data)

	determine_encoding_from_data (self, data)

	isatty (self)

Public Member Functions inherited from docutils.TransformSpec
	get_transforms (self)

Public Attributes
	autoclose

	source

	encoding

	source_path

Public Attributes inherited from docutils.io.Input
	encoding

	error_handler

	source

	source_path

	successful_encoding

Public Attributes inherited from docutils.TransformSpec
	default_transforms

Protected Attributes
	_stderr

Additional Inherited Members
Static Public Attributes inherited from docutils.io.Input
str	component_type = 'input'

	default_source_path = None

	coding_slug = re.compile(br"coding[:=]\s*([-\w.]+)")

tuple	byte_order_marks

Static Public Attributes inherited from docutils.TransformSpec
tuple	default_transforms = ()

tuple	unknown_reference_resolvers = ()

Detailed Description

Input for single, simple file-like objects.

Constructor & Destructor Documentation

◆ init()

docutils.io.FileInput.__init__	(	self,
		source = `None`,
		source_path = `None`,
		encoding = `None`,
		error_handler = `'strict'`,
		autoclose = `True`,
		mode = `'r'`
	)

: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 for reading.
    - `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').

Reimplemented from docutils.io.Input.

Reimplemented in sphinx.io.SphinxFileInput.

Member Function Documentation

◆ read()

docutils.io.FileInput.read ( self )

Read and decode a single file, return as `str`.

Reimplemented from docutils.io.Input.

◆ readlines()

docutils.io.FileInput.readlines ( self )

Return lines of a single file as list of strings.

The documentation for this class was generated from the following file:

docs/help/help-venv/lib/python3.12/site-packages/docutils/io.py

Public Member Functions

Public Attributes

Protected Attributes