BaseReader

class BaseReader(*args, **kwargs)

The Base Reader class.

The base functionality includes reading data from a file, and allowing access to the underlying vtk reader. See pyvista.get_reader() for an example using a built-in subclass.

Subclasses parameterize BaseReader with the concrete DataObject subclass they produce, e.g. XMLPolyDataReader is declared as class XMLPolyDataReader(BaseReader[PolyData], ...) so read() returns PolyData under static analysis without each subclass needing its own read override.

Parameters:

pathstr, Path

Path of the file to read.

Inheritance

Inherited members are documented on _FileIOBase.

See them all under Inherited Attributes.

Attributes

BaseReader.path	Return or set the filename or directory of the reader.
BaseReader.reader	Return the vtk Reader object.

Inherited Attributes

_FileIOBase.extension_patterns	Return mapping from regex pattern matching associated with this class.
_FileIOBase.extensions	Return the file extensions associated with this class.

Methods

BaseReader.hide_progress()	Hide the progress bar when loading the file.
BaseReader.read(*[, validate])	Read data in file.
BaseReader.show_progress([msg])	Show a progress bar when loading the file.