Function storage

core/src/stdlib/pyscript/storage.py:207–250

Open or create persistent storage with a unique `name` and optional `storage_class` (used to extend the default `Storage` based behavior). Each storage is isolated by name within the current origin (domain). If the storage doesn't exist, it will be created. If it does exist, it

(name="", storage_class=Storage)

async def storage(name="", storage_class=Storage):
    """
    Open or create persistent storage with a unique `name` and optional
    `storage_class` (used to extend the default `Storage` based behavior).

    Each storage is isolated by name within the current origin (domain).
    If the storage doesn't exist, it will be created. If it does exist,
    its current contents will be loaded.

    This function returns a `Storage` instance (or custom subclass instance)
    acting as a persistent dictionary. A `ValueError` is raised if `name` is
    empty or not provided.

    ```python
    from pyscript import storage


    # Basic usage.
    user_data = await storage("user-profile")
    user_data["name"] = "Alice"
    user_data["age"] = 30

    # Multiple independent storages.
    settings = await storage("app-settings")
    cache = await storage("api-cache")

    # With custom Storage class.
    class ValidatingStorage(Storage):
        def __setitem__(self, key, value):
            if not isinstance(key, str):
                raise TypeError("Keys must be strings")
            super().__setitem__(key, value)

    validated = await storage("validated-data", ValidatingStorage)
    ```

    Storage names are automatically prefixed with `"@pyscript/"` to
    namespace them within IndexedDB.
    """
    if not name:
        raise ValueError("Storage name must be a non-empty string")

    underlying_store = await _polyscript_storage(f"@pyscript/{name}")
    return storage_class(underlying_store)