Warning

The package qiskit-ibmq-provider is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in https://ibm.biz/provider_migration_guide

ParameterNamespace

class ParameterNamespace(parameters)

Bases: types.SimpleNamespace

A namespace for program parameters with validation.

This class provides a namespace for program parameters with auto-completion and validation support.

ParameterNamespace constructor.

Parameters

parameters (Dict) - The program’s input parameters.

Methods

Warning

The package qiskit-ibmq-provider is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in https://ibm.biz/provider_migration_guide

ParameterNamespace.validate()

Validate program input values.

Note

This method only verifies that required parameters have values. It does not fail the validation if the namespace has extraneous parameters.

Raises

IBMQInputValueError - if validation fails

Return type

None

Returns the parameter metadata

Return type

Dict

Was this page helpful?

Report a bug or request content on GitHub.