fix: rename prompt() to safe_prompt() to avoid module shadowing

docs/pages/advanced.rst

@@ -104,7 +104,7 @@ Safe
 
 The following are safe (capture keyboard interrupts):
 
-* :meth:`~questionary.prompt`;
+* :func:`~questionary.safe_prompt`;
 
 * :attr:`~questionary.Form.ask` on :class:`~questionary.Form` (returned by
   :meth:`~questionary.form`);
@@ -121,7 +121,7 @@ Here is an example:
 
     # Questionary handles keyboard interrupt and returns `None` if the
     # user hits e.g. `Ctrl+C`
-    prompt(...)
+    safe_prompt(...)
 
 Unsafe
 ******
@@ -136,7 +136,7 @@ The following are unsafe (do not catch keyboard interrupts):
 * :attr:`~questionary.Question.unsafe_ask` on :class:`~questionary.Question`,
   which is returned by the various prompt functions (e.g. :meth:`~questionary.text`,
   :meth:`~questionary.checkbox`).
-  
+
 As a caller you must handle keyboard interrupts yourself
 when calling these methods. Here is an example:
 
@@ -252,7 +252,7 @@ them using a configuration dictionary:
 
 .. code-block:: python3
 
-  from questionary import prompt
+  from questionary import safe_prompt
 
   questions = [
       {
@@ -268,9 +268,9 @@ them using a configuration dictionary:
       }
   ]
 
-  answers = prompt(questions)
+  answers = safe_prompt(questions)
 
-The questions will be prompted one after another and ``prompt`` will return
+The questions will be prompted one after the other and ``safe_prompt`` will return
 as soon as all of them are answered. The returned ``answers``
 will be a dictionary containing the responses, e.g.
 
@@ -314,10 +314,9 @@ add the following optional parameters:
 
 ``filter`` (optional)
   Receive the user input and return the filtered value to be
-  used inside the program. 
+  used inside the program.
 
-Further information can be found at the :class:`questionary.prompt`
-documentation.
+Further information can be found in the :func:`~questionary.safe_prompt` documentation.
 
 .. _random_label:
 
@@ -345,14 +344,14 @@ Depending on the route the user took, the result will look like the following:
 
 .. code-block:: python3
 
-  { 
+  {
       'conditional_step': False,
       'second_question': 'Test input'   # Free form text
   }
 
 .. code-block:: python3
 
-  { 
+  {
       'conditional_step': True,
       'next_question': 'questionary',
       'second_question': 'Test input'   # Free form text

docs/pages/api_reference.rst

@@ -21,6 +21,6 @@ API Reference
 
 .. automethod:: questionary::form
 
-.. automethod:: questionary::prompt
+.. automethod:: questionary::safe_prompt
 
 .. automethod:: questionary::unsafe_prompt

docs/pages/quickstart.rst

@@ -82,7 +82,7 @@ The printed output will have the following format:
 
   {'first': True, 'second': 'item2'}
 
-The :meth:`~questionary.prompt` function also allows you to ask a
+The :func:`~questionary.safe_prompt` function also allows you to ask a
 collection of questions, however instead of taking :class:`~questionary.Question`
 instances, it takes a dictionary:
 
@@ -105,7 +105,7 @@ instances, it takes a dictionary:
     },
   ]
 
-  questionary.prompt(questions)
+  questionary.safe_prompt(questions)
 
 The format of the returned answers is the same as the one for
 :meth:`~questionary.form`. You can find more details on the configuration

examples/advanced_workflow.py

@@ -1,7 +1,7 @@
 from pprint import pprint
 
 from questionary import Separator
-from questionary import prompt
+from questionary import safe_prompt
 
 
 def ask_dictstyle(**kwargs):
@@ -51,7 +51,7 @@ def ask_dictstyle(**kwargs):
             "when": lambda x: x["second_question"] == "other",
         },
     ]
-    return prompt(questions, **kwargs)
+    return safe_prompt(questions, **kwargs)
 
 
 if __name__ == "__main__":

examples/autocomplete_ants.py

@@ -8,7 +8,7 @@
 from examples import custom_style_fancy
 from questionary import ValidationError
 from questionary import Validator
