ayon-core/client/ayon_core/pipeline/tempdir.py

"""
Temporary folder operations
"""

import os
from ayon_core.lib import StringTemplate
from ayon_core.pipeline import Anatomy


def create_custom_tempdir(project_name, anatomy=None):
    """ Create custom tempdir

    Template path formatting is supporting:
    - optional key formatting
    - available keys:
        - root[work | <root name key>]
        - project[name | code]

    Args:
        project_name (str): project name
        anatomy (ayon_core.pipeline.Anatomy)[optional]: Anatomy object

    Returns:
        str | None: formatted path or None
    """
    env_tmpdir = os.getenv("AYON_TMPDIR")
    if not env_tmpdir:
        return

    custom_tempdir = None
    if "{" in env_tmpdir:
        if anatomy is None:
            anatomy = Anatomy(project_name)
        # create base formate data
        data = {
            "root": anatomy.roots,
            "project": {
                "name": anatomy.project_name,
                "code": anatomy.project_code,
            }
        }
        # path is anatomy template
        custom_tempdir = StringTemplate.format_template(
            env_tmpdir, data).normalized()

    else:
        # path is absolute
        custom_tempdir = env_tmpdir

    # create the dir path if it doesn't exists
    if not os.path.exists(custom_tempdir):
        try:
            # create it if it doesn't exists
            os.makedirs(custom_tempdir)
        except IOError as error:
            raise IOError(
                "Path couldn't be created: {}".format(error))

    return custom_tempdir