repl-session 0.1.0__py3-none-any.whl

repl_session/__init__.py

@@ -0,0 +1,159 @@
+# ~/~ 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

repl_session-0.1.0.dist-info/METADATA

@@ -0,0 +1,182 @@
+Metadata-Version: 2.4
+Name: repl-session
+Version: 0.1.0
+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
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Topic :: Software Development
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: argh>=0.30.5
+Requires-Dist: msgspec>=0.19.0
+Requires-Dist: pexpect>=4.9.0
+Dynamic: license-file
+
+# REPL Session
+
+[![docs](https://github.com/entangled/repl-session/actions/workflows/pages.yml/badge.svg)](https://github.com/entangled/repl-session/actions/workflows/pages.yml)
+[![Static Badge](https://img.shields.io/badge/docs-latest-blue)](https://entangled.github.io/repl-session)
+
+This is script that runs a session on any REPL following a description  in a JSON file. The output contains the commands entered and the results given. This can be useful to drive documentation tests or literate programming tasks. This way we decouple running the commands from rendering or presenting the corresponding results, leading  to better reproducibility, caching output and modularity w.r.t. any other tools that you may use.
+
+This is very similar to running a Jupyter notebook from the console, with the benefit that you don't need a Jupyter kernel available for the language you're using. The downside is that REPLs can be messy to interact with.
+
+## Is this for you?
+
+This is only really useful if you're hacking together a literate programming environment similar to [Entangled](https://entangled.github.io). Suppose you have your documentation written in Markdown, ready for rendering with MkDocs or Pandoc. You want to automatically evaluate some expressions in this document as if they're entered in a REPL and process the results for inclusion in the document generator. Here `repl-session` is a nicely confined command-line tool, so its easy to integrate into a build pipeline.
+
+## How does it work?
+
+The REPL of your choice is started and interacted with through the `pexpect` library. All I/O is dealt with through `msgspec`.
+
+The preferred way to solve this is by using `jupyter-client` in combination with an existing Jupyter kernel. However, not all languages have a Jupyter kernel available, and developing one takes a bit more than configuring `pexpect` for an existing REPL. I may still include Jupyter support in this application at a later stage.
+
+## Install
+
+Install with,
+
+```bash
+pip install repl-session
+```
+
+Or equivalent Poetry, Astral Uv, Hatch or Conda commands.
+
+## Documentation
+
+The full documentation is available at [entangled.github.io/repl-session](https://entangled.github.io/repl-session).
+
+## Examples
+
+Here are some examples where we could interact with a REPL successfully. In general, the less intricate the REPL the better the results.
+
+### Chez Scheme
+
+I like to work with [Chez Scheme](https://cisco.github.io/ChezScheme/). Suppose I want to document an interactive session. This can be done:
+
+```yaml
+#| file: test/scheme.yml
+config:
+    command: "scheme --eedisable"
+    first_prompt: "> "
+    change_prompt: "(waiter-prompt-string \"{key}>\")"
+    next_prompt: "{key}> "
+    strip_command: true
+commands:
+   - command: (* 6 7)
+   - command: |
+      (define (fac n init)
+        (if (zero? n)
+          init
+          (fac (- n 1) (* init n)))))
+   - 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:
+
+```bash
+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)))))"
+"3628800"
+```
+
+### Lua
+
+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
+commands:
+   - command: 6 * 7
+   - command: "\"Hello\" .. \", \" .. \"World!\""
+```
+
+The Lua REPL is not so nice. It sends ANSI escape codes and those need to be filtered out.
+
+```bash
+repl-session < test/lua.yml | jq '.commands.[].output'
+```
+
+```
+"42"
+"Hello, World!"
+```
+
+## Input/Output structure
+
+The user can configure how the REPL is called and interpreted.
+
+```python
+#| 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
+```
+
+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.
+
+```python
+#| 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]
+```
+
+## License and contribution
+
+Licensed under the Apache 2.0 license. Contributions are welcome: if you've succesfully applied `repl-session` to a REPL not listed in the documentation, consider contributing your configuration to the documentation. If your contribution fixes a bug, please first file an issue.

repl_session-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+repl_session/__init__.py,sha256=cNCtAsVKo0u3oiUZ5NyFwqSYFYc6x0kE5OOrVwUO-Jk,4802
+repl_session/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+repl_session-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+repl_session-0.1.0.dist-info/METADATA,sha256=e_niCwnDlrC3GcXV1a0xgBXC360huUwK_y6EQjOO8HU,7207
+repl_session-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+repl_session-0.1.0.dist-info/entry_points.txt,sha256=xXozNA4gf-3EZswR-RbskiPNMi0c5Qr4H-7jDlV93jA,51
+repl_session-0.1.0.dist-info/top_level.txt,sha256=DFSo-6BXOFKSBP0NM2Lel-YX374VCvRR5yhQOY89ECc,13
+repl_session-0.1.0.dist-info/RECORD,,

repl_session-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

repl_session-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+repl-session = repl_session:main

repl_session-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

repl_session-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+repl_session