hdf5storage.Marshallers
=======================

.. currentmodule:: hdf5storage.marshallers

.. automodule:: hdf5storage.marshallers


The marshallers have the following inheritance diagram


.. inheritance-diagram:: hdf5storage.marshallers
   :parts: 1


.. autosummary::

   TypeMarshaller
   NumpyScalarArrayMarshaller
   NumpyDtypeMarshaller
   PythonScalarMarshaller
   PythonStringMarshaller
   PythonNoneEllipsisNotImplementedMarshaller
   PythonDictMarshaller
   PythonCounterMarshaller
   PythonSliceRangeMarshaller
   PythonDatetimeObjsMarshaller
   PythonFractionMarshaller
   PythonListMarshaller
   PythonTupleSetDequeMarshaller
   PythonChainMapMarshaller


TypeMarshaller
--------------

.. autoclass:: TypeMarshaller
   :members: update_type_lookups, get_type_string, read, read_approximate, write, write_metadata
   :show-inheritance:

   .. autoattribute:: TypeMarshaller.required_parent_modules
      :annotation: = ()

   .. autoattribute:: TypeMarshaller.required_modules
      :annotation: = ()

   .. autoattribute:: TypeMarshaller.python_attributes
      :annotation: = {'Python.Type'}

   .. autoattribute:: TypeMarshaller.matlab_attributes
      :annotation: = {'H5PATH'}

   .. autoattribute:: TypeMarshaller.types
      :annotation: = ()

   .. autoattribute:: TypeMarshaller.python_type_strings
      :annotation: = ()

   .. autoattribute:: TypeMarshaller.matlab_classes
      :annotation: = ()

   .. autoattribute:: TypeMarshaller.type_to_typestring
      :annotation: = dict()

   .. autoattribute:: TypeMarshaller.typestring_to_type
      :annotation: = dict()


NumpyScalarArrayMarshaller
--------------------------

.. autoclass:: NumpyScalarArrayMarshaller
   :no-members:
   :show-inheritance:

   Handles the following ::

       python_attributes = {'Python.Type', 'Python.Shape', 'Python.Empty',
                            'Python.numpy.UnderlyingType',
                            'Python.numpy.Container', 'Python.Fields'}

       matlab_attributes = {'H5PATH', 'MATLAB_class', 'MATLAB_empty',
                            'MATLAB_int_decode', 'MATLAB_fields'}

       types = (np.ndarray, np.matrix,
                np.chararray, np.core.records.recarray,
                np.bool_, np.void,
                np.uint8, np.uint16, np.uint32, np.uint64,
                np.int8, np.int16, np.int32, np.int64,
                np.float16, np.float32, np.float64,
                np.complex64, np.complex128,
                np.bytes_, np.str_, np.object_)

       python_type_strings = ('numpy.ndarray', 'numpy.matrix',
                              'numpy.chararray', 'numpy.recarray',
                              'numpy.bool_', 'numpy.void',
                              'numpy.uint8', 'numpy.uint16',
                              'numpy.uint32', 'numpy.uint64', 'numpy.int8',
                              'numpy.int16', 'numpy.int32', 'numpy.int64',
                              'numpy.float16', 'numpy.float32', 'numpy.float64',
                              'numpy.complex64', 'numpy.complex128',
                              'numpy.bytes_', 'numpy.str_', 'numpy.object_')

       matlab_classes = ('logical', 'char', 'single', 'double', 'uint8',
                         'uint16', 'uint32', 'uint64', 'int8', 'int16',
                         'int32', 'int64', 'cell', 'canonical empty')


NumpyDtypeMarshaller
--------------------

.. autoclass:: NumpyDtypeMarshaller
   :no-members:
   :show-inheritance:

   Handles the following ::

       python_attributes = {'Python.Type', 'Python.Shape', 'Python.Empty',
                            'Python.numpy.UnderlyingType',
                            'Python.numpy.Container', 'Python.Fields'}

       matlab_attributes = {'H5PATH', 'MATLAB_class', 'MATLAB_empty',
                            'MATLAB_int_decode'}

       types = (np.dtype, )

       python_type_strings = ('numpy.dtype', )

       matlab_classes = ()


PythonScalarMarshaller
----------------------

.. autoclass:: PythonScalarMarshaller
   :no-members:
   :show-inheritance:

   Handles the following ::

       python_attributes = {'Python.Type', 'Python.Shape', 'Python.Empty',
                            'Python.numpy.UnderlyingType',
                            'Python.numpy.Container', 'Python.Fields'}

       matlab_attributes = {'H5PATH', 'MATLAB_class', 'MATLAB_empty',
                            'MATLAB_int_decode'}

       types = (bool, int, float, complex)

       python_type_strings = ('bool', 'int', 'float', 'complex')

       matlab_classes = ()


PythonStringMarshaller
----------------------

.. autoclass:: PythonStringMarshaller
   :no-members:
   :show-inheritance:

   Handles the following ::

       python_attributes = {'Python.Type', 'Python.Shape', 'Python.Empty',
                            'Python.numpy.UnderlyingType',
                            'Python.numpy.Container', 'Python.Fields'}

       matlab_attributes = {'H5PATH', 'MATLAB_class', 'MATLAB_empty',
                            'MATLAB_int_decode'}

       types = (str, bytes, bytearray)

       python_type_strings = ('str', 'bytes', 'bytearray')

       matlab_classes = ()


