kqcircuits.util.parameter_helper¶

Helper module for pcell parameter schemas.

Typical usage example:

from kqcircuits.util.parameter_helper import Validator
schema = {
    "n": {
        "type": pya.PCellParameterDeclaration.TypeInt,
        "description": "Number of elements",
        "default": 10
    }
}
validator = Validator(schema)
if validator.validate({"n": 100}):
    # Do something with validated parameters...

kqcircuits.util.parameter_helper.normalize_rules(name, rules)[source]¶

Normalizes rule fields corresponding to specified name.

Adds missing optional rule fields with default settings.

Returns: Dictionary containing all rule fields.

class kqcircuits.util.parameter_helper.Validator(schema)[source]¶

Bases: object

Validates KLayout parameters according to specified schema.

schema¶: Dictionary containing rules for validating KLayout parameters.

validate(parameters)[source]¶

Validates KLayout parameters.

Parameters

parameters – KLayout parameters.

Returns

True if validation is successful.

Raises

MissingParameterException – Failed to validate because a required parameter is missing.
InvalidParameterException – Failed to validate parameter because of invalid value.