# {py:mod}`django_bird.components`

```{py:module} django_bird.components
```

```{autodoc2-docstring} django_bird.components
:parser: myst
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`Component <django_bird.components.Component>`
  - ```{autodoc2-docstring} django_bird.components.Component
    :parser: myst
    :summary:
    ```
* - {py:obj}`SequenceGenerator <django_bird.components.SequenceGenerator>`
  - ```{autodoc2-docstring} django_bird.components.SequenceGenerator
    :parser: myst
    :summary:
    ```
* - {py:obj}`BoundComponent <django_bird.components.BoundComponent>`
  - ```{autodoc2-docstring} django_bird.components.BoundComponent
    :parser: myst
    :summary:
    ```
* - {py:obj}`ComponentRegistry <django_bird.components.ComponentRegistry>`
  - ```{autodoc2-docstring} django_bird.components.ComponentRegistry
    :parser: myst
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`components <django_bird.components.components>`
  - ```{autodoc2-docstring} django_bird.components.components
    :parser: myst
    :summary:
    ```
````

### API

`````{py:class} Component
:canonical: django_bird.components.Component

```{autodoc2-docstring} django_bird.components.Component
:parser: myst
```

````{py:attribute} name
:canonical: django_bird.components.Component.name
:type: str
:value: >
   None

```{autodoc2-docstring} django_bird.components.Component.name
:parser: myst
```

````

````{py:attribute} template
:canonical: django_bird.components.Component.template
:type: django.template.backends.django.Template
:value: >
   None

```{autodoc2-docstring} django_bird.components.Component.template
:parser: myst
```

````

````{py:attribute} assets
:canonical: django_bird.components.Component.assets
:type: frozenset[django_bird.staticfiles.Asset]
:value: >
   'field(...)'

```{autodoc2-docstring} django_bird.components.Component.assets
:parser: myst
```

````

````{py:method} get_asset(asset_filename: str) -> django_bird.staticfiles.Asset | None
:canonical: django_bird.components.Component.get_asset

```{autodoc2-docstring} django_bird.components.Component.get_asset
:parser: myst
```

````

````{py:method} get_bound_component(node: django_bird.templatetags.tags.bird.BirdNode)
:canonical: django_bird.components.Component.get_bound_component

```{autodoc2-docstring} django_bird.components.Component.get_bound_component
:parser: myst
```

````

````{py:property} data_attribute_name
:canonical: django_bird.components.Component.data_attribute_name

```{autodoc2-docstring} django_bird.components.Component.data_attribute_name
:parser: myst
```

````

````{py:property} id
:canonical: django_bird.components.Component.id

```{autodoc2-docstring} django_bird.components.Component.id
:parser: myst
```

````

````{py:property} nodelist
:canonical: django_bird.components.Component.nodelist

```{autodoc2-docstring} django_bird.components.Component.nodelist
:parser: myst
```

````

````{py:property} path
:canonical: django_bird.components.Component.path

```{autodoc2-docstring} django_bird.components.Component.path
:parser: myst
```

````

````{py:property} source
:canonical: django_bird.components.Component.source

```{autodoc2-docstring} django_bird.components.Component.source
:parser: myst
```

````

````{py:method} from_abs_path(path: pathlib.Path) -> django_bird.components.Component
:canonical: django_bird.components.Component.from_abs_path
:classmethod:

```{autodoc2-docstring} django_bird.components.Component.from_abs_path
:parser: myst
```

````

````{py:method} from_name(name: str) -> django_bird.components.Component
:canonical: django_bird.components.Component.from_name
:classmethod:

```{autodoc2-docstring} django_bird.components.Component.from_name
:parser: myst
```

````

````{py:method} from_template(template: django.template.backends.django.Template) -> django_bird.components.Component
:canonical: django_bird.components.Component.from_template
:classmethod:

```{autodoc2-docstring} django_bird.components.Component.from_template
:parser: myst
```

````

`````

