robotcode-repl-server 0.100.0__py3-none-any.whl

robotcode/repl_server/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.100.0"

robotcode/repl_server/cli.py

@@ -0,0 +1,235 @@
+import asyncio
+import threading
+import time
+from pathlib import Path
+from typing import Any, Optional, Sequence, Tuple
+
+import click
+
+from robotcode.core.concurrent import Task, run_as_debugpy_hidden_task
+from robotcode.core.types import ServerMode, TcpParams
+from robotcode.plugin import Application, pass_application
+from robotcode.plugin.click_helper.options import (
+    resolve_server_options,
+    server_options,
+)
+from robotcode.plugin.click_helper.types import AddressesPort, add_options
+from robotcode.repl.run import run_repl
+
+from .__version__ import __version__
+from .interpreter import Interpreter
+from .server import TCP_DEFAULT_PORT, ReplServer
+
+REPL_SERVER_DEFAULT_PORT = TCP_DEFAULT_PORT
+
+_server: Optional[ReplServer] = None
+_server_lock = threading.RLock()
+
+
+def get_server() -> Optional["ReplServer"]:
+    with _server_lock:
+        return _server
+
+
+def set_server(value: Optional["ReplServer"]) -> None:
+    with _server_lock:
+        global _server
+        _server = value
+
+
+def wait_for_server(task: "Task[Any]", timeout: float = 10) -> "ReplServer":
+    start_time = time.monotonic()
+    while get_server() is None and time.monotonic() - start_time < timeout:
+        time.sleep(0.005)
+
+    result = get_server()
+
+    if result is None:
+        task.result(5)
+        raise RuntimeError("Timeout to get server instance.")
+
+    return result
+
+
+def run_jsonrpc_server_async(
+    mode: ServerMode,
+    port: Optional[int],
+    bind: Optional[Sequence[str]],
+    pipe_name: Optional[str],
+    interpreter: Interpreter,
+) -> None:
+    with ReplServer(
+        interpreter,
+        ServerMode(mode),
+        tcp_params=TcpParams(bind or "127.0.0.1", port if port is not None else REPL_SERVER_DEFAULT_PORT),
+        pipe_name=pipe_name,
+    ) as server:
+        set_server(server)
+        try:
+            server.run()
+        finally:
+            set_server(None)
+
+
+def run_jsonrpc_server(
+    mode: ServerMode,
+    port: Optional[int],
+    bind: Optional[Sequence[str]],
+    pipe_name: Optional[str],
+    interpreter: Interpreter,
+) -> None:
+    loop = asyncio.new_event_loop()
+    asyncio.set_event_loop(loop)
+    run_jsonrpc_server_async(mode, port, bind, pipe_name, interpreter)
+
+
+@click.command(
+    context_settings={"allow_extra_args": True, "ignore_unknown_options": True},
+    add_help_option=True,
+)
+@add_options(*server_options(ServerMode.STDIO, default_port=REPL_SERVER_DEFAULT_PORT))
+@click.option(
+    "-v",
+    "--variable",
+    metavar="name:value",
+    type=str,
+    multiple=True,
+    help="Set variables in the test data. see `robot --variable` option.",
+)
+@click.option(
+    "-V",
+    "--variablefile",
+    metavar="PATH",
+    type=str,
+    multiple=True,
+    help="Python or YAML file file to read variables from. see `robot --variablefile` option.",
+)
+@click.option(
+    "-P",
+    "--pythonpath",
+    metavar="PATH",
+    type=str,
+    multiple=True,
+    help="Additional locations where to search test libraries"
+    " and other extensions when they are imported. see `robot --pythonpath` option.",
+)
+@click.option(
+    "-d",
+    "--outputdir",
+    metavar="DIR",
+    type=str,
+    help="Where to create output files. see `robot --outputdir` option.",
+)
+@click.option(
+    "-o",
+    "--output",
+    metavar="FILE",
+    type=str,
+    help="XML output file. see `robot --output` option.",
+)
+@click.option(
+    "-r",
+    "--report",
+    metavar="FILE",
+    type=str,
+    help="HTML output file. see `robot --report` option.",
+)
+@click.option(
+    "-l",
+    "--log",
+    metavar="FILE",
+    type=str,
+    help="HTML log file. see `robot --log` option.",
+)
+@click.option(
+    "-x",
+    "--xunit",
+    metavar="FILE",
+    type=str,
+    help="xUnit output file. see `robot --xunit` option.",
+)
+@click.version_option(version=__version__, prog_name="RobotCode REPL Server")
+@click.option(
+    "-s",
+    "--source",
+    type=click.Path(path_type=Path),
+    metavar="FILE",
+    help="Specifies the path to a source file. This file must not exist and will neither be read nor written. "
+    "It is used solely to set the current working directory for the REPL script "
+    "and to assign a name to the internal suite.",
+)
+@click.argument(
+    "files",
+    type=click.Path(exists=True, dir_okay=False, path_type=Path),
+    nargs=-1,
+    required=False,
+)
+@pass_application
+@click.pass_context
+def repl_server(
+    ctx: click.Context,
+    app: Application,
+    mode: ServerMode,
+    port: Optional[int],
+    bind: Optional[Sequence[str]],
+    pipe_name: Optional[str],
+    tcp: Optional[AddressesPort],
+    socket: Optional[AddressesPort],
+    stdio: Optional[bool],
+    pipe: Optional[str],
+    pipe_server: Optional[str],
+    variable: Tuple[str, ...],
+    variablefile: Tuple[str, ...],
+    pythonpath: Tuple[str, ...],
+    outputdir: Optional[str],
+    output: Optional[str],
+    report: Optional[str],
+    log: Optional[str],
+    xunit: Optional[str],
+    source: Optional[Path],
+    files: Tuple[Path, ...],
+) -> None:
+    """\
+    Start a REPL server, client can connect to the server and run the REPL scripts.
+    """
+
+    mode, port, bind, pipe_name = resolve_server_options(
+        ctx,
+        app,
+        mode,
+        port,
+        bind,
+        pipe_name,
+        tcp,
+        socket,
+        stdio,
+        pipe,
+        pipe_server,
+    )
+
+    interpreter = Interpreter(list(files))
+
+    server_task = run_as_debugpy_hidden_task(run_jsonrpc_server, mode, port, bind, pipe_name, interpreter)
+
+    server = wait_for_server(server_task)
+
+    try:
+        run_repl(
+            interpreter=interpreter,
+            app=app,
+            variablefile=variable,
+            variable=variablefile,
+            pythonpath=pythonpath,
+            outputdir=outputdir,
+            output=output,
+            report=report,
+            log=log,
+            xunit=xunit,
+            source=source,
+            files=files,
+        )
+    finally:
+        if server is not None:
+            server.loop.stop()
+
+        server_task.result(5)

