robotcode 2.6.2__py3-none-any.whl → 2.7.0__py3-none-any.whl

robotcode/cli/__init__.py

@@ -2,6 +2,9 @@ import json
 import logging
 import logging.config
 import os
+import shlex
+import subprocess
+import sys
 from pathlib import Path
 from typing import Any, List, Literal, Optional
 
@@ -18,6 +21,7 @@ from robotcode.plugin import (
 from robotcode.plugin._agent_detection import is_running_in_ai_agent
 from robotcode.plugin.click_helper.aliases import AliasedGroup
 from robotcode.plugin.click_helper.types import EnumChoice
+from robotcode.plugin.click_helper.wrappable import WRAPPER_APPLIED_ENV, is_wrappable
 from robotcode.plugin.manager import PluginManager
 
 from .__version__ import __version__
@@ -46,6 +50,99 @@ class RobotCodeFormatter(logging.Formatter):
         super().__init__(*args, defaults=defaults, **kwargs)
 
 
+def _maybe_reexec_under_wrapper(
+    ctx: click.Context, app: Application, cli_wrapper: Optional[str] = None, no_wrapper: bool = False
+) -> None:
+    """Re-execute this process through a configured ``wrapper`` command.
+
+    When a ``wrapper`` is configured - either via ``--wrapper`` on the command
+    line (``cli_wrapper``) or the selected profile's ``wrapper`` (e.g. to run
+    the tests inside a specific X11/Wayland session) - and the invoked command
+    is ``@wrappable`` (i.e. it executes Robot Framework), the process
+    re-executes itself **once** through that command before Robot Framework
+    starts. ``--wrapper`` overrides the profile; ``--no-wrapper`` disables
+    wrapping for this run. The guard env var prevents infinite recursion and
+    lets an outer layer suppress the re-exec by setting it itself.
+    """
+    if no_wrapper:
+        if cli_wrapper:
+            app.warning("Ignoring --wrapper because --no-wrapper was given.")
+        return
+    if os.environ.get(WRAPPER_APPLIED_ENV):
+        return
+
+    sub_name = ctx.invoked_subcommand
+    if not sub_name:
+        return
+    # The command itself opts in via @wrappable; aliases resolve to the same
+    # command object, so this is alias-safe and needs no central name list.
+    sub_cmd = ctx.command.get_command(ctx, sub_name) if isinstance(ctx.command, click.Group) else None
+    if sub_cmd is None or not is_wrappable(sub_cmd):
+        if cli_wrapper:
+            app.warning(f"Ignoring --wrapper: '{sub_name}' does not execute Robot Framework.")
+        return
+
+    from robotcode.robot.config.loader import load_robot_config_from_path
+    from robotcode.robot.config.utils import get_config_files
+
+    profile_wrapper = None
+    try:
+        config_files, _, _ = get_config_files(
+            config_files=app.config.config_files,
+            root_folder=app.config.root,
+            no_vcs=app.config.no_vcs,
+            verbose_callback=app.verbose,
+        )
+        # `evaluated_with_env` also applies the profile's `env` to `os.environ`,
+        # so the wrapper command can rely on it.
+        profile = (
+            load_robot_config_from_path(*config_files, verbose_callback=app.verbose)
+            .combine_profiles(*(app.config.profiles or []), verbose_callback=app.verbose, error_callback=app.error)
+            .evaluated_with_env(verbose_callback=app.verbose, error_callback=app.error)
+        )
+        profile_wrapper = profile.wrapper
+    except Exception as e:
+        # Don't fail early on config problems here; the actual command loads the
+        # config again and reports errors properly. An explicit --wrapper is
+        # still honored below.
+        message = str(e)
+        app.verbose(lambda: f"Skipping profile wrapper detection: {message}")
+
+    # `--wrapper` overrides the profile's `wrapper`. The evaluated profile turns
+    # StringExpression entries into plain strings.
+    if cli_wrapper:
+        wrapper = shlex.split(cli_wrapper)
+    elif profile_wrapper:
+        wrapper = [str(w) for w in profile_wrapper]
+    else:
+        return
+
+    # Rebuild the invocation the way this process was actually started, so the
+    # re-exec finds robotcode even when it runs from a bundled path (VS Code) and
+    # is not installed in the interpreter. `launcher_script` is set only when we
+    # were started through a bundled entry (its `__main__` sets it) or an explicit
+    # `--launcher-script`; otherwise robotcode is importable directly and
+    # `-m robotcode.cli` is correct. We deliberately do NOT consult the
+    # ROBOTCODE_BUNDLED_ROBOTCODE_MAIN env var: VS Code sets it in every terminal,
+    # so a directly started robotcode would be diverted to the bundled copy.
+    # Mirrors the debug launcher's `debugger_script` handling.
+    entry = [str(app.config.launcher_script)] if app.config.launcher_script else ["-m", "robotcode.cli"]
+    command = [*wrapper, sys.executable, *entry, *sys.argv[1:]]
+    app.verbose(lambda: "Running under wrapper: " + " ".join(command))
+
+    # Run robotcode again under the wrapper; the guard env stops the spawned
+    # robotcode from wrapping a second time. On POSIX we replace this process with
+    # execvp (no extra process); Windows has no such exec, so there we spawn the
+    # command, wait, and forward its exit code.
+    os.environ[WRAPPER_APPLIED_ENV] = "1"
+    try:
+        if sys.platform == "win32":
+            sys.exit(subprocess.run(command).returncode)
+        os.execvp(command[0], command)
+    except OSError as e:
+        raise click.ClickException(f"Failed to execute wrapper command {wrapper!r}: {e}") from e
+
+
 @click.group(
     cls=AliasedGroup,
     context_settings={"auto_envvar_prefix": "ROBOTCODE"},
@@ -129,6 +226,20 @@ class RobotCodeFormatter(logging.Formatter):
     help="Enables verbose mode.",
     show_envvar=True,
 )
+@click.option(
+    "--wrapper",
+    type=str,
+    default=None,
+    show_envvar=True,
+    help='Command prefix to run the test execution through, e.g. `--wrapper "xvfb-run -a"`. '
+    "Split like a shell command. Applies only to commands that execute Robot Framework "
+    "(run/debug/repl). Overrides the profile's `wrapper`.",
+)
+@click.option(
+    "--no-wrapper",
+    is_flag=True,
+    help="Disable any configured `wrapper` (profile or --wrapper) for this run.",
+)
 @click.option("--log", is_flag=True, help="Enables logging.", show_envvar=True)
 @click.option(
     "--log-level",
@@ -230,7 +341,9 @@ class RobotCodeFormatter(logging.Formatter):
 )
 @click.version_option(version=__version__, prog_name="robotcode")
 @pass_application
+@click.pass_context
 def robotcode(
+    ctx: click.Context,
     app: Application,
     config_files: Optional[List[Path]],
     profiles: Optional[List[str]],
@@ -249,6 +362,8 @@ def robotcode(
     log_calls: bool,
     log_config: Optional[Path],
     default_path: Optional[List[str]],
+    wrapper: Optional[str] = None,
+    no_wrapper: bool = False,
     launcher_script: Optional[str] = None,
     debugpy: bool = False,
     debugpy_port: int = 5678,
@@ -295,6 +410,8 @@ def robotcode(
     app.config.log_level = log_level
     app.config.log_calls = log_calls
 
+    _maybe_reexec_under_wrapper(ctx, app, wrapper, no_wrapper)
+
     if log_config:
         if log_calls:
             LoggingDescriptor.set_call_tracing(True)

robotcode/cli/__version__.py

@@ -1 +1 @@
-__version__ = "2.6.2"
+__version__ = "2.7.0"

{robotcode-2.6.2.dist-info → robotcode-2.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotcode
-Version: 2.6.2
+Version: 2.7.0
 Summary: Command line interface for RobotCode
 Project-URL: Homepage, https://robotcode.io
 Project-URL: Donate, https://opencollective.com/robotcode
@@ -33,35 +33,35 @@ Classifier: Topic :: Text Editors :: Integrated Development Environments (IDE)
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: >=3.10
-Requires-Dist: robotcode-core==2.6.2
-Requires-Dist: robotcode-plugin==2.6.2
-Requires-Dist: robotcode-robot==2.6.2
+Requires-Dist: robotcode-core==2.7.0
+Requires-Dist: robotcode-plugin==2.7.0
+Requires-Dist: robotcode-robot==2.7.0
 Provides-Extra: all
 Requires-Dist: docutils; extra == 'all'
 Requires-Dist: pyyaml>=5.4; extra == 'all'
-Requires-Dist: robotcode-analyze==2.6.2; extra == 'all'
-Requires-Dist: robotcode-debugger==2.6.2; extra == 'all'
-Requires-Dist: robotcode-language-server==2.6.2; extra == 'all'
-Requires-Dist: robotcode-repl-server==2.6.2; extra == 'all'
-Requires-Dist: robotcode-repl==2.6.2; extra == 'all'
-Requires-Dist: robotcode-runner==2.6.2; extra == 'all'
+Requires-Dist: robotcode-analyze==2.7.0; extra == 'all'
+Requires-Dist: robotcode-debugger==2.7.0; extra == 'all'
+Requires-Dist: robotcode-language-server==2.7.0; extra == 'all'
+Requires-Dist: robotcode-repl-server==2.7.0; extra == 'all'
+Requires-Dist: robotcode-repl==2.7.0; extra == 'all'
+Requires-Dist: robotcode-runner==2.7.0; extra == 'all'
 Requires-Dist: robotframework-robocop>=6.0.0; extra == 'all'
 Provides-Extra: analyze
-Requires-Dist: robotcode-analyze==2.6.2; extra == 'analyze'
+Requires-Dist: robotcode-analyze==2.7.0; extra == 'analyze'
 Provides-Extra: debugger
-Requires-Dist: robotcode-debugger==2.6.2; extra == 'debugger'
+Requires-Dist: robotcode-debugger==2.7.0; extra == 'debugger'
 Provides-Extra: languageserver
-Requires-Dist: robotcode-language-server==2.6.2; extra == 'languageserver'
+Requires-Dist: robotcode-language-server==2.7.0; extra == 'languageserver'
 Provides-Extra: lint
 Requires-Dist: robotframework-robocop>=2.0.0; extra == 'lint'
 Provides-Extra: repl
-Requires-Dist: robotcode-repl==2.6.2; extra == 'repl'
+Requires-Dist: robotcode-repl==2.7.0; extra == 'repl'
 Provides-Extra: replserver
-Requires-Dist: robotcode-repl-server==2.6.2; extra == 'replserver'
+Requires-Dist: robotcode-repl-server==2.7.0; extra == 'replserver'
 Provides-Extra: rest
 Requires-Dist: docutils; extra == 'rest'
 Provides-Extra: runner
-Requires-Dist: robotcode-runner==2.6.2; extra == 'runner'
+Requires-Dist: robotcode-runner==2.7.0; extra == 'runner'
 Provides-Extra: yaml
 Requires-Dist: pyyaml>=5.4; extra == 'yaml'
 Description-Content-Type: text/markdown

robotcode-2.7.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+robotcode/cli/__init__.py,sha256=qvIUqcHP8K1FNyu3whFDe6M_Wyeo_SKCqwBxtPeQfy0,15608
+robotcode/cli/__main__.py,sha256=hX3nwROMTnsYGT1KS0rXUYrslu9sFzctYdAh66Rcckw,153
+robotcode/cli/__version__.py,sha256=EtKWW0Hnl5oWglRNH0HZigvcDT2FEs58ek8buJdwW1E,22
+robotcode/cli/py.typed,sha256=bWew9mHgMy8LqMu7RuqQXFXLBxh2CRx0dUbSx-3wE48,27
+robotcode/cli/commands/__init__.py,sha256=XJHRt_YwMO2Ni2EfL2aj4jkJXMVG6NGFTpzvSVgIRnQ,92
+robotcode/cli/commands/config.py,sha256=0Jmf7HDIo7IIaOMU9M_bYi7PdHAfcae6x3SW93NA3EA,10481
+robotcode/cli/commands/profiles.py,sha256=5H9lvSVCMggWXf0IH54QtgDgqupEEvpcUrEsTZvZsNM,6127
+robotcode-2.7.0.dist-info/METADATA,sha256=nJWf0wXHOE5LlTfA-cTYK3NsBzv6tGYnOfKj8XZSt9M,14582
+robotcode-2.7.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+robotcode-2.7.0.dist-info/entry_points.txt,sha256=Pb4DKVVdJb5PboVl48njwk3DkKQHBJOL1A8KkpemqA8,58
+robotcode-2.7.0.dist-info/licenses/LICENSE.txt,sha256=B05uMshqTA74s-0ltyHKI6yoPfJ3zYgQbvcXfDVGFf8,10280
+robotcode-2.7.0.dist-info/RECORD,,

{robotcode-2.6.2.dist-info → robotcode-2.7.0.dist-info}/WHEEL

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

robotcode-2.6.2.dist-info/RECORD

@@ -1,12 +0,0 @@
-robotcode/cli/__init__.py,sha256=-zPNouLiGkJg8KKz6gVzyVm47dXHqM-zv2gJV3r-n7Y,10254
-robotcode/cli/__main__.py,sha256=hX3nwROMTnsYGT1KS0rXUYrslu9sFzctYdAh66Rcckw,153
-robotcode/cli/__version__.py,sha256=53Sii4w6BIWn-1RhaTyqUO46gDe4nDCRQDAcpsWFH24,22
-robotcode/cli/py.typed,sha256=bWew9mHgMy8LqMu7RuqQXFXLBxh2CRx0dUbSx-3wE48,27
-robotcode/cli/commands/__init__.py,sha256=XJHRt_YwMO2Ni2EfL2aj4jkJXMVG6NGFTpzvSVgIRnQ,92
-robotcode/cli/commands/config.py,sha256=0Jmf7HDIo7IIaOMU9M_bYi7PdHAfcae6x3SW93NA3EA,10481
-robotcode/cli/commands/profiles.py,sha256=5H9lvSVCMggWXf0IH54QtgDgqupEEvpcUrEsTZvZsNM,6127
-robotcode-2.6.2.dist-info/METADATA,sha256=OV5izStIuVLT677FLY1vM3MUTPLaRqb7ESS-cm3LkXU,14582
-robotcode-2.6.2.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
-robotcode-2.6.2.dist-info/entry_points.txt,sha256=Pb4DKVVdJb5PboVl48njwk3DkKQHBJOL1A8KkpemqA8,58
-robotcode-2.6.2.dist-info/licenses/LICENSE.txt,sha256=B05uMshqTA74s-0ltyHKI6yoPfJ3zYgQbvcXfDVGFf8,10280
-robotcode-2.6.2.dist-info/RECORD,,