"""
cookiecutter.replay.
-------------------
"""
import json
import os
from cookiecutter.utils import make_sure_path_exists
[docs]
def get_file_name(replay_dir, template_name):
"""Get the name of file."""
suffix = '.json' if not template_name.endswith('.json') else ''
file_name = f'{template_name}{suffix}'
return os.path.join(replay_dir, file_name)
[docs]
def dump(replay_dir: "os.PathLike[str]", template_name: str, context: dict):
"""Write json data to file."""
make_sure_path_exists(replay_dir)
if not isinstance(template_name, str):
raise TypeError('Template name is required to be of type str')
if not isinstance(context, dict):
raise TypeError('Context is required to be of type dict')
if 'cookiecutter' not in context:
raise ValueError('Context is required to contain a cookiecutter key')
replay_file = get_file_name(replay_dir, template_name)
with open(replay_file, 'w', encoding="utf-8") as outfile:
json.dump(context, outfile, indent=2)
[docs]
def load(replay_dir, template_name):
"""Read json data from file."""
if not isinstance(template_name, str):
raise TypeError('Template name is required to be of type str')
replay_file = get_file_name(replay_dir, template_name)
with open(replay_file, encoding="utf-8") as infile:
context = json.load(infile)
if 'cookiecutter' not in context:
raise ValueError('Context is required to contain a cookiecutter key')
return context