repl-session 0.1.0__tar.gz → 0.2.1__tar.gz

{repl_session-0.1.0 → repl_session-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: repl-session
-Version: 0.1.0
+Version: 0.2.1
 Summary: Runs a session with a Read-Eval-Print-Loop (REPL). Takes YAML as input gives JSON as output.
 Classifier: Development Status :: 3 - Alpha
 Classifier: Environment :: Console
@@ -11,7 +11,7 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: argh>=0.30.5
+Requires-Dist: click>=8.1
 Requires-Dist: msgspec>=0.19.0
 Requires-Dist: pexpect>=4.9.0
 Dynamic: license-file
@@ -60,22 +60,22 @@ I like to work with [Chez Scheme](https://cisco.github.io/ChezScheme/). Suppose
 ```yaml
 #| file: test/scheme.yml
 config:
-    command: "scheme --eedisable"
-    first_prompt: "> "
-    change_prompt: "(waiter-prompt-string \"{key}>\")"
-    next_prompt: "{key}> "
-    strip_command: true
+  command: "scheme --eedisable"
+  first_prompt: "> "
+  change_prompt: '(waiter-prompt-string "{key}>")'
+  prompt: "{key}> "
+  # continuation_prompt: ""
 commands:
-   - command: (* 6 7)
-   - command: |
+  - command: (* 6 7)
+  - command: |
       (define (fac n init)
         (if (zero? n)
           init
           (fac (- n 1) (* init n)))))
-   - command: (fac 10 1)
+  - command: (fac 10 1)
 ```
 
-Passing this to `repl-session`, it will start the Chez Scheme interpreter, waiting for the `>` prompt to appear. It then changes the prompt to a generated `uuid4` code, for instance `27e87a8a-742c-4501-b05d-b05814f5a010> `. This will make sure that we can't accidentally match something else for an interactive prompt (imagine we're generating some XML!). Since commands are also echoed to standard out, we need to strip them from the resulting output. Running this should give:
+Passing this to `repl-session`, it will start the Chez Scheme interpreter, waiting for the `>` prompt to appear. It then changes the prompt to a generated `uuid4` code, for instance `27e87a8a-742c-4501-b05d-b05814f5a010> `. This will make sure that we can't accidentally match something else for an interactive prompt (imagine we're generating some XML!). Running this should give:
 
 ```bash
 repl-session < test/scheme.yml | jq '.commands.[].output'
@@ -83,7 +83,7 @@ repl-session < test/scheme.yml | jq '.commands.[].output'
 
 ```
 "42"
-"(define (fac n init)\n  (if (zero? n)\n    init\n    (fac (- n 1) (* init n)))))"
+null
 "3628800"
 ```
 
@@ -94,15 +94,27 @@ This looks very similar to the previous example:
 ```yaml
 #| file: test/lua.yml
 config:
-    command: "lua"
-    first_prompt: "> "
-    change_prompt: "_PROMPT = \"{key}> \""
-    next_prompt: "{key}> "
-    strip_command: true
-    strip_ansi: true
+  command: "lua"
+  first_prompt: "> "
+  change_prompt: '_PROMPT = "{key}> "; _PROMPT2 = "{key}+ "'
+  prompt: "{key}> "
+  continuation_prompt: "{key}\\+ "
+  strip_ansi: true
 commands:
-   - command: 6 * 7
-   - command: "\"Hello\" .. \", \" .. \"World!\""
+  - command: 6 * 7
+  - command: '"Hello" .. ", " .. "World!"'
+  - command: |
+      function fac(n, m)
+          if m == nil then
+              return fac(n, 1)
+          end
+          if n == 0 then
+              return m
+          else
+              return fac(n-1, m*n)
+          end
+      end
+  - command: fac(10)
 ```
 
 The Lua REPL is not so nice. It sends ANSI escape codes and those need to be filtered out.
@@ -114,6 +126,45 @@ repl-session < test/lua.yml | jq '.commands.[].output'
 ```
 "42"
 "Hello, World!"
