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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: repl-session
-Version: 0.2.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
@@ -64,7 +64,7 @@ config:
   first_prompt: "> "
   change_prompt: '(waiter-prompt-string "{key}>")'
   prompt: "{key}> "
-  continuation_prompt: ""
+  # continuation_prompt: ""
 commands:
   - command: (* 6 7)
   - command: |
@@ -75,7 +75,7 @@ commands:
   - 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"
 ```
 
@@ -126,6 +126,8 @@ repl-session < test/lua.yml | jq '.commands.[].output'
 ```
 "42"
 "Hello, World!"
+null
+"3628800"
 ```
 
 ### Python
@@ -142,6 +144,7 @@ config:
   continuation_prompt: "{key}\\+\\+\\+ "
   environment:
     NO_COLOR: "1"
+    PYTHON_BASIC_REPL: "1"
 commands:
   - command: print("Hello, World!")
   - command: 6 * 7
@@ -153,6 +156,17 @@ commands:
   - command: fac(10)
 ```
 
+```bash
+repl-session < test/python.yml | jq '.commands.[].output'
+```
+
+```
+"Hello, World!"
+"42"
+null
+"3628800"
+```
+
 ## Input/Output structure
 
 The user can configure how the REPL is called and interpreted.
@@ -183,8 +197,6 @@ class ReplConfig(msgspec.Struct):
     strip_ansi: bool = False
     environment: dict[str, str] = msgspec.field(default_factory=dict)
     timeout: float = 5.0
-
-
 ```
 
 Then, a session is a list of commands. Each command should be a UTF-8 string, and we allow to attach some meta-data like expected MIME type for the output. We can also pass an expected output in the case of a documentation test. If `output` was already given on the input, it is  moved to `expected`. This way it becomes really easy to setup regression tests on your documentation. Just rerun on the generated output file.
@@ -217,8 +229,6 @@ class ReplSession(msgspec.Struct):
 
     config: ReplConfig
     commands: list[ReplCommand]
-
-
 ```
 
 ## License and contribution

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

@@ -46,7 +46,7 @@ config:
   first_prompt: "> "
   change_prompt: '(waiter-prompt-string "{key}>")'
   prompt: "{key}> "
-  continuation_prompt: ""
+  # continuation_prompt: ""
 commands:
   - command: (* 6 7)
   - command: |
@@ -57,7 +57,7 @@ commands:
   - 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"
 ```
 
@@ -108,6 +108,8 @@ repl-session < test/lua.yml | jq '.commands.[].output'
 ```
 "42"
 "Hello, World!"
+null
+"3628800"
 ```
 
 ### Python
@@ -124,6 +126,7 @@ config:
   continuation_prompt: "{key}\\+\\+\\+ "
   environment:
     NO_COLOR: "1"
+    PYTHON_BASIC_REPL: "1"
 commands:
   - command: print("Hello, World!")
   - command: 6 * 7
@@ -135,6 +138,17 @@ commands:
   - command: fac(10)
 ```
 
+```bash
+repl-session < test/python.yml | jq '.commands.[].output'
+```
+
+```
+"Hello, World!"
+"42"
+null
+"3628800"
+```
+
 ## Input/Output structure
 
 The user can configure how the REPL is called and interpreted.
@@ -165,8 +179,6 @@ class ReplConfig(msgspec.Struct):
     strip_ansi: bool = False
     environment: dict[str, str] = msgspec.field(default_factory=dict)
     timeout: float = 5.0
-
-
 ```
 
 Then, a session is a list of commands. Each command should be a UTF-8 string, and we allow to attach some meta-data like expected MIME type for the output. We can also pass an expected output in the case of a documentation test. If `output` was already given on the input, it is  moved to `expected`. This way it becomes really easy to setup regression tests on your documentation. Just rerun on the generated output file.
@@ -199,8 +211,6 @@ class ReplSession(msgspec.Struct):
 
     config: ReplConfig
     commands: list[ReplCommand]
-
-
 ```
 
 ## License and contribution

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

@@ -1,6 +1,6 @@
 [project]
 name = "repl-session"
-version = "0.2.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,9 +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.0 → repl_session-0.2.1}/src/repl_session/__init__.py

@@ -1,12 +1,10 @@
 # ~/~ 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, cast
 from collections.abc import Generator, Callable
@@ -17,19 +15,17 @@ import uuid
 import sys
 import re
 import logging
+import os
 
 import pexpect
 import msgspec
-import argh
+import click
 import importlib.metadata
 
 
 __version__ = importlib.metadata.version("repl-session")
 # ~/~ end
-
-
 # ~/~ begin <<README.md#input-data>>[init]
