74 lines
1.9 KiB
Python
74 lines
1.9 KiB
Python
"""
|
|
util.py - miscellaneous utility functions
|
|
"""
|
|
from contextlib import contextmanager
|
|
import json
|
|
import os
|
|
from pathlib import Path
|
|
import shutil
|
|
import sys
|
|
from typing import Any, Callable, Dict, NoReturn
|
|
|
|
|
|
TZK_VERSION = "0.3.0"
|
|
|
|
|
|
class BuildError(Exception):
|
|
pass
|
|
|
|
|
|
def alter_tiddlywiki_info(
|
|
info_path: Path,
|
|
edit_func: Callable[[Dict[str, Any]], Dict[str, Any]]) -> None:
|
|
"Change a tiddlywiki.info (or other json file) in an arbitrary manner."
|
|
with info_path.open("r") as f:
|
|
tinfo = json.load(f)
|
|
tinfo = edit_func(tinfo)
|
|
with info_path.open("w") as f:
|
|
json.dump(tinfo, f, indent=2)
|
|
|
|
|
|
def fail(msg: str, exit_code: int = 1) -> NoReturn:
|
|
"Print message to stderr and quit with exit code 1."
|
|
print(msg, file=sys.stderr)
|
|
sys.exit(exit_code)
|
|
|
|
|
|
def numerize(number: int, singular: str, plural: str = None) -> str:
|
|
"Render a string in the singular or plural as appropriate."
|
|
if plural is None:
|
|
plural = singular + 's'
|
|
|
|
if number == 1:
|
|
return singular
|
|
else:
|
|
return plural
|
|
|
|
|
|
@contextmanager
|
|
def pushd(directory: str):
|
|
"""
|
|
Change directory into the directory /directory/ until the end of the with-block,
|
|
then return to previous directory.
|
|
"""
|
|
old_directory = os.getcwd()
|
|
try:
|
|
os.chdir(directory)
|
|
yield
|
|
finally:
|
|
os.chdir(old_directory)
|
|
|
|
def require_dependencies() -> None:
|
|
"""
|
|
Raise an exception if dependencies of tzk aren't available.
|
|
"""
|
|
if shutil.which("npm") is None:
|
|
fail("npm is not available. "
|
|
"Please install NPM and make it available on your PATH.\n"
|
|
"https://docs.npmjs.com/downloading-and-installing-node-js-and-npm")
|
|
|
|
if shutil.which("git") is None:
|
|
fail("Git is not available. "
|
|
"Please install Git and make it available on your PATH.\n"
|
|
"https://git-scm.com/book/en/v2/Getting-Started-Installing-Git")
|