pl-run-program 0.0.1__tar.gz

pl_run_program-0.0.1/LICENSE

@@ -0,0 +1,203 @@
+Copyright 2026 Peter Lavigne
+
+                                 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.

pl_run_program-0.0.1/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: pl-run-program
+Version: 0.0.1
+Summary: A simple interface for running programs.
+Author: Peter Lavigne
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: License :: OSI Approved :: Apache Software License
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+
+# pl-run-program
+
+A simple interface for running programs.
+
+## License
+
+Licensed under the Apache License 2.0. See [LICENSE](./LICENSE).

pl_run_program-0.0.1/README.md

@@ -0,0 +1,7 @@
+# pl-run-program
+
+A simple interface for running programs.
+
+## License
+
+Licensed under the Apache License 2.0. See [LICENSE](./LICENSE).

pl_run_program-0.0.1/pyproject.toml

@@ -0,0 +1,179 @@
+[project]
+name = "pl-run-program"
+version = "0.0.1"
+description = "A simple interface for running programs."
+readme = "README.md"
+authors = [
+    { name = "Peter Lavigne" }
+]
+requires-python = ">=3.14"
+dependencies = []
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+classifiers = [
+  "License :: OSI Approved :: Apache Software License",
+]
+
+[build-system]
+requires = ["uv_build>=0.10.4,<0.11.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "pyright>=1.1.408",
+    "pytest>=9.0.2",
+    "pytest-cov>=7.0.0",
+    "pytest-xdist>=3.8.0",
+    "ruff>=0.15.2",
+]
+
+[tool.ruff.lint]
+select = [
+    "AIR",
+    "ERA",
+    "FAST",
+    "YTT",
+    "ANN",
+    "ASYNC",
+    "S",
+    "B",
+    "A",
+    "COM",
+    "C4",
+    "T10",
+    "DJ",
+    "EM",
+    "EXE",
+    "FIX",
+    "FA",
+    "INT",
+    "ISC",
+    "ICN",
+    "LOG",
+    "G",
+    "INP",
+    "PIE",
+    "PYI",
+    "PT",
+    "Q",
+    "RSE",
+    "RET",
+    "SLF",
+    "SIM",
+    "SLOT",
+    "TID",
+    "TD",
+    "TC",
+    "ARG",
+    "PTH",
+    "FLY",
+    "I",
+    "NPY",
+    "PD",
+    "N",
+    "PERF",
+    "W",
+    "E",
+    "W",
+    "D",
+    "F",
+    "PGH",
+    "PL",
+    "PLC",
+    "PLE",
+    "PLR",
+    "PLW",
+    "UP",
+    "FURB",
+    "RUF",
+    "TRY",
+]
+ignore = [
+    # From https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules :
+    # "When using Ruff as a formatter, we recommend avoiding the following lint rules:"
+    "W191",
+    "E111",
+    "E114",
+    "E117",
+    "D206",
+    "D300",
+    "Q000",
+    "Q001",
+    "Q002",
+    "Q003",
+    "COM812",
+    # Line-too-long errors. I'm OK with long lines.
+    "E501",
+    # Inconsistent with D211, which I prefer.
+    # https://docs.astral.sh/ruff/rules/incorrect-blank-line-before-class/
+    "D203",
+    # Most of this repo is CLI tools, so I use `print` and `pprint` a lot.
+    # Therefore, don't flag them.
+    "T20",
+    # D212 and D213 are mutually exclusive. I prefer D213.
+    "D212",
+    # D100-D107 make docstrings mandatory. I think redundant docstrings add noise, so I disable these checks.
+    "D100",
+    "D101",
+    "D102",
+    "D103",
+    "D104",
+    "D105",
+    "D106",
+    "D107",
+    # While a dead code check would be useful, this implementation has too many false positives to be useful.
+    "ERA001",
+    # I don't completely disagree with the reasoning behind this check, but this leans more into API design than code quality.
+    # Since I have a decent amount of code already written with boolean arguments, and it's a difficult change, I'm choosing to ignore this for now.
+    "FBT",
+    # I understand why this check exists, but I don't use performance mode and think that asserts are a concise way to express some constraints. Leaving this disabled.
+    # Note: This is also ignored in test files below, because I definitely don't want this check in pytest tests.
+    "S101",
+    # Someday, when I am old and wise and at peace (or banging my head against timezones, again), I'd like to sit down and fully guard my codebase against timezone issues.
+    # That day is not today.
+    "DTZ",
+    # Code smells, but not necessarily errors.
+    "PLR2004",
+    "PLR0911",
+    "PLR0912",
+    "PLR0913",
+    "PLR0914",
+    "PLR0915",
+    "C90",
+    # Exception-related checks. When I better understand exception handling best practices, I may re-enable some of these.
+    "B017",
+    "BLE",
+    "PT011",
+    "PT017",
+    "PT027",
+    "RUF043",
+    "TRY002",
+    "TRY301",
+    # Logging-related checks. When I better understand logging best practices, I may re-enable this.
+    "G004",
+    "LOG015",
+    # SQL-related check. When I start using SQL more, I may re-enable this.
+    "S608",
+    # All of my failures for this check were false positives.
+    # "Prone to false positives" is listed in the docs for this check.
+    "S603",
+    # I keep typing-only imports because they're used during code generation, not just tests.
+    "TC001",
+    "TC002",
+    "TC003",
+]
+
+[tool.ruff.lint.per-file-ignores]
+# S101 bans assert statements. Since I use them heavily in test files, I disable this check in tests.
+# S105 and S106 ban hard-coding secrets-setting. I often do this in tests to configure dependencies, so I disable these checks in tests.
+"*_test.py" = ["S101", "S105", "S106"]
+
+
+[tool.pyright]
+typeCheckingMode = "strict"
+
+[tool.coverage.run]
+omit = [
+    # Tests are not included in coverage.
+    "src/*_test.py",
+]

