Source code for Karana._tab_completion

# Copyright (c) 2024-2026 Karana Dynamics Pty Ltd. All rights reserved.
#
# NOTICE TO USER:
#
# This source code and/or documentation (the "Licensed Materials") is
# the confidential and proprietary information of Karana Dynamics Inc.
# Use of these Licensed Materials is governed by the terms and conditions
# of a separate software license agreement between Karana Dynamics and the
# Licensee ("License Agreement"). Unless expressly permitted under that
# agreement, any reproduction, modification, distribution, or disclosure
# of the Licensed Materials, in whole or in part, to any third party
# without the prior written consent of Karana Dynamics is strictly prohibited.
#
# THE LICENSED MATERIALS ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND.
# KARANA DYNAMICS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
# BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT, AND
# FITNESS FOR A PARTICULAR PURPOSE.
#
# IN NO EVENT SHALL KARANA DYNAMICS BE LIABLE FOR ANY DAMAGES WHATSOEVER,
# INCLUDING BUT NOT LIMITED TO LOSS OF PROFITS, DATA, OR USE, EVEN IF
# ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, WHETHER IN CONTRACT, TORT,
# OR OTHERWISE ARISING OUT OF OR IN CONNECTION WITH THE LICENSED MATERIALS.
#
# U.S. Government End Users: The Licensed Materials are a "commercial item"
# as defined at 48 C.F.R. 2.101, and are provided to the U.S. Government
# only as a commercial end item under the terms of this license.
#
# Any use of the Licensed Materials in individual or commercial software must
# include, in the user documentation and internal source code comments,
# this Notice, Disclaimer, and U.S. Government Use Provision.


class _CustomTabCompletion(type):
    """Settings for CustomTabCompletion."""

    _custom_tab_completion: bool = False

    @property
    def enabled(cls):
        """Return whether custom tab completion is enabled.

        Returns
        -------
        bool:
            True if custom tab completion is enabled. False otherwise.
        """
        return cls._custom_tab_completion

    @enabled.setter
    def enabled(cls, enable: bool):
        """Set custom tab-completion.

        Parameters
        ----------
        enable : bool
            True to enable, False to disable.
        """
        from ._custom_tab_completion import install, uninstall

        if enable and not cls._custom_tab_completion:
            install()
            cls._custom_tab_completion = True
        if not enable and cls._custom_tab_completion:
            uninstall()
            cls._custom_tab_completion = False




class CustomTabCompletion(metaclass=_CustomTabCompletion):
    pass



__all__ = ["CustomTabCompletion"]