robotcode/repl_server/hooks.py

@@ -0,0 +1,12 @@
+from typing import List
+
+import click
+
+from robotcode.plugin import hookimpl
+
+from .cli import repl_server
+
+
+@hookimpl
+def register_cli_commands() -> List[click.Command]:
+    return [repl_server]

robotcode/repl_server/html_writer.py

@@ -0,0 +1,324 @@
+from contextlib import contextmanager
+from datetime import datetime, timedelta
+from typing import Any, Dict, Generator, List, Optional, Sequence, TypeVar, Union
+
+from robot.utils.robottime import elapsed_time_to_string
+
+from robotcode.repl.base_interpreter import is_true
+from robotcode.robot.utils import get_robot_version
+
+
+class ElementDataBase:
+    def as_str(self, indent: int = 0) -> str:
+        raise NotImplementedError
+
+    def __str__(self) -> str:
+        return self.as_str(0)
+
+
+_T = TypeVar("_T", bound=ElementDataBase)
+
+
+class TextElement(ElementDataBase):
+    def __init__(self, text: str) -> None:
+        self.text = text
+
+    def as_str(self, indent: int = 0) -> str:
+        return f"{'  '*indent}{self.text}"
+
+
+class RawElement(ElementDataBase):
+    def __init__(self, text: str) -> None:
+        self.text = text
+
+    def as_str(self, indent: int = 0) -> str:
+        return f"{'  '*indent}{self.text}"
+
+
+class Element(ElementDataBase):
+    def __init__(
+        self,
+        tag_name: str,
+        text: Optional[str] = None,
+        classes: Optional[List[str]] = None,
+        styles: Optional[Dict[str, str]] = None,
+        attributes: Optional[Dict[str, str]] = None,
+        **kwargs: Any,
+    ) -> None:
+        self.tag_name = tag_name
+        self.classes = classes
+        self.styles = styles
+        if attributes is None:
+            attributes = {}
+        attributes.update(kwargs)
+        self.attributes = attributes
+        self.children: List[ElementDataBase] = []
+
+        if text is not None:
+            self.add_element(TextElement(text))
+
+    def add_element(self, child: _T) -> _T:
+        self.children.append(child)
+        return child
+
+    @contextmanager
+    def tag(
+        self,
+        tag_name: str,
+        *,
+        text: Optional[str] = None,
+        classes: Optional[List[str]] = None,
+        styles: Optional[Dict[str, str]] = None,
+        attributes: Optional[Dict[str, str]] = None,
+        **kwargs: Any,
+    ) -> Generator["Element", None, None]:
+        element = Element(tag_name, text=text, classes=classes, styles=styles, attributes=attributes, **kwargs)
+
+        yield element
+
+        self.add_element(element)
+
+    def add_raw(self, text: Any) -> None:
+        self.add_element(RawElement(str(text)))
+
+    def add_text(self, text: Any) -> None:
+        self.add_element(TextElement(str(text)))
+
+    def _build_attributes(self) -> str:
+        result = []
+        if self.classes:
+            result.append(f'class="{" ".join(s for s in self.classes if s)}"')
+        if self.styles:
+            result.append(f'style="{"; ".join(f"{k}: {v}" for k, v in self.styles.items() if v)}"')
+        if self.attributes:
+            result.extend(f'{k}="{v}"' for k, v in self.attributes.items())
+
+        return " ".join(result)
+
+    NON_BREAKABLE_TAGS = {"span", "a", "b", "i", "u", "strong", "em", "code", "pre", "tt", "samp", "kbd", "var", "td"}
+
+    def as_str(self, indent: int = 0, *, only_children: bool = False) -> str:
+        if not only_children:
+            attributes = self._build_attributes()
+
+            if attributes:
+                start_tag = f"<{self.tag_name} {attributes}>"
+            else:
+                start_tag = f"<{self.tag_name}>"
+
+            end_tag = f"</{self.tag_name}>"
+
+            result = "  " * indent + start_tag
+        else:
+            result = ""
+            end_tag = None
+
+        if self.children:
+            result += "\n" if self.tag_name not in self.NON_BREAKABLE_TAGS else ""
+            for child in self.children:
+                result += child.as_str((indent + 1) if self.tag_name not in self.NON_BREAKABLE_TAGS else 0) + (
+                    "\n" if self.tag_name not in self.NON_BREAKABLE_TAGS else ""
+                )
+            result += ("  " * indent) if self.tag_name not in self.NON_BREAKABLE_TAGS else ""
+
+        if end_tag:
+            result += end_tag
+
+        return result
+
+
+def create_keyword_html(
+    id: Optional[str] = None,
+    name: Optional[str] = "",
+    owner: Optional[str] = None,
+    source_name: Optional[str] = None,
+    doc: Optional[str] = "",
+    args: Sequence[str] = (),
+    assign: Sequence[str] = (),
+    tags: Sequence[str] = (),
+    timeout: Optional[str] = None,
+    type: str = "KEYWORD",
+    status: str = "FAIL",
+    message: str = "",
+    start_time: Union[datetime, str, None] = None,
+    end_time: Union[datetime, str, None] = None,
+    elapsed_time: Union[timedelta, int, float, None] = None,
+    shadow_root_id: Optional[str] = None,
+) -> Element:
+    result = Element("div", classes=["keyword"], id=id)
+
+    elapsed_time_str = (
+        (
+            elapsed_time_to_string(elapsed_time)
+            if get_robot_version() < (7, 0)
+            else elapsed_time_to_string(elapsed_time, seconds=True)
+        )
+        if elapsed_time is not None
+        else ""
+    )
+
+    with result.tag(
+        "div",
+        classes=["element-header", "closed" if status not in ["FAIL"] else ""],
+        onclick=f"toggleKeyword('{id}', '{shadow_root_id}')",
+    ) as e_element_header:
+        with e_element_header.tag(
+            "div",
+            classes=["element-header-left"],
+            title=f"{type.upper()} {owner}.{name} [{status}]",
+        ) as e_header_left:
+            if elapsed_time is not None:
+                with e_header_left.tag("span", classes=["elapsed"]) as e_elapsed:
+                    e_elapsed.add_text(elapsed_time_str)
+            with e_header_left.tag("span", classes=["label", status.lower()]) as e_label:
+                e_label.add_text(str(type).upper())
+            with e_header_left.tag("span", classes=["assign"]) as e_assign:
+                e_assign.add_text("    ".join(assign))
+            with e_header_left.tag("span", classes=["name"]) as e_name:
+                with e_name.tag("span", classes=["parent-name"]) as parent_name:
+                    parent_name.add_text((owner + " . ") if owner else "")
+                e_name.add_text(name)
+            e_header_left.add_raw("&nbsp;")
+            with e_header_left.tag("span", classes=["arg"]) as args_tag:
+                args_tag.add_text("    ".join(args))
+        with e_element_header.tag("div", classes=["element-header-right"]) as e_header_right:
+            with e_header_right.tag(
+                "div",
+                classes=["expand"],
+                title="Expand all",
+                onclick=f"expandAll(event, '{id}', '{shadow_root_id}')",
+            ):
+                pass
+            with e_header_right.tag(
+                "div",
+                classes=["collapse"],
+                title="Collapse all",
+                onclick=f"collapseAll(event, '{id}', '{shadow_root_id}')",
+            ):
+                pass
+            with e_header_right.tag(
+                "div",
+                classes=["link"],
+                title="Highlight this item",
+                onclick=f"makeElementVisible(event, '{id}', '{shadow_root_id}')",
+            ):
+                pass
+        with e_element_header.tag("div", classes=["element-header-toggle"], title="Toggle visibility"):
+            pass
+
+    with result.tag(
+        "div", classes=["children", "populated"], styles={"display": "none" if status not in ["FAIL"] else "block"}
+    ) as e_children:
+        with e_children.tag("table", classes=["metadata", "keyword-metadata"]) as e_body:
+            if doc:
+                with e_body.tag("tr") as tr:
+                    with tr.tag("th", text="Documentation:"):
+                        pass
+                    with tr.tag("td", classes=["doc"]) as td:
+                        td.add_text(doc)
+            if tags:
+                with e_body.tag("tr") as tr:
+                    with tr.tag("th", text="Tags:"):
+                        pass
+                    with tr.tag("td", classes=["tags"]) as td:
+                        td.add_text(", ".join(tags))
+            if timeout:
+                with e_body.tag("tr") as tr:
+                    with tr.tag("th", text="Timeout:"):
+                        pass
+                    with tr.tag("td", classes=["timeout"]) as td:
+                        td.add_text(timeout)
+            if source_name:
+                with e_body.tag("tr") as tr:
+                    with tr.tag("th", text="Source:"):
+                        pass
+                    with tr.tag("td", classes=["source"]) as td:
+                        td.add_text(source_name)
+            with e_body.tag("tr") as tr:
+                with tr.tag("th", text="Start / End / Elapsed:"):
+                    pass
+                with tr.tag("td", classes=["message"]) as td:
+                    td.add_text(str(start_time) + " / " + str(end_time) + " / " + elapsed_time_str)
+            if message:
+                with e_body.tag("tr") as tr:
+                    with tr.tag("th", text="Message:"):
+                        pass
+                    with tr.tag("td", classes=["message"]) as td:
+                        td.add_text(message)
+
+    return result
+
+
+def create_message_html(
+    id: str,
+    message: str,
+    level: str,
+    html: Union[str, bool] = False,
+    timestamp: Union[datetime, str, None] = None,
+    shadow_root_id: Optional[str] = None,
+) -> Element:
+    result = Element("table", classes=["messages", f"{level.lower()}-message"], id=id)
+
+    with result.tag("tr", classes=["message-row"]) as tr:
+        with tr.tag("td", classes=["time"]) as td:
+            if isinstance(timestamp, datetime):
+                td.add_text(timestamp.strftime("%H:%M:%S"))
+            else:
+                td.add_text(timestamp)
+        with tr.tag("td", classes=["level", level.lower()]) as td:
+            with td.tag("span", classes=["label", level.lower()]) as sp:
+                sp.add_text(level.upper())
+        with tr.tag("td", classes=["message"]) as td:
+            if is_true(html):
+                td.add_raw(message)
+            else:
+                td.add_text(message)
+        with tr.tag(
+            "td",
+            classes=["select-message"],
+            onclick=f"selectMessage('{id}', '{shadow_root_id}')",
+            title="Select message text",
+        ) as td:
+            with td.tag("div"):
+                pass
+
+    return result
+
+
+if __name__ == "__main__":
+    # div = Element("div", id="main", classes=["test", "test2"], styles={"color": "red", "font-size": "12px"})
+    # p = div.add_element(Element("p", text="Hello, world!"))
+    # p.add_element(Element("span", text="This is a test"))
+    # print(div)
+
+    # body = Element("body")
+    # with body.tag("div", id="main", classes=["test", "test2"], styles={"color": "red"}) as div:
+    #     with div.tag("p") as p:
+    #         p.add_text("Hello, world!")
+    #         with p.tag("span") as span:
+    #             span.add_text("This is a test")
+    #             with span.tag("br"):
+    #                 pass
+    #             span.add_text("This is a test")
+    #             with span.tag("br", id="test"):
+    #                 pass
+    # print(body)
+
+    # r = create_keyword_html(
+    #     id="ts-1-2-3-4-5-6",
+    #     name="Test Keyword",
+    #     owner="Test Library",
+    #     doc="This is a test keyword",
+    #     args=("arg1", "arg2"),
+    #     assign=("${var1}", "${var2}"),
+    #     tags=("tag1", "tag2"),
+    #     timeout="10s",
+    #     type="KEYWORD",
+    #     status="PASS",
+    #     message="This is a test message",
+    #     start_time=datetime.now(timezone.utc),
+    #     end_time=datetime.now(timezone.utc),
+    #     elapsed_time=timedelta(seconds=5),
+    # )
+    r = create_message_html("ts-1-2-3-4-5-6", "This is a test message", "INFO", timestamp="2021-10-10 12:00:00")
+    print(r)

