Source code for runway.config.models.utils

"""Runway & CFNgin config model utilities."""

from __future__ import annotations

import re
from typing import TYPE_CHECKING, Any

if TYPE_CHECKING:
    from pathlib import Path

CFNGIN_LOOKUP_STRING_REGEX = r"^\$\{.+\}$"
RUNWAY_LOOKUP_STRING_ERROR = ValueError("field can only be a string if it's a lookup")
RUNWAY_LOOKUP_STRING_REGEX = r"^\$\{.+\}$"



[docs]
def convert_null_values(v: Any) -> Any:
    """Convert a "null" string into type(None)."""
    null_strings = ["null", "none", "undefined"]
    return None if isinstance(v, str) and v.lower() in null_strings else v




[docs]
def resolve_path_field(v: Path | None) -> Path | None:
    """Resolve sys_path."""
    return v.resolve() if v else v




[docs]
def validate_string_is_lookup(v: Any) -> Any:
    """Validate value against regex if it's a string to ensure its a lookup."""
    if isinstance(v, str) and not re.match(RUNWAY_LOOKUP_STRING_REGEX, v):
        raise RUNWAY_LOOKUP_STRING_ERROR
    return v