# {py:mod}`django_bird.templates` ```{py:module} django_bird.templates ``` ```{autodoc2-docstring} django_bird.templates :parser: myst :allowtitles: ``` ## Module Contents ### Classes ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`NodeVisitor ` - ```{autodoc2-docstring} django_bird.templates.NodeVisitor :parser: myst :summary: ``` ```` ### Functions ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`get_template_names ` - ```{autodoc2-docstring} django_bird.templates.get_template_names :parser: myst :summary: ``` * - {py:obj}`get_default_engine_directories ` - ```{autodoc2-docstring} django_bird.templates.get_default_engine_directories :parser: myst :summary: ``` * - {py:obj}`get_app_template_directories ` - ```{autodoc2-docstring} django_bird.templates.get_app_template_directories :parser: myst :summary: ``` * - {py:obj}`get_template_directories ` - ```{autodoc2-docstring} django_bird.templates.get_template_directories :parser: myst :summary: ``` * - {py:obj}`get_component_directory_names ` - ```{autodoc2-docstring} django_bird.templates.get_component_directory_names :parser: myst :summary: ``` * - {py:obj}`get_component_directories ` - ```{autodoc2-docstring} django_bird.templates.get_component_directories :parser: myst :summary: ``` * - {py:obj}`gather_bird_tag_template_usage ` - ```{autodoc2-docstring} django_bird.templates.gather_bird_tag_template_usage :parser: myst :summary: ``` * - {py:obj}`_process_template_chunk ` - ```{autodoc2-docstring} django_bird.templates._process_template_chunk :parser: myst :summary: ``` * - {py:obj}`find_components_in_template ` - ```{autodoc2-docstring} django_bird.templates.find_components_in_template :parser: myst :summary: ``` * - {py:obj}`has_nodelist ` - ```{autodoc2-docstring} django_bird.templates.has_nodelist :parser: myst :summary: ``` ```` ### Data ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`logger ` - ```{autodoc2-docstring} django_bird.templates.logger :parser: myst :summary: ``` * - {py:obj}`NodeVisitorMethod ` - ```{autodoc2-docstring} django_bird.templates.NodeVisitorMethod :parser: myst :summary: ``` ```` ### API ````{py:data} logger :canonical: django_bird.templates.logger :value: > 'getLogger(...)' ```{autodoc2-docstring} django_bird.templates.logger :parser: myst ``` ```` ````{py:function} get_template_names(name: str) -> list[str] :canonical: django_bird.templates.get_template_names ```{autodoc2-docstring} django_bird.templates.get_template_names :parser: myst ``` ```` ````{py:function} get_default_engine_directories() -> list[pathlib.Path] :canonical: django_bird.templates.get_default_engine_directories ```{autodoc2-docstring} django_bird.templates.get_default_engine_directories :parser: myst ``` ```` ````{py:function} get_app_template_directories() -> list[pathlib.Path] :canonical: django_bird.templates.get_app_template_directories ```{autodoc2-docstring} django_bird.templates.get_app_template_directories :parser: myst ``` ```` ````{py:function} get_template_directories() -> collections.abc.Generator[pathlib.Path, typing.Any, None] :canonical: django_bird.templates.get_template_directories ```{autodoc2-docstring} django_bird.templates.get_template_directories :parser: myst ``` ```` ````{py:function} get_component_directory_names() -> list[pathlib.Path | str] :canonical: django_bird.templates.get_component_directory_names ```{autodoc2-docstring} django_bird.templates.get_component_directory_names :parser: myst ``` ```` ````{py:function} get_component_directories(template_dirs: collections.abc.Iterator[pathlib.Path] | None = None) -> list[pathlib.Path] :canonical: django_bird.templates.get_component_directories ```{autodoc2-docstring} django_bird.templates.get_component_directories :parser: myst ``` ```` ````{py:function} gather_bird_tag_template_usage() -> collections.abc.Generator[tuple[pathlib.Path, set[str]], typing.Any, None] :canonical: django_bird.templates.gather_bird_tag_template_usage ```{autodoc2-docstring} django_bird.templates.gather_bird_tag_template_usage :parser: myst ``` ```` ````{py:function} _process_template_chunk(templates: list[tuple[pathlib.Path, pathlib.Path]]) -> list[tuple[pathlib.Path, set[str]]] :canonical: django_bird.templates._process_template_chunk ```{autodoc2-docstring} django_bird.templates._process_template_chunk :parser: myst ``` ```` ````{py:function} find_components_in_template(template_path: str | pathlib.Path) -> set[str] :canonical: django_bird.templates.find_components_in_template ```{autodoc2-docstring} django_bird.templates.find_components_in_template :parser: myst ``` ```` ````{py:data} NodeVisitorMethod :canonical: django_bird.templates.NodeVisitorMethod :value: > None ```{autodoc2-docstring} django_bird.templates.NodeVisitorMethod :parser: myst ``` ```` ````{py:function} has_nodelist(node: django.template.base.Template | django.template.base.Node) -> typing.TypeGuard[django.template.base.Template] :canonical: django_bird.templates.has_nodelist ```{autodoc2-docstring} django_bird.templates.has_nodelist :parser: myst ``` ```` `````{py:class} NodeVisitor(engine: django.template.engine.Engine) :canonical: django_bird.templates.NodeVisitor ```{autodoc2-docstring} django_bird.templates.NodeVisitor :parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} django_bird.templates.NodeVisitor.__init__ :parser: myst ``` ````{py:method} visit(node: django.template.base.Template | django.template.base.Node, context: django.template.context.Context) -> None :canonical: django_bird.templates.NodeVisitor.visit ```{autodoc2-docstring} django_bird.templates.NodeVisitor.visit :parser: myst ``` ```` ````{py:method} generic_visit(node: django.template.base.Template | django.template.base.Node, context: django.template.context.Context) -> None :canonical: django_bird.templates.NodeVisitor.generic_visit ```{autodoc2-docstring} django_bird.templates.NodeVisitor.generic_visit :parser: myst ``` ```` ````{py:method} visit_BirdNode(node: django_bird.templatetags.tags.bird.BirdNode, context: django.template.context.Context) -> None :canonical: django_bird.templates.NodeVisitor.visit_BirdNode ```{autodoc2-docstring} django_bird.templates.NodeVisitor.visit_BirdNode :parser: myst ``` ```` ````{py:method} visit_ExtendsNode(node: django.template.loader_tags.ExtendsNode, context: django.template.context.Context) -> None :canonical: django_bird.templates.NodeVisitor.visit_ExtendsNode ```{autodoc2-docstring} django_bird.templates.NodeVisitor.visit_ExtendsNode :parser: myst ``` ```` ````{py:method} visit_IncludeNode(node: django.template.loader_tags.IncludeNode, context: django.template.context.Context) -> None :canonical: django_bird.templates.NodeVisitor.visit_IncludeNode ```{autodoc2-docstring} django_bird.templates.NodeVisitor.visit_IncludeNode :parser: myst ``` ```` ````{py:method} visit_LoadNode(node: django_bird.templatetags.tags.load.LoadNode, context: django.template.context.Context) -> None :canonical: django_bird.templates.NodeVisitor.visit_LoadNode ```{autodoc2-docstring} django_bird.templates.NodeVisitor.visit_LoadNode :parser: myst ``` ```` ````{py:method} visit_Template(template: django.template.base.Template, context: django.template.context.Context) -> None :canonical: django_bird.templates.NodeVisitor.visit_Template ```{autodoc2-docstring} django_bird.templates.NodeVisitor.visit_Template :parser: myst ``` ```` `````