# {py:mod}`django_bird.staticfiles` ```{py:module} django_bird.staticfiles ``` ```{autodoc2-docstring} django_bird.staticfiles :parser: myst :allowtitles: ``` ## Module Contents ### Classes ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`AssetElement ` - * - {py:obj}`AssetType ` - ```{autodoc2-docstring} django_bird.staticfiles.AssetType :parser: myst :summary: ``` * - {py:obj}`AssetTypes ` - ```{autodoc2-docstring} django_bird.staticfiles.AssetTypes :parser: myst :summary: ``` * - {py:obj}`Asset ` - ```{autodoc2-docstring} django_bird.staticfiles.Asset :parser: myst :summary: ``` * - {py:obj}`BirdAssetStorage ` - * - {py:obj}`BirdAssetFinder ` - ```` ### Functions ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`register_asset_types ` - ```{autodoc2-docstring} django_bird.staticfiles.register_asset_types :parser: myst :summary: ``` * - {py:obj}`collect_component_assets ` - ```{autodoc2-docstring} django_bird.staticfiles.collect_component_assets :parser: myst :summary: ``` * - {py:obj}`get_component_assets ` - ```{autodoc2-docstring} django_bird.staticfiles.get_component_assets :parser: myst :summary: ``` ```` ### Data ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`logger ` - ```{autodoc2-docstring} django_bird.staticfiles.logger :parser: myst :summary: ``` * - {py:obj}`CSS ` - ```{autodoc2-docstring} django_bird.staticfiles.CSS :parser: myst :summary: ``` * - {py:obj}`JS ` - ```{autodoc2-docstring} django_bird.staticfiles.JS :parser: myst :summary: ``` * - {py:obj}`asset_types ` - ```{autodoc2-docstring} django_bird.staticfiles.asset_types :parser: myst :summary: ``` ```` ### API ````{py:data} logger :canonical: django_bird.staticfiles.logger :value: > 'getLogger(...)' ```{autodoc2-docstring} django_bird.staticfiles.logger :parser: myst ``` ```` `````{py:class} AssetElement(*args, **kwds) :canonical: django_bird.staticfiles.AssetElement Bases: {py:obj}`enum.Enum` ````{py:attribute} STYLESHEET :canonical: django_bird.staticfiles.AssetElement.STYLESHEET :value: > 'stylesheet' ```{autodoc2-docstring} django_bird.staticfiles.AssetElement.STYLESHEET :parser: myst ``` ```` ````{py:attribute} SCRIPT :canonical: django_bird.staticfiles.AssetElement.SCRIPT :value: > 'script' ```{autodoc2-docstring} django_bird.staticfiles.AssetElement.SCRIPT :parser: myst ``` ```` ````` `````{py:class} AssetType :canonical: django_bird.staticfiles.AssetType ```{autodoc2-docstring} django_bird.staticfiles.AssetType :parser: myst ``` ````{py:attribute} element :canonical: django_bird.staticfiles.AssetType.element :type: django_bird.staticfiles.AssetElement :value: > None ```{autodoc2-docstring} django_bird.staticfiles.AssetType.element :parser: myst ``` ```` ````{py:attribute} extension :canonical: django_bird.staticfiles.AssetType.extension :type: str :value: > None ```{autodoc2-docstring} django_bird.staticfiles.AssetType.extension :parser: myst ``` ```` ````{py:attribute} tag :canonical: django_bird.staticfiles.AssetType.tag :type: django_bird.templatetags.tags.asset.AssetTag :value: > None ```{autodoc2-docstring} django_bird.staticfiles.AssetType.tag :parser: myst ``` ```` ````{py:property} suffix :canonical: django_bird.staticfiles.AssetType.suffix ```{autodoc2-docstring} django_bird.staticfiles.AssetType.suffix :parser: myst ``` ```` ````` ````{py:data} CSS :canonical: django_bird.staticfiles.CSS :value: > 'AssetType(...)' ```{autodoc2-docstring} django_bird.staticfiles.CSS :parser: myst ``` ```` ````{py:data} JS :canonical: django_bird.staticfiles.JS :value: > 'AssetType(...)' ```{autodoc2-docstring} django_bird.staticfiles.JS :parser: myst ``` ```` `````{py:class} AssetTypes() :canonical: django_bird.staticfiles.AssetTypes ```{autodoc2-docstring} django_bird.staticfiles.AssetTypes :parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} django_bird.staticfiles.AssetTypes.__init__ :parser: myst ``` ````{py:method} is_known_type(path: pathlib.Path) -> bool :canonical: django_bird.staticfiles.AssetTypes.is_known_type ```{autodoc2-docstring} django_bird.staticfiles.AssetTypes.is_known_type :parser: myst ``` ```` ````{py:method} register_type(asset_type: django_bird.staticfiles.AssetType) -> None :canonical: django_bird.staticfiles.AssetTypes.register_type ```{autodoc2-docstring} django_bird.staticfiles.AssetTypes.register_type :parser: myst ``` ```` ````{py:method} reset() -> None :canonical: django_bird.staticfiles.AssetTypes.reset ```{autodoc2-docstring} django_bird.staticfiles.AssetTypes.reset :parser: myst ``` ```` ````` ````{py:data} asset_types :canonical: django_bird.staticfiles.asset_types :value: > 'AssetTypes(...)' ```{autodoc2-docstring} django_bird.staticfiles.asset_types :parser: myst ``` ```` ````{py:function} register_asset_types(register_type: collections.abc.Callable[[django_bird.staticfiles.AssetType], None]) :canonical: django_bird.staticfiles.register_asset_types ```{autodoc2-docstring} django_bird.staticfiles.register_asset_types :parser: myst ``` ```` `````{py:class} Asset :canonical: django_bird.staticfiles.Asset ```{autodoc2-docstring} django_bird.staticfiles.Asset :parser: myst ``` ````{py:attribute} path :canonical: django_bird.staticfiles.Asset.path :type: pathlib.Path :value: > None ```{autodoc2-docstring} django_bird.staticfiles.Asset.path :parser: myst ``` ```` ````{py:attribute} type :canonical: django_bird.staticfiles.Asset.type :type: django_bird.staticfiles.AssetType :value: > None ```{autodoc2-docstring} django_bird.staticfiles.Asset.type :parser: myst ``` ```` ````{py:method} __hash__() -> int :canonical: django_bird.staticfiles.Asset.__hash__ ```` ````{py:method} exists() -> bool :canonical: django_bird.staticfiles.Asset.exists ```{autodoc2-docstring} django_bird.staticfiles.Asset.exists :parser: myst ``` ```` ````{py:method} render() :canonical: django_bird.staticfiles.Asset.render ```{autodoc2-docstring} django_bird.staticfiles.Asset.render :parser: myst ``` ```` ````{py:property} absolute_path :canonical: django_bird.staticfiles.Asset.absolute_path ```{autodoc2-docstring} django_bird.staticfiles.Asset.absolute_path :parser: myst ``` ```` ````{py:property} relative_path :canonical: django_bird.staticfiles.Asset.relative_path ```{autodoc2-docstring} django_bird.staticfiles.Asset.relative_path :parser: myst ``` ```` ````{py:property} storage :canonical: django_bird.staticfiles.Asset.storage ```{autodoc2-docstring} django_bird.staticfiles.Asset.storage :parser: myst ``` ```` ````{py:property} template_dir :canonical: django_bird.staticfiles.Asset.template_dir ```{autodoc2-docstring} django_bird.staticfiles.Asset.template_dir :parser: myst ``` ```` ````{py:property} url :canonical: django_bird.staticfiles.Asset.url :type: str | None ```{autodoc2-docstring} django_bird.staticfiles.Asset.url :parser: myst ``` ```` ````` ````{py:function} collect_component_assets(template_path: pathlib.Path) -> collections.abc.Iterable[django_bird.staticfiles.Asset] :canonical: django_bird.staticfiles.collect_component_assets ```{autodoc2-docstring} django_bird.staticfiles.collect_component_assets :parser: myst ``` ```` ````{py:function} get_component_assets(component: django_bird.components.Component, asset_type: str | None = None) -> list[django_bird.staticfiles.Asset] :canonical: django_bird.staticfiles.get_component_assets ```{autodoc2-docstring} django_bird.staticfiles.get_component_assets :parser: myst ``` ```` `````{py:class} BirdAssetStorage(*args: typing.Any, prefix: str, **kwargs: typing.Any) :canonical: django_bird.staticfiles.BirdAssetStorage Bases: {py:obj}`django.contrib.staticfiles.storage.StaticFilesStorage` ````{py:method} url(name: str | None) -> str :canonical: django_bird.staticfiles.BirdAssetStorage.url ```` ````` `````{py:class} BirdAssetFinder :canonical: django_bird.staticfiles.BirdAssetFinder Bases: {py:obj}`django.contrib.staticfiles.finders.BaseFinder` ````{py:method} check(**kwargs: typing.Any) -> list[django.core.checks.CheckMessage] :canonical: django_bird.staticfiles.BirdAssetFinder.check ```{autodoc2-docstring} django_bird.staticfiles.BirdAssetFinder.check :parser: myst ``` ```` ````{py:method} find(path: str, all: bool = False, find_all: bool | None = None) -> str | list[str] | None :canonical: django_bird.staticfiles.BirdAssetFinder.find ```{autodoc2-docstring} django_bird.staticfiles.BirdAssetFinder.find :parser: myst ``` ```` ````{py:method} list(ignore_patterns: collections.abc.Iterable[str] | None) -> collections.abc.Iterable[tuple[str, django.core.files.storage.FileSystemStorage]] :canonical: django_bird.staticfiles.BirdAssetFinder.list ```{autodoc2-docstring} django_bird.staticfiles.BirdAssetFinder.list :parser: myst ``` ```` `````