Module `spin_sdk.wit.imports.variables`

Expand source code

from typing import TypeVar, Generic, Union, Optional, Union, Protocol, Tuple, List, Any, Self
from enum import Flag, Enum, auto
from dataclasses import dataclass
from abc import abstractmethod
import weakref

from ..types import Result, Ok, Err, Some



@dataclass
class ErrorInvalidName:
    value: str


@dataclass
class ErrorUndefined:
    value: str


@dataclass
class ErrorProvider:
    value: str


@dataclass
class ErrorOther:
    value: str


Error = Union[ErrorInvalidName, ErrorUndefined, ErrorProvider, ErrorOther]
"""
The set of errors which may be raised by functions in this interface.
"""



def get(name: str) -> str:
    """
    Get an application variable value for the current component.
    
    The name must match one defined in in the component manifest.
    
    Raises: `spin_sdk.wit.types.Err(spin_sdk.wit.imports.variables.Error)`
    """
    raise NotImplementedError

Global variables

var Error: The set of errors which may be raised by functions in this interface.

Functions

def get(name: str) ‑> str

Get an application variable value for the current component.

The name must match one defined in in the component manifest.

Raises: Err(Error)

Expand source code

def get(name: str) -> str:
    """
    Get an application variable value for the current component.
    
    The name must match one defined in in the component manifest.
    
    Raises: `spin_sdk.wit.types.Err(spin_sdk.wit.imports.variables.Error)`
    """
    raise NotImplementedError

Classes

class ErrorInvalidName (value: str)

ErrorInvalidName(value: str)

Expand source code

@dataclass
class ErrorInvalidName:
    value: str

Class variables

var value : str

class ErrorOther (value: str)

ErrorOther(value: str)

Expand source code

@dataclass
class ErrorOther:
    value: str

Class variables

var value : str

class ErrorProvider (value: str)

ErrorProvider(value: str)

Expand source code

@dataclass
class ErrorProvider:
    value: str

Class variables

var value : str

class ErrorUndefined (value: str)

ErrorUndefined(value: str)

Expand source code

@dataclass
class ErrorUndefined:
    value: str

Class variables

var value : str