Skip to content

gds.parameters

Bases: BaseModel

Schema definition for a single parameter.

Defines one dimension of Θ structurally — type, constraints, and bounds. No values, no binding, no execution semantics.

Source code in packages/gds-framework/gds/parameters.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
class ParameterDef(BaseModel):
    """Schema definition for a single parameter.

    Defines one dimension of Θ structurally — type, constraints, and bounds.
    No values, no binding, no execution semantics.
    """

    model_config = ConfigDict(frozen=True, arbitrary_types_allowed=True)

    name: str
    typedef: TypeDef
    description: str = ""
    bounds: tuple[Any, Any] | None = None

    def check_value(self, value: Any) -> bool:
        """Check if a value satisfies this parameter's type and constraints."""
        if not self.typedef.check_value(value):
            return False
        if self.bounds is not None:
            low, high = self.bounds
            if not (low <= value <= high):
                return False
        return True

check_value(value)

Check if a value satisfies this parameter's type and constraints.

Source code in packages/gds-framework/gds/parameters.py 
35
36
37
38
39
40
41
42
43
def check_value(self, value: Any) -> bool:
    """Check if a value satisfies this parameter's type and constraints."""
    if not self.typedef.check_value(value):
        return False
    if self.bounds is not None:
        low, high = self.bounds
        if not (low <= value <= high):
            return False
    return True

Bases: BaseModel

Defines the parameter space Θ at specification level.

Immutable registry of parameter definitions. GDS does not interpret values — only validates structural references.

Source code in packages/gds-framework/gds/parameters.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
class ParameterSchema(BaseModel):
    """Defines the parameter space Θ at specification level.

    Immutable registry of parameter definitions.
    GDS does not interpret values — only validates structural references.
    """

    model_config = ConfigDict(frozen=True, arbitrary_types_allowed=True)

    parameters: dict[str, ParameterDef] = Field(default_factory=dict)

    def add(self, param: ParameterDef) -> ParameterSchema:
        """Return new schema with added parameter (immutable)."""
        if param.name in self.parameters:
            raise ValueError(f"Parameter '{param.name}' already registered")
        new_params = dict(self.parameters)
        new_params[param.name] = param
        return self.model_copy(update={"parameters": new_params})

    def get(self, name: str) -> ParameterDef:
        """Get a parameter definition by name."""
        return self.parameters[name]

    def names(self) -> set[str]:
        """Return all parameter names."""
        return set(self.parameters.keys())

    def validate_references(self, ref_names: set[str]) -> list[str]:
        """Validate that all referenced parameter names exist in schema.

        Returns list of error strings (empty = all references valid).
        """
        errors: list[str] = []
        for name in sorted(ref_names):
            if name not in self.parameters:
                errors.append(f"Referenced parameter '{name}' not defined in schema")
        return errors

    def __len__(self) -> int:
        return len(self.parameters)

    def __contains__(self, name: str) -> bool:
        return name in self.parameters

add(param)

Return new schema with added parameter (immutable).

Source code in packages/gds-framework/gds/parameters.py 
57
58
59
60
61
62
63
def add(self, param: ParameterDef) -> ParameterSchema:
    """Return new schema with added parameter (immutable)."""
    if param.name in self.parameters:
        raise ValueError(f"Parameter '{param.name}' already registered")
    new_params = dict(self.parameters)
    new_params[param.name] = param
    return self.model_copy(update={"parameters": new_params})

get(name)

Get a parameter definition by name.

Source code in packages/gds-framework/gds/parameters.py 
65
66
67
def get(self, name: str) -> ParameterDef:
    """Get a parameter definition by name."""
    return self.parameters[name]

names()

Return all parameter names.

Source code in packages/gds-framework/gds/parameters.py 
69
70
71
def names(self) -> set[str]:
    """Return all parameter names."""
    return set(self.parameters.keys())

validate_references(ref_names)

Validate that all referenced parameter names exist in schema.

Returns list of error strings (empty = all references valid).

Source code in packages/gds-framework/gds/parameters.py 
73
74
75
76
77
78
79
80
81
82
def validate_references(self, ref_names: set[str]) -> list[str]:
    """Validate that all referenced parameter names exist in schema.

    Returns list of error strings (empty = all references valid).
    """
    errors: list[str] = []
    for name in sorted(ref_names):
        if name not in self.parameters:
            errors.append(f"Referenced parameter '{name}' not defined in schema")
    return errors