Source code for WallGo.PotentialTools.utils

"""Utility functions"""
import importlib.resources




def getSafePathToResource(relativePathToResource: str) -> str:
    r""" Gives a safe path to a packaged resource. The input is a relative path
    from PotentialTools package directory (ie. where `__init__.py` is located).
    Use this function to convert the relative path to a path that is safe to
    use in packaged context.
    Example relative path: `/Data/Something/example.txt`.
    
    Returns
    -------
    Path to the resource file: str.
    """

    # fallback to "PotentialTools" if the package call fails for some reason
    packageName = __package__ or "PotentialTools"

    return importlib.resources.files(packageName) / relativePathToResource