A small, curated list of Uriel functions that might be useful to call from user-defined Python code.
See the Soju and Handlers sections for information on how to call these functions.
Uriel has dozens of other functions. See the well-commented Uriel source code for the full list.
log(s: str) -> None Log the given string to stderr.
escape(text: str) -> str Escape HTML. Accepts unescaped text. Returns an HTML escaped string.
encode_url_path(url_path: str) -> str URL encode a URL path. Accepts an unencoded URL path. The URL path is likely to include slashes, and slashes are not URL encoded. This is relatively permissive filtering that allows Unicode characters to pass through, but filters out ASCII special characters that are likely to cause problems in various ways. Returns a URL encoded URL path (with slashes preserved literally).
get_eligible_nodes(node: Node,
boolean_header: str,
default: bool,
node_set: Set[Node]) -> None
Get nodes that have the given header set to true.
Accepts a Node, the name of the header to check for true status,
and a node set to store the eligible nodes.
Accepts the following arguments:
node - root node to search
boolean_header - header name to check for boolean value
default - default boolean value to use if header not set
node_set - set the node will be added to if eligible
write_rss(project_root: str, root_node: Node) -> None Write RSS feed to disk (if RSS-URL is enabled). Accepts the project root, and the root Node.
write_sitemap(project_root: str, root_node: Node) -> None Write a single sitemap file to disk (if Sitemap-URL enabled). Accepts the project root, and the root Node.
Tags:
This page was generated by Uriel with the following settings:
Page Details
| Resource | Path | Project File |
|---|---|---|
| Node | uriel/functions | nodes/uriel/functions |
| Template | default.html | templates/default.html |
| URL | /uriel/functions/ | public/uriel/functions/index.html |
Node Headers
| Header (Lowercase) | Value |
|---|---|
| title | Functions |
| breadcrumb-separator | » |
| canonical-url | https://documentation.uriel.foo |
| rss-description | Uriel Documentation |
| rss-image-height | 32 |
| rss-image-url | /favicon-32x32.png |
| rss-image-width | 32 |
| rss-max-entries | 50 |
| rss-title | Uriel Documentation |
| rss-url | /rss.xml |
| sitemap-max-entries | 10000 |
| sitemap-url | /sitemap.xml |
| tag-node | tag |
| template | default.html |
Node Timestamps
| Type | Value |
|---|---|
| Created | |
| Modified | 2026-10-30T00:04:36-04:00 |
Node Methods
| Method | Value |
|---|---|
| get_parent_node() | uriel/index |
| get_path() | uriel/functions |
| get_node_type() | file |
| get_url() | /uriel/functions/ |
| get_canonical_url() | https://documentation.uriel.foo/uriel/functions/ |
| get_name() | functions |
| get_display_name() | Functions |
| get_title() | Functions |
| get_escaped_title() | Functions |
| get_link() | <a href="/uriel/functions/">Functions</a> |
| get_canonical_link() | <a href="https://documentation.uriel.foo/uriel/functions/">Functions</a> |
| get_link_prefix() | <p> |
| get_link_suffix() | </p> |
| get_tags() | [] |
| get_dest_dir() | ./public/uriel/functions |
| get_dest_file() | ./public/uriel/functions/index.html |
| get_breadcrumb_separator() | » |