Functions
register
Register advanced collection functions with Jinja2 environment.
register
def register(env: Environment, site: Site) -> None
Register advanced collection functions with Jinja2 environment.
Parameters 2
| Name | Type | Default | Description |
|---|---|---|---|
env |
Environment |
— | |
site |
Site |
— |
sample
Get random sample of items.
sample
def sample(items: list[Any], count: int = 1, seed: int | None = None) -> list[Any]
Get random sample of items.
Parameters 3
| Name | Type | Default | Description |
|---|---|---|---|
items |
list[Any] |
— | List to sample from |
count |
int |
1 |
Number of items to sample (default: 1) |
seed |
int | None |
None |
Random seed for reproducibility (optional) |
Returns
Random sample of itemslist[Any]
—
shuffle
Shuffle items randomly.
shuffle
def shuffle(items: list[Any], seed: int | None = None) -> list[Any]
Shuffle items randomly.
Parameters 2
| Name | Type | Default | Description |
|---|---|---|---|
items |
list[Any] |
— | List to shuffle |
seed |
int | None |
None |
Random seed for reproducibility (optional) |
Returns
Shuffled copy of listlist[Any]
—
chunk
Split list into chunks of specified size.
chunk
def chunk(items: list[Any], size: int) -> list[list[Any]]
Split list into chunks of specified size.
Parameters 2
| Name | Type | Default | Description |
|---|---|---|---|
items |
list[Any] |
— | List to chunk |
size |
int |
— | Chunk size |
Returns
List of chunkslist[list[Any]]
—