Skip to content

library

library #

Library — a browser library shipped as package data, copied whole into a page.

  1. A library lives under <package>/_vendor/<name>/ beside its LICENSE, its version recorded in the VERSIONS manifest in _vendor/; files() is that folder.
  2. copy_to writes the folder into a page under a relative path, unchanged files left alone; Render.lib does so once per render, the first time a component asks for one of its files, so the page stays self-contained.

Library dataclass #

A browser library shipped as package data under <package>/_vendor/<name>/.

Any package ships its own: a viewer outside capturegraph_ui names the package its JavaScript lives in.

LEAFLET = Library("capturegraph_ui", "leaflet")
Source code in capturegraph-ui/capturegraph_ui/core/library.py
@dataclass(frozen=True)
class Library:
    """A browser library shipped as package data under ``<package>/_vendor/<name>/``.

    Any package ships its own: a viewer outside ``capturegraph_ui`` names the
    package its JavaScript lives in.

    ```python
    LEAFLET = Library("capturegraph_ui", "leaflet")
    ```
    """

    package: str
    name: str

    def files(self) -> Traversable:
        """The shipped folder.

        Raises:
            FileNotFoundError: If ``package`` ships no library named ``name``.
        """
        folder = resources.files(self.package).joinpath("_vendor", self.name)
        if not folder.is_dir():
            raise FileNotFoundError(f"{self.package} ships no library named {self.name!r}")
        return folder

    def copy_to(self, page: cg.DirScalar, relative: str) -> None:
        """Write the library into ``page`` under ``relative``, unchanged files left alone.

        ```python
        LEAFLET.copy_to(page, "lib/leaflet")
        ```

        Raises:
            FileNotFoundError: If ``package`` ships no library named ``name``.
            ValueError: If ``relative`` does not stay inside ``page``.
        """
        _copy_tree(self.files(), page, relative)

copy_to(page, relative) #

Write the library into page under relative, unchanged files left alone.

LEAFLET.copy_to(page, "lib/leaflet")

Raises:

Type Description
FileNotFoundError

If package ships no library named name.

ValueError

If relative does not stay inside page.

Source code in capturegraph-ui/capturegraph_ui/core/library.py
def copy_to(self, page: cg.DirScalar, relative: str) -> None:
    """Write the library into ``page`` under ``relative``, unchanged files left alone.

    ```python
    LEAFLET.copy_to(page, "lib/leaflet")
    ```

    Raises:
        FileNotFoundError: If ``package`` ships no library named ``name``.
        ValueError: If ``relative`` does not stay inside ``page``.
    """
    _copy_tree(self.files(), page, relative)

files() #

The shipped folder.

Raises:

Type Description
FileNotFoundError

If package ships no library named name.

Source code in capturegraph-ui/capturegraph_ui/core/library.py
def files(self) -> Traversable:
    """The shipped folder.

    Raises:
        FileNotFoundError: If ``package`` ships no library named ``name``.
    """
    folder = resources.files(self.package).joinpath("_vendor", self.name)
    if not folder.is_dir():
        raise FileNotFoundError(f"{self.package} ships no library named {self.name!r}")
    return folder