:py:mod:`flow.record.adapter.jsonfile`
======================================

.. py:module:: flow.record.adapter.jsonfile


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   flow.record.adapter.jsonfile.JsonfileWriter
   flow.record.adapter.jsonfile.JsonfileReader




Attributes
~~~~~~~~~~

.. autoapisummary::

   flow.record.adapter.jsonfile.__usage__


.. py:data:: __usage__
   :value: Multiline-String

    .. raw:: html

        <details><summary>Show Value</summary>

    .. code-block:: python

        """
        JSON adapter
        ---
        Write usage: rdump -w jsonfile://[PATH]?indent=[INDENT]&descriptors=[DESCRIPTORS]
        Read usage: rdump jsonfile://[PATH]
        [PATH]: path to file. Leave empty or "-" to output to stdout
        [INDENT]: optional number of identation. Omit "indent" field value for jsonlines output
        [DESCRIPTORS]: optional boolean. If false, don't output record descriptors (default: true)
        """

    .. raw:: html

        </details>

   

.. py:class:: JsonfileWriter(path, indent=None, descriptors=True, **kwargs)


   Bases: :py:obj:`flow.record.adapter.AbstractWriter`

   .. py:attribute:: fp

      

   .. py:method:: packer_on_new_descriptor(descriptor)


   .. py:method:: write(r)

      Write a record.


   .. py:method:: flush()

      Flush any buffered writes.


   .. py:method:: close()

      Close the Writer, no more writes will be possible.



.. py:class:: JsonfileReader(path, selector=None, **kwargs)


   Bases: :py:obj:`flow.record.adapter.AbstractReader`

   .. py:attribute:: fp

      

   .. py:method:: close()

      Close the Reader, can be overriden to properly free resources.


   .. py:method:: __iter__()

      Return a record iterator.