connexion.apis.flask_utils

This module defines utility functions related to the Flask framework.

Module Contents

Functions

flaskify_endpoint(identifier, randomize=None)

Converts the provided identifier in a valid flask endpoint name

convert_path_parameter(match, types)

flaskify_path(swagger_path, types=None)

Convert swagger path templates to flask path templates

is_flask_response(obj: object) → bool

Verifies if obj is a default Flask response instance.

Attributes

PATH_PARAMETER

PATH_PARAMETER_CONVERTERS

connexion.apis.flask_utils.PATH_PARAMETER
connexion.apis.flask_utils.PATH_PARAMETER_CONVERTERS
connexion.apis.flask_utils.flaskify_endpoint(identifier, randomize=None)

Converts the provided identifier in a valid flask endpoint name

Parameters

randomize (int | None) – If specified, add this many random characters (upper case and digits) to the endpoint name, separated by a pipe character.

Return type

str

connexion.apis.flask_utils.convert_path_parameter(match, types)
connexion.apis.flask_utils.flaskify_path(swagger_path, types=None)

Convert swagger path templates to flask path templates

Return type

str

>>> flaskify_path('/foo-bar/{my-param}')
'/foo-bar/<my_param>'
>>> flaskify_path('/foo/{someint}', {'someint': 'int'})
'/foo/<int:someint>'
connexion.apis.flask_utils.is_flask_response(obj: object) bool

Verifies if obj is a default Flask response instance.

>>> is_flask_response(redirect('http://example.com/'))
True
>>> is_flask_response(flask.Response())
True