Function path_template

src/openai/_utils/_path.py:78–127

Interpolate {name} placeholders in `template` from keyword arguments. Args: template: The template string containing {name} placeholders. **kwargs: Keyword arguments to interpolate into the template. Returns: The template with placeholders interpolated and percent-e

(template: str, /, **kwargs: Any)

def path_template(template: str, /, **kwargs: Any) -> str:
    class="st">"""Interpolate {name} placeholders in `template` from keyword arguments.

    Args:
        template: The template string containing {name} placeholders.
        **kwargs: Keyword arguments to interpolate into the template.

    Returns:
        The template with placeholders interpolated and percent-encoded.

        Safe characters for percent-encoding are dependent on the URI component.
        Placeholders in path and fragment portions are percent-encoded where the `segment`
        and `fragment` sets from RFC 3986 respectively are considered safe.
        Placeholders in the query portion are percent-encoded where the `query` set from
        RFC 3986 §3.3 is considered safe except for = and & characters.

    Raises:
        KeyError: If a placeholder is not found in `kwargs`.
        ValueError: If resulting path contains /./ or /../ segments (including percent-encoded dot-segments).
    class="st">"""
    class="cm"># Split the template into path, query, and fragment portions.
    fragment_template: str | None = None
    query_template: str | None = None

    rest = template
    if class="st">"class="cm">#" in rest:
        rest, fragment_template = rest.split(class="st">"class="cm">#", 1)
    if class="st">"?" in rest:
        rest, query_template = rest.split(class="st">"?", 1)
    path_template = rest

    class="cm"># Interpolate each portion with the appropriate quoting rules.
    path_result = _interpolate(path_template, kwargs, _quote_path_segment_part)

    class="cm"># Reject dot-segments (. and ..) in the final assembled path.  The check
    class="cm"># runs after interpolation so that adjacent placeholders or a mix of static
    class="cm"># text and placeholders that together form a dot-segment are caught.
    class="cm"># Also reject percent-encoded dot-segments to protect against incorrectly
    class="cm"># implemented normalization in servers/proxies.
    for segment in path_result.split(class="st">"/"):
        if _DOT_SEGMENT_RE.match(segment):
            raise ValueError(fclass="st">"Constructed path {path_result!r} contains dot-segment {segment!r} which is not allowed")

    result = path_result
    if query_template is not None:
        result += class="st">"?" + _interpolate(query_template, kwargs, _quote_query_part)
    if fragment_template is not None:
        result += class="st">"class="cm">#" + _interpolate(fragment_template, kwargs, _quote_fragment_part)

    return result