robotcode-repl 2.6.2__py3-none-any.whl → 2.8.0.dev548__py3-none-any.whl

robotcode/repl/prompt_toolkit_interpreter.py

@@ -28,6 +28,7 @@ from prompt_toolkit.history import History, InMemoryHistory
 from robot import result, running
 
 from robotcode.plugin import Application
+from robotcode.robot.utils.markdown_docs import REFERENCE_KEYWORD, LinkResolver
 
 from ._pt.components import (
     _DEFAULT_STYLE,
@@ -121,12 +122,32 @@ class PromptToolkitConsoleInterpreter(ConsoleInterpreter):
             return self._session.prompt(prompt, default=prefill, completer=completer)
         return self._session.prompt(prompt, default=prefill)
 
+    def _end_read(self) -> None:
+        loop = self._session.app.loop
+        if loop is None:
+            # No event loop runs the prompt (yet, or any more).
+            super()._end_read()
+            return
+        # The signal handler can run inside a callback of the prompt's event loop, which
+        # would only report an error raised there; so the prompt ends through the loop.
+        loop.call_soon_threadsafe(self._end_prompt)
+
+    def _end_prompt(self) -> None:
+        app = self._session.app
+        if app.future is not None and not app.future.done():
+            app.exit(exception=EOFError())
+
+    def _report_interrupt(self, prompt: str) -> None:
+        # An aborted prompt has already ended its line.
+        del prompt
+        self._echo("KeyboardInterrupt")
+
     def make_completer(
         self, command_names: List[str], context_provider: Callable[[], Tuple[Any, Any]]
     ) -> Optional[Any]:
         return _RobotCompleter(command_names=command_names, context_provider=context_provider)
 
-    def show_doc(self, title: str, markdown: str, *, scroll_to: Optional[str] = None) -> None:
+    def show_doc(self, title: str, markdown: str, *, scroll_to: Optional[str] = None, outline: bool = False) -> None:
         """Display ``markdown`` in the fullscreen doc viewer.
 
         Blocks until the user closes the viewer (Esc / q / Enter). The
@@ -135,8 +156,9 @@ class PromptToolkitConsoleInterpreter(ConsoleInterpreter):
         untouched. Safe to call from inside a dot-command handler that
         runs between two `read_line` invocations. ``scroll_to`` opens the
         viewer scrolled to the first rendered line containing that text.
+        ``outline`` gives the page of a library a sidebar with its headings.
         """
-        self._doc_viewer.run(title, markdown, scroll_to=scroll_to)
+        self._doc_viewer.run(title, markdown, scroll_to=scroll_to, outline=outline)
 
     def _keyword_list_entry(self, owner_name: str, kw_name: str) -> str:
         """Render a `.kw` list entry as a link into the keyword's page.
@@ -148,6 +170,17 @@ class PromptToolkitConsoleInterpreter(ConsoleInterpreter):
         """
         return f"- [{kw_name}](kw:{quote(f'{owner_name}.{kw_name}')})"
 
+    def _keyword_link_resolver(self, owner_name: str) -> Optional[LinkResolver]:
+        """References to other keywords of the same owner open that
+        keyword's page, like the entries of the `.kw` list."""
+
+        def resolve(kind: str, name: str) -> Optional[str]:
+            if kind == REFERENCE_KEYWORD:
+                return f"kw:{quote(f'{owner_name}.{name}')}"
+            return None
+
+        return resolve
+
     def _resolve_doc_link(self, target: str) -> Optional[Tuple[str, str]]:
         """Resolve a `kw:<owner.keyword>` doc-viewer link to a keyword
         page; returns ``None`` for any other target so the viewer falls

robotcode/repl/run.py

@@ -1,5 +1,6 @@
 import io
 import sys
+from dataclasses import dataclass
 from pathlib import Path
 from typing import Optional, Tuple
 
@@ -25,6 +26,36 @@ RobotCode REPL
     repl
 """
 
+# Options from robot.toml, `args`, argument files or ROBOT_OPTIONS that are meant for real
+# suites. Applied to REPL_SUITE they deselect or skip its only test, so the REPL never
+# starts, or turn the session into a dry run in which nothing typed is executed. The
+# other skip options are dropped along with them.
+_IGNORED_ROBOT_OPTIONS = (
+    "include",
+    "exclude",
+    "suite",
+    "test",
+    "task",
+    "rerunfailed",
+    "rerunfailedsuites",
+    "dryrun",
+    "settag",
+    "skip",
+    "skiponfailure",
+    "skipteardownonexit",
+)
+
+
+@dataclass
+class ReplResult:
+    """How a REPL session ended."""
+
+    # Robot Framework's return code for the session test: 1 when it failed, 0 when it
+    # passed or when `statusrc` is switched off.
+    return_code: int
+    # The code given to `.exit`/`.quit`, None without one.
+    exit_code: Optional[int]
+
 
 def run_repl(
     interpreter: BaseInterpreter,
@@ -39,7 +70,8 @@ def run_repl(
     xunit: Optional[str] = None,
     source: Optional[Path] = None,
     files: Tuple[Path, ...] = (),
-) -> None:
+    statusrc: Optional[bool] = None,
+) -> ReplResult:
     robot_options_and_args: Tuple[str, ...] = ()
 
     if files:
@@ -53,16 +85,18 @@ def run_repl(
         robot_options_and_args += ("--pythonpath", pypath)
     if outputdir:
         robot_options_and_args += ("--outputdir", outputdir)
+    # Parsed after the configured options, so Robot's "last one wins" lets it override them.
+    if statusrc is not None:
+        robot_options_and_args += ("--statusrc" if statusrc else "--nostatusrc",)
 
     root_folder, _profile, cmd_options = handle_robot_options(app, (*robot_options_and_args, *(str(f) for f in files)))
 
-    if source is None:
-        source = Path.cwd() / "__repl_internal__.robot"
+    # Resolved before `app.chdir`, so a relative `--source` is relative to where the
+    # REPL was started (like FILES), not to the project root.
+    source = normalized_path(source if source is not None else Path.cwd() / "__repl_internal__.robot")
 
     with app.chdir(root_folder) as orig_folder:
         try:
-            curdir = normalized_path(source).parent if source is not None else Path.cwd()
-
             options, _ = RobotFrameworkEx(
                 app,
                 ["."],
@@ -71,7 +105,12 @@ def run_repl(
                 orig_folder=orig_folder,
             ).parse_arguments((*cmd_options, *robot_options_and_args))
 
-            interpreter.source = normalized_path(source) if source is not None else None
+            # Every key is dropped, but only options that are actually set (not e.g. `--nodryrun`) are reported.
+            ignored = [key for key in _IGNORED_ROBOT_OPTIONS if options.pop(key, None)]
+            if ignored:
+                app.verbose(f"Ignoring robot options in the REPL: {', '.join(ignored)}")
+
+            interpreter.source = source
 
             settings = RobotSettings(
                 options,
@@ -92,8 +131,9 @@ def run_repl(
                 sys.path = settings.pythonpath + sys.path
 
             with io.StringIO(REPL_SUITE) as suite_io:
-                model = get_model(suite_io, curdir=str(curdir).replace("\\", "\\\\"))
-                model.source = source
+                model = get_model(suite_io, curdir=str(source.parent).replace("\\", "\\\\"))
+                # RF < 6.1 expects a `str` suite source; RF 6.1+ converts it to a `Path` itself.
+                model.source = str(source)
 
                 suite = TestSuite.from_model(model)
                 suite.configure(**settings.suite_config)
@@ -109,3 +149,6 @@ def run_repl(
         except DataError as err:
             app.error(str(err))
             app.exit(DATA_ERROR)
+
+    # The prompt loop runs inside `suite.run`, so a code given to `.exit` is known by now.
+    return ReplResult(result.return_code, interpreter.exit_code)

{robotcode_repl-2.6.2.dist-info → robotcode_repl-2.8.0.dev548.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: robotcode-repl
-Version: 2.6.2
+Version: 2.8.0-dev.548
 Summary: RobotCode REPL for Robot Framework
 Project-URL: Homepage, https://robotcode.io
 Project-URL: Donate, https://opencollective.com/robotcode
@@ -20,13 +20,14 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: >=3.10
 Requires-Dist: prompt-toolkit!=3.0.52
-Requires-Dist: robotcode-runner==2.6.2
+Requires-Dist: robotcode-runner==2.8.0-dev.548
 Description-Content-Type: text/markdown
 
 # robotcode-repl

robotcode_repl-2.8.0.dev548.dist-info/RECORD

@@ -0,0 +1,30 @@
+robotcode/repl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+robotcode/repl/__version__.py,sha256=4qGR5Sg7VszfoERVpnszHJ_tsWJ0G_bUZdheH0_dqx4,30
+robotcode/repl/_backends.py,sha256=s7PV-HBhnAvwjn2le0cbOJ5hwLb4MjahUo6KWtRC3lc,110
+robotcode/repl/_indent.py,sha256=jwFKaHNvTWYpUwIWHu6JHoaCz7ljOxneR5sBrKcAjpI,3303
+robotcode/repl/_keyword_lookup.py,sha256=c8InMUDGKsw4wYmiqJzBr9GGxPC-59sRZHI0C-GWjFA,7748
+robotcode/repl/_progress.py,sha256=BaSbDGOy5UOXvD855Kd-lDrYbqPrYIWRVs507vJznK4,2586
+robotcode/repl/_session_export.py,sha256=sTSkLEMoSxNQOsII3xfDY8h-nV-mrem-4h6Iug7VQv4,2841
+robotcode/repl/base_interpreter.py,sha256=haLDzqVqrgs7uqmAGVjma8W8j110GcLA0KZlv0QHKxI,29856
+robotcode/repl/cli.py,sha256=jt0fvcQqZ40wX7GwfPawGDAd53BFCggsKSnydZYsHvc,22029
+robotcode/repl/console_interpreter.py,sha256=4PwPwsE3D6ZE8qYe0ZRc58gTuf3GWQQa7Hh5hqs7hJw,87781
+robotcode/repl/doc_cli.py,sha256=24ZzA37cOt21wPzggx1fi_K2_GCpBekA6xiAp5_WRE0,23122
+robotcode/repl/hooks.py,sha256=huqeT18sHWxG2dQNCGmgQUkb11CzVQkOoDgrDAy9hqg,238
+robotcode/repl/prompt_toolkit_interpreter.py,sha256=0xbh71AMbuJt8nyIRVv0gEfIhnRrmO7ZVNKVss5yfNw,13344
+robotcode/repl/py.typed,sha256=bWew9mHgMy8LqMu7RuqQXFXLBxh2CRx0dUbSx-3wE48,27
+robotcode/repl/run.py,sha256=IWeiGZm56vkLn-hykP-_mWLrdpDciNyMk33_dT-6EJA,5327
+robotcode/repl/Repl/__init__.py,sha256=-j2WxY3MzdLfsMvpa2wMs6WVF_eeJygdshtMN50r67U,43
+robotcode/repl/Repl/repl.py,sha256=k3vCeg9z_4cb2dgZ4YKHl4TD599gumVkQMImAzGl20Y,1628
+robotcode/repl/_debug/__init__.py,sha256=uQNyC3pdlpJZI3FRKzcp9BYEz1QtfBR--gsgKNomxrQ,908
+robotcode/repl/_debug/controller.py,sha256=D5lxDqrVmjRG4bAF9_5561TIQ9MzlvOphIBVW8DzhOU,33221
+robotcode/repl/_debug/types.py,sha256=3Vbecx44pruY0fXptEowKr_tYhljXSb6Sbr81YS22Mk,4597
+robotcode/repl/_pt/__init__.py,sha256=k1bJgYbKwp5ScYO8fSx0BVy8XW9Aw_8o0jTOWQTQdX8,411
+robotcode/repl/_pt/completion.py,sha256=BJD6sASKu1EfW0QPNKIDRc9O-8ttErXvxvnFb10lAxk,23318
+robotcode/repl/_pt/components.py,sha256=kuYVXJc4bFJq4b3-JtAtBYymvS7ssSwlKDldWYFGMuA,20152
+robotcode/repl/_pt/doc_viewer.py,sha256=iazNOQEvRygPSUyqKH2qOYShzdYqd7vufZcxPziJx8Q,71648
+robotcode/repl/_pt/history.py,sha256=Rvbdu4LtbYk9dPgYJY7D1JpfyT1SETUdNmtevxo21H4,1591
+robotcode/repl/_pt/lexer.py,sha256=YXtDMWQXPIocwceMXFlvULWyGXCDmqeAtTer_Ecuvwk,13925
+robotcode_repl-2.8.0.dev548.dist-info/METADATA,sha256=tIi2Mhdf0HfnLnCvUOt5LQwp_vcblkLrW1fEqG_Fatc,2835
+robotcode_repl-2.8.0.dev548.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+robotcode_repl-2.8.0.dev548.dist-info/entry_points.txt,sha256=lI4idVOEmSWxmmioejg-_QvHXTLySK6ZxJ13R_v8ykU,40
+robotcode_repl-2.8.0.dev548.dist-info/RECORD,,

{robotcode_repl-2.6.2.dist-info → robotcode_repl-2.8.0.dev548.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.30.1
+Generator: hatchling 1.32.4
 Root-Is-Purelib: true
 Tag: py3-none-any

robotcode_repl-2.6.2.dist-info/RECORD

@@ -1,29 +0,0 @@
-robotcode/repl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-robotcode/repl/__version__.py,sha256=53Sii4w6BIWn-1RhaTyqUO46gDe4nDCRQDAcpsWFH24,22
-robotcode/repl/_backends.py,sha256=s7PV-HBhnAvwjn2le0cbOJ5hwLb4MjahUo6KWtRC3lc,110
-robotcode/repl/_indent.py,sha256=0v0RYe8nWpfNZpCEQanVOuotA7WZJtfg5KFuybq18I0,3014
-robotcode/repl/_keyword_lookup.py,sha256=c8InMUDGKsw4wYmiqJzBr9GGxPC-59sRZHI0C-GWjFA,7748
-robotcode/repl/_progress.py,sha256=BaSbDGOy5UOXvD855Kd-lDrYbqPrYIWRVs507vJznK4,2586
-robotcode/repl/_session_export.py,sha256=sTSkLEMoSxNQOsII3xfDY8h-nV-mrem-4h6Iug7VQv4,2841
-robotcode/repl/base_interpreter.py,sha256=TZGHfoXgUATlFhQdpFS48DFO21oZrUxqosGJhMV8jnI,17786
-robotcode/repl/cli.py,sha256=A6QwuTYyOfTkQf1U6dWgd-pEY5_69deURaYa4AA59dU,19418
-robotcode/repl/console_interpreter.py,sha256=c88N5U7FNXCTwexj79iiAZ8Rq_o1TI7sEPmi1d92fZg,75687
-robotcode/repl/hooks.py,sha256=FyaV18JRJqAls3Sox8J3uRQFV59HDO92EdN6cQEEgPo,208
-robotcode/repl/prompt_toolkit_interpreter.py,sha256=iZnsS0hwbxxS_RFh799x1Ide0tvAghEI25R7JF8lC4E,11939
-robotcode/repl/py.typed,sha256=bWew9mHgMy8LqMu7RuqQXFXLBxh2CRx0dUbSx-3wE48,27
-robotcode/repl/run.py,sha256=ISAU_m5nGwVQqBnjLCy30oBbIvtYQsU-aknkSJODPGw,3581
-robotcode/repl/Repl/__init__.py,sha256=-j2WxY3MzdLfsMvpa2wMs6WVF_eeJygdshtMN50r67U,43
-robotcode/repl/Repl/repl.py,sha256=-uYIceM5OQ2uvkc4WUBJ1SjQjT3avusoeSBVx9UnUGg,1129
-robotcode/repl/_debug/__init__.py,sha256=uQNyC3pdlpJZI3FRKzcp9BYEz1QtfBR--gsgKNomxrQ,908
-robotcode/repl/_debug/controller.py,sha256=DOs3MM1AVxui0g5I1WdNA4nwGgeUdOhtfQogRE-4KC0,31263
-robotcode/repl/_debug/types.py,sha256=9bj3oi99wI3KsWNm7xs9GrxizaOw8WKDd7CCxrqxhAs,4363
-robotcode/repl/_pt/__init__.py,sha256=k1bJgYbKwp5ScYO8fSx0BVy8XW9Aw_8o0jTOWQTQdX8,411
-robotcode/repl/_pt/completion.py,sha256=BJD6sASKu1EfW0QPNKIDRc9O-8ttErXvxvnFb10lAxk,23318
-robotcode/repl/_pt/components.py,sha256=hMZl9K82gc1ONNUa0kuTCzyHeMyiqs0FG0aBSd3-Q-c,20094
-robotcode/repl/_pt/doc_viewer.py,sha256=_WAkJP8U3eslj2aWrNaOknLyYzdpKUsWeWuVC3PB6Y0,55635
-robotcode/repl/_pt/history.py,sha256=Rvbdu4LtbYk9dPgYJY7D1JpfyT1SETUdNmtevxo21H4,1591
-robotcode/repl/_pt/lexer.py,sha256=EIPGOkUaQie0PGa3lym0-s3CHHvLZiIxvz5sJNo3jdQ,13725
-robotcode_repl-2.6.2.dist-info/METADATA,sha256=RSThPSpI0PZIHMFNjl8hYkFtMYIO9vkNVHB4pICOGyg,2768
-robotcode_repl-2.6.2.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
-robotcode_repl-2.6.2.dist-info/entry_points.txt,sha256=lI4idVOEmSWxmmioejg-_QvHXTLySK6ZxJ13R_v8ykU,40
-robotcode_repl-2.6.2.dist-info/RECORD,,