:tocdepth: 3

:py:mod:`gws.base.web.wsgi`
===========================

.. py:module:: gws.base.web.wsgi


**Source code:** :source:`gws.base.web.wsgi<gws/base/web/wsgi.py>`



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



.. py:class:: Requester(root: gws.Root, environ: dict, site: gws.WebSite, **kwargs)


   Bases: :py:obj:`gws.WebRequester`

   Web Requester object.

   .. py:attribute:: environ

      Request environment.

   .. py:attribute:: inputType
      :value: None


   .. py:attribute:: isApi

      The request is an 'api' request.

   .. py:attribute:: isGet

      The request is a 'get' request.

   .. py:attribute:: isPost

      The request is a 'post' request.

   .. py:attribute:: isSecure

      The request is secure.

   .. py:attribute:: method

      Request method.

   .. py:attribute:: outputType
      :value: None


   .. py:attribute:: root

      Object tree root.

   .. py:attribute:: session

      Current session.

   .. py:attribute:: site

      Website the request is processed for.

   .. py:attribute:: user

      Current use.

   .. py:method:: api_responder(response)

      Return a Responder object for an Api (structured) response.

      :param response: Response object.

      :returns: A Responder.


   .. py:method:: command()

      Command name to execute.


   .. py:method:: content_responder(response)

      Return a Responder object for a content response.

      :param response: Response object.

      :returns: A Responder.


   .. py:method:: cookie(key, default='')

      Get a cookie.

      :param key: Cookie name.
      :param default: Default value.

      :returns: A cookie value.


   .. py:method:: data()

      Get POST data.

      :returns: Data bytes or ``None`` if request is not a POST.


   .. py:method:: env(key, default='')

      Get an environment variable.

      :param key: Variable name.
      :param default: Default value.

      :returns: A variable value.


   .. py:method:: error_responder(exc)

      Return a Responder object for an Exception.

      :param exc: An Exception.

      :returns: A Responder.


   .. py:method:: has_param(key)

      Check if a GET parameter exists.

      :param key: Parameter name.


   .. py:method:: header(key, default='')

      Get a header.

      :param key: Header name.
      :param default: Default value.

      :returns: A header value.


   .. py:method:: param(key, default='')

      Get a GET parameter.

      :param key: Parameter name.
      :param default: Default value.

      :returns: A parameter value.


   .. py:method:: params()

      GET parameters.


   .. py:method:: redirect_responder(response)

      Return a Responder object for a redirect response.

      :param response: Response object.

      :returns: A Responder.


   .. py:method:: set_session(sess)

      Attach a session to the requester.

      :param session: A Session object.


   .. py:method:: struct()

      Structured JSON payload.


   .. py:method:: text()

      Get POST data as a text.

      :returns: Data string or ``None`` if request is not a POST.


   .. py:method:: url_for(path, **kwargs)

      Return a canonical Url for the given request path.

      :param request_path: Request path.
      :param \*\*kwargs: Additional GET parameters.

      :returns: An URL.



.. py:class:: Responder(**kwargs)


   Bases: :py:obj:`gws.WebResponder`

   Web Responder object.

   .. py:attribute:: response

   .. py:attribute:: status

      Response status.

   .. py:method:: add_header(key, value)

      Add a header.

      :param key: Header name.
      :param value: Header value.


   .. py:method:: delete_cookie(key, **kwargs)

      Delete a cookie.

      :param key: Cookie name.
      :param \*\*kwargs: Cookie options.


   .. py:method:: send_response(environ, start_response)

      Send the response to the client.

      :param environ: WSGI environment.
      :param start_response: WSGI ``start_response`` function.


   .. py:method:: set_cookie(key, value, **kwargs)

      Set a cookie.

      :param key: Cookie name.
      :param value: Cookie value.
      :param \*\*kwargs: Cookie options.


   .. py:method:: set_status(status)

      Set the response status.

      :param status: HTTP status code.