-#| id: input-data
 class ReplConfig(msgspec.Struct):
     """Configuration
 
@@ -54,11 +50,8 @@ class ReplConfig(msgspec.Struct):
     strip_ansi: bool = False
     environment: dict[str, str] = msgspec.field(default_factory=dict)
     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.
 
@@ -85,24 +78,33 @@ class ReplSession(msgspec.Struct):
 
     config: ReplConfig
     commands: list[ReplCommand]
-
-
 # ~/~ end
-
-
 # ~/~ begin <<docs/index.md#repl-contextmanager>>[init]
-#| id: repl-contextmanager
 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=config.environment,
+        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())
@@ -122,58 +124,61 @@ def repl(config: ReplConfig) -> Generator[Callable[[str], str | None]]:
         #    child.expect(key)
         _ = child.expect(prompt)
 
-        def send(msg: str) -> str | None:
-            nonlocal prompt, continuation_prompt, change_prompt_cmd
-            lines = msg.splitlines()
-            answer: list[str] = []
+        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)
-                if continuation_prompt is not 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<cont>{continuation_prompt})|(?P<norm>{prompt})"
+                        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")
+                        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
-                else:
-                    logging.debug("waiting for prompt")
+
+                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)
-                    still_waiting = False
 
-            if still_waiting:
-                _ = child.sendline("")
-                _ = child.expect(prompt)
-                if child.before:
-                    answer.append(child.before)
+                if not answer:
+                    return None
 
-            if not answer:
-                return None
+                return clean_output(config, answer[-1])
 
-            if config.strip_ansi:
-                ansi_escape = re.compile(r"(\u001b\[|\x1B\[)[0-?]*[ -\/]*[@-~]")
-                return ansi_escape.sub("", answer[-1].strip())
+        else:
+            def send(msg: str) -> str | None:
+                logging.debug("sending: %s", msg)
 
-            return answer[-1].strip()
+                _ = child.sendline(msg)
+                _ = child.expect(prompt)
 
-        yield send
+                if not child.before:
+                    return None
 
+                return clean_output(config, child.before)
 
+        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:
@@ -183,11 +188,8 @@ def run_session(session: ReplSession):
             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)
@@ -196,23 +198,20 @@ def read_session(port: IO[str] = sys.stdin) -> 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")
-@argh.arg("-l", "--log-enable", help="show debugging output")
-def repl_session(version: bool = False, log_enable: bool = False):
+@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 version:
-        print(f"repl-session {__version__}")
-        sys.exit(0)
-
     if log_enable:
         logging.basicConfig(level=logging.DEBUG)
 
@@ -220,7 +219,5 @@ def repl_session(version: bool = False, log_enable: bool = False):
 
 
 def main():
-    argh.dispatch_command(repl_session)
-
-
+    repl_session()
 # ~/~ end

{repl_session-0.2.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.2.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
@@ -64,7 +64,7 @@ config:
   first_prompt: "> "
   change_prompt: '(waiter-prompt-string "{key}>")'
   prompt: "{key}> "
-  continuation_prompt: ""
+  # continuation_prompt: ""
 commands:
   - command: (* 6 7)
   - command: |
@@ -75,7 +75,7 @@ commands:
   - 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"
 ```
 
@@ -126,6 +126,8 @@ repl-session < test/lua.yml | jq '.commands.[].output'
 ```
 "42"
 "Hello, World!"
+null
+"3628800"
 ```
 
 ### Python
@@ -142,6 +144,7 @@ config:
   continuation_prompt: "{key}\\+\\+\\+ "
   environment:
     NO_COLOR: "1"
+    PYTHON_BASIC_REPL: "1"
 commands:
   - command: print("Hello, World!")
   - command: 6 * 7
@@ -153,6 +156,17 @@ commands:
   - command: fac(10)
 ```
 
+```bash
+repl-session < test/python.yml | jq '.commands.[].output'
+```
+
+```
+"Hello, World!"
+"42"
+null
+"3628800"
+```
+
 ## Input/Output structure
 
 The user can configure how the REPL is called and interpreted.
@@ -183,8 +197,6 @@ class ReplConfig(msgspec.Struct):
     strip_ansi: bool = False
     environment: dict[str, str] = msgspec.field(default_factory=dict)
     timeout: float = 5.0
-
-
 ```
 
 Then, a session is a list of commands. Each command should be a UTF-8 string, and we allow to attach some meta-data like expected MIME type for the output. We can also pass an expected output in the case of a documentation test. If `output` was already given on the input, it is  moved to `expected`. This way it becomes really easy to setup regression tests on your documentation. Just rerun on the generated output file.
@@ -217,8 +229,6 @@ class ReplSession(msgspec.Struct):
 
     config: ReplConfig
     commands: list[ReplCommand]
-
-
 ```
 
 ## License and contribution

{repl_session-0.2.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.2.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]