UnifiedReadWrite¶
-
class
astropy.io.registry.
UnifiedReadWrite
(instance, cls, method_name)[source]¶ Bases:
object
Base class for the worker object used in unified read() or write() methods.
This lightweight object is created for each
read()
orwrite()
call viaread
/write
descriptors on the data object class. The key driver is to allow complete format-specific documentation of available method options via ahelp()
method, e.g.Table.read.help('fits')
.Subclasses must define a
__call__
method which is what actually gets called when the data objectread()
orwrite()
method is called.For the canonical example see the
Table
class implementation (in particular theconnect.py
module there).- Parameters
- instanceobject
Descriptor calling instance or None if no instance
- clstype
Descriptor calling class (either owner class or instance class)
- method_namestr
Method name, either ‘read’ or ‘write’
Methods Summary
help
(self[, format, out])Output help documentation for the specified unified I/O
format
.list_formats
(self[, out])Print a list of available formats to console (or
out
filehandle)Methods Documentation
-
help
(self, format=None, out=None)[source]¶ Output help documentation for the specified unified I/O
format
.By default the help output is printed to the console via
pydoc.pager
. Instead one can supplied a file handle object asout
and the output will be written to that handle.- Parameters
- formatstr
Unified I/O format name, e.g. ‘fits’ or ‘ascii.ecsv’
- outNone or file handle object
Output destination (default is stdout via a pager)