Merge pull request #40 from ColibrITD-SAS/feat-quit-setup

Allow exit with ctrl+c

Author: hJaffaliColibritd

docs/execution-extras.rst

@@ -64,7 +64,7 @@ __________
 Connection setup script 
 -----------------------
 
-.. automodule:: mpqp.execution.connection.setup_connections
+.. automodule:: mpqp_scripts.setup_connections
 
 On disk configuration manager
 -----------------------------

mpqp/__init__.py

@@ -1,5 +1,5 @@
 # pyright: reportUnusedImport=false
 from mpqp.core.circuit import QCircuit
+from mpqp.core.instruction import Instruction
 from mpqp.core.instruction.barrier import Barrier
 from mpqp.core.languages import Language
-from mpqp.core.instruction import Instruction

mpqp/tools/choice_tree.py

@@ -50,24 +50,29 @@ def run_choice_tree(question: QuestionNode):
     Args:
         question: Root question from which the choice tree will start
     """
-    # 3M-TODO: allow exit with Ctrl+C and Q
+    # 3M-TODO: allow exit with Q
     prev_args = []
     prev_message = ""
     next_question = question
-    while True:
-        option, _ = pick(
-            list(map(lambda a: a.label, next_question.answers)) + ["Exit"],
-            prev_message + "\n\n" + next_question.label,
-            indicator="=>",
-        )
-        if option == "Exit":
-            return
-        selected_answer = find(next_question.answers, lambda a: a.label == option)
-        prev_message, prev_args = selected_answer.action(*prev_args)
-        next_question = selected_answer.next_question
-        if next_question is None:
-            pick(["Press 'Enter' to continue"], prev_message, indicator="")
-            return
+    try:
+        while True:
+            option, _ = pick(
+                list(map(lambda a: a.label, next_question.answers)) + ["Exit"],
+                prev_message + "\n\n" + next_question.label,
+                indicator="=>",
+            )
+            if option == "Exit":
+                return
+            selected_answer = find(next_question.answers, lambda a: a.label == option)
+            prev_message, prev_args = selected_answer.action(*prev_args)
+            next_question = selected_answer.next_question
+            if next_question is None:
+                pick(["Press 'Enter' to continue"], prev_message, indicator="")
+                return
+
+    except KeyboardInterrupt:
+        print()
+        pass
 
 
 # Example:

mpqp/execution/connection/setup_connections.py mpqp_scripts/setup_connections.py

@@ -1,21 +1,23 @@
 #! /usr/bin/env python3
-"""This script helps you configuring the connections for all the supported 
-remote backends. In time, it will also guide you to retrieve the tokens,
-passwords, etc... but for now, it is a prerequisite that you already have these
-credentials to use this script.
+"""The ``setup_connections`` script helps you configuring the connections for
+all the supported remote backends. In time, it will also guide you to retrieve
+the tokens, passwords, etc... but for now, it is a prerequisite that you already
+have these credentials to use this script.
 
-Information concerning which provider is configured and related
-credentials are stored in the ``~/.mpqp`` file."""
+Information concerning which provider is configured and related credentials are
+stored in the ``~/.mpqp`` file."""
 
-import mpqp.execution.connection.aws_connection as awsc
-import mpqp.execution.connection.env_manager as env_m
-import mpqp.execution.connection.ibm_connection as ibmqc
-import mpqp.execution.connection.qlm_connection as qlmc
-from mpqp.tools.choice_tree import AnswerNode, QuestionNode, run_choice_tree
-from mpqp.tools.errors import IBMRemoteExecutionError
+import os
+
+os.environ["FOR_DISABLE_CONSOLE_CTRL_HANDLER"] = "1"
 
 
 def print_config_info():
+    import mpqp.execution.connection.aws_connection as awsc
+    import mpqp.execution.connection.env_manager as env_m
+    import mpqp.execution.connection.ibm_connection as ibmqc
+    from mpqp.tools.errors import IBMRemoteExecutionError
+
     """Prints the info concerning each provider's registered account."""
     print("===== IBM Quantum info : ===== ")
     try:
@@ -45,6 +47,10 @@ def print_config_info():
 def main_setup():
     """Function called by the script bellow to setup all connections or to get
     information about the existing ones."""
+    import mpqp.execution.connection.aws_connection as awsc
+    import mpqp.execution.connection.ibm_connection as ibmqc
+    import mpqp.execution.connection.qlm_connection as qlmc
+    from mpqp.tools.choice_tree import AnswerNode, QuestionNode, run_choice_tree
 
     setup_tree = QuestionNode(
         "~~~~~ MPQP REMOTE CONFIGURATION ~~~~~",
@@ -63,4 +69,7 @@ def main_setup():
 
 
 if __name__ == "__main__":
-    main_setup()
+    try:
+        main_setup()
+    except KeyboardInterrupt:
+        exit()

setup.py

@@ -1,4 +1,4 @@
-from setuptools import setup, find_packages
+from setuptools import find_packages, setup
 
 with open("README.md", "r", encoding="utf-8") as f:
     long_description = f.read()
@@ -32,7 +32,7 @@
     packages=find_packages(include=["mpqp*"]),
     entry_points={
         "console_scripts": [
-            "setup_connections = mpqp.execution.connection.setup_connections:main_setup",
+            "setup_connections = mpqp_scripts.setup_connections:main_setup",
         ]
     },
     project_urls={