component_registry ¤

def all(self) -> Dict[str, Type["Component"]]:
    """
    Retrieve all registered [`Component`](../api#django_components.Component) classes.

    Returns:
        Dict[str, Type[Component]]: A dictionary of component names to component classes

    **Example:**

    ```python
    # First register components
    registry.register("button", ButtonComponent)
    registry.register("card", CardComponent)
    # Then get all
    registry.all()
    # > {
    # >   "button": ButtonComponent,
    # >   "card": CardComponent,
    # > }
    ```
    """
    comps = {key: entry.cls for key, entry in self._registry.items()}
    return comps

def clear(self) -> None:
    """
    Clears the registry, unregistering all components.

    Example:

    ```python
    # First register components
    registry.register("button", ButtonComponent)
    registry.register("card", CardComponent)
    # Then clear
    registry.clear()
    # Then get all
    registry.all()
    # > {}
    ```
    """
    all_comp_names = list(self._registry.keys())
    for comp_name in all_comp_names:
        self.unregister(comp_name)

    self._registry = {}
    self._tags = {}

def get(self, name: str) -> Type["Component"]:
    """
    Retrieve a [`Component`](../api#django_components.Component)
    class registered under the given name.

    Args:
        name (str): The name under which the component was registered. Required.

    Returns:
        Type[Component]: The component class registered under the given name.

    **Raises:**

    - [`NotRegistered`](../exceptions#django_components.NotRegistered)
      if the given name is not registered.

    **Example:**

    ```python
    # First register component
    registry.register("button", ButtonComponent)
    # Then get
    registry.get("button")
    # > ButtonComponent
    ```
    """
    if name not in self._registry:
        raise NotRegistered('The component "%s" is not registered' % name)

    return self._registry[name].cls

def register(self, name: str, component: Type["Component"]) -> None:
    """
    Register a [`Component`](../api#django_components.Component) class
    with this registry under the given name.

    A component MUST be registered before it can be used in a template such as:
    ```django
    {% component "my_comp" %}
    {% endcomponent %}
    ```

    Args:
        name (str): The name under which the component will be registered. Required.
        component (Type[Component]): The component class to register. Required.

    **Raises:**

    - [`AlreadyRegistered`](../exceptions#django_components.AlreadyRegistered)
    if a different component was already registered under the same name.

    **Example:**

    ```python
    registry.register("button", ButtonComponent)
    ```
    """
    existing_component = self._registry.get(name)
    if existing_component and existing_component.cls._class_hash != component._class_hash:
        raise AlreadyRegistered('The component "%s" has already been registered' % name)

    entry = self._register_to_library(name, component)

    # Keep track of which components use which tags, because multiple components may
    # use the same tag.
    tag = entry.tag
    if tag not in self._tags:
        self._tags[tag] = set()
    self._tags[tag].add(name)

    self._registry[name] = entry

def unregister(self, name: str) -> None:
    """
    Unregister the [`Component`](../api#django_components.Component) class
    that was registered under the given name.

    Once a component is unregistered, it is no longer available in the templates.

    Args:
        name (str): The name under which the component is registered. Required.

    **Raises:**

    - [`NotRegistered`](../exceptions#django_components.NotRegistered)
    if the given name is not registered.

    **Example:**

    ```python
    # First register component
    registry.register("button", ButtonComponent)
    # Then unregister
    registry.unregister("button")
    ```
    """
    # Validate
    self.get(name)

    entry = self._registry[name]
    tag = entry.tag

    # Unregister the tag from library if this was the last component using this tag
    # Unlink component from tag
    self._tags[tag].remove(name)

    # Cleanup
    is_tag_empty = not len(self._tags[tag])
    if is_tag_empty:
        del self._tags[tag]

    # Only unregister a tag if it's NOT protected
    is_protected = is_tag_protected(self.library, tag)
    if not is_protected:
        # Unregister the tag from library if this was the last component using this tag
        if is_tag_empty and tag in self.library.tags:
            del self.library.tags[tag]

    del self._registry[name]