pl_run_program-0.0.1/src/pl_run_program/__init__.py

@@ -0,0 +1,12 @@
+from .program_at_path import Program, program_at_path
+from .run_program import ProgramResult, run_program
+from .run_simple_program import SimpleProgramError, run_simple_program
+
+__all__ = [
+    "Program",
+    "program_at_path",
+    "ProgramResult",
+    "run_program",
+    "SimpleProgramError",
+    "run_simple_program",
+]

pl_run_program-0.0.1/src/pl_run_program/program_at_path.py

@@ -0,0 +1,25 @@
+import os
+from pathlib import Path
+from typing import NewType
+
+Program = NewType("Program", Path)
+
+
+def program_at_path(path: Path) -> Program:
+    if not path.is_absolute():
+        msg = "Program path must be absolute"
+        raise ValueError(msg)
+
+    if not path.exists():
+        msg = f"Program path does not exist: {path}"
+        raise ValueError(msg)
+
+    if path.is_dir():
+        msg = f"Program path is a directory: {path}"
+        raise ValueError(msg)
+
+    if not os.access(path, os.X_OK):
+        msg = f"Program path is not executable: {path}"
+        raise ValueError(msg)
+
+    return Program(path)

pl_run_program-0.0.1/src/pl_run_program/run_program.py

@@ -0,0 +1,75 @@
+import logging
+import subprocess
+from dataclasses import dataclass
+from pathlib import Path
+
+from pl_run_program.program_at_path import Program
+
+
+@dataclass
+class ProgramResult:
+    stdout: str
+    stderr: str
+    returncode: int
+
+
+def run_program(
+    program: Program,
+    args: list[str] | None = None,
+    stdin: str | None = None,
+    cwd: Path | None = None,
+    env: dict[str, str] | None = None,
+) -> ProgramResult:
+    r"""
+    Run a program and return its result.
+
+    It is the responsibility of the caller to ensure that inputs are safe.
+
+    Args:
+        program: Program to run, e.g. "/bin/git", "/bin/ls", or "/usr/bin/python3". Must be an absolute path.
+        args: Arguments to pass, e.g. ["commit", "-m", "message"]
+        stdin: String to send to the program's stdin
+        cwd: Working directory (Defaults to current working directory)
+        env: Environment variables (Defaults to empty environment)
+
+    Returns:
+        ProgramResult with stdout, stderr, and return code
+
+    Example:
+        ```
+        result = run_program("git", ["status"])
+        print(result.stdout)
+
+        # With stdin
+        result = run_program("grep", ["error"], stdin="line1\nline2\nerror here\n")
+
+        # Check result
+        if result.returncode != 0:
+            print(f"Failed: {result.stderr}")
+        ```
+
+    """
+    cmd = [program] + (args or [])
+
+    if env is None:
+        env = {}
+
+    args_log = f"[{', '.join(f'"{arg}"' for arg in args)}]" if args else "[]"
+    env_log = "{" + ", ".join(f'"{k}": "{v}"' for k, v in env.items()) + "}"
+    logging.debug(
+        f'Running a program with the following parameters: program="{program}", args={args_log}, cwd="{cwd}", env={env_log}'
+    )
+
+    result = subprocess.run(
+        cmd, input=stdin, capture_output=True, text=True, cwd=cwd, env=env, check=False
+    )
+
+    return_value = ProgramResult(
+        stdout=result.stdout,
+        stderr=result.stderr,
+        returncode=result.returncode,
+    )
+
+    logging.debug(f"Program result: {return_value}")
+
+    return return_value

pl_run_program-0.0.1/src/pl_run_program/run_simple_program.py

@@ -0,0 +1,27 @@
+from pathlib import Path
+
+from pl_run_program.program_at_path import Program
+from pl_run_program.run_program import run_program
+
+
+class SimpleProgramError(Exception):
+    pass
+
+
+def run_simple_program(
+    program: Program,
+    args: list[str] | None = None,
+    stdin: str | None = None,
+    cwd: Path | None = None,
+    env: dict[str, str] | None = None,
+) -> str:
+    """Wrap `run_program` for simple use cases where we want an exception on non-zero return codes and only care about stdout."""
+    result = run_program(program, args=args, stdin=stdin, cwd=cwd, env=env)
+    if result.returncode != 0:
+        program_with_args = f"{program} {' '.join(args)}" if args else str(program)
+        msg = (
+            f"Program `{program_with_args}` returned non-zero return code {result.returncode}. "
+            f"stdout: `{result.stdout}` stderr: `{result.stderr}`"
+        )
+        raise SimpleProgramError(msg)
+    return result.stdout