+null
+"3628800"
+```
+
+### Python
+
+The Python REPL got a revision in version 3.13, with lots of colour and ANSI codes.
+
+```yaml
+#| file: test/python.yml
+config:
+  command: python -q
+  first_prompt: ">>>"
+  change_prompt: 'import sys; sys.ps1 = "{key}>>> "; sys.ps2 = "{key}+++ "'
+  prompt: "{key}>>> "
+  continuation_prompt: "{key}\\+\\+\\+ "
+  environment:
+    NO_COLOR: "1"
+    PYTHON_BASIC_REPL: "1"
+commands:
+  - command: print("Hello, World!")
+  - command: 6 * 7
+  - command: |
+      def fac(n):
+          for i in range(1, n):
+              n *= i
+          return n
+  - command: fac(10)
+```
+
+```bash
+repl-session < test/python.yml | jq '.commands.[].output'
+```
+
+```
+"Hello, World!"
+"42"
+null
+"3628800"
 ```
 
 ## Input/Output structure
@@ -137,13 +188,14 @@ class ReplConfig(msgspec.Struct):
             output; useful if the REPL echoes your input before answering.
         timeout (float): Command timeout for this session in seconds.
     """
+
     command: str
     first_prompt: str
     change_prompt: str
-    next_prompt: str
-    append_newline: bool = True
-    strip_command: bool = False
+    prompt: str
+    continuation_prompt: str | None = None
     strip_ansi: bool = False
+    environment: dict[str, str] = msgspec.field(default_factory=dict)
     timeout: float = 5.0
 ```
 
@@ -160,6 +212,7 @@ class ReplCommand(msgspec.Struct):
         output (str | None): evaluated output.
         expected (str | None): expected output.
     """
+
     command: str
     output_type: str = "text/plain"
     output: str | None = None
@@ -173,6 +226,7 @@ class ReplSession(msgspec.Struct):
         config (ReplConfig): Config for setting up a REPL session.
         commands (list[ReplCommand]): List of commands in the session.
     """
+
     config: ReplConfig
     commands: list[ReplCommand]
 ```

{repl_session-0.1.0 → repl_session-0.2.1}/README.md

@@ -42,22 +42,22 @@ I like to work with [Chez Scheme](https://cisco.github.io/ChezScheme/). Suppose
 ```yaml
 #| file: test/scheme.yml
 config:
-    command: "scheme --eedisable"
-    first_prompt: "> "
-    change_prompt: "(waiter-prompt-string \"{key}>\")"
-    next_prompt: "{key}> "
-    strip_command: true
+  command: "scheme --eedisable"
+  first_prompt: "> "
+  change_prompt: '(waiter-prompt-string "{key}>")'
+  prompt: "{key}> "
+  # continuation_prompt: ""
 commands:
-   - command: (* 6 7)
-   - command: |
+  - command: (* 6 7)
+  - command: |
       (define (fac n init)
         (if (zero? n)
           init
           (fac (- n 1) (* init n)))))
-   - command: (fac 10 1)
+  - command: (fac 10 1)
 ```
 
-Passing this to `repl-session`, it will start the Chez Scheme interpreter, waiting for the `>` prompt to appear. It then changes the prompt to a generated `uuid4` code, for instance `27e87a8a-742c-4501-b05d-b05814f5a010> `. This will make sure that we can't accidentally match something else for an interactive prompt (imagine we're generating some XML!). Since commands are also echoed to standard out, we need to strip them from the resulting output. Running this should give:
+Passing this to `repl-session`, it will start the Chez Scheme interpreter, waiting for the `>` prompt to appear. It then changes the prompt to a generated `uuid4` code, for instance `27e87a8a-742c-4501-b05d-b05814f5a010> `. This will make sure that we can't accidentally match something else for an interactive prompt (imagine we're generating some XML!). Running this should give:
 
 ```bash
 repl-session < test/scheme.yml | jq '.commands.[].output'
@@ -65,7 +65,7 @@ repl-session < test/scheme.yml | jq '.commands.[].output'
 
 ```
 "42"
-"(define (fac n init)\n  (if (zero? n)\n    init\n    (fac (- n 1) (* init n)))))"
+null
 "3628800"
 ```
 
