bolster.utils
=============

.. py:module:: bolster.utils

.. autoapi-nested-parse::

   Utility bits and pieces.

   Random helpful functions that don't fit anywhere else:
   - timed: decorator to time function execution
   - TqdmLoggingHandler: logging that plays nice with tqdm progress bars
   - web: resilient web scraping helpers
   - rss: RSS/Atom feed parsing utilities
   - dt: datetime utilities
   - io: file/data helpers
   - aws/azure: cloud platform helpers



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/bolster/utils/aws/index
   /autoapi/bolster/utils/azure/index
   /autoapi/bolster/utils/cache/index
   /autoapi/bolster/utils/datatables/index
   /autoapi/bolster/utils/deco/index
   /autoapi/bolster/utils/dt/index
   /autoapi/bolster/utils/io/index
   /autoapi/bolster/utils/rss/index
   /autoapi/bolster/utils/web/index


Attributes
----------

.. autoapisummary::

   bolster.utils.logger
   bolster.utils.F
   bolster.utils.version_no


Classes
-------

.. autoapisummary::

   bolster.utils.TqdmLoggingHandler


Functions
---------

.. autoapisummary::

   bolster.utils.timed


Package Contents
----------------

.. py:data:: logger

.. py:data:: F

.. py:data:: version_no

.. py:class:: TqdmLoggingHandler(level=logging.NOTSET)

   Bases: :py:obj:`logging.Handler`


   Custom logging handler that uses tqdm to display log messages.

   Usage: `logging.getLogger().addHandler(TqdmLoggingHandler())`.

   Initialize the handler with the specified logging level.


   .. py:method:: emit(record)

      Emit a log record using tqdm.write to avoid interfering with progress bars.



.. py:function:: timed(func)

   This decorator prints the execution time for the decorated function.