classiq 0.38.0__py3-none-any.whl → 0.65.3__py3-none-any.whl

classiq/qmod/native/pretty_printer.py

@@ -1,44 +1,69 @@
-from typing import Dict, List
+from collections.abc import Mapping
+from typing import Optional, Union
 
 from classiq.interface.generator.constant import Constant
 from classiq.interface.generator.expressions.expression import Expression
 from classiq.interface.generator.functions.classical_type import (
+    Bool,
     ClassicalArray,
+    ClassicalList,
+    Integer,
+    Real,
+)
+from classiq.interface.generator.functions.concrete_types import (
     ConcreteClassicalType,
+    ConcreteQuantumType,
 )
 from classiq.interface.generator.functions.port_declaration import (
     PortDeclarationDirection,
 )
+from classiq.interface.generator.functions.type_name import TypeName
+from classiq.interface.generator.types.enum_declaration import EnumDeclaration
+from classiq.interface.generator.types.qstruct_declaration import QStructDeclaration
+from classiq.interface.generator.types.struct_declaration import StructDeclaration
 from classiq.interface.generator.visitor import NodeType, Visitor
+from classiq.interface.model.allocate import Allocate
 from classiq.interface.model.bind_operation import BindOperation
+from classiq.interface.model.classical_if import ClassicalIf
 from classiq.interface.model.classical_parameter_declaration import (
-    ClassicalParameterDeclaration,
+    AnonClassicalParameterDeclaration,
 )
+from classiq.interface.model.control import Control
 from classiq.interface.model.handle_binding import (
+    FieldHandleBinding,
     HandleBinding,
     SlicedHandleBinding,
     SubscriptHandleBinding,
 )
 from classiq.interface.model.inplace_binary_operation import InplaceBinaryOperation
+from classiq.interface.model.invert import Invert
 from classiq.interface.model.model import Model
 from classiq.interface.model.native_function_definition import NativeFunctionDefinition
-from classiq.interface.model.port_declaration import PortDeclaration
+from classiq.interface.model.phase_operation import PhaseOperation
+from classiq.interface.model.port_declaration import (
+    AnonPortDeclaration,
+)
+from classiq.interface.model.power import Power
 from classiq.interface.model.quantum_expressions.amplitude_loading_operation import (
     AmplitudeLoadingOperation,
 )
 from classiq.interface.model.quantum_expressions.arithmetic_operation import (
     ArithmeticOperation,
+    ArithmeticOperationKind,
 )
 from classiq.interface.model.quantum_function_call import (
-    OperandIdentifier,
     QuantumFunctionCall,
 )
 from classiq.interface.model.quantum_function_declaration import (
+    AnonQuantumFunctionDeclaration,
+    AnonQuantumOperandDeclaration,
     QuantumFunctionDeclaration,
     QuantumOperandDeclaration,
 )