@@ -76,15 +76,27 @@ This looks very similar to the previous example:
 ```yaml
 #| file: test/lua.yml
 config:
-    command: "lua"
-    first_prompt: "> "
-    change_prompt: "_PROMPT = \"{key}> \""
-    next_prompt: "{key}> "
-    strip_command: true
-    strip_ansi: true
+  command: "lua"
+  first_prompt: "> "
+  change_prompt: '_PROMPT = "{key}> "; _PROMPT2 = "{key}+ "'
+  prompt: "{key}> "
+  continuation_prompt: "{key}\\+ "
+  strip_ansi: true
 commands:
-   - command: 6 * 7
-   - command: "\"Hello\" .. \", \" .. \"World!\""
+  - command: 6 * 7
+  - command: '"Hello" .. ", " .. "World!"'
+  - command: |
+      function fac(n, m)
+          if m == nil then
+              return fac(n, 1)
+          end
+          if n == 0 then
+              return m
+          else
+              return fac(n-1, m*n)
+          end
+      end
+  - command: fac(10)
 ```
 
 The Lua REPL is not so nice. It sends ANSI escape codes and those need to be filtered out.
@@ -96,6 +108,45 @@ repl-session < test/lua.yml | jq '.commands.[].output'
 ```
 "42"
 "Hello, World!"
+null
+"3628800"
+```
+
+### Python
+
+The Python REPL got a revision in version 3.13, with lots of colour and ANSI codes.
+
+```yaml
+#| file: test/python.yml
+config:
+  command: python -q
+  first_prompt: ">>>"
+  change_prompt: 'import sys; sys.ps1 = "{key}>>> "; sys.ps2 = "{key}+++ "'
+  prompt: "{key}>>> "
+  continuation_prompt: "{key}\\+\\+\\+ "
+  environment:
+    NO_COLOR: "1"
+    PYTHON_BASIC_REPL: "1"
+commands:
+  - command: print("Hello, World!")
+  - command: 6 * 7
+  - command: |
+      def fac(n):
+          for i in range(1, n):
+              n *= i
+          return n
+  - command: fac(10)
+```
+
+```bash
+repl-session < test/python.yml | jq '.commands.[].output'
+```
+
+```
+"Hello, World!"
+"42"
+null
+"3628800"
 ```
 
 ## Input/Output structure
@@ -119,13 +170,14 @@ class ReplConfig(msgspec.Struct):
             output; useful if the REPL echoes your input before answering.
         timeout (float): Command timeout for this session in seconds.
     """
+
     command: str
     first_prompt: str
     change_prompt: str
-    next_prompt: str
-    append_newline: bool = True
-    strip_command: bool = False
+    prompt: str
+    continuation_prompt: str | None = None
     strip_ansi: bool = False
+    environment: dict[str, str] = msgspec.field(default_factory=dict)
     timeout: float = 5.0
 ```
 
@@ -142,6 +194,7 @@ class ReplCommand(msgspec.Struct):
         output (str | None): evaluated output.
         expected (str | None): expected output.
     """
+
     command: str
     output_type: str = "text/plain"
     output: str | None = None
