qunicorn_core.api.flask_api_utils module

Module containing utilities for flask smorest APIs.

class qunicorn_core.api.flask_api_utils.MaBaseSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: Schema

Base schema that automatically changes python snake case to camelCase in json.

on_bind_field(field_name: str, field_obj: Field)

Hook to modify a field when it is bound to the Schema.

No-op by default.

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class qunicorn_core.api.flask_api_utils.SecurityBlueprint(*args: Any, **kwargs)

Bases: Blueprint, JWTMixin

Blueprint that is aware of jwt tokens and how to document them.

Use this Blueprint if you want to document security requirements for your api.

qunicorn_core.api.flask_api_utils.camelcase(s: str) → str

Turn a string from python snake_case into camelCase.