Source code for flask_jsonrpc.conf.global_settings

# Copyright (c) 2025-2025, Cenobit Technologies, Inc. http://cenobit.es/
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice,
#    this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
#    this list of conditions and the following disclaimer in the documentation
#    and/or other materials provided with the distribution.
# * Neither the name of the Cenobit Technologies nor the names of
#    its contributors may be used to endorse or promote products derived from
#    this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
from __future__ import annotations

import typing as t

if t.TYPE_CHECKING:
    from flask import typing as ft
    from flask.wrappers import Request, Response

DEBUG = False
TESTING = False

_FLASK_JSONRPC_ENV_PREFIX = 'FLASK_JSONRPC_'




def IS_ENV_KEY(key: str) -> bool:
    return key.upper().startswith(_FLASK_JSONRPC_ENV_PREFIX)





def ENV_TO_CONFIG(key: str) -> str:
    return key.replace(_FLASK_JSONRPC_ENV_PREFIX, '').upper()





def CONFIG_TO_ENV(key: str) -> str:
    return f'{_FLASK_JSONRPC_ENV_PREFIX}{key.upper()}'



DEFAULT_JSONRPC_METHOD_VALIDATE = True
DEFAULT_JSONRPC_METHOD_NOTIFICATION = True

BROWSE_TITLE = 'Flask JSON-RPC'
BROWSE_TITLE_URL = 'https://github.com/cenobites/flask-jsonrpc'
BROWSE_SUBTITLE = 'Web browsable API'
BROWSE_DESCRIPTION = 'An interactive web browsable API for Flask JSON-RPC services'
BROWSE_FORK_ME_BUTTON_ENABLED = True
BROWSE_DASHBOARD_MENU_NAME = 'Dashboard'
BROWSE_DASHBOARD_PARTIAL_TEMPLATE = 'browse/partials/dashboard.html'
BROWSE_LOGIN_TEMPLATE: str | None = None
BROWSE_LOGOUT_TEMPLATE: str | None = None
BROWSE_MEDIA_CSS: dict[str, list[str]] = {}  # {media: [css_file, ...]}
BROWSE_MEDIA_JS: list[str] = []
BROWSE_MIDDLEWARE: list[
    tuple[
        str,
        t.Callable[
            [Request], t.Generator[ft.ResponseReturnValue | bool | None, Response, ft.ResponseReturnValue | None]
        ],
    ]
] = []