@@ -155,6 +208,7 @@ class ReplSession(msgspec.Struct):
         config (ReplConfig): Config for setting up a REPL session.
         commands (list[ReplCommand]): List of commands in the session.
     """
+
     config: ReplConfig
     commands: list[ReplCommand]
 ```

{repl_session-0.1.0 → repl_session-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "repl-session"
-version = "0.1.0"
+version = "0.2.1"
 description = "Runs a session with a Read-Eval-Print-Loop (REPL). Takes YAML as input gives JSON as output."
 readme = "README.md"
 classifiers = [
@@ -13,7 +13,7 @@ classifiers = [
 ]
 requires-python = ">=3.11"
 dependencies = [
-    "argh>=0.30.5",
+    "click>=8.1",
     "msgspec>=0.19.0",
     "pexpect>=4.9.0",
 ]
@@ -24,7 +24,11 @@ dev = [
     "entangled-cli>=2.1.13",
     "mkdocs-macros-plugin>=1.3.9",
     "mkdocs-material>=9.6.20",
+    "pytest>=9.2.0",
+    "python-lsp-server>=1.13.1",
+    "ruff>=0.13.2",
     "ty>=0.0.1a21",
+    "types-pexpect>=4.9.0.20250916",
 ]
 
 [project.scripts]

repl_session-0.2.1/src/repl_session/__init__.py

@@ -0,0 +1,223 @@
+# ~/~ begin <<docs/index.md#src/repl_session/__init__.py>>[init]
+"""
+`repl-session` is a command-line tool to evaluate a given session
+in any REPL, and store the results.
+"""
+
+# ~/~ begin <<docs/index.md#imports>>[init]
+# from datetime import datetime, tzinfo
+from typing import IO, cast
+from collections.abc import Generator, Callable
+
+# import re
+from contextlib import contextmanager
+import uuid
+import sys
+import re
+import logging
+import os
+
+import pexpect
+import msgspec
+import click
+import importlib.metadata
+
+
+__version__ = importlib.metadata.version("repl-session")
+# ~/~ end
+# ~/~ begin <<README.md#input-data>>[init]
+class ReplConfig(msgspec.Struct):
+    """Configuration
+
+    Attributes:
+        command (str): Command to start the REPL
+        first_prompt (str): Regex to match the first prompt
+        change_prompt (str): Command to change prompt; should contain '{key}' as an
+            argument.
+        next_prompt (str): Regex to match the changed prompts; should contain '{key}'
+            as an argument.
+        append_newline (bool): Whether to append a newline to given commands.
+        strip_command (bool): Whether to strip the original command from the gotten
+            output; useful if the REPL echoes your input before answering.
+        timeout (float): Command timeout for this session in seconds.
+    """
+
+    command: str
+    first_prompt: str
+    change_prompt: str
+    prompt: str
+    continuation_prompt: str | None = None
+    strip_ansi: bool = False
+    environment: dict[str, str] = msgspec.field(default_factory=dict)
+    timeout: float = 5.0
+# ~/~ end
+# ~/~ begin <<README.md#input-data>>[1]
+class ReplCommand(msgspec.Struct):
+    """A command to be sent to the REPL.
+
+    Attributes:
+        command (str): the command.
+        output_type (str): MIME type of expected output.
+        output (str | None): evaluated output.
+        expected (str | None): expected output.
+    """
+
+    command: str
+    output_type: str = "text/plain"
+    output: str | None = None
+    expected: str | None = None
+
+
+class ReplSession(msgspec.Struct):
+    """A REPL session.
+
+    Attributes:
+        config (ReplConfig): Config for setting up a REPL session.
+        commands (list[ReplCommand]): List of commands in the session.
+    """
+
+    config: ReplConfig
+    commands: list[ReplCommand]
+# ~/~ end
+# ~/~ begin <<docs/index.md#repl-contextmanager>>[init]
+def spawn(config: ReplConfig):
+    env = dict(os.environ) | config.environment
+    child: pexpect.spawn[str] = pexpect.spawn(
+        config.command,
+        timeout=config.timeout,
+        echo=False,
+        encoding="utf-8",
+        env=dict(os.environ) | config.environment,
+    )
+    return child
+
+
+ANSI_ESCAPE = re.compile(r"(\u001b|\x1B)(\[[0-?]*[ -\/]*[@-~]|[\>\=])")
+
+
+def clean_output(config: ReplConfig, output: str) -> str | None:
+    """Remove ANSI escapes (if requested), normalize the CRLF line endings
+    that the pseudo-terminal produces, and trim surrounding whitespace.
+    Returns `None` if nothing is left."""
+    if config.strip_ansi:
+        output = ANSI_ESCAPE.sub("", output)
+    output = output.replace("\r\n", "\n").replace("\r", "").strip()
+    return output or None
+
+
+@contextmanager
+def repl(config: ReplConfig) -> Generator[Callable[[str], str | None]]:
+    key = str(uuid.uuid4())
+    change_prompt_cmd = config.change_prompt.format(key=key)
+    prompt = config.prompt.format(key=key)
+    continuation_prompt = (
+        config.continuation_prompt.format(key=key)
+        if config.continuation_prompt is not None
+        else None
+    )
+
+    child: pexpect.spawn[str]
+    with spawn(config) as child:
+        _ = child.expect(config.first_prompt)
+        _ = child.sendline(change_prompt_cmd)
+        # if config.strip_command:
+        #    child.expect(key)
+        _ = child.expect(prompt)
+
+        if continuation_prompt is not None:
+            def send(msg: str) -> str | None:
+                lines = msg.splitlines()
+                answer: list[str] = []
+
+                if not lines:
+                    return None
+
+                still_waiting: bool = True
+                for line in lines:
+                    logging.debug("sending: '%s'", line)
+                    _ = child.sendline(line)
+                    logging.debug("waiting for prompt or continuation")
+                    _ = child.expect(
+                        f"(?P<norm>{prompt})|(?P<cont>{continuation_prompt})"
+                    )
+                    if not isinstance(child.match, re.Match):
+                        continue
+                    if child.match.group("cont") is not None:
+                        logging.debug("continuation: %s -- %s", child.before, child.after)
+                        still_waiting = True
+                    else:
+                        logging.debug("done: %s", child.before)
+                        if child.before is not None:
+                            answer.append(child.before)
+                        still_waiting = False
+
+                if still_waiting:
+                    logging.debug(f"waiting for last prompt")
+                    _ = child.sendline("")
+                    _ = child.expect(prompt)
+                    logging.debug(f"got: %s", child.before)
+                    if child.before:
+                        answer.append(child.before)
+
+                if not answer:
+                    return None
+
+                return clean_output(config, answer[-1])
+
+        else:
+            def send(msg: str) -> str | None:
+                logging.debug("sending: %s", msg)
+
+                _ = child.sendline(msg)
+                _ = child.expect(prompt)
+
+                if not child.before:
+                    return None
+
+                return clean_output(config, child.before)
+
+        yield send
+# ~/~ end
+# ~/~ begin <<docs/index.md#run-session>>[init]
+def run_session(session: ReplSession):
+    with repl(session.config) as run:
+        for cmd in session.commands:
+            expected = cmd.expected or cmd.output
+            output = run(cmd.command)
+            cmd.output = output
+            cmd.expected = expected
+
+    return session
+# ~/~ end
+# ~/~ begin <<docs/index.md#io>>[init]
+def read_session(port: IO[str] = sys.stdin) -> ReplSession:
+    data: str = port.read()
+    return msgspec.yaml.decode(data, type=ReplSession)
+
+
+def write_session(session: ReplSession, port: IO[str] = sys.stdout):
+    data = msgspec.json.encode(session)
+    _ = port.write(data.decode())
+# ~/~ end
+
+@click.command()
+@click.version_option(
+    __version__, "-v", "--version",
+    prog_name="repl-session", message="%(prog)s %(version)s",
+    help="show version and exit")
+@click.option("-l", "--log-enable", is_flag=True, help="show debugging output")
+def repl_session(log_enable: bool = False):
+    """
+    repl-session runs a REPL session, reading JSON from standard input and
+    writing to standard output. Both the input and output follow the same
+    schema.
+    """
+    if log_enable:
+        logging.basicConfig(level=logging.DEBUG)
+
+    write_session(run_session(read_session()))
+
+
+def main():
+    repl_session()
+# ~/~ end

{repl_session-0.1.0 → repl_session-0.2.1}/src/repl_session.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: repl-session
-Version: 0.1.0
+Version: 0.2.1
 Summary: Runs a session with a Read-Eval-Print-Loop (REPL). Takes YAML as input gives JSON as output.
 Classifier: Development Status :: 3 - Alpha
 Classifier: Environment :: Console
@@ -11,7 +11,7 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: argh>=0.30.5
+Requires-Dist: click>=8.1
 Requires-Dist: msgspec>=0.19.0
 Requires-Dist: pexpect>=4.9.0
 Dynamic: license-file
@@ -60,22 +60,22 @@ I like to work with [Chez Scheme](https://cisco.github.io/ChezScheme/). Suppose
 ```yaml
 #| file: test/scheme.yml
 config:
-    command: "scheme --eedisable"
-    first_prompt: "> "
-    change_prompt: "(waiter-prompt-string \"{key}>\")"
-    next_prompt: "{key}> "
-    strip_command: true
+  command: "scheme --eedisable"
+  first_prompt: "> "
+  change_prompt: '(waiter-prompt-string "{key}>")'
+  prompt: "{key}> "
+  # continuation_prompt: ""
 commands:
-   - command: (* 6 7)
-   - command: |
+  - command: (* 6 7)
+  - command: |
       (define (fac n init)
         (if (zero? n)
           init
           (fac (- n 1) (* init n)))))
-   - command: (fac 10 1)
+  - command: (fac 10 1)
 ```
 
-Passing this to `repl-session`, it will start the Chez Scheme interpreter, waiting for the `>` prompt to appear. It then changes the prompt to a generated `uuid4` code, for instance `27e87a8a-742c-4501-b05d-b05814f5a010> `. This will make sure that we can't accidentally match something else for an interactive prompt (imagine we're generating some XML!). Since commands are also echoed to standard out, we need to strip them from the resulting output. Running this should give:
+Passing this to `repl-session`, it will start the Chez Scheme interpreter, waiting for the `>` prompt to appear. It then changes the prompt to a generated `uuid4` code, for instance `27e87a8a-742c-4501-b05d-b05814f5a010> `. This will make sure that we can't accidentally match something else for an interactive prompt (imagine we're generating some XML!). Running this should give:
 
 ```bash
 repl-session < test/scheme.yml | jq '.commands.[].output'
@@ -83,7 +83,7 @@ repl-session < test/scheme.yml | jq '.commands.[].output'
 
 ```
 "42"
-"(define (fac n init)\n  (if (zero? n)\n    init\n    (fac (- n 1) (* init n)))))"
+null
 "3628800"
 ```
 
@@ -94,15 +94,27 @@ This looks very similar to the previous example:
 ```yaml
 #| file: test/lua.yml
 config:
-    command: "lua"
-    first_prompt: "> "
-    change_prompt: "_PROMPT = \"{key}> \""
-    next_prompt: "{key}> "
-    strip_command: true
-    strip_ansi: true
+  command: "lua"
+  first_prompt: "> "
+  change_prompt: '_PROMPT = "{key}> "; _PROMPT2 = "{key}+ "'
+  prompt: "{key}> "
+  continuation_prompt: "{key}\\+ "
+  strip_ansi: true
 commands:
-   - command: 6 * 7
-   - command: "\"Hello\" .. \", \" .. \"World!\""
+  - command: 6 * 7
+  - command: '"Hello" .. ", " .. "World!"'
+  - command: |
+      function fac(n, m)
+          if m == nil then
+              return fac(n, 1)
+          end
+          if n == 0 then
+              return m
+          else
+              return fac(n-1, m*n)
+          end
+      end
+  - command: fac(10)
 ```
 
 The Lua REPL is not so nice. It sends ANSI escape codes and those need to be filtered out.
@@ -114,6 +126,45 @@ repl-session < test/lua.yml | jq '.commands.[].output'
 ```
 "42"
 "Hello, World!"
+null
+"3628800"
+```
+
+### Python
+
+The Python REPL got a revision in version 3.13, with lots of colour and ANSI codes.
+
+```yaml
+#| file: test/python.yml
+config:
+  command: python -q
+  first_prompt: ">>>"
+  change_prompt: 'import sys; sys.ps1 = "{key}>>> "; sys.ps2 = "{key}+++ "'
+  prompt: "{key}>>> "
+  continuation_prompt: "{key}\\+\\+\\+ "
+  environment:
+    NO_COLOR: "1"
+    PYTHON_BASIC_REPL: "1"
+commands:
+  - command: print("Hello, World!")
+  - command: 6 * 7
+  - command: |
+      def fac(n):
+          for i in range(1, n):
+              n *= i
+          return n
+  - command: fac(10)
+```
+
+```bash
+repl-session < test/python.yml | jq '.commands.[].output'
+```
+
+```
+"Hello, World!"
+"42"
+null
+"3628800"
 ```
 
 ## Input/Output structure
@@ -137,13 +188,14 @@ class ReplConfig(msgspec.Struct):
             output; useful if the REPL echoes your input before answering.
         timeout (float): Command timeout for this session in seconds.
     """