robotcode/repl_server/interpreter.py

@@ -0,0 +1,365 @@
+from dataclasses import dataclass, field
+from datetime import datetime
+from pathlib import Path
+from threading import Event
+from typing import TYPE_CHECKING, Iterator, List, Optional, Protocol, Union, runtime_checkable
+from uuid import uuid4
+
+from robot.running import Keyword
+
+from robotcode.core.utils.dataclasses import as_json
+from robotcode.repl.base_interpreter import BaseInterpreter, is_true
+
+from .html_writer import Element, create_keyword_html, create_message_html
+
+if TYPE_CHECKING:
+    from robot import result, running
+
+
+@dataclass
+class ExecutionOutput:
+    mime: str
+    data: str
+
+
+@dataclass
+class ExecutionResult:
+    success: Optional[bool] = None
+    items: Optional[List[ExecutionOutput]] = None
+
+
+class CellInputError(Exception):
+    pass
+
+
+@dataclass
+class ResultData:
+    pass
+
+
+@dataclass
+class MessageData(ResultData):
+    id: str
+    message: str
+    level: str
+    html: bool
+    timestamp: Optional[str] = None
+
+    node_type: str = "message"
+
+
+@dataclass
+class RootResultData(ResultData):
+    items: List[ResultData] = field(default_factory=list)
+
+    node_type: str = "root"
+
+
+@runtime_checkable
+class ResultDataWithChildren(Protocol):
+    items: List[ResultData]
+
+
+@dataclass
+class KeywordResultData(ResultData):
+    id: str
+    name: str
+    owner: str
+    source_name: str
+    doc: str
+    args: List[str]
+    assign: List[str]
+    tags: List[str]
+    timeout: Optional[str]
+    type: str
+    status: str
+    message: str
+    start_time: Optional[str]
+    end_time: Optional[str]
+    elapsed_time: Optional[float]
+
+    items: List[ResultData] = field(default_factory=list)
+
+    node_type: str = "keyword"
+
+
+class Interpreter(BaseInterpreter):
+    def __init__(
+        self,
+        files: Optional[List[Path]] = None,
+    ) -> None:
+        super().__init__()
+        self.files = files
+        self.has_input = Event()
+        self.executed = Event()
+        self._code: List[str] = []
+        self._html_result: Optional[Element] = None
+        self._result_stack: List[Element] = []
+        self._output_stack: List[Element] = []
+        self._shadow_marker: Optional[str] = None
+        self._success: Optional[bool] = None
+        self._result_data: Optional[ResultData] = None
+        self._result_data_stack: List[ResultData] = []
+        self.collect_messages: bool = False
+        self._has_shutdown = False
+
+    def shutdown(self) -> None:
+        self._code = []
+        self._has_shutdown = True
+        self.has_input.set()
+        # self.executed.set()
+
+    def execute(self, source: str) -> ExecutionResult:
+        self._result_stack = []
+        self._result_data_stack = []
+
+        self._success = None
+        try:
+            self._shadow_marker = str(uuid4())
+
+            html_result = Element("div", classes=["robot-results"])
+
+            with html_result.tag(
+                "div", attributes={"data-shadow-marker": self._shadow_marker}, styles={"display": "none"}
+            ):
+                pass
+
+            outer_test: Optional[Element] = None
+            with html_result.tag("div", classes=["result_body"]) as body:
+                with body.tag("div", classes=["test"]) as test:
+                    with test.tag("div", classes=["children"], styles={"display": "block"}):
+                        pass
+                    outer_test = test
+
+            self._html_result = outer_test
+            self._result_data = RootResultData()
+
+            self.executed.clear()
+
+            self._code.append(source)
+            self.has_input.set()
+
+            self.executed.wait()
+
+            return ExecutionResult(
+                self._success,
+                (
+                    [
+                        ExecutionOutput(
+                            "x-application/robotframework-repl-log", as_json(self._result_data, compact=True)
+                        ),
+                        ExecutionOutput(
+                            "x-application/robotframework-repl-html", html_result.as_str(only_children=True)
+                        ),
+                    ]
+                    if self._success is not None
+                    else []
+                ),
+            )
+        except BaseException as e:
+            return ExecutionResult(False, [ExecutionOutput("application/vnd.code.notebook.stderr", str(e))])
+
+    def get_input(self) -> Iterator[Optional[Keyword]]:
+        while self._code:
+            s = self._code.pop(0)
+            test, errors = self.get_test_body_from_string(s)
+            if errors:
+                raise CellInputError(errors)
+
+            for kw in test.body:
+                yield kw
+
+    def log_message(
+        self, message: str, level: str, html: Union[str, bool] = False, timestamp: Union[datetime, str, None] = None
+    ) -> None:
+        if self._result_data is not None and isinstance(self._result_data, ResultDataWithChildren):
+            self._result_data.items.append(
+                MessageData(
+                    id=f"message-{len(self._result_data.items)}",
+                    message=message,
+                    level=level,
+                    html=is_true(html),
+                    timestamp=timestamp.strftime("%H:%M:%S") if isinstance(timestamp, datetime) else str(timestamp),
+                )
+            )
+
+        if level in ("DEBUG", "TRACE"):
+            return
+
+        if self._html_result is None:
+            return
+
+        items = next(
+            (
+                i
+                for i in self._html_result.children
+                if isinstance(i, Element) and i.tag_name == "div" and i.classes is not None and "children" in i.classes
+            ),
+            None,
+        )
+        if items is None:
+            items = Element("div", classes=["children"])
+            self._html_result.add_element(items)
+
+        id = f"message-{len(items.children)}"
+
+        message_data = create_message_html(id, message, level, html, timestamp, shadow_root_id=self._shadow_marker)
+        items.add_element(message_data)
+
+    def message(
+        self, message: str, level: str, html: Union[str, bool] = False, timestamp: Union[datetime, str, None] = None
+    ) -> None:
+        if not self.collect_messages:
+            return
+
+        if self._result_data is not None and isinstance(self._result_data, ResultDataWithChildren):
+            self._result_data.items.append(
+                MessageData(
+                    id=f"message-{len(self._result_data.items)}",
+                    message=message,
+                    level=level,
+                    html=is_true(html),
+                    timestamp=timestamp.strftime("%H:%M:%S") if isinstance(timestamp, datetime) else str(timestamp),
+                )
+            )
+
+    def start_keyword(self, data: "running.Keyword", result: "result.Keyword") -> None:
+        if data.type in ["IF/ELSE ROOT", "TRY/EXCEPT ROOT"]:
+            return
+        if self._result_data is not None:
+            kw_data = KeywordResultData(
+                id=result.id,
+                name=result.name if getattr(result, "name", None) else "",
+                owner=result.owner if getattr(result, "owner", None) else "",
+                source_name=result.source_name if getattr(result, "source_name", None) else "",
+                doc=result.doc if getattr(result, "doc", None) else "",
+                args=list(result.args) if getattr(result, "args", None) else [],
+                assign=list(result.assign) if getattr(result, "assign", None) else [],
+                tags=list(result.tags) if getattr(result, "tags", None) else [],
+                timeout=result.timeout if getattr(result, "timeout", None) else None,
+                type=result.type,
+                status=result.status,
+                message=result.message,
+                start_time=result.starttime,
+                end_time=result.endtime,
+                elapsed_time=result.elapsedtime,
+            )
+            if self._result_data is not None and isinstance(self._result_data, ResultDataWithChildren):
+                self._result_data.items.append(kw_data)
+            self._result_data_stack.append(self._result_data)
+            self._result_data = kw_data
+
+        if self._html_result is not None:
+            self._result_stack.append(self._html_result)
+            kw = self.create_keyword_html_element(result)
+
+            children = next(
+                (
+                    i
+                    for i in self._html_result.children
+                    if isinstance(i, Element)
+                    and i.tag_name == "div"
+                    and i.classes is not None
+                    and "children" in i.classes
+                ),
+                None,
+            )
+
+            if children is None:
+                self._html_result.add_element(kw)
+            else:
+                children.add_element(kw)
+
+            self._html_result = kw
+
+    def end_keyword(self, data: "running.Keyword", result: "result.Keyword") -> None:
+        if data.type in ["IF/ELSE ROOT", "TRY/EXCEPT ROOT"]:
+            return
+        if self._result_data is not None:
+            if isinstance(self._result_data, KeywordResultData):
+                self._result_data.end_time = result.endtime
+                self._result_data.elapsed_time = result.elapsedtime
+                self._result_data.status = result.status
+                self._result_data.message = result.message
+
+            self._result_data = self._result_data_stack.pop()
+
+        if result.status == "FAIL":
+            self._success = False
+        elif result.status == "PASS" and self.last_result is not False:
+            self._success = True
+
+        if self._html_result is not None and isinstance(self._html_result, Element):
+            kw = self.create_keyword_html_element(result)
+
+            old_children = next(
+                (
+                    i
+                    for i in self._html_result.children
+                    if isinstance(i, Element)
+                    and i.tag_name == "div"
+                    and i.classes is not None
+                    and "children" in i.classes
+                ),
+                None,
+            )
+            if old_children is not None:
+                new_children = next(
+                    (
+                        i
+                        for i in kw.children
+                        if isinstance(i, Element)
+                        and i.tag_name == "div"
+                        and i.classes is not None
+                        and "children" in i.classes
+                    ),
+                    None,
+                )
+                if new_children is None:
+                    new_children = Element("div", classes=["children"])
+                    self._html_result.add_element(new_children)
+
+                for old_child in old_children.children:
+                    if not (
+                        isinstance(old_child, Element)
+                        and old_child.tag_name == "table"
+                        and old_child.classes is not None
+                        and "metadata" in old_child.classes
+                    ):
+                        new_children.add_element(old_child)
+
+            self._html_result.children = kw.children
+
+        self._html_result = self._result_stack.pop()
+
+    def create_keyword_html_element(self, result: "result.Keyword") -> Element:
+        return create_keyword_html(
+            id=result.id,
+            name=result.name if getattr(result, "name", None) else None,
+            owner=result.owner if getattr(result, "owner", None) else None,
+            source_name=result.source_name if getattr(result, "source_name", None) else None,
+            doc=result.doc if getattr(result, "doc", None) else None,
+            args=result.args if getattr(result, "args", None) else (),
+            assign=result.assign if getattr(result, "assign", None) else (),
+            tags=result.tags if getattr(result, "tags", None) else (),
+            timeout=result.timeout if getattr(result, "timeout", None) else None,
+            type=result.type,
+            status=result.status,
+            message=result.message,
+            start_time=result.starttime,
+            end_time=result.endtime,
+            elapsed_time=result.elapsedtime,
+            shadow_root_id=self._shadow_marker,
+        )
+
+    def run_input(self) -> None:
+        self.has_input.wait()
+        if self._has_shutdown:
+            self.executed.set()
+            raise EOFError
+
+        try:
+            return super().run_input()
+        finally:
+            self.has_input.clear()
+            self.executed.set()

