Function pop

python/nemo_relay/scope.py:150–172

Pop a scope previously returned by ``push()`` or ``scope()``. Args: handle: Scope handle to close. output: Optional JSON payload exported as the semantic scope output. metadata: Optional JSON metadata to append to the metadata set when the scope was created. time

(
    handle: ScopeHandle, *, output: Json | None = None, metadata: Json | None = None, timestamp: datetime | None = None
)

def pop(
    handle: ScopeHandle, *, output: Json | None = None, metadata: Json | None = None, timestamp: datetime | None = None
) -> None:
    """Pop a scope previously returned by ``push()`` or ``scope()``.

    Args:
        handle: Scope handle to close.
        output: Optional JSON payload exported as the semantic scope output.
        metadata: Optional JSON metadata to append to the metadata set when the scope was created.
        timestamp: Optional timezone-aware ``datetime`` recorded on the scope
            end event. When omitted, the runtime default end timestamp is used.

    Returns:
        None: This function returns after the scope is closed successfully.

    Notes:
        The handle must correspond to an active scope in the current scope
        stack. Popping a scope also removes any scope-local registrations owned
        by that scope. ``timestamp`` must be a timezone-aware ``datetime``;
        strings and naive datetimes are rejected.
    """
    _ensure_scope_stack()
    _native_pop_scope(handle, output=output, metadata=metadata, timestamp=timestamp)


def event(