Classes
RouteMeta
7
▼
Route metadata from ``_meta.py``.
All fields optional. Static META or meta() callable provides val…
RouteMeta
7
▼
Route metadata from_meta.py.
All fields optional. Static META or meta() callable provides values.
Attributes
| Name | Type | Description |
|---|---|---|
title |
str | None
|
— |
section |
str | None
|
— |
breadcrumb_label |
str | None
|
— |
shell_mode |
str | None
|
— |
auth |
str | None
|
— |
cache |
str | None
|
— |
tags |
tuple[str, ...]
|
— |
TabItem
2
▼
A tab item for section navigation.
TabItem
2
▼
A tab item for section navigation.
Attributes
| Name | Type | Description |
|---|---|---|
label |
str
|
— |
href |
str
|
— |
ActionInfo
2
▼
A named action from ``_actions.py``.
ActionInfo
2
▼
A named action from_actions.py.
Attributes
| Name | Type | Description |
|---|---|---|
name |
str
|
— |
func |
Callable[..., Any]
|
— |
Section
6
▼
A named section with tab items and breadcrumb prefix.
Section
6
▼
A named section with tab items and breadcrumb prefix.
Attributes
| Name | Type | Description |
|---|---|---|
id |
str
|
— |
label |
str
|
— |
tab_items |
tuple[TabItem, ...]
|
— |
breadcrumb_prefix |
tuple[dict[str, str], ...]
|
— |
active_prefixes |
tuple[str, ...]
|
— |
Methods
is_active
1
bool
▼
Return True if *path* matches any of this section's active prefixes.
is_active
1
bool
▼
def is_active(self, path: str) -> bool
Parameters
| Name | Type | Description |
|---|---|---|
path |
— |
Returns
bool
LayoutInfo
3
▼
A layout template discovered in the filesystem.
Each ``_layout.html`` declares a shell with a ``{%…
LayoutInfo
3
▼
A layout template discovered in the filesystem.
Each_layout.html declares a shell with a {% block content %}
slot and a{# target: element_id #}comment declaring which DOM
element it owns.
Attributes
| Name | Type | Description |
|---|---|---|
template_name |
str
|
Template name for kida (relative to pages root). |
target |
str
|
DOM element ID this layout renders into. |
depth |
int
|
Nesting depth (0 = root). |
LayoutChain
2
▼
Ordered sequence of layouts from root (outermost) to deepest.
The chain determines rendering depth…
LayoutChain
2
▼
Ordered sequence of layouts from root (outermost) to deepest.
The chain determines rendering depth based onHX-Target:
- Full page: render all layouts nested
HX-Target: #app-content: find the layout that ownsapp-content, render from the next layout down- Fragment: render just the targeted block
Attributes
| Name | Type | Description |
|---|---|---|
layouts |
tuple[LayoutInfo, ...]
|
— |
Methods
find_start_index_for_target
1
int | None
▼
Find the layout index to start rendering from for a given HX-Target.
Each layo…
find_start_index_for_target
1
int | None
▼
def find_start_index_for_target(self, htmx_target: str | None) -> int | None
Find the layout index to start rendering from for a given HX-Target.
Each layout declares{# target: element_id #}— the DOM
element it renders into. WhenHX-Targetmatches a
layout's target, we render from that layout onward (it
produces the content that fills the targeted element).
Returns the index of the matched layout, orNoneif the
target doesn't match any layout (treat as fragment).
Parameters
| Name | Type | Description |
|---|---|---|
htmx_target |
— |
Returns
int | None
ContextProvider
3
▼
A ``_context.py`` file's context function.
Each provider is an async or sync function that receive…
ContextProvider
3
▼
A_context.pyfile's context function.
Each provider is an async or sync function that receives path parameters and returns a dict of context variables.
Attributes
| Name | Type | Description |
|---|---|---|
module_path |
str
|
Filesystem path to the |
func |
Callable[..., dict[str, Any] | Awaitable[dict[str, Any]]]
|
The |
depth |
int
|
Nesting depth (0 = root). |
PageRoute
12
▼
A discovered page route with its layout chain and context providers.
Built during filesystem disco…
PageRoute
12
▼
A discovered page route with its layout chain and context providers.
Built during filesystem discovery. Used bymount_pages()to
register routes with the chirp app.
Attributes
| Name | Type | Description |
|---|---|---|
url_path |
str
|
URL pattern (e.g., |
handler |
Callable[..., Any]
|
The route handler callable. |
methods |
frozenset[str]
|
HTTP methods (e.g., |
layout_chain |
LayoutChain
|
The sequence of layouts wrapping this route. |
context_providers |
tuple[ContextProvider, ...]
|
Context functions to run, ordered root-first. |
template_name |
str | None
|
Template to render (for page routes with templates). |
name |
str | None
|
Optional route name. |
meta |
RouteMeta | None
|
— |
meta_provider |
MetaProvider | None
|
— |
actions |
tuple[ActionInfo, ...]
|
— |
viewmodel_provider |
Callable[..., Any] | None
|
— |
kind |
RouteKind
|
— |