extension

class f8s.extension.F8s(app=None)

Bases: object

__dict__ = mappingproxy({'__module__': 'f8s.extension', 'api': <Blueprint 'f8s'>, '__init__': <function F8s.__init__>, 'name': <property object>, 'init_app': <function F8s.init_app>, 'get_config': <function F8s.get_config>, 'validate': <function F8s.validate>, '__dict__': <attribute '__dict__' of 'F8s' objects>, '__weakref__': <attribute '__weakref__' of 'F8s' objects>, '__doc__': None, '__annotations__': {}})

__init__(app=None)

Initialize flask extension.

Parameters:

app (flask.Flask, optional) – Flask app.

__module__ = 'f8s.extension'

__weakref__

list of weak references to the object (if defined)

api = <Blueprint 'f8s'>

get_config(app)

Get config from envirnment variables or config file.

Parameters:

app (flask.Flask) – Flask app.

Returns:

Database config.

Return type:

dict

init_app(app)

Add endpoints and error handlers to given app.

Parameters:

app (Flask) – Flask app.

Return type:

None

property name: str

Returns: str: Name of class.

validate(config)

Raises an error if given config is invalid.

Parameters:

config (dict) – Extension config.

Return type:

None

f8s.extension.apidocs()

Route to F8s API documentation.

Returns:

Flassger generated API page.

Return type:

html

tools

f8s.tools.error_to_response(error)

Convenience function for formatting a given exception as a Flask Response.

Parameters:

error (Exception) – Error to be formatted.

Returns:

Flask response.

Return type:

flask.Response

f8s.tools.get_app(extensions, live_probe=None, ready_probe=None, testing=False)

Creates a F8S app.

Returns:

Flask app.

Return type:

flask.Flask