-from questionary import prompt
+from questionary import safe_prompt
 
 
 class PolyergusValidator(Validator):
@@ -81,7 +81,7 @@ def ask_dictstyle(**kwargs):
         }
     ]
 
-    return prompt(questions, style=custom_style_fancy, **kwargs)
+    return safe_prompt(questions, style=custom_style_fancy, **kwargs)
 
 
 if __name__ == "__main__":

examples/checkbox_separators.py

@@ -8,7 +8,7 @@
 from examples import custom_style_dope
 from questionary import Choice
 from questionary import Separator
-from questionary import prompt
+from questionary import safe_prompt
 
 
 def ask_pystyle(**kwargs):
@@ -48,7 +48,7 @@ def ask_dictstyle(**kwargs):
         }
     ]
 
-    return prompt(questions, style=custom_style_dope, **kwargs)
+    return safe_prompt(questions, style=custom_style_dope, **kwargs)
 
 
 if __name__ == "__main__":

examples/confirm_continue.py

@@ -6,7 +6,7 @@
 
 import questionary
 from examples import custom_style_dope
-from questionary import prompt
+from questionary import safe_prompt
 
 
 def ask_pystyle(**kwargs):
@@ -29,7 +29,7 @@ def ask_dictstyle(**kwargs):
         }
     ]
 
-    return prompt(questions, style=custom_style_dope, **kwargs)
+    return safe_prompt(questions, style=custom_style_dope, **kwargs)
 
 
 if __name__ == "__main__":

examples/dependent_selects.py

@@ -1,6 +1,6 @@
 from pprint import pprint
 
-from questionary import prompt
+from questionary import safe_prompt
 
 OPTIONS = {"key1": ["k1v1", "k1v2"], "key2": ["k2v1", "k2v2"]}
 
@@ -20,7 +20,7 @@ def ask_dictstyle(**kwargs):
             "choices": lambda x: OPTIONS[x["key"]],
         },
     ]
-    return prompt(questions, **kwargs)
+    return safe_prompt(questions, **kwargs)
 
 
 if __name__ == "__main__":

examples/password_git.py

@@ -6,7 +6,7 @@
 
 import questionary
 from examples import custom_style_dope
-from questionary import prompt
+from questionary import safe_prompt
 
 
 def ask_pystyle(**kwargs):
@@ -24,7 +24,7 @@ def ask_dictstyle(**kwargs):
         {"type": "password", "message": "Enter your git password", "name": "password"}
     ]
 
-    return prompt(questions, style=custom_style_dope, **kwargs)
+    return safe_prompt(questions, style=custom_style_dope, **kwargs)
 
 
 if __name__ == "__main__":

examples/rawselect_separator.py

@@ -7,7 +7,7 @@
 import questionary
 from examples import custom_style_dope
 from questionary import Separator
-from questionary import prompt
+from questionary import safe_prompt
 
 
 def ask_pystyle(**kwargs):
@@ -45,7 +45,7 @@ def ask_dictstyle(**kwargs):
         },
     ]
 
-    return prompt(questions, style=custom_style_dope, **kwargs)
+    return safe_prompt(questions, style=custom_style_dope, **kwargs)
 
 
 if __name__ == "__main__":

examples/select_restaurant.py

@@ -8,7 +8,7 @@
 from examples import custom_style_dope
 from questionary import Choice
 from questionary import Separator
-from questionary import prompt
+from questionary import safe_prompt
 
 
 def ask_pystyle(**kwargs):
@@ -49,7 +49,7 @@ def ask_dictstyle(**kwargs):
         }
     ]
 
-    return prompt(questions, style=custom_style_dope, **kwargs)
+    return safe_prompt(questions, style=custom_style_dope, **kwargs)
 
 
 if __name__ == "__main__":

examples/select_search.py

@@ -8,7 +8,7 @@
 from examples import custom_style_dope
 from questionary import Choice
 from questionary import Separator
-from questionary import prompt
+from questionary import safe_prompt
 
 
 def ask_pystyle(**kwargs):
@@ -55,7 +55,7 @@ def ask_dictstyle(**kwargs):
         }
     ]
 
-    return prompt(questions, style=custom_style_dope, **kwargs)
+    return safe_prompt(questions, style=custom_style_dope, **kwargs)
 
 
 if __name__ == "__main__":

