.. _f-flaskhelper: module ``td_1a.flask_helper`` ============================= .. inheritance-diagram:: ensae_teaching_cs.td_1a.flask_helper Short summary +++++++++++++ module ``ensae_teaching_cs.td_1a.flask_helper`` Helpers for :epkg:`Flask`. :githublink:`%|py|6` Classes +++++++ +-----------------------------------------------------------------------------+----------------------------------+ | class | truncated documentation | +=============================================================================+==================================+ | :class:`FlaskInThread ` | Defines a thread for the server. | +-----------------------------------------------------------------------------+----------------------------------+ Functions +++++++++ +--------------------------------------------------------------------------------------+--------------------------------------------------------------------+ | function | truncated documentation | +======================================================================================+====================================================================+ | :func:`Exception2Response ` | Converts an exception into plain text and display the stack trace. | +--------------------------------------------------------------------------------------+--------------------------------------------------------------------+ | :func:`Text2Response ` | Converts a text into plain text. | +--------------------------------------------------------------------------------------+--------------------------------------------------------------------+ Properties ++++++++++ +----------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | property | truncated documentation | +==================================================================================+=============================================================================================================================+ | :meth:`daemon ` | A boolean value indicating whether this thread is a daemon thread. This must be set before start() is called, otherwise ... | +----------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :meth:`ident ` | Thread identifier of this thread or None if it has not been started. This is a nonzero integer. See the get_ident() ... | +----------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :meth:`name ` | A string used for identification purposes only. It has no semantics. Multiple threads may be given the same name. ... | +----------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :meth:`native_id ` | Native integral thread ID of this thread, or None if it has not been started. This is a non-negative integer. ... | +----------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ Methods +++++++ +----------------------------------------------------------------------------------------------+----------------------------------------------------+ | method | truncated documentation | +==============================================================================================+====================================================+ | :py:meth:`__init__ ` | | +----------------------------------------------------------------------------------------------+----------------------------------------------------+ | :meth:`raise_exception ` | | +----------------------------------------------------------------------------------------------+----------------------------------------------------+ | :meth:`run ` | Starts the server. | +----------------------------------------------------------------------------------------------+----------------------------------------------------+ | :meth:`shutdown ` | Shuts down the server, the function could work if: | +----------------------------------------------------------------------------------------------+----------------------------------------------------+ Documentation +++++++++++++ .. automodule:: ensae_teaching_cs.td_1a.flask_helper :members: :special-members: __init__ :show-inheritance: