Source code for cookiecutter.find

"""Functions for finding Cookiecutter templates and other components."""

import logging
import os
from pathlib import Path

from jinja2 import Environment

from cookiecutter.exceptions import NonTemplatedInputDirException

logger = logging.getLogger(__name__)

[docs] def find_template(repo_dir: "os.PathLike[str]", env: Environment) -> Path: """Determine which child directory of ``repo_dir`` is the project template. :param repo_dir: Local directory of newly cloned repo. :return: Relative path to project template. """ logger.debug('Searching %s for the project template.', repo_dir) for str_path in os.listdir(repo_dir): if ( 'cookiecutter' in str_path and env.variable_start_string in str_path and env.variable_end_string in str_path ): project_template = Path(repo_dir, str_path) break else: raise NonTemplatedInputDirException logger.debug('The project template appears to be %s', project_template) return project_template