+
     command: str
     first_prompt: str
     change_prompt: str
-    next_prompt: str
-    append_newline: bool = True
-    strip_command: bool = False
+    prompt: str
+    continuation_prompt: str | None = None
     strip_ansi: bool = False
+    environment: dict[str, str] = msgspec.field(default_factory=dict)
     timeout: float = 5.0
 ```
 
@@ -160,6 +212,7 @@ class ReplCommand(msgspec.Struct):
         output (str | None): evaluated output.
         expected (str | None): expected output.
     """
+
     command: str
     output_type: str = "text/plain"
     output: str | None = None
@@ -173,6 +226,7 @@ class ReplSession(msgspec.Struct):
         config (ReplConfig): Config for setting up a REPL session.
         commands (list[ReplCommand]): List of commands in the session.
     """
+
     config: ReplConfig
     commands: list[ReplCommand]
 ```

{repl_session-0.1.0 → repl_session-0.2.1}/src/repl_session.egg-info/SOURCES.txt

@@ -8,4 +8,5 @@ src/repl_session.egg-info/SOURCES.txt
 src/repl_session.egg-info/dependency_links.txt
 src/repl_session.egg-info/entry_points.txt
 src/repl_session.egg-info/requires.txt
-src/repl_session.egg-info/top_level.txt
+src/repl_session.egg-info/top_level.txt
+test/test_examples.py

