.. include:: /include/substitutions.txt
.. include:: /include/external_links.txt
.. include:: /include/custom_roles.txt
.. _paths:

*****
Paths
*****

The following are the different path-related functions in ``sublime.py`` (as of
build 4200):

.. code-block:: py

    def executable_path() -> str:
        """
        .. since:: 4081
            This may be called at import time.

        :returns: The path to the main Sublime |nbsp| Text executable.
        """
        return sublime_api.executable_path()


    def executable_hash() -> tuple[str, str, str]:
        """
        .. since:: 4081
            This may be called at import time.

        :returns: A tuple uniquely identifying the installation of Sublime |nbsp| Text.
        """
        import hashlib
        return (
            version(), platform() + '_' + arch(),
            hashlib.md5(open(executable_path(), 'rb').read()).hexdigest())


    def packages_path() -> str:
        """
        .. since:: 4081
            This may be called at import time.

        :returns: The path to the "Packages" folder.
        """
        return sublime_api.packages_path()


    def installed_packages_path() -> str:
        """
        .. since:: 4081
            This may be called at import time.

        :returns: The path to the "Installed Packages" folder.
        """
        return sublime_api.installed_packages_path()


    def cache_path() -> str:
        """
        .. since:: 4081
            This may be called at import time.

        :returns: The path where Sublime |nbsp| Text stores cache files.
        """
        return sublime_api.cache_path()