`django_bird.components`¶

Module Contents¶

Classes¶

`Component`
`SequenceGenerator`
`BoundComponent`
`ComponentRegistry`

Data¶

API¶

class django_bird.components.Component¶

name: str¶: None

template: django.template.backends.django.Template¶: None

assets: frozenset[django_bird.staticfiles.Asset]¶: ‘field(…)’

get_asset(asset_filename: str) → django_bird.staticfiles.Asset | None¶

get_bound_component(node: django_bird.templatetags.tags.bird.BirdNode)¶

property data_attribute_name¶

property id¶

property nodelist¶

property path¶

property source¶

classmethod from_abs_path(path: pathlib.Path) → django_bird.components.Component¶

classmethod from_name(name: str) → django_bird.components.Component¶

classmethod from_template(template: django.template.backends.django.Template) → django_bird.components.Component¶

class django_bird.components.SequenceGenerator¶

Initialization

_instance: django_bird.components.SequenceGenerator | None¶: None

_lock: threading.Lock¶: ‘Lock(…)’

_counters: dict[str, int]¶: None

__new__() → django_bird.components.SequenceGenerator¶

next(component: django_bird.components.Component) → int¶

class django_bird.components.BoundComponent¶

component: django_bird.components.Component¶: None

params: django_bird.params.Params¶: None

nodelist: django.template.base.NodeList | None¶: None

_sequence: django_bird.components.SequenceGenerator¶: ‘field(…)’

render(context: django.template.context.Context, resolution_context: django.template.context.Context | None = None)¶

fill_slots(context: django.template.context.Context)¶

property id¶

class django_bird.components.ComponentRegistry¶

Initialization

reset() → None¶: Reset the registry, used for testing.

get_assets(asset_type: django_bird.staticfiles.AssetType | None = None) → frozenset[django_bird.staticfiles.Asset]¶

get_component(name: str) → django_bird.components.Component¶

get_component_names_used_in_template(template_path: str | pathlib.Path) → set[str]¶: Get names of components used in a template.

get_component_usage(template_path: str | pathlib.Path) → collections.abc.Generator[django_bird.components.Component, Any, None]¶: Get components used in a template.

django_bird.components.components¶: ‘ComponentRegistry(…)’