{repl_session-0.1.0 → repl_session-0.2.1}/src/repl_session.egg-info/requires.txt

@@ -1,3 +1,3 @@
-argh>=0.30.5
+click>=8.1
 msgspec>=0.19.0
 pexpect>=4.9.0

repl_session-0.2.1/test/test_examples.py

@@ -0,0 +1,40 @@
+"""Run the example sessions from the README and check their outputs."""
+
+import os
+import shlex
+import shutil
+from pathlib import Path
+
+import msgspec
+import pytest
+
+from repl_session import ReplSession, run_session
+
+
+TEST_DIR = Path(__file__).parent
+
+
+EXPECTED = {
+    "scheme": ["42", None, "3628800"],
+    "lua": ["42", "Hello, World!", None, "3628800"],
+    "python": ["Hello, World!", "42", None, "3628800"],
+}
+
+
+def load_session(name: str) -> ReplSession:
+    data = (TEST_DIR / f"{name}.yml").read_bytes()
+    return msgspec.yaml.decode(data, type=ReplSession)
+
+
+@pytest.mark.parametrize("name", EXPECTED.keys())
+def test_example(name: str):
+    session = load_session(name)
+    executable = shlex.split(session.config.command)[0]
+    if shutil.which(executable) is None:
+        # In CI every interpreter must be available; locally we allow skipping.
+        if os.environ.get("CI"):
+            pytest.fail(f"`{executable}` not found")
+        pytest.skip(f"`{executable}` not found")
+
+    result = run_session(session)
+    assert [cmd.output for cmd in result.commands] == EXPECTED[name]

