:py:mod:`ethos_penalps.stream_handler`
======================================

.. py:module:: ethos_penalps.stream_handler


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

Classes
~~~~~~~

.. autoapisummary::

   ethos_penalps.stream_handler.StreamHandler




Attributes
~~~~~~~~~~

.. autoapisummary::

   ethos_penalps.stream_handler.logger


.. py:data:: logger

   

.. py:class:: StreamHandler


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

      Prints all attributes of all streams that are stored in the stream_dict. Is only used for debugging purposes.


   .. py:method:: json_dumps_streams() -> str


   .. py:method:: json_dump_streams(path: str | None = None)


   .. py:method:: json_loads_streams(json_string: str)


   .. py:method:: json_load_streams(path: str)


   .. py:method:: create_continuous_stream(continuous_stream_static_data: ethos_penalps.stream.ContinuousStreamStaticData) -> ethos_penalps.stream.ContinuousStream


   .. py:method:: add_stream(new_stream: ethos_penalps.stream.ContinuousStream | ethos_penalps.stream.BatchStream, overwrite_stream: bool = False)


   .. py:method:: get_list_of_all_stream_names_in_stream_handler() -> list[str]

      Gets the names of all streams stored in the StreamHandler instance. Includes inactive streams.

      :return: _description_
      :rtype: list[str]


   .. py:method:: get_stream(stream_name: str) -> ethos_penalps.stream.ContinuousStream | ethos_penalps.stream.BatchStream

      returns a stream based on the name as a key

      :param stream_name: [description]
      :type stream_name: str
      :return: [description]
      :rtype: Stream


   .. py:method:: create_batch_stream(batch_stream_static_data: ethos_penalps.stream.BatchStreamStaticData) -> ethos_penalps.stream.BatchStream