: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: str | pathlib.Path | BinaryIO, indent: str | int | None = None, descriptors: bool = True, **kwargs)

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


   .. py:attribute:: fp
      :value: None



   .. py:attribute:: descriptors
      :value: True



   .. py:attribute:: packer


   .. py:method:: packer_on_new_descriptor(descriptor: flow.record.base.RecordDescriptor) -> None


   .. py:method:: write(r: flow.record.base.Record) -> None

      Write a record.



   .. py:method:: flush() -> None

      Flush any buffered writes.



   .. py:method:: close() -> None

      Close the Writer, no more writes will be possible.



.. py:class:: JsonfileReader(path: str | pathlib.Path | BinaryIO, selector: str | None = None, **kwargs)

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


   .. py:attribute:: fp
      :value: None



   .. py:attribute:: selector
      :value: None



   .. py:attribute:: packer


   .. py:method:: close() -> None

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



   .. py:method:: __iter__() -> collections.abc.Iterator[flow.record.base.Record]

      Return a record iterator.