-from classiq.interface.model.quantum_if_operation import QuantumIfOperation
-from classiq.interface.model.quantum_lambda_function import QuantumLambdaFunction
+from classiq.interface.model.quantum_lambda_function import (
+    OperandIdentifier,
+    QuantumLambdaFunction,
+)
 from classiq.interface.model.quantum_type import (
     QuantumBit,
     QuantumBitvector,
@@ -47,21 +72,28 @@ from classiq.interface.model.quantum_type import (
 from classiq.interface.model.quantum_variable_declaration import (
     QuantumVariableDeclaration,
 )
+from classiq.interface.model.repeat import Repeat
 from classiq.interface.model.statement_block import StatementBlock
 from classiq.interface.model.variable_declaration_statement import (
     VariableDeclarationStatement,
 )
-from classiq.interface.model.within_apply_operation import WithinApplyOperation
+from classiq.interface.model.within_apply_operation import WithinApply
 
-from classiq import Bool, ClassicalList, Integer, Pauli, Real, Struct, StructDeclaration
+from classiq.open_library.functions import OPEN_LIBRARY_FUNCTIONS
 from classiq.qmod.native.expression_to_qmod import transform_expression
+from classiq.qmod.semantics.annotation.call_annotation import resolve_function_calls
 from classiq.qmod.utilities import DEFAULT_DECIMAL_PRECISION
 
 
 class DSLPrettyPrinter(Visitor):
-    def __init__(self, decimal_precision: int = DEFAULT_DECIMAL_PRECISION) -> None:
+    def __init__(
+        self,
+        decimal_precision: Optional[int] = DEFAULT_DECIMAL_PRECISION,
+        emit_open_lib_functions: bool = False,
+    ) -> None:
         self._level = 0
         self._decimal_precision = decimal_precision
+        self._emit_open_lib_functions = emit_open_lib_functions
 
     def visit(self, node: NodeType) -> str:
         res = super().visit(node)
@@ -70,42 +102,64 @@ class DSLPrettyPrinter(Visitor):
         return res
 
     def visit_Model(self, model: Model) -> str:
+        # FIXME - CAD-20149: Remove this line once the froggies are removed, and the visit of lambdas can be done without accessing the func_decl property (with rename_params values only).
+        resolve_function_calls(model, model.function_dict)
+        enum_decls = [self.visit(enum_decl) for enum_decl in model.enums]
         struct_decls = [self.visit(struct_decl) for struct_decl in model.types]
+        qstruct_decls = [self.visit(qstruct_decl) for qstruct_decl in model.qstructs]
         func_defs = [self.visit(func_def) for func_def in model.functions]
         constants = [self.visit(constant) for constant in model.constants]
         classical_code = (
-            f"cscope ```\n{model.classical_execution_code}\n```"
+            [f"cscope ```\n{model.classical_execution_code}\n```\n"]
             if model.classical_execution_code
-            else ""
+            else []
         )
-        return "\n".join([*constants, *struct_decls, *func_defs, classical_code])
+
+        items = [
+            *constants,
+            *enum_decls,
+            *struct_decls,
+            *qstruct_decls,
+            *func_defs,
+            *classical_code,
+        ]
+        return "\n".join([item for item in items if item != ""])
 
     def visit_Constant(self, constant: Constant) -> str:
         return f"{self._indent}{self.visit(constant.name)}: {self.visit(constant.const_type)} = {self.visit(constant.value)};\n"
 
-    def _visit_arg_decls(self, func_def: QuantumFunctionDeclaration) -> str:
-        gen_time_args = ", ".join(
-            self.visit(arg_decl)
-            for arg_decl in func_def.get_positional_arg_decls()
-            if not isinstance(arg_decl, PortDeclaration)
-        )
-        quantum_args = ", ".join(
-            self.visit(arg_decl)
-            for arg_decl in func_def.get_positional_arg_decls()
-            if isinstance(arg_decl, PortDeclaration)
+    def _visit_arg_decls(self, func_def: AnonQuantumFunctionDeclaration) -> str:
+        positional_args = ", ".join(
+            self.visit(arg_decl) for arg_decl in func_def.positional_arg_declarations
         )
-        gen_time_arg_list = f"<{gen_time_args}>" if gen_time_args else ""
-        return f"{gen_time_arg_list}({quantum_args})"
+        return f"({positional_args})"
 
     def visit_QuantumFunctionDeclaration(
         self, func_decl: QuantumFunctionDeclaration
     ) -> str:
         return f"qfunc {func_decl.name}{self._visit_arg_decls(func_decl)}"
 
+    def visit_EnumDeclaration(self, enum_decl: EnumDeclaration) -> str:
+        return f"enum {enum_decl.name} {{\n{self._visit_members(enum_decl.members)}}}\n"
+
+    def _visit_members(self, members: dict[str, int]) -> str:
+        self._level += 1
+        members_str = "".join(
+            f"{self._indent}{self.visit(member_name)} = {member_value};\n"
+            for member_name, member_value in members.items()
+        )
+        self._level -= 1
+        return members_str
+
     def visit_StructDeclaration(self, struct_decl: StructDeclaration) -> str:
         return f"struct {struct_decl.name} {{\n{self._visit_variables(struct_decl.variables)}}}\n"
 
-    def _visit_variables(self, variables: Dict[str, ConcreteClassicalType]) -> str:
+    def visit_QStructDeclaration(self, qstruct_decl: QStructDeclaration) -> str:
+        return f"qstruct {qstruct_decl.name} {{\n{self._visit_variables(qstruct_decl.fields)}}}\n"
+
+    def _visit_variables(
+        self, variables: Mapping[str, Union[ConcreteClassicalType, ConcreteQuantumType]]
+    ) -> str:
         self._level += 1
         variables_str = "".join(
             f"{self._indent}{self.visit(field_name)}: {self.visit(var_decl)};\n"
@@ -119,43 +173,42 @@ class DSLPrettyPrinter(Visitor):
     ) -> str:
         return f"{var_decl.name}: {self.visit(var_decl.quantum_type)}"
 
-    def visit_PortDeclaration(self, port_decl: PortDeclaration) -> str:
+    def visit_AnonPortDeclaration(self, port_decl: AnonPortDeclaration) -> str:
         dir_str = (
             f"{port_decl.direction} "
             if port_decl.direction != PortDeclarationDirection.Inout
             else ""
         )
-        return f"{dir_str}{self.visit_QuantumVariableDeclaration(port_decl)}"
+        param_name = f"{port_decl.name}: " if port_decl.name is not None else ""
+        return f"{dir_str}{param_name}{self.visit(port_decl.quantum_type)}"
 
     def visit_QuantumBit(self, qtype: QuantumBit) -> str:
         return "qbit"
 
     def visit_QuantumBitvector(self, qtype: QuantumBitvector) -> str:
+        element_type = self.visit(qtype.element_type)
         if qtype.length is not None:
-            if qtype.length.is_evaluated() and qtype.length.to_int_value() == 1:
-                return "qbit"
-            return f"qbit[{self.visit(qtype.length)}]"
-        return "qbit[]"
+            return f"{element_type}[{self.visit(qtype.length)}]"
+        return f"{element_type}[]"
 
     def visit_QuantumNumeric(self, qtype: QuantumNumeric) -> str:
         params = ""
         if qtype.size is not None:
-            assert qtype.is_signed is not None
-            assert qtype.fraction_digits is not None
-
             params = "<{}>".format(
                 ", ".join(
                     self.visit(param)
                     for param in [qtype.size, qtype.is_signed, qtype.fraction_digits]
+                    if param is not None
                 )
             )
 
         return f"qnum{params}"
 
-    def visit_ClassicalParameterDeclaration(
-        self, cparam: ClassicalParameterDeclaration
+    def visit_AnonClassicalParameterDeclaration(
+        self, cparam: AnonClassicalParameterDeclaration
     ) -> str:
-        return f"{cparam.name}: {self.visit(cparam.classical_type)}"
+        param_name = f"{cparam.name}: " if cparam.name is not None else ""
+        return f"{param_name}{self.visit(cparam.classical_type)}"
 
     def visit_Integer(self, ctint: Integer) -> str:
         return "int"
@@ -166,75 +219,109 @@ class DSLPrettyPrinter(Visitor):
     def visit_Bool(self, ctbool: Bool) -> str:
         return "bool"
 
-    def visit_Pauli(self, ctbool: Pauli) -> str:
-        return "Pauli"
-
     def visit_ClassicalList(self, ctlist: ClassicalList) -> str:
         return f"{self.visit(ctlist.element_type)}[]"
 
     def visit_ClassicalArray(self, ctarray: ClassicalArray) -> str:
         return f"{self.visit(ctarray.element_type)}[{ctarray.size}]"
 
-    def visit_Struct(self, struct: Struct) -> str:
-        return struct.name
+    def visit_TypeName(self, type_: TypeName) -> str:
+        return type_.name
 
     def visit_VariableDeclarationStatement(
         self, local_decl: VariableDeclarationStatement
     ) -> str:
         return f"{self._indent}{self.visit_QuantumVariableDeclaration(local_decl)};\n"
 
+    def visit_AnonQuantumOperandDeclaration(
+        self, op_decl: AnonQuantumOperandDeclaration
+    ) -> str:
+        param_name = f"{op_decl.name}: " if op_decl.name is not None else ""
+        return f"{param_name}qfunc{[] if op_decl.is_list else ''} {self._visit_arg_decls(op_decl)}"
+
     def visit_QuantumOperandDeclaration(
         self, op_decl: QuantumOperandDeclaration
     ) -> str:
-        return f"{op_decl.name}: qfunc{[] if op_decl.is_list else ''} {self._visit_arg_decls(op_decl)}"
+        return self.visit_AnonQuantumOperandDeclaration(op_decl)
 
     def visit_NativeFunctionDefinition(self, func_def: NativeFunctionDefinition) -> str:
+        if not self._emit_open_lib_functions and func_def.name in [
+            qfunc_.func_decl.name for qfunc_ in OPEN_LIBRARY_FUNCTIONS
+        ]:
+            return ""
         self._level += 1
         body = "".join(self.visit(qvar_decl) for qvar_decl in func_def.body)
         self._level -= 1
         return f"{self.visit_QuantumFunctionDeclaration(func_def)} {{\n{body}}}\n"
 
+    def visit_Allocate(self, allocate: Allocate) -> str:
+        if allocate.size is not None:
+            size = f"{self.visit(allocate.size)}, "
+        else:
+            size = ""
+        return f"{self._indent}allocate({size}{self.visit(allocate.target)});\n"
+
     def visit_QuantumFunctionCall(self, func_call: QuantumFunctionCall) -> str:
-        gen_time_args = ", ".join(
-            self.visit(arg_decl)
-            for arg_decl in func_call.get_positional_args()
-            if not isinstance(arg_decl, HandleBinding)
+        positional_args = ", ".join(
+            self.visit(arg_decl) for arg_decl in func_call.positional_args
         )
-        gen_time_arg_list = f"<{gen_time_args}>" if gen_time_args else ""
-        quantum_args = ", ".join(
-            self.visit(arg_decl)
-            for arg_decl in func_call.get_positional_args()
-            if isinstance(arg_decl, HandleBinding)
-        )
-        return f"{self._indent}{func_call.func_name}{f'[{self.visit(func_call.function.index)}]' if isinstance(func_call.function, OperandIdentifier) else ''}{gen_time_arg_list}({quantum_args});\n"
-
-    def visit_QuantumIfOperation(self, op: QuantumIfOperation) -> str:
-        quantum_if = f"{self._indent}quantum_if ({self.visit(op.expression)}) {{\n"
-        operand = op.then
-        if not isinstance(operand, QuantumLambdaFunction):
-            raise AssertionError(
-                "Expected quantum_if to be implemented using a lambda function"
-            )
-        quantum_if += self._visit_body(operand.body)
-        quantum_if += f"{self._indent}}}\n"
-        return quantum_if
-
-    def visit_WithinApplyOperation(self, op: WithinApplyOperation) -> str:
-        action = op.action
-        compute = op.compute
-        if not isinstance(action, QuantumLambdaFunction) or not isinstance(
-            compute, QuantumLambdaFunction
-        ):
-            raise AssertionError(
-                "Expected within-apply to be implemented using a lambda functions"
-            )
+        return f"{self._indent}{func_call.func_name}{f'[{self.visit(func_call.function.index)}]' if isinstance(func_call.function, OperandIdentifier) else ''}({positional_args});\n"
+
+    def visit_Control(self, op: Control) -> str:
+        control = f"{self._indent}control ({self.visit(op.expression)}) {{\n"
+        control += self._visit_body(op.body)
+        control += f"{self._indent}}}"
+        if op.else_block is not None:
+            control += " else {\n"
+            control += self._visit_body(op.else_block)
+            control += f"{self._indent}}}"
+        control += "\n"
+        return control
+
+    def visit_PhaseOperation(self, op: PhaseOperation) -> str:
+        theta = f", {self.visit(op.theta)}" if op.theta else ""
+        phase = f"{self._indent}phase ({self.visit(op.expression)}{theta});\n"
+        return phase
+
+    def visit_ClassicalIf(self, op: ClassicalIf) -> str:
+        classical_if = f"{self._indent}if ({self.visit(op.condition)}) {{\n"
+        if not op.then:
+            raise AssertionError('Expected non empty "then" block')
+        classical_if += self._visit_body(op.then)
+
+        if op.else_:
+            classical_if += f"{self._indent}}} else {{\n"
+            classical_if += self._visit_body(op.else_)
+
+        classical_if += f"{self._indent}}}\n"
+        return classical_if
+
+    def visit_WithinApply(self, op: WithinApply) -> str:
         within_apply_code = f"{self._indent}within {{\n"
-        within_apply_code += self._visit_body(compute.body)
+        within_apply_code += self._visit_body(op.compute)
         within_apply_code += f"{self._indent}}} apply {{\n"
-        within_apply_code += self._visit_body(action.body)
+        within_apply_code += self._visit_body(op.action)
         within_apply_code += f"{self._indent}}}\n"
         return within_apply_code
 
+    def visit_Repeat(self, repeat: Repeat) -> str:
+        repeat_code = f"{self._indent}repeat ({self.visit(repeat.iter_var)}: {self.visit(repeat.count)}) {{\n"
+        repeat_code += self._visit_body(repeat.body)
+        repeat_code += f"{self._indent}}}\n"
+        return repeat_code
+
+    def visit_Power(self, power: Power) -> str:
+        power_code = f"{self._indent}power ({self.visit(power.power)}) {{\n"
+        power_code += self._visit_body(power.body)
+        power_code += f"{self._indent}}}\n"
+        return power_code
+
+    def visit_Invert(self, invert: Invert) -> str:
+        invert_code = f"{self._indent}invert {{\n"
+        invert_code += self._visit_body(invert.body)
+        invert_code += f"{self._indent}}}\n"
+        return invert_code
+
     def _visit_body(self, body: StatementBlock) -> str:
         code = ""
         self._level += 1
@@ -244,11 +331,9 @@ class DSLPrettyPrinter(Visitor):
         return code
 
     def visit_InplaceBinaryOperation(self, op: InplaceBinaryOperation) -> str:
-        return (
-            f"{self._indent}{op.operation.value}({op.value.name}, {op.target.name});\n"
-        )
+        return f"{self._indent}{op.operation.value}({self.visit(op.value)}, {self.visit(op.target)});\n"
 
-    def _visit_pack_expr(self, vars: List[HandleBinding]) -> str:
+    def _visit_pack_expr(self, vars: list[HandleBinding]) -> str:
         if len(vars) == 1:
             return self.visit(vars[0])
 
@@ -261,32 +346,34 @@ class DSLPrettyPrinter(Visitor):
         )
 
     def visit_QuantumLambdaFunction(self, qlambda: QuantumLambdaFunction) -> str:
-        assert qlambda.func_decl is not None
-        gen_time_args = ", ".join(
-            qlambda.rename_params.get(arg_decl.name, arg_decl.name)
-            for arg_decl in qlambda.func_decl.get_positional_arg_decls()
-            if not isinstance(arg_decl, PortDeclaration)
-        )
-        quantum_args = ", ".join(
-            arg_decl.name
-            for arg_decl in qlambda.func_decl.get_positional_arg_decls()
-            if isinstance(arg_decl, PortDeclaration)
+        positional_args = ", ".join(
+            qlambda.pos_rename_params[idx]
+            for idx, arg_decl in enumerate(
+                qlambda.func_decl.positional_arg_declarations
+            )
         )
-        gen_time_arg_list = f"<{gen_time_args}>" if gen_time_args else ""
         body = self._visit_body(qlambda.body)
-        return f"lambda{gen_time_arg_list}({quantum_args}) {{\n{body}{self._indent}}}"
+        return f"lambda({positional_args}) {{\n{body}{self._indent}}}"
 
     def visit_HandleBinding(self, var_ref: HandleBinding) -> str:
         return var_ref.name
 
     def visit_SlicedHandleBinding(self, var_ref: SlicedHandleBinding) -> str:
-        return str(var_ref)
+        return f"{self.visit(var_ref.base_handle)}[{self.visit(var_ref.start)}:{self.visit(var_ref.end)}]"
 
     def visit_SubscriptHandleBinding(self, var_ref: SubscriptHandleBinding) -> str:
-        return str(var_ref)
+        return f"{self.visit(var_ref.base_handle)}[{self.visit(var_ref.index)}]"
+
+    def visit_FieldHandleBinding(self, var_ref: FieldHandleBinding) -> str:
+        return f"{self.visit(var_ref.base_handle)}.{self.visit(var_ref.field)}"
 
     def visit_ArithmeticOperation(self, arith_op: ArithmeticOperation) -> str:
-        op = "^=" if arith_op.inplace_result else "="
+        if arith_op.operation_kind == ArithmeticOperationKind.Assignment:
+            op = "="
+        elif arith_op.operation_kind == ArithmeticOperationKind.InplaceXor:
+            op = "^="
+        else:
+            op = "+="
         return f"{self._indent}{self.visit(arith_op.result_var)} {op} {self.visit(arith_op.expression)};\n"
 
     def visit_AmplitudeLoadingOperation(
@@ -294,7 +381,7 @@ class DSLPrettyPrinter(Visitor):
     ) -> str:
         return f"{self._indent}{self.visit(amplitude_loading_op.result_var)} *= {self.visit(amplitude_loading_op.expression)};\n"
 
-    def _print_bind_handles(self, handles: List[HandleBinding]) -> str:
+    def _print_bind_handles(self, handles: list[HandleBinding]) -> str:
         if len(handles) == 1:
             return self.visit(handles[0])
 
@@ -306,6 +393,9 @@ class DSLPrettyPrinter(Visitor):
     def visit_list(self, node: list) -> str:
         return "[" + ", ".join(self.visit(elem) for elem in node) + "]"
 
+    def visit_OperandIdentifier(self, op: OperandIdentifier) -> str:
+        return str(op)
+
     @property
     def _indent(self) -> str:
         return "  " * self._level

classiq/qmod/pretty_print/__init__.py

@@ -0,0 +1,7 @@
+from .pretty_printer import PythonPrettyPrinter
+
+__all__ = ["PythonPrettyPrinter"]
+
+
+def __dir__() -> list[str]:
+    return __all__