URI Template (std-uritemplate)

2.0.8 · active · verified Thu Apr 09

std-uritemplate is a Python library providing a robust and compliant implementation of RFC 6570, the URI Template specification. It allows users to expand URI templates with provided variables, generating complete URIs. The library is actively maintained, with frequent patch releases within major versions, and is currently at version 2.0.8.

Warnings

breaking Version 2.0.0 introduced a significant API change. The `URITemplate` class is now the primary entry point for working with URI templates, replacing the direct `uritemplate.expand` and `uritemplate.partial_expand` functions.
Fix: Migrate existing code to use `URITemplate(template_str).expand(**variables)` instead of `uritemplate.expand(template_str, **variables)`.
deprecated The standalone functions `uritemplate.expand()` and `uritemplate.partial_expand()` have been deprecated in favor of the methods on the `URITemplate` class.
Fix: Instantiate `URITemplate` and call its `expand()` or `partial_expand()` methods. Example: `URITemplate(template).expand(var=value)`.
gotcha The library strictly adheres to RFC 6570. Misunderstandings of the RFC's nuances regarding variable modifiers (e.g., `+`, `#`, `.`, `/`, `;`, `?`, `&`) or how different variable types (simple, lists, dictionaries) are expanded can lead to unexpected URI outputs.
Fix: Consult RFC 6570 for specific behavior of operators and variable types, and test template expansions thoroughly, especially with complex data structures.
gotcha The package name for installation is `std-uritemplate`, but the Python module to import is `uritemplate`. This is a common source of `ModuleNotFoundError`.
Fix: Ensure you use `import uritemplate` or `from uritemplate import ...` after `pip install std-uritemplate`.

Install

pip install std-uritemplate Install latest version

Imports

URITemplate
```
from uritemplate import URITemplate
```
The PyPI package is `std-uritemplate`, but the actual Python module name for import is `uritemplate`.

Quickstart

Initialize a URITemplate object with your template string. Use the `expand` method to fill in variables and generate the final URI. `partial_expand` can be used to expand a subset of variables, returning a new `URITemplate` object with the remaining unexpanded variables.

from uritemplate import URITemplate

template_str = "https://example.com/api/{resource}{?id,name}"
tpl = URITemplate(template_str)

# Expand with simple variables
expanded_uri = tpl.expand(resource="users", id=123, name="Alice")
print(f"Expanded URI: {expanded_uri}")

# Partial expansion
partially_expanded_tpl = tpl.partial_expand(resource="posts")
print(f"Partially Expanded URI (with resource): {partially_expanded_tpl.template}")

# Final expansion of partially expanded template
final_uri = partially_expanded_tpl.expand(id=456)
print(f"Final URI: {final_uri}")

view raw JSON →