running_process 3.0.0__tar.gz

running_process-3.0.0/Cargo.lock

@@ -0,0 +1,209 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "autocfg"
+version = "1.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c08606f8c3cbf4ce6ec8e28fb0014a2c086708fe954eaa885384a6165172e7e8"
+
+[[package]]
+name = "cfg-if"
+version = "1.0.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801"
+
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
+[[package]]
+name = "indoc"
+version = "2.0.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "79cf5c93f93228cf8efb3ba362535fb11199ac548a09ce117c9b1adc3030d706"
+dependencies = [
+ "rustversion",
+]
+
+[[package]]
+name = "libc"
+version = "0.2.184"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "48f5d2a454e16a5ea0f4ced81bd44e4cfc7bd3a507b61887c99fd3538b28e4af"
+
+[[package]]
+name = "memoffset"
+version = "0.9.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "488016bfae457b036d996092f6cb448677611ce4449e970ceaf42695203f218a"
+dependencies = [
+ "autocfg",
+]
+
+[[package]]
+name = "once_cell"
+version = "1.21.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
+
+[[package]]
+name = "portable-atomic"
+version = "1.13.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c33a9471896f1c69cecef8d20cbe2f7accd12527ce60845ff44c153bb2a21b49"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.106"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "pyo3"
+version = "0.23.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7778bffd85cf38175ac1f545509665d0b9b92a198ca7941f131f85f7a4f9a872"
+dependencies = [
+ "cfg-if",
+ "indoc",
+ "libc",
+ "memoffset",
+ "once_cell",
+ "portable-atomic",
+ "pyo3-build-config",
+ "pyo3-ffi",
+ "pyo3-macros",
+ "unindent",
+]
+
+[[package]]
+name = "pyo3-build-config"
+version = "0.23.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "94f6cbe86ef3bf18998d9df6e0f3fc1050a8c5efa409bf712e661a4366e010fb"
+dependencies = [
+ "once_cell",
+ "target-lexicon",
+]
+
+[[package]]
+name = "pyo3-ffi"
+version = "0.23.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e9f1b4c431c0bb1c8fb0a338709859eed0d030ff6daa34368d3b152a63dfdd8d"
+dependencies = [
+ "libc",
+ "pyo3-build-config",
+]
+
+[[package]]
+name = "pyo3-macros"
+version = "0.23.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fbc2201328f63c4710f68abdf653c89d8dbc2858b88c5d88b0ff38a75288a9da"
+dependencies = [
+ "proc-macro2",
+ "pyo3-macros-backend",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "pyo3-macros-backend"
+version = "0.23.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fca6726ad0f3da9c9de093d6f116a93c1a38e417ed73bf138472cf4064f72028"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "pyo3-build-config",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.45"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "41f2619966050689382d2b44f664f4bc593e129785a36d6ee376ddf37259b924"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "running-process-core"
+version = "3.0.0"
+dependencies = [
+ "libc",
+ "thiserror",
+]
+
+[[package]]
+name = "running-process-py"
+version = "3.0.0"
+dependencies = [
+ "pyo3",
+ "running-process-core",
+]
+
+[[package]]
+name = "rustversion"
+version = "1.0.22"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d"
+
+[[package]]
+name = "syn"
+version = "2.0.117"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e665b8803e7b1d2a727f4023456bbbbe74da67099c585258af0ad9c5013b9b99"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "target-lexicon"
+version = "0.12.16"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "61c41af27dd6d1e27b1b16b489db798443478cef1f06a660c96db617ba5de3b1"
+
+[[package]]
+name = "thiserror"
+version = "2.0.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4288b5bcbc7920c07a1149a35cf9590a2aa808e0bc1eafaade0b80947865fbc4"
+dependencies = [
+ "thiserror-impl",
+]
+
+[[package]]
+name = "thiserror-impl"
+version = "2.0.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ebc4ee7f67670e9b64d05fa4253e753e016c6c95ff35b89b7941d6b856dec1d5"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.24"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75"
+
+[[package]]
+name = "unindent"
+version = "0.2.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7264e107f553ccae879d21fbea1d6724ac785e8c3bfc762137959b5802826ef3"

running_process-3.0.0/Cargo.toml

@@ -0,0 +1,15 @@
+[workspace]
+resolver = "2"
+members = ["crates/running-process-core", "crates/running-process-py"]
+
+[workspace.package]
+version = "3.0.0"
+edition = "2021"
+rust-version = "1.85"
+license = "BSD-3-Clause"
+repository = "https://github.com/zackees/running-process"
+homepage = "https://github.com/zackees/running-process"
+
+[workspace.dependencies]
+pyo3 = { version = "0.23", features = ["extension-module"] }
+thiserror = "2"

running_process-3.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 zackees
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

running_process-3.0.0/PKG-INFO

@@ -0,0 +1,261 @@
+Metadata-Version: 2.4
+Name: running_process
+Version: 3.0.0
+Requires-Dist: psutil>=5.9.0
+Requires-Dist: pywinpty>=3.0.0 ; platform_system == 'Windows'
+License-File: LICENSE
+Summary: A Rust-backed subprocess wrapper with split stdout/stderr streaming
+Home-Page: https://github.com/zackees/running-process
+Author-email: Your Name <your.email@example.com>
+License: BSD 3-Clause License
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+
+# running-process
+
+[![Linux x86](https://github.com/zackees/running-process/actions/workflows/linux-x86.yml/badge.svg)](https://github.com/zackees/running-process/actions/workflows/linux-x86.yml)
+[![Linux ARM](https://github.com/zackees/running-process/actions/workflows/linux-arm.yml/badge.svg)](https://github.com/zackees/running-process/actions/workflows/linux-arm.yml)
+[![Windows x86](https://github.com/zackees/running-process/actions/workflows/windows-x86.yml/badge.svg)](https://github.com/zackees/running-process/actions/workflows/windows-x86.yml)
+[![Windows ARM](https://github.com/zackees/running-process/actions/workflows/windows-arm.yml/badge.svg)](https://github.com/zackees/running-process/actions/workflows/windows-arm.yml)
+[![macOS x86](https://github.com/zackees/running-process/actions/workflows/macos-x86.yml/badge.svg)](https://github.com/zackees/running-process/actions/workflows/macos-x86.yml)
+[![macOS ARM](https://github.com/zackees/running-process/actions/workflows/macos-arm.yml/badge.svg)](https://github.com/zackees/running-process/actions/workflows/macos-arm.yml)
+
+`running-process` is a Rust-backed subprocess runtime with a thin Python API.
+
+The pipe-backed API keeps `stdout` and `stderr` separate, preserves raw bytes until decode time, and defaults to UTF-8 with `errors="replace"` when you ask for text. The PTY API is separate because terminal sessions are chunk-oriented and should not be forced through line normalization.
+
+## Pipe-backed API
+
+```python
+from running_process import RunningProcess
+
+process = RunningProcess(
+    ["python", "-c", "import sys; print('out'); print('err', file=sys.stderr)"]
+)
+
+process.wait()
+
+print(process.stdout)          # stdout only
+print(process.stderr)          # stderr only
+print(process.combined_output) # combined compatibility view
+```
+
+Captured data values stay plain `str | bytes`. Live stream handles are exposed separately:
+
+```python
+if process.stdout_stream.available():
+    print(process.stdout_stream.drain())
+```
+
+Process priority is a first-class launch option:
+
+```python
+from running_process import CpuPriority, RunningProcess
+
+process = RunningProcess(
+    ["python", "-c", "import time; time.sleep(1)"],
+    nice=CpuPriority.LOW,
+)
+```
+
+`nice=` behavior:
+
+- accepts either a raw `int` niceness or a platform-neutral `CpuPriority`
+- on Unix, it maps directly to process niceness
+- on Windows, positive values map to below-normal or idle priority classes and negative values map to above-normal or high priority classes
+- `0` leaves the default scheduler priority unchanged
+- positive values are the portable default; negative values may require elevated privileges
+- the enum intentionally stops at `HIGH`; there is no realtime tier
+
+Available helpers:
+
+- `get_next_stdout_line(timeout)`
+- `get_next_stderr_line(timeout)`
+- `get_next_line(timeout)` for combined compatibility reads
+- `drain_stdout()`
+- `drain_stderr()`
+- `drain_combined()`
+- `stdout_stream.available()`
+- `stderr_stream.available()`
+- `combined_stream.available()`
+
+`RunningProcess.run(...)` supports common `subprocess.run(...)` style cases including:
+
+- `capture_output=True`
+- `text=True`
+- `encoding=...`
+- `errors=...`
+- `shell=True`
+- `env=...`
+- `nice=...`
+- `stdin=subprocess.DEVNULL`
+- `input=...` in text or bytes form
+
+Unsupported `subprocess.run(...)` kwargs now fail loudly instead of being silently ignored.
+
+## Expect API
+
+`expect(...)` is available on both the pipe-backed and PTY-backed process APIs.
+
+```python
+import re
+import subprocess
+from running_process import RunningProcess
+
+process = RunningProcess(
+    ["python", "-c", "print('prompt>'); import sys; print('echo:' + sys.stdin.readline().strip())"],
+    stdin=subprocess.PIPE,
+)
+
+process.expect("prompt>", timeout=5, action="hello\n")
+match = process.expect(re.compile(r"echo:(.+)"), timeout=5)
+print(match.groups)
+```
+
+Supported `action=` forms:
+
+- `str` or `bytes`: write to stdin
+- `"interrupt"`: send Ctrl-C style interrupt when supported
+- `"terminate"`
+- `"kill"`
+- `callable(match, process)`
+
+Pipe-backed `expect(...)` matches line-delimited output. If the child writes prompts without trailing newlines, use the PTY API instead.
+
+## PTY API
+
+Use `RunningProcess.pseudo_terminal(...)` for interactive terminal sessions. It is chunk-oriented by design and preserves carriage returns and terminal control flow instead of normalizing it away.
+
+```python
+from running_process import ExpectRule, RunningProcess
+
+pty = RunningProcess.pseudo_terminal(
+    ["python", "-c", "import sys; sys.stdout.write('name?'); sys.stdout.flush(); print('hello ' + sys.stdin.readline().strip())"],
+    text=True,
+    expect=[ExpectRule("name?", "world\n")],
+    expect_timeout=5,
+)
+
+print(pty.output)
+```
+
+PTY behavior:
+
+- accepts `str` and `list[str]` commands
+- auto-splits simple string commands into argv when shell syntax is not present
+- uses shell mode automatically when shell metacharacters are present
+- keeps output chunk-buffered by default
+- preserves `\r` for redraw-style terminal output
+- supports `write(...)`, `read(...)`, `drain()`, `available()`, `expect(...)`, `resize(...)`, and `send_interrupt()`
+- supports `nice=...` at launch
+- supports `restore_callback=` and `cleanup_callback=` so terminal restoration and cleanup paths are explicit and testable
+- supports `interrupt_and_wait(...)` for staged interrupt escalation
+- supports `wait_for_idle(...)` with activity filtering
+- exposes `exit_reason`, `interrupt_count`, `interrupted_by_caller`, and `exit_status`
+
+There is also a compatibility alias: `RunningProcess.psuedo_terminal(...)`.
+
+You can also inspect the intended interactive launch semantics without launching a child:
+
+```python
+from running_process import RunningProcess
+
+spec = RunningProcess.interactive_launch_spec("console_isolated")
+print(spec.ctrl_c_owner)
+print(spec.creationflags)
+```
+
+Supported launch specs:
+
+- `pseudo_terminal`
+- `console_shared`
+- `console_isolated`
+
+For an actual launch, use `RunningProcess.interactive(...)`:
+
+```python
+process = RunningProcess.interactive(
+    ["python", "-c", "print('hello from interactive mode')"],
+    mode="console_shared",
+    nice=5,
+)
+process.wait()
+```
+
+## Abnormal Exits
+
+By default, nonzero exits stay subprocess-like: you get a return code and can inspect `exit_status`.
+
+```python
+process = RunningProcess(["python", "-c", "import sys; sys.exit(3)"])
+process.wait()
+print(process.exit_status)
+```
+
+If you want abnormal exits to raise, opt in:
+
+```python
+from running_process import ProcessAbnormalExit, RunningProcess
+
+try:
+    RunningProcess.run(
+        ["python", "-c", "import sys; sys.exit(3)"],
+        capture_output=True,
+        raise_on_abnormal_exit=True,
+    )
+except ProcessAbnormalExit as exc:
+    print(exc.status.summary)
+```
+
+Notes:
+
+- keyboard interrupts still raise `KeyboardInterrupt`
+- `kill -9` / `SIGKILL` is classified as an abnormal signal exit
+- possible OOM conditions are exposed as a hint on `exit_status.possible_oom`
+- OOM cannot be identified perfectly across platforms from exit status alone, so it is best-effort rather than guaranteed
+
+## Text and bytes
+
+Pipe mode is byte-safe internally:
+
+- invalid UTF-8 does not break capture
+- text mode decodes with UTF-8 and `errors="replace"` by default
+- binary mode returns bytes unchanged
+- `\r\n` is normalized as a line break in pipe mode
+- bare `\r` is preserved
+
+PTY mode is intentionally more conservative:
+
+- output is handled as chunks, not lines
+- redraw-oriented `\r` is preserved
+- no automatic terminal-output normalization is applied
+
+## Development
+
+```bash
+./install
+./lint
+./test
+```
+
+`./install` bootstraps the repo-local Rust toolchain into `./.cargo` and `./.rustup`.
+
+`./test` runs the Rust tests, rebuilds the native extension with the unoptimized `dev` profile, runs the non-live Python tests, and then runs the `@pytest.mark.live` coverage that exercises real OS process and signal behavior.
+
+If you want to invoke pytest directly, set `RUNNING_PROCESS_LIVE_TESTS=1` and run `uv run pytest -m live`.
+
+For direct Rust commands, prefer the repo-local trampolines:
+
+```bash
+./_cargo check --workspace
+./_cargo fmt --all --check
+./_cargo clippy --workspace --all-targets -- -D warnings
+```
+
+## Notes
+
+- `stdout` and `stderr` are no longer merged by default.
+- `combined_output` exists for compatibility when you need the merged view.
+- `RunningProcess(..., use_pty=True)` is no longer the preferred path; use `RunningProcess.pseudo_terminal(...)` for PTY sessions.
+- The test suite checks that `running_process.__version__`, package metadata, and manifest versions stay in sync.
+