freeflux.utils.progress
=======================

.. py:module:: freeflux.utils.progress

.. autoapi-nested-parse::

   Define the Progress class.



Attributes
----------

.. autoapisummary::

   freeflux.utils.progress.__author__


Classes
-------

.. autoapisummary::

   freeflux.utils.progress.Progress


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

.. py:data:: __author__
   :value: 'Chao Wu'


.. py:class:: Progress(descp, silent=False)

   Progress instances can be either used in a WITH statement or assigned to a variable.
   In the second case, the start and stop method should be called explicitely.


   .. py:attribute:: descp


   .. py:attribute:: count
      :value: 0



   .. py:attribute:: is_running
      :value: False



   .. py:attribute:: silent
      :value: False



   .. py:method:: __enter__()


   .. py:method:: __exit__(type, value, traceback)


   .. py:method:: _sleeptime()


   .. py:method:: _show_progress(descp)


   .. py:method:: start()


   .. py:method:: stop()