helikite.classes.base
=====================

.. py:module:: helikite.classes.base


Classes
-------

.. autoapisummary::

   helikite.classes.base.BaseProcessor


Functions
---------

.. autoapisummary::

   helikite.classes.base.function_dependencies


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

.. py:function:: function_dependencies(required_operations: list[str] = [], use_once=False)

   A decorator to enforce that a method can only run if the required
   operations have been completed and not rerun.

   If used without a list, the function can only run once.


.. py:class:: BaseProcessor

   Bases: :py:obj:`abc.ABC`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: _completed_operations
      :type:  List[str]
      :value: []



   .. py:method:: _data_state_info() -> List[str]
      :abstractmethod:



   .. py:method:: _operations_state_info() -> List[str]


   .. py:method:: state()

      Prints the current state of the class in a tabular format



   .. py:method:: help()

      Prints available methods in a clean format



   .. py:method:: _print_success_errors(operation: str, success: list[str], errors: list[tuple[str, Any]]) -> None