robotcode/repl_server/protocol.py

@@ -0,0 +1,32 @@
+import sys
+from typing import Optional
+
+from robotcode.jsonrpc2.protocol import JsonRPCProtocol, rpc_method
+
+from .interpreter import ExecutionResult, Interpreter
+
+
+class ReplServerProtocol(JsonRPCProtocol):
+    def __init__(self, interpreter: Interpreter):
+        super().__init__()
+        self.interpreter = interpreter
+        self._is_shutdown = False
+
+    @rpc_method(name="initialize", threaded=True)
+    def initialize(self, message: str) -> str:
+        return "yeah initialized " + message
+
+    @rpc_method(name="executeCell", threaded=True)
+    def execute_cell(self, source: str) -> Optional[ExecutionResult]:
+        return self.interpreter.execute(source)
+
+    @rpc_method(name="shutdown", threaded=True)
+    def shutdown(self) -> None:
+        try:
+            self.interpreter.shutdown()
+        finally:
+            self._is_shutdown = True
+
+    @rpc_method(name="exit", threaded=True)
+    def exit(self) -> None:
+        sys.exit(0 if self._is_shutdown else 1)

robotcode/repl_server/py.typed

@@ -0,0 +1 @@
+# Marker file for PEP 561.

robotcode/repl_server/server.py