examples/text_phone_number.py

@@ -9,7 +9,7 @@
 from examples import custom_style_dope
 from questionary import ValidationError
 from questionary import Validator
-from questionary import prompt
+from questionary import safe_prompt
 
 
 class PhoneNumberValidator(Validator):
@@ -50,7 +50,7 @@ def ask_dictstyle(**kwargs):
         }
     ]
 
-    return prompt(questions, style=custom_style_dope, **kwargs)
+    return safe_prompt(questions, style=custom_style_dope, **kwargs)
 
 
 if __name__ == "__main__":

questionary/__init__.py

@@ -7,8 +7,8 @@
 from questionary.form import Form
 from questionary.form import FormField
 from questionary.form import form
-from questionary.prompt import prompt
 from questionary.prompt import prompt_async
+from questionary.prompt import safe_prompt
 from questionary.prompt import unsafe_prompt
 from questionary.prompt import unsafe_prompt_async
 
@@ -44,7 +44,7 @@
     # utility methods
     "print",
     "form",
-    "prompt",
+    "safe_prompt",
     "prompt_async",
     "unsafe_prompt",
     "unsafe_prompt_async",

questionary/prompt.py

@@ -193,7 +193,7 @@ async def prompt_async(
         return {}
 
 
-def prompt(
+def safe_prompt(
     questions: Union[Dict[str, Any], Iterable[Mapping[str, Any]]],
     answers: Optional[Mapping[str, Any]] = None,
     patch_stdout: bool = False,
@@ -229,6 +229,7 @@ def prompt(
                       are printing to stdout.
 
         kbi_msg: The message to be printed on a keyboard interrupt.
+
         true_color: Use true color output.
 
         color_depth: Color depth to use. If ``true_color`` is set to true then this
@@ -244,7 +245,6 @@ def prompt(
     Returns:
         Dictionary of question answers.
     """
-
     try:
         return unsafe_prompt(questions, answers, patch_stdout, true_color, **kwargs)
     except KeyboardInterrupt:

tests/test_prompt.py

@@ -1,18 +1,18 @@
 import pytest
 
 from questionary.prompt import PromptParameterException
-from questionary.prompt import prompt
+from questionary.prompt import safe_prompt
 from tests.utils import patched_prompt
 
 
 def test_missing_message():
     with pytest.raises(PromptParameterException):
-        prompt([{"type": "confirm", "name": "continue", "default": True}])
+        safe_prompt([{"type": "confirm", "name": "continue", "default": True}])
 
 
 def test_missing_type():
     with pytest.raises(PromptParameterException):
-        prompt(
+        safe_prompt(
             [
                 {
                     "message": "Do you want to continue?",
@@ -25,7 +25,7 @@ def test_missing_type():
 
 def test_missing_name():
     with pytest.raises(PromptParameterException):
-        prompt(
+        safe_prompt(
             [
                 {
                     "type": "confirm",
@@ -38,7 +38,7 @@ def test_missing_name():
 
 def test_invalid_question_type():
     with pytest.raises(ValueError):
-        prompt(
+        safe_prompt(
             [
                 {
                     "type": "mytype",
@@ -53,7 +53,7 @@ def test_invalid_question_type():
 def test_missing_print_message():
     """Test 'print' raises exception if missing 'message'"""
     with pytest.raises(PromptParameterException):
-        prompt(
+        safe_prompt(
             [
                 {
                     "name": "test",

tests/utils.py

@@ -5,7 +5,7 @@
 from prompt_toolkit.input.defaults import create_pipe_input
 from prompt_toolkit.output import DummyOutput
 
-from questionary import prompt
+from questionary import safe_prompt
 from questionary.prompts import prompt_by_name
 from questionary.utils import is_prompt_toolkit_3
 
@@ -72,7 +72,7 @@ def patched_prompt(questions, text, **kwargs):
     def run(inp):
         # noinspection PyUnresolvedReferences
         inp.send_text(text)
-        result = prompt(questions, input=inp, output=DummyOutput(), **kwargs)
+        result = safe_prompt(questions, input=inp, output=DummyOutput(), **kwargs)
         return result
 
     return execute_with_input_pipe(run)