repl_session-0.1.0/src/repl_session/__init__.py

@@ -1,159 +0,0 @@
-# ~/~ begin <<docs/index.md#src/repl_session/__init__.py>>[init]
-#| file: src/repl_session/__init__.py
-"""
-`repl-session` is a command-line tool to evaluate a given session
-in any REPL, and store the results.
-"""
-# ~/~ begin <<docs/index.md#imports>>[init]
-#| id: imports
-# from datetime import datetime, tzinfo
-from typing import IO
-from collections.abc import Generator, Callable
-# import re
-from contextlib import contextmanager
-import uuid
-import sys
-import re
-
-import pexpect
-import msgspec
-import argh
-import importlib.metadata
-
-
-__version__ = importlib.metadata.version("repl-session")
-# ~/~ end
-
-# ~/~ begin <<README.md#input-data>>[init]
-#| id: input-data
-class ReplConfig(msgspec.Struct):
-    """Configuration
-
-    Attributes:
-        command (str): Command to start the REPL
-        first_prompt (str): Regex to match the first prompt
-        change_prompt (str): Command to change prompt; should contain '{key}' as an
-            argument.
-        next_prompt (str): Regex to match the changed prompts; should contain '{key}'
-            as an argument.
-        append_newline (bool): Whether to append a newline to given commands.
-        strip_command (bool): Whether to strip the original command from the gotten
-            output; useful if the REPL echoes your input before answering.
-        timeout (float): Command timeout for this session in seconds.
-    """
-    command: str
-    first_prompt: str
-    change_prompt: str
-    next_prompt: str
-    append_newline: bool = True
-    strip_command: bool = False
-    strip_ansi: bool = False
-    timeout: float = 5.0
-# ~/~ end
-# ~/~ begin <<README.md#input-data>>[1]
-#| id: input-data
-class ReplCommand(msgspec.Struct):
-    """A command to be sent to the REPL.
-
-    Attributes:
-        command (str): the command.
-        output_type (str): MIME type of expected output.
-        output (str | None): evaluated output.
-        expected (str | None): expected output.
-    """
-    command: str
-    output_type: str = "text/plain"
-    output: str | None = None
-    expected: str | None = None
-
-
-class ReplSession(msgspec.Struct):
-    """A REPL session.
-
-    Attributes:
-        config (ReplConfig): Config for setting up a REPL session.
-        commands (list[ReplCommand]): List of commands in the session.
-    """
-    config: ReplConfig
-    commands: list[ReplCommand]
-# ~/~ end
-
-# ~/~ begin <<docs/index.md#repl-contextmanager>>[init]
-#| id: repl-contextmanager
-
-@contextmanager
-def repl(config: ReplConfig) -> Generator[Callable[[str], str]]:
-    key = str(uuid.uuid4())
-
-    with pexpect.spawn(config.command, timeout=config.timeout) as child:
-        child.expect(config.first_prompt)
-        change_prompt_cmd = config.change_prompt.format(key=key)
-        if config.append_newline:
-            change_prompt_cmd = change_prompt_cmd + "\n"
-        child.send(change_prompt_cmd)
-        if config.strip_command:
-            child.expect(key)
-        prompt = config.next_prompt.format(key=key)
-        child.expect(prompt)
-
-        def send(msg: str) -> str:
-            if config.append_newline:
-                msg = msg + "\n"
-            child.send(msg)
-            child.expect("(.*)" + prompt)
-
-            answer = child.match[1].decode()
-            if config.strip_ansi:
-                ansi_escape = re.compile(r'(\u001b\[|\x1B\[)[0-?]*[ -\/]*[@-~]')
-                answer = ansi_escape.sub("", answer)
-            if config.strip_command:
-                answer = answer.strip().replace("\r", "")
-                return answer.removeprefix(msg)
-            else:
-                return child.match[1].decode()
-
-        yield send
-# ~/~ end
-# ~/~ begin <<docs/index.md#run-session>>[init]
-#| id: run-session
-def run_session(session: ReplSession):
-    with repl(session.config) as run:
-        for cmd in session.commands:
-            expected = cmd.expected or cmd.output
-            output = run(cmd.command)
-            cmd.output = output
-            cmd.expected = expected
-
-    return session
-# ~/~ end
-# ~/~ begin <<docs/index.md#io>>[init]
-#| id: io
-
-def read_session(port: IO[str] = sys.stdin) -> ReplSession:
-    data: str = port.read()
-    return msgspec.yaml.decode(data, type=ReplSession)
-
-
-def write_session(session: ReplSession, port: IO[str] = sys.stdout):
-    data = msgspec.json.encode(session)
-    port.write(data.decode())
-# ~/~ end
-
-
-@argh.arg("-v", "--version", help="show version and exit")
-def repl_session(version: bool = False):
-    """
-    repl-session runs a REPL session, reading JSON from standard input and
-    writing to standard output. Both the input and output follow the same
-    schema.
-    """
-    if version:
-        print(f"repl-session {__version__}")
-        sys.exit(0)
-
-    write_session(run_session(read_session()))
-
-
-def main():
-    argh.dispatch_command(repl_session)
-# ~/~ end