:mod:`pytimings.tools`
======================

.. py:module:: pytimings.tools

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


Functions
~~~~~~~~~

.. autoapisummary::
  :nosignatures:

   pytimings.tools.ensure_directory_exists
   pytimings.tools.output_at_exit
   pytimings.tools.busywait
   pytimings.tools.generate_example_data



.. py:function:: ensure_directory_exists(dirname)

   create dirname if it doesn't exist


.. py:function:: output_at_exit(output_dir: Optional[Union[str, pathlib.Path]] = None, csv_base='timings', timings=None, files=True, console=True) -> None

   Register output methods to be executed at Python interpreter exit

   files: set to False to not write csv files to disk
   console: set to False to not display console output for timing sections
   csv_base: filename stem for csv outputs
   output_dir: directory for csv outputs, defaults to current working directory


.. py:function:: busywait(secs)

   busywait simulates load, so user time won't be 0 in timings


.. py:function:: generate_example_data(output_dir, number_of_runs=10)