:py:mod:`helper`
================

.. py:module:: helper

.. autodoc2-docstring:: helper
   :allowtitles:

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

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`ContextIterator <helper.ContextIterator>`
     - .. autodoc2-docstring:: helper.ContextIterator
          :summary:
   * - :py:obj:`Klass <helper.Klass>`
     - .. autodoc2-docstring:: helper.Klass
          :summary:
   * - :py:obj:`Evaluation <helper.Evaluation>`
     - .. autodoc2-docstring:: helper.Evaluation
          :summary:

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`terminal_yes_no <helper.terminal_yes_no>`
     - .. autodoc2-docstring:: helper.terminal_yes_no
          :summary:
   * - :py:obj:`silent_keyboard_interrupt <helper.silent_keyboard_interrupt>`
     - .. autodoc2-docstring:: helper.silent_keyboard_interrupt
          :summary:
   * - :py:obj:`greptex <helper.greptex>`
     - .. autodoc2-docstring:: helper.greptex
          :summary:
   * - :py:obj:`lower_ascii <helper.lower_ascii>`
     - .. autodoc2-docstring:: helper.lower_ascii
          :summary:
   * - :py:obj:`bat <helper.bat>`
     - .. autodoc2-docstring:: helper.bat
          :summary:
   * - :py:obj:`as_valid_filename <helper.as_valid_filename>`
     - .. autodoc2-docstring:: helper.as_valid_filename
          :summary:
   * - :py:obj:`progress_bar <helper.progress_bar>`
     - .. autodoc2-docstring:: helper.progress_bar
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`logger <helper.logger>`
     - .. autodoc2-docstring:: helper.logger
          :summary:

API
~~~

.. py:data:: logger
   :canonical: helper.logger
   :value: 'getLogger(...)'

   .. autodoc2-docstring:: helper.logger

.. py:function:: terminal_yes_no(prompt: str) -> bool
   :canonical: helper.terminal_yes_no

   .. autodoc2-docstring:: helper.terminal_yes_no

.. py:function:: silent_keyboard_interrupt(func)
   :canonical: helper.silent_keyboard_interrupt

   .. autodoc2-docstring:: helper.silent_keyboard_interrupt

.. py:function:: greptex(query: str, path: pathlib.Path, silent: bool) -> set[str]
   :canonical: helper.greptex

   .. autodoc2-docstring:: helper.greptex

.. py:function:: lower_ascii(txt: str) -> str
   :canonical: helper.lower_ascii

   .. autodoc2-docstring:: helper.lower_ascii

.. py:function:: bat(path: pathlib.Path, title: str) -> None
   :canonical: helper.bat

   .. autodoc2-docstring:: helper.bat

.. py:function:: as_valid_filename(txt: str) -> str
   :canonical: helper.as_valid_filename

   .. autodoc2-docstring:: helper.as_valid_filename

.. py:class:: ContextIterator(iterable: typing.Iterable[T], before: int, after: int)
   :canonical: helper.ContextIterator

   .. autodoc2-docstring:: helper.ContextIterator

   .. rubric:: Initialization

   .. autodoc2-docstring:: helper.ContextIterator.__init__

   .. py:method:: get() -> list[T]
      :canonical: helper.ContextIterator.get

      .. autodoc2-docstring:: helper.ContextIterator.get

.. py:class:: Klass(uuid: str, name: str, year: int, extra: str, evaluations: list[str])
   :canonical: helper.Klass

   .. autodoc2-docstring:: helper.Klass

   .. rubric:: Initialization

   .. autodoc2-docstring:: helper.Klass.__init__

   .. py:method:: is_current() -> bool
      :canonical: helper.Klass.is_current

      .. autodoc2-docstring:: helper.Klass.is_current

   .. py:method:: to_dict() -> dict[str, str | list[str] | int]
      :canonical: helper.Klass.to_dict

      .. autodoc2-docstring:: helper.Klass.to_dict

.. py:class:: Evaluation(uuid: str, klass_uuid: str, title: str = '', date: str = '2024-08-31', number: str = '', extra: list[str] = [], exercises: list[str] = [])
   :canonical: helper.Evaluation

   .. autodoc2-docstring:: helper.Evaluation

   .. rubric:: Initialization

   .. autodoc2-docstring:: helper.Evaluation.__init__

   .. py:method:: update(data: dict) -> tuple[set[str], set[str]]
      :canonical: helper.Evaluation.update

      .. autodoc2-docstring:: helper.Evaluation.update

   .. py:method:: to_dict() -> dict[str, str | list[str]]
      :canonical: helper.Evaluation.to_dict

      .. autodoc2-docstring:: helper.Evaluation.to_dict

.. py:function:: progress_bar(max_step: int, step: int, length: int, msg: str) -> None
   :canonical: helper.progress_bar

   .. autodoc2-docstring:: helper.progress_bar