pyrio.streams.file_stream
=========================

.. py:module:: pyrio.streams.file_stream


Attributes
----------

.. autoapisummary::

   pyrio.streams.file_stream.TEMP_PATH
   pyrio.streams.file_stream.DSV_CONFIG
   pyrio.streams.file_stream.MAPPING_READ_CONFIG
   pyrio.streams.file_stream.MAPPING_WRITE_CONFIG


Classes
-------

.. autoapisummary::

   pyrio.streams.file_stream.FileStream


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

.. py:data:: TEMP_PATH
   :value: '{file_path}.tmp'


.. py:data:: DSV_CONFIG

.. py:data:: MAPPING_READ_CONFIG

.. py:data:: MAPPING_WRITE_CONFIG

.. py:class:: FileStream(file_path)

   Bases: :py:obj:`pyrio.streams.BaseStream`


   Derived Stream class for querying files; maps file content to im-memory dict structures and vice versa


   .. py:method:: process(file_path, *, f_open_options=None, f_read_options=None, **kwargs)
      :classmethod:


      Creates Stream from a file with advanced 'reading' options passed by the user



   .. py:method:: _read_file(file_path, f_open_options=None, f_read_options=None, **kwargs)
      :classmethod:



   .. py:method:: _read_dsv(path, f_open_options, f_read_options)
      :staticmethod:



   .. py:method:: _read_mapping(path, f_open_options, f_read_options, **kwargs)
      :staticmethod:



   .. py:method:: _read_plain(path, f_open_options)
      :staticmethod:



   .. py:method:: save(file_path=None, *, f_open_options=None, f_write_options=None, null_handler=None, **kwargs)

      Writes Stream to a new file (or updates an existing one) with advanced 'writing' options passed by the user



   .. py:method:: _write_dsv(path, tmp_path, f_open_options, f_write_options, null_handler=None)


   .. py:method:: _write_mapping(path, tmp_path, f_open_options, f_write_options, null_handler=None, **kwargs)


   .. py:method:: _write_plain(path, tmp_path, f_open_options, f_write_options)


   .. py:method:: _get_file_path(file_path, read_mode=True)
      :staticmethod:



   .. py:method:: _prepare_file_paths(file_path)


   .. py:method:: _prepare_io_options(settings)
      :staticmethod:



   .. py:method:: _atomic_write(path, tmp_path, f_open_options)