_FileIOBase.format_description

property _FileIOBase.format_description: str

Return the human-readable description of the file format.

A reader and a writer for the same format share the same description. A custom reader subclass can set its own with format_description = 'My Format' in the class body.

Added in version 0.50.

Returns:

str

Description of the file format, or an empty string if the class does not declare one.

Examples

Download Python source code | Download Jupyter notebook

>>> import pyvista as pv
>>> from pyvista import examples
>>> pv.get_reader(examples.hexbeamfile).format_description
'Legacy VTK'
>>> pv.XMLUnstructuredGridReader.format_description
'VTK UnstructuredGrid'
>>> pv.XMLUnstructuredGridWriter.format_description
'VTK UnstructuredGrid'