`````{py:class} SequenceGenerator()
:canonical: django_bird.components.SequenceGenerator

```{autodoc2-docstring} django_bird.components.SequenceGenerator
:parser: myst
```

```{rubric} Initialization
```

```{autodoc2-docstring} django_bird.components.SequenceGenerator.__init__
:parser: myst
```

````{py:attribute} _instance
:canonical: django_bird.components.SequenceGenerator._instance
:type: django_bird.components.SequenceGenerator | None
:value: >
   None

```{autodoc2-docstring} django_bird.components.SequenceGenerator._instance
:parser: myst
```

````

````{py:attribute} _lock
:canonical: django_bird.components.SequenceGenerator._lock
:type: threading.Lock
:value: >
   'Lock(...)'

```{autodoc2-docstring} django_bird.components.SequenceGenerator._lock
:parser: myst
```

````

````{py:attribute} _counters
:canonical: django_bird.components.SequenceGenerator._counters
:type: dict[str, int]
:value: >
   None

```{autodoc2-docstring} django_bird.components.SequenceGenerator._counters
:parser: myst
```

````

````{py:method} __new__() -> django_bird.components.SequenceGenerator
:canonical: django_bird.components.SequenceGenerator.__new__

```{autodoc2-docstring} django_bird.components.SequenceGenerator.__new__
:parser: myst
```

````

````{py:method} next(component: django_bird.components.Component) -> int
:canonical: django_bird.components.SequenceGenerator.next

```{autodoc2-docstring} django_bird.components.SequenceGenerator.next
:parser: myst
```

````

`````

`````{py:class} BoundComponent
:canonical: django_bird.components.BoundComponent

```{autodoc2-docstring} django_bird.components.BoundComponent
:parser: myst
```

````{py:attribute} component
:canonical: django_bird.components.BoundComponent.component
:type: django_bird.components.Component
:value: >
   None

```{autodoc2-docstring} django_bird.components.BoundComponent.component
:parser: myst
```

````

````{py:attribute} params
:canonical: django_bird.components.BoundComponent.params
:type: django_bird.params.Params
:value: >
   None

```{autodoc2-docstring} django_bird.components.BoundComponent.params
:parser: myst
```

````

````{py:attribute} nodelist
:canonical: django_bird.components.BoundComponent.nodelist
:type: django.template.base.NodeList | None
:value: >
   None

```{autodoc2-docstring} django_bird.components.BoundComponent.nodelist
:parser: myst
```

````

````{py:attribute} _sequence
:canonical: django_bird.components.BoundComponent._sequence
:type: django_bird.components.SequenceGenerator
:value: >
   'field(...)'

```{autodoc2-docstring} django_bird.components.BoundComponent._sequence
:parser: myst
```

````

````{py:method} render(context: django.template.context.Context, resolution_context: django.template.context.Context | None = None)
:canonical: django_bird.components.BoundComponent.render

```{autodoc2-docstring} django_bird.components.BoundComponent.render
:parser: myst
```

````

````{py:method} fill_slots(context: django.template.context.Context)
:canonical: django_bird.components.BoundComponent.fill_slots

```{autodoc2-docstring} django_bird.components.BoundComponent.fill_slots
:parser: myst
```

````

````{py:property} id
:canonical: django_bird.components.BoundComponent.id

```{autodoc2-docstring} django_bird.components.BoundComponent.id
:parser: myst
```

````

`````

`````{py:class} ComponentRegistry()
:canonical: django_bird.components.ComponentRegistry

```{autodoc2-docstring} django_bird.components.ComponentRegistry
:parser: myst
```

```{rubric} Initialization
```

```{autodoc2-docstring} django_bird.components.ComponentRegistry.__init__
:parser: myst
```

````{py:method} reset() -> None
:canonical: django_bird.components.ComponentRegistry.reset

```{autodoc2-docstring} django_bird.components.ComponentRegistry.reset
:parser: myst
```

````

````{py:method} get_assets(asset_type: django_bird.staticfiles.AssetType | None = None) -> frozenset[django_bird.staticfiles.Asset]
:canonical: django_bird.components.ComponentRegistry.get_assets

```{autodoc2-docstring} django_bird.components.ComponentRegistry.get_assets
:parser: myst
```

````

````{py:method} get_component(name: str) -> django_bird.components.Component
:canonical: django_bird.components.ComponentRegistry.get_component

```{autodoc2-docstring} django_bird.components.ComponentRegistry.get_component
:parser: myst
```

````

````{py:method} get_component_names_used_in_template(template_path: str | pathlib.Path) -> set[str]
:canonical: django_bird.components.ComponentRegistry.get_component_names_used_in_template

```{autodoc2-docstring} django_bird.components.ComponentRegistry.get_component_names_used_in_template
:parser: myst
```

````

````{py:method} get_component_usage(template_path: str | pathlib.Path) -> collections.abc.Generator[django_bird.components.Component, typing.Any, None]
:canonical: django_bird.components.ComponentRegistry.get_component_usage

```{autodoc2-docstring} django_bird.components.ComponentRegistry.get_component_usage
:parser: myst
```

````

`````

````{py:data} components
:canonical: django_bird.components.components
:value: >
   'ComponentRegistry(...)'

```{autodoc2-docstring} django_bird.components.components
:parser: myst
```

````