taipy/taipy/config/common/_config_blocker.py

# Copyright 2021-2024 Avaiga Private Limited
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
#        http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
# specific language governing permissions and limitations under the License.

import functools

from ...logger._taipy_logger import _TaipyLogger
from ..exceptions.exceptions import ConfigurationUpdateBlocked


class _ConfigBlocker:
    """Configuration blocker singleton."""

    __logger = _TaipyLogger._get_logger()
    __block_config_update = False

    @classmethod
    def _block(cls):
        if not cls.__block_config_update:
            cls.__logger.info("Blocking configuration update.")
            cls.__block_config_update = True

    @classmethod
    def _unblock(cls):
        if cls.__block_config_update:
            cls.__logger.info("Unblocking configuration update.")
            cls.__block_config_update = False

    @classmethod
    def _check(cls):
        def inner(f):
            @functools.wraps(f)
            def _check_if_is_blocking(*args, **kwargs):
                if cls.__block_config_update:
                    error_message = (
                        "The Core service should be stopped by running core.stop() before"
                        " modifying the Configuration. For more information, please refer to:"
                        " https://docs.taipy.io/en/latest/manuals/running_services/#running-core."
                    )
                    cls.__logger.error(f"ConfigurationUpdateBlocked: {error_message}")
                    raise ConfigurationUpdateBlocked(error_message)

                return f(*args, **kwargs)

            return _check_if_is_blocking

        return inner