Formatter
=========

.. currentmodule:: lsst.daf.butler

.. autoclass:: Formatter
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~Formatter.dataId
      ~Formatter.fileDescriptor
      ~Formatter.supportedExtensions
      ~Formatter.supportedWriteParameters
      ~Formatter.unsupportedParameters
      ~Formatter.writeParameters
      ~Formatter.writeRecipes

   .. rubric:: Methods Summary

   .. autosummary::

      ~Formatter.can_read_bytes
      ~Formatter.fromBytes
      ~Formatter.makeUpdatedLocation
      ~Formatter.name
      ~Formatter.predictPath
      ~Formatter.read
      ~Formatter.segregateParameters
      ~Formatter.toBytes
      ~Formatter.validateExtension
      ~Formatter.validateWriteRecipes
      ~Formatter.write

   .. rubric:: Attributes Documentation

   .. autoattribute:: dataId
   .. autoattribute:: fileDescriptor
   .. autoattribute:: supportedExtensions
   .. autoattribute:: supportedWriteParameters
   .. autoattribute:: unsupportedParameters
   .. autoattribute:: writeParameters
   .. autoattribute:: writeRecipes

   .. rubric:: Methods Documentation

   .. automethod:: can_read_bytes
   .. automethod:: fromBytes
   .. automethod:: makeUpdatedLocation
   .. automethod:: name
   .. automethod:: predictPath
   .. automethod:: read
   .. automethod:: segregateParameters
   .. automethod:: toBytes
   .. automethod:: validateExtension
   .. automethod:: validateWriteRecipes
   .. automethod:: write