Functions

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.

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 sitemap file to disk (if Sitemap-URL enabled).

Accepts the project root, and the root Node.

Tags: