spresso.view package

Subpackages

• spresso.view.api package
  • Submodules
  • spresso.view.api.api module
  • Module contents
• spresso.view.authentication package
  • Submodules
  • spresso.view.authentication.forward module
  • spresso.view.authentication.identity_provider module
  • spresso.view.authentication.relying_party module
  • Module contents

Submodules

spresso.view.base module

class JsonView(response_class=<class 'spresso.model.web.base.Response'>, **kwargs)

Bases: spresso.view.base.View

Abstract JSON view class.

json()

Provides the actual JSON content. Has to be implemented by inheriting classes

make_response(response)

Wrapper around json_success_response(). Retrieves the JSON data by calling json().

Parameters:response (spresso.model.web.base.Response) – The response. Returns:The response returned by json_success_response().

class Script(settings)

Bases: spresso.view.base.TemplateBase

Template view class that is used to render a JavaScript used in SPRESSO.

template()

Return the JS template file from the settings.

Returns:The template file path.

class TemplateBase(settings)

Bases: spresso.model.base.SettingsMixin

Abstract template view class. Uses Jinja2 for template rendering, enabling the use of Jinja2 functionality in templates.

render()

The configuration object is mixed in. A template is chosen, loaded and rendered.

Returns:The rendered template.

template()

Abstract template file definition. Has to be implemented by inheriting classes.

Returns:The template file path.

template_context = {}

class TemplateView(response_class=<class 'spresso.model.web.base.Response'>, **kwargs)

Bases: spresso.view.base.View, spresso.view.base.TemplateBase

Abstract template view class that inserts the template in a HTTP response.

make_response(response)

Wrapper around render(). Adds the rendered template to the response object.

Parameters:response (spresso.model.web.base.Response) – The response. Returns:The response containing the template.

class View(response_class=<class 'spresso.model.web.base.Response'>, **kwargs)

Bases: object

Basic view class.

Parameters:response_class (optional) – The response class, defaults to spresso.model.web.base.Response.

make_response(response)

Basic Interface method. Can be extended by inheriting classes.

Parameters:

• response (spresso.model.web.base.Response) – The
• response. –

Returns:

The response parameter.

process(response)

Wrapper around make_response(). If no valid response is returned a default instance of type response_class is returned.

Parameters:response – The response. Returns:The verified response of type response_class.

json_error_response(error, response, status_code=400)

Method for returning a JSON error response, based on a spresso.utils.error.SpressoBaseError.

Parameters:

• error (spresso.utils.error.SpressoBaseError) – The error.
• response (spresso.model.web.base.Response) – The response.
• status_code (int) – The HTTP status code.

Returns:

The response containing

the error.

Return type:

spresso.model.web.base.Response

json_success_response(data, response)

Method for returning a JSON success response, based on response data.

Parameters:

• data (str) – The response data.
• response (spresso.model.web.base.Response) – The response.

Returns:

The response containing the data.

Return type:

spresso.model.web.base.Response

Module contents