Error

class qiskit.transpiler.passes.Error(*args, **kwargs)

GitHub

Bases: AnalysisPass

Error pass to be called when an error happens.

Error pass.

Parameters

msg (str | Callable[[PropertySet], str]) – Error message, if not provided a generic error will be used. This can be either a raw string, or a callback function that accepts the current property_set and returns the desired message.
action (str) – the action to perform. Default: ‘raise’. The options are: * 'raise': Raises a TranspilerError exception with msg * 'warn': Raises a non-fatal warning with msg * 'log': logs in logging.getLogger(__name__)

Raises

TranspilerError – if action is not valid.

Attributes

is_analysis_pass

Check if the pass is an analysis pass.

If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass.

is_transformation_pass

Check if the pass is a transformation pass.

If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read).

Methods

execute

execute(passmanager_ir, state, callback=None)

GitHub

Execute optimization task for input Qiskit IR.

Parameters

passmanager_ir (Any) – Qiskit IR to optimize.
state (PassManagerState) – State associated with workflow execution by the pass manager itself.
callback (Callable | None) – A callback function which is caller per execution of optimization task.