@@ -0,0 +1,24 @@
+from typing import Optional
+
+from robotcode.core.types import ServerMode, TcpParams
+from robotcode.jsonrpc2.server import JsonRPCServer
+
+from .interpreter import Interpreter
+from .protocol import ReplServerProtocol
+
+TCP_DEFAULT_PORT = 6601
+
+
+class ReplServer(JsonRPCServer[ReplServerProtocol]):
+    def __init__(
+        self,
+        interpreter: Interpreter,
+        mode: ServerMode = ServerMode.STDIO,
+        tcp_params: TcpParams = TcpParams(None, TCP_DEFAULT_PORT),
+        pipe_name: Optional[str] = None,
+    ):
+        super().__init__(mode=mode, tcp_params=tcp_params, pipe_name=pipe_name)
+        self.interpreter = interpreter
+
+    def create_protocol(self) -> ReplServerProtocol:
+        return ReplServerProtocol(self.interpreter)

robotcode_repl_server-0.100.0.dist-info/METADATA

@@ -0,0 +1,51 @@
+Metadata-Version: 2.3
+Name: robotcode-repl-server
+Version: 0.100.0
+Summary: RobotCode REPL Server for Robot Framework
+Project-URL: Homepage, https://robotcode.io
+Project-URL: Donate, https://opencollective.com/robotcode
+Project-URL: Documentation, https://github.com/robotcodedev/robotcode#readme
+Project-URL: Changelog, https://github.com/robotcodedev/robotcode/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/robotcodedev/robotcode/issues
+Project-URL: Source, https://github.com/robotcodedev/robotcode
+Author-email: Daniel Biehl <dbiehl@live.de>
+License: Apache-2.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Robot Framework
+Classifier: Framework :: Robot Framework :: Tool
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Requires-Dist: robotcode-jsonrpc2==0.100.0
+Requires-Dist: robotcode-runner==0.100.0
+Description-Content-Type: text/markdown
+
+# robotcode-repl-server
+
+[![PyPI - Version](https://img.shields.io/pypi/v/robotcode-repl.svg)](https://pypi.org/project/robotcode-repl-server)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/robotcode-repl.svg)](https://pypi.org/project/robotcode-repl-server)
+[![License](https://img.shields.io/github/license/robotcodedev/robotcode?style=flat&logo=apache)](https://github.com/robotcodedev/robotcode/blob/master/LICENSE.txt)
+
+-----
+
+## Introduction
+
+Some classes for [RobotCode](https://robotcode.io) plugin management
+
+## Installation
+
+```console
+pip install robotcode-repl-server
+```
+
+## License
+
+`robotcode-repl-server` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.

robotcode_repl_server-0.100.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+robotcode/repl_server/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+robotcode/repl_server/__version__.py,sha256=hBw9-oaz7x5BBjFEByYUTbik88urWGwnI3lE91SfgJ8,24
+robotcode/repl_server/cli.py,sha256=yxgD_4QFwRD-BSGxto3MeimKess5_KZWkUJldERBsSk,5970
+robotcode/repl_server/hooks.py,sha256=4O9H8cefHc6T7erjPxzU941w3KWytTBB5gmvYb4bs_I,196
+robotcode/repl_server/html_writer.py,sha256=fr-6kSobkhqfYPGlOgBuAs-CSln-lkAwYsxc8_nb79Y,11647
+robotcode/repl_server/interpreter.py,sha256=5Xgr2bACjU2-hOvZYe2p4MP4c9K3XivsUpyFd6Vbrz4,12557
+robotcode/repl_server/protocol.py,sha256=4Eeoz45DfkKuzMZ7NJed8x0m0SWJdKkeFbnuO3e6DgQ,980
+robotcode/repl_server/py.typed,sha256=bWew9mHgMy8LqMu7RuqQXFXLBxh2CRx0dUbSx-3wE48,27
+robotcode/repl_server/server.py,sha256=zzFsD6ds56d4GQJKXoysVZP-oiS08AtMKeyLKXH9Fss,746
+robotcode_repl_server-0.100.0.dist-info/METADATA,sha256=bmZLDzfC8G0bzbErMpkhrSXI6KGukLBHIdrtOfRjPg4,2112
+robotcode_repl_server-0.100.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+robotcode_repl_server-0.100.0.dist-info/entry_points.txt,sha256=U_1iYu71VNyPq_epO0fXHki3B4BE4gR2mbZFAOWN1cg,54
+robotcode_repl_server-0.100.0.dist-info/licenses/LICENSE.txt,sha256=B05uMshqTA74s-0ltyHKI6yoPfJ3zYgQbvcXfDVGFf8,10280
+robotcode_repl_server-0.100.0.dist-info/RECORD,,

robotcode_repl_server-0.100.0.dist-info/WHEEL

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

robotcode_repl_server-0.100.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[robotcode]
+repl_server = robotcode.repl_server.hooks

robotcode_repl_server-0.100.0.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,73 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+     (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+     (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+     (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+     (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+     You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.