CfgVariables#

class pyedb.configuration.cfg_common.CfgVariables(/, **data: Any)#

Bases: pydantic.BaseModel

Collect variable definitions for the variables section.

Overview#

add

Add a design or project variable.

Import detail#

from pyedb.configuration.cfg_common import CfgVariables

Attribute detail#

CfgVariables.variables: list[CfgVar] = None#

Method detail#

CfgVariables.add(name: str, value: int | float | str, description: str = '') None#

Add a design or project variable.

Parameters:
namestr

Variable name. Prefix with $ for project-scope, e.g. "$project_temp"; unprefixed names are design-scope.

valueint, float, or str

Variable value.

descriptionstr, optional

Human-readable description. Default is "".

Examples

>>> cfg.variables.add("trace_width", "0.15mm", "Default trace width")
>>> cfg.variables.add("$project_temp", "25cel")