qiskit_classroom.input_view

  1"""Widget for converting informations"""
  2
  3#  Licensed to the Apache Software Foundation (ASF) under one
  4#  or more contributor license agreements.  See the NOTICE file
  5#  distributed with this work for additional information
  6#  regarding copyright ownership.  The ASF licenses this file
  7#  to you under the Apache License, Version 2.0 (the
  8#  "License"); you may not use this file except in compliance
  9#  with the License.  You may obtain a copy of the License at
 10#
 11#    http://www.apache.org/licenses/LICENSE-2.0
 12#
 13#  Unless required by applicable law or agreed to in writing,
 14#  software distributed under the License is distributed on an
 15#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 16#  KIND, either express or implied.  See the License for the
 17#  specific language governing permissions and limitations
 18#  under the License.
 19
 20# pylint: disable=no-name-in-module
 21from PySide6.QtGui import QDragEnterEvent, QDropEvent
 22from PySide6.QtWidgets import (
 23    QWidget,
 24    QVBoxLayout,
 25    QHBoxLayout,
 26    QLabel,
 27    QLineEdit,
 28    QPlainTextEdit,
 29    QPushButton,
 30    QFileDialog,
 31    QCheckBox,
 32)
 33from PySide6.QtCore import Qt, Signal
 34
 35from .expression_enum import QuantumExpression
 36from .input_model import Input, QuantumCircuitInput, DiracInput, MatrixInput
 37
 38
 39EXPRESSION_PLACEHOLDERS: dict[QuantumExpression:str] = {
 40    QuantumExpression.CIRCUIT: """from qiskit import QuantumCircuit
 41quantum_circuit = QuantumCircuit(2, 2)
 42quantum_circuit.x(0)
 43quantum_circuit.cx(0, 1)
 44""",
 45    QuantumExpression.DIRAC: "sqrt(2)*|00>/2+sqrt(2)*|11>/2",
 46    QuantumExpression.MATRIX: """[[1, 0, 0, 0],
 47[0, 0, 0, 1],
 48[0, 0, 1, 0],
 49[0, 1, 0, 0]]""",
 50    QuantumExpression.NONE: "",
 51}
 52
 53
 54class ExpressionPlainText(QPlainTextEdit):
 55    """
 56    ExpressionPlainText
 57    """
 58
 59    file_dropped = Signal(object)
 60
 61    def __init__(self, parent) -> None:
 62        super().__init__(parent=parent)
 63        self.setAcceptDrops(True)
 64        self.set_ui()
 65
 66    def set_ui(self) -> None:
 67        """
 68        set UI
 69        """
 70        self.setFixedHeight(250)
 71
 72    def dragEnterEvent(self, event: QDragEnterEvent) -> None:
 73        # pylint: disable=invalid-name
 74        """
 75        handle drag event and accept only url
 76        """
 77        if event.mimeData().hasUrls():
 78            event.accept()
 79        else:
 80            event.ignore()
 81
 82    def dropEvent(self, event: QDropEvent) -> None:
 83        # pylint: disable=invalid-name
 84        """
 85        handle drop event and emit file imported event
 86        """
 87        if event.mimeData().hasUrls():
 88            files = [u.toLocalFile() for u in event.mimeData().urls()]
 89            self.file_dropped.emit(files)
 90            event.accept()
 91
 92    def set_placeholder_text(self, expression: QuantumExpression) -> None:
 93        """set placeholder for expression plain text
 94
 95        Args:
 96            expression (QuantumExpression): selection
 97        """
 98        self.setPlaceholderText("")
 99        self.setPlaceholderText(EXPRESSION_PLACEHOLDERS[expression])
100
101
102class InputWidget(QWidget):
103    """Widget group for certain input"""
104
105    def set_ui(self) -> None:
106        """show widgets"""
107
108    def get_input(self) -> Input:
109        """return user input
110
111        Returns:
112            Input: user input class
113        """
114        return Input
115
116
117class QuantumCircuitInputWidget(InputWidget):
118    """Widget group for QuantumCircuit Input"""
119
120    file_imported = Signal(str)
121
122    def __init__(self, parent: QWidget) -> None:
123        super().__init__(parent)
124        self.set_ui()
125
126    def set_ui(self):
127        """set ui for QuantumCircuitInputWidget"""
128        vbox = QVBoxLayout(self)
129        vbox.setAlignment(Qt.AlignmentFlag.AlignCenter)
130
131        value_name_box = QHBoxLayout()
132        value_name_label = QLabel("value name")
133        value_name_box.addWidget(value_name_label)
134        self.value_name_text = QLineEdit()
135        self.value_name_text.setPlaceholderText("input value name of quantum circuit")
136        value_name_box.addWidget(self.value_name_text)
137
138        load_box = QHBoxLayout()
139        load_box.addStretch()
140        self.load_push_button = QPushButton("or load...")
141        self.load_push_button.setMinimumWidth(150)
142        self.load_push_button.clicked.connect(self.on_file_load_clicked)
143        load_box.addWidget(self.load_push_button)
144
145        vbox.addLayout(value_name_box)
146        vbox.addLayout(load_box)
147
148    def on_file_load_clicked(self) -> None:
149        """
150        handling file dialog
151        """
152        filename = QFileDialog.getOpenFileName(
153            self, "Open .py", "", "python3 script (*.py)"
154        )[0]
155        self.file_imported.emit(filename)
156
157    def get_input(self) -> QuantumCircuitInput:
158        user_input = QuantumCircuitInput(
159            self.value_name_text.text().strip(),
160        )
161        return user_input
162
163
164class DiracInputWidget(InputWidget):
165    """Widget group for Dirac Notaion input"""
166
167    def __init__(self, parent: QWidget) -> None:
168        super().__init__(parent)
169        self.set_ui()
170
171    def get_input(self) -> DiracInput:
172        return DiracInput()
173
174
175class MatrixInputWidget(InputWidget):
176    """Widget group for matrix input"""
177
178    matrix_plain_text: QPlainTextEdit
179    num_cubit_text: QLineEdit
180    do_measure_checkbox: QCheckBox
181
182    def __init__(self, parent: QWidget) -> None:
183        super().__init__(parent)
184        self.set_ui()
185
186    def set_ui(self):
187        vbox = QVBoxLayout(self)
188        vbox.setAlignment(Qt.AlignmentFlag.AlignCenter)
189
190        hbox = QHBoxLayout()
191        num_cubit_label = QLabel("number of cubit")
192        self.num_cubit_text = QLineEdit(self)
193        self.num_cubit_text.setToolTip("input 3 digits number")
194        self.do_measure_checkbox = QCheckBox("do measure this circuit?", self)
195        self.do_measure_checkbox.setToolTip("do measure all qubits")
196
197        hbox.addWidget(num_cubit_label)
198        hbox.addWidget(self.num_cubit_text)
199        hbox.addWidget(self.do_measure_checkbox)
200        vbox.addLayout(hbox)
201
202    def get_input(self) -> Input:
203        return MatrixInput(
204            int(self.num_cubit_text.text()), self.do_measure_checkbox.isChecked()
205        )