server.web.server_side_exception
================================

.. py:module:: server.web.server_side_exception

.. autoapi-nested-parse::

   Exceptions only used on the Server Side.



Exceptions
----------

.. autoapisummary::

   server.web.server_side_exception.ServerSideException
   server.web.server_side_exception.InvalidUsage
   server.web.server_side_exception.ServerError


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

.. py:exception:: ServerSideException(msg: str)

   Bases: :py:obj:`Exception`


   Used for all exceptions on the server side.

   Initialize Exception with message.


   .. py:attribute:: msg


.. py:exception:: InvalidUsage(msg: str, status_code: Optional[int] = None, payload: Optional[tuple] = None)

   Bases: :py:obj:`ServerSideException`


   Error caused by client mistakes (ex. bad data provided).

   Initialize ServerSide exception and default to 400 if not status_code available.


   .. py:attribute:: status_code
      :value: None



   .. py:attribute:: payload
      :value: None



   .. py:method:: to_dict() -> Dict

      Put exception in a dictionary.



.. py:exception:: ServerError(msg: str, status_code: Optional[int] = None, payload: Optional[tuple] = None)

   Bases: :py:obj:`ServerSideException`


   Use for Internal Server Error.

   Initialize and assign 500 status code if none provided.


   .. py:attribute:: status_code
      :value: None



   .. py:attribute:: payload
      :value: None



   .. py:method:: to_dict() -> Dict

      Return payload and message as dictionary.