PythonNoneEllipsisNotImplementedMarshaller
------------------------------------------

.. autoclass:: PythonNoneEllipsisNotImplementedMarshaller
   :no-members:
   :show-inheritance:

   Handles the following ::

       python_attributes = {'Python.Type', 'Python.Shape', 'Python.Empty',
                            'Python.numpy.UnderlyingType',
                            'Python.numpy.Container', 'Python.Fields'}

       matlab_attributes = {'H5PATH', 'MATLAB_class', 'MATLAB_empty',
                            'MATLAB_int_decode'}

       types = (builtins.NoneType, builtins.ellipsis,
                builtins.NotImplementedType)

       python_type_strings = ('builtins.NoneType', 'builtins.ellipsis',
                              'builtins.NotImplementedType')

       matlab_classes = ()


PythonDictMarshaller
--------------------

.. autoclass:: PythonDictMarshaller
   :no-members:
   :show-inheritance:

   Handles the following ::

       python_attributes = {'Python.Type', 'Python.Fields'}

       matlab_attributes = {'H5PATH', 'MATLAB_class', 'MATLAB_fields'}

       types = (dict, collections.OrderedDict)

       python_type_strings = ('dict', 'collections.OrderedDict')

       matlab_classes = ()


PythonCounterMarshaller
------------------------

.. autoclass:: PythonCounterMarshaller
   :no-members:
   :show-inheritance:

   Handles the following ::

       python_attributes = {'Python.Type', 'Python.Fields'}

       matlab_attributes = {'H5PATH', 'MATLAB_class', 'MATLAB_fields'}

       types = (collections.Counter, )

       python_type_strings = ('collections.Counter', )

       matlab_classes = ()


PythonSliceRangeMarshaller
--------------------------

.. autoclass:: PythonSliceRangeMarshaller
   :no-members:
   :show-inheritance:

   Handles the following ::

       python_attributes = {'Python.Type', 'Python.Fields'}

       matlab_attributes = {'H5PATH', 'MATLAB_class', 'MATLAB_fields'}

       types = (slice, range)

       python_type_strings = ('slice', 'range')

       matlab_classes = ()


PythonDatetimeObjsMarshaller
----------------------------

.. autoclass:: PythonDatetimeObjsMarshaller
   :no-members:
   :show-inheritance:

   Handles the following ::

       python_attributes = {'Python.Type', 'Python.Fields'}

       matlab_attributes = {'H5PATH', 'MATLAB_class', 'MATLAB_fields'}

       types = (datetime.timedelta, datetime.timezone,
                datetime.date, datetime.time, datetime.datetime)

       python_type_strings = ('datetime.timedelta', 'datetime.timezone',
                              'datetime.date', 'datetime.time',
                              'datetime.datetime')

       matlab_classes = ()


PythonFractionMarshaller
------------------------

.. autoclass:: PythonFractionMarshaller
   :no-members:
   :show-inheritance:

   Handles the following ::

       required_parent_modules = ('fractions', )

       required_modules = ('fractions', )

       python_attributes = {'Python.Type', 'Python.Fields'}

       matlab_attributes = {'H5PATH', 'MATLAB_class', 'MATLAB_fields'}

       types = ('fractions.Fraction', )

       python_type_strings = ('fractions.Fraction', )

       matlab_classes = ()


PythonListMarshaller
--------------------

.. autoclass:: PythonListMarshaller
   :no-members:
   :show-inheritance:

   Handles the following ::

       python_attributes = {'Python.Type', 'Python.Shape', 'Python.Empty',
                            'Python.numpy.UnderlyingType',
                            'Python.numpy.Container', 'Python.Fields'}

       matlab_attributes = {'H5PATH', 'MATLAB_class', 'MATLAB_empty',
                            'MATLAB_int_decode'}

       types = (list, )

       python_type_strings = ('list', )

       matlab_classes = ()


PythonTupleSetDequeMarshaller
-----------------------------

.. autoclass:: PythonTupleSetDequeMarshaller
   :no-members:
   :show-inheritance:

   Handles the following ::

       python_attributes = {'Python.Type', 'Python.Shape', 'Python.Empty',
                            'Python.numpy.UnderlyingType',
                            'Python.numpy.Container', 'Python.Fields'}

       matlab_attributes = {'H5PATH', 'MATLAB_class', 'MATLAB_empty',
                            'MATLAB_int_decode'}

       types = (tuple, set, frozenset, collections.deque)

       python_type_strings = ('tuple', 'set', 'frozenset', 'collections.deque')

       matlab_classes = ()


PythonChainMapMarshaller
------------------------

.. autoclass:: PythonChainMapMarshaller
   :no-members:
   :show-inheritance:

   Handles the following ::

       python_attributes = {'Python.Type', 'Python.Shape', 'Python.Empty',
                            'Python.numpy.UnderlyingType',
                            'Python.numpy.Container', 'Python.Fields'}

       matlab_attributes = {'H5PATH', 'MATLAB_class', 'MATLAB_empty',
                            'MATLAB_int_decode'}

       types = (collections.ChainMap, )

       python_type_strings = ('collections.ChainMap', )

       matlab_classes = ()