hyfi.core

GlobalHyFIResolver

Source code in hyfi/core/core.py

class GlobalHyFIResolver:
    @staticmethod
    def __hyfi_version__() -> str:
        """
        Returns the version of HyFI.

        Returns:
            string containing the version of HyFI
        """
        from hyfi._version import __version__

        return __version__

    def __hyfi_path__() -> str:
        """Returns the path to the HyFI root folder"""
        return __global_hyfi__.hyfi_package_path

    @staticmethod
    def __home_path__() -> str:
        """Returns the path to the user's home folder"""
        return Path.home().as_posix()

    @staticmethod
    def __app_version__() -> str:
        """
        Returns the version of App.

        Returns:
            string containing the version of App
        """

        return __global_hyfi__.version

    @staticmethod
    def __package_name__() -> str:
        """
        Returns the package name of the App

        Returns:
            string containing the package name of the App
        """

        return __global_hyfi__.package_name

    @staticmethod
    def __package_path__() -> str:
        """
        Returns the path to the App root folder

        Returns:
            string containing the path to the App root folder
        """

        return __global_hyfi__.package_path

    @staticmethod
    def __config_module_path__() -> str:
        """Global HyFI config path for the package to search for."""
        return __global_hyfi__.config_module_path

    @staticmethod
    def __user_config_path__() -> str:
        """Global HyFI user config path for the package to search for."""
        return __global_hyfi__.user_config_path

__app_version__() staticmethod

Returns the version of App.

Returns:

Type	Description
str	string containing the version of App

Source code in hyfi/core/core.py

@staticmethod
def __app_version__() -> str:
    """
    Returns the version of App.

    Returns:
        string containing the version of App
    """

    return __global_hyfi__.version

__config_module_path__() staticmethod

Global HyFI config path for the package to search for.

Source code in hyfi/core/core.py

@staticmethod
def __config_module_path__() -> str:
    """Global HyFI config path for the package to search for."""
    return __global_hyfi__.config_module_path

__home_path__() staticmethod

Returns the path to the user's home folder

Source code in hyfi/core/core.py

@staticmethod
def __home_path__() -> str:
    """Returns the path to the user's home folder"""
    return Path.home().as_posix()

__hyfi_path__()

Returns the path to the HyFI root folder

Source code in hyfi/core/core.py

def __hyfi_path__() -> str:
    """Returns the path to the HyFI root folder"""
    return __global_hyfi__.hyfi_package_path

__hyfi_version__() staticmethod

Returns the version of HyFI.

Returns:

Type	Description
str	string containing the version of HyFI

Source code in hyfi/core/core.py

@staticmethod
def __hyfi_version__() -> str:
    """
    Returns the version of HyFI.

    Returns:
        string containing the version of HyFI
    """
    from hyfi._version import __version__

    return __version__

__package_name__() staticmethod

Returns the package name of the App

Returns:

Type	Description
str	string containing the package name of the App

Source code in hyfi/core/core.py

@staticmethod
def __package_name__() -> str:
    """
    Returns the package name of the App

    Returns:
        string containing the package name of the App
    """

    return __global_hyfi__.package_name

__package_path__() staticmethod

Returns the path to the App root folder

Returns:

Type	Description
str	string containing the path to the App root folder

Source code in hyfi/core/core.py

@staticmethod
def __package_path__() -> str:
    """
    Returns the path to the App root folder

    Returns:
        string containing the path to the App root folder
    """

    return __global_hyfi__.package_path

__user_config_path__() staticmethod

Global HyFI user config path for the package to search for.

Source code in hyfi/core/core.py

@staticmethod
def __user_config_path__() -> str:
    """Global HyFI user config path for the package to search for."""
    return __global_hyfi__.user_config_path