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

.. py:module:: flow.record.adapter.csvfile


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

Classes
~~~~~~~

.. autoapisummary::

   flow.record.adapter.csvfile.CsvfileWriter
   flow.record.adapter.csvfile.CsvfileReader




Attributes
~~~~~~~~~~

.. autoapisummary::

   flow.record.adapter.csvfile.__usage__


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

    .. raw:: html

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

    .. code-block:: python

        """
        Comma-separated values (CSV) adapter
        ---
        Write usage: rdump -w csvfile://[PATH]?lineterminator=[TERMINATOR]
        Read usage: rdump csvfile://[PATH]?fields=[FIELDS]
        [PATH]: path to file. Leave empty or "-" to output to stdout
        
        Optional parameters:
            [TERMINATOR]: line terminator, default is \r\n
            [FIELDS]: comma-separated list of CSV fields (in case of missing CSV header)
        """

    .. raw:: html

        </details>

   

.. py:class:: CsvfileWriter(path, fields=None, exclude=None, lineterminator=None, **kwargs)


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

   .. 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:: CsvfileReader(path, selector=None, fields=None, **kwargs)


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

   .. py:method:: close()

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


   .. py:method:: __iter__()

      Return a record iterator.