bashrun 0.1.0__tar.gz → 0.1.2__tar.gz

bashrun-0.1.2/.gitattributes

@@ -0,0 +1 @@
+ruff.base.toml -text

{bashrun-0.1.0 → bashrun-0.1.2}/.github/workflows/ci.yml

@@ -32,6 +32,9 @@ jobs:
       - name: Test
         run: uv run pytest
 
+      - name: Ruff config drift
+        run: uvx --from python-devkit==0.1.3 sync-ruff --check
+
   publish:
     needs: check
     if: github.event_name == 'push' && github.ref == 'refs/heads/main'
@@ -48,4 +51,4 @@ jobs:
       - uses: astral-sh/setup-uv@v7
 
       - name: Publish
-        run: uvx --from git+https://github.com/outernet-foundation/pubpkg.git@ea2ecf35a93a3c6405b9430a651d2a7b3d2faa6c publish-packages --config publish-config.json
+        run: uvx --from release-kit==0.1.0 publish-packages --config publish-config.json

{bashrun-0.1.0 → bashrun-0.1.2}/AGENTS.md

@@ -17,7 +17,7 @@ The package is `bashrun` (src-layout under `src/bashrun/`); consumer repos decla
   - `bash_pipe(cmd1, cmd2, ...)` — runs a real shell pipeline by chaining child processes' stdio in Python; each intermediate's stderr is discarded, the final's is preserved. This is why `bash`/`bash_output` reject `|`: pipelines have their own helper.
   - `bash_handoff(command)` — `os.execvpe`s into the child (Windows falls back to `subprocess.run` + `sys.exit`). The current process is replaced; no return.
   - `first_stderr_line(error)` — the first non-empty stderr line of a `CalledProcessError`, falling back to `str(error)` when stderr is absent. The one-liner shape for surfacing "why did it fail" in a verdict row or problem message without dumping full stderr.
-- `__init__.py` — re-exports the seven helper names plus `CalledProcessError` (the type `bash`/`bash_output` raise on failure), so consumers can catch the wrapper's own failure shape without importing `subprocess` themselves; the re-export is routed through `bash.py`, so the `# ruff: noqa: S404` boundary stays that one file.
+- `__init__.py` — empty (RUF067 strict mode); the public surface is `bashrun.bash`, imported by submodule path (`from bashrun.bash import bash, CalledProcessError`). `CalledProcessError` (the type `bash`/`bash_output` raise on failure) lives in `bash.py`, so consumers can catch the wrapper's own failure shape without importing `subprocess` themselves; the `# ruff: noqa: S404` boundary stays that one file.
 
 ## Constraints
 

{bashrun-0.1.0 → bashrun-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: bashrun
-Version: 0.1.0
+Version: 0.1.2
 Summary: Guardrailed shell-exec helpers for Python
 License-File: LICENSE
 License-File: NOTICE

{bashrun-0.1.0 → bashrun-0.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "bashrun"
-version = "0.1.0"
+version = "0.1.2"
 description = "Guardrailed shell-exec helpers for Python"
 requires-python = ">=3.13"
 dependencies = []

bashrun-0.1.2/ruff.base.toml

@@ -0,0 +1,204 @@
+# Org-canonical ruff configuration, hosted in python-devkit.
+# Consuming repos carry this file verbatim as ruff.base.toml, written by the
+# sync-ruff verb (uvx --from python-devkit sync-ruff) and drift-gated in CI.
+# Never edit a synced copy: change this canonical, release python-devkit, and
+# re-run sync-ruff in each consuming repo.
+target-version = "py313"
+line-length = 120
+preview = true
+required-version = ">=0.14.11"
+
+[lint]
+select = ["ALL"]
+ignore = [
+    # ── Temporarily ignored (inline noqas exist for these rules but are redundant
+    # while the rules are globally ignored — RUF100 suppresses the "unused noqa" warning
+    # until we un-ignore each ticket's rules)
+    "RUF100",
+
+    # ── Permanently ignored ──────────────────────────────────────────────
+    # Type annotations — basedpyright strict mode handles this
+    "ANN",
+    # EM101 (string literal in exception) — the msg = ... indirection adds verbosity without benefit
+    "EM101",
+    # TRY003 (raise vanilla args) — requires custom exception class for every raise site;
+    # the real problem (interpolation) is caught by EM102/EM103
+    "TRY003",
+    # A003 (class attribute shadowing) — class attributes via self.x never conflict with builtins
+    "A003",
+    # Function complexity counting — C901 already covers structural complexity;
+    # these counting rules are largely redundant
+    "PLR0911",
+    "PLR0912",
+    "PLR0913",
+    "PLR0914",
+    "PLR0915",
+    "PLR0917",
+
+    # ── Temporarily ignored (will enable when conventions are established) ─
+    # Docstrings — project policy is "no docstrings" for now
+    "D",
+    # Copyright notices — not yet established
+    "CPY",
+    # Docstring formatting — blocked on D
+    "DOC",
+    # TODO/FIXME comment formatting
+    "TD",
+    "FIX",
+
+    # The "Ticket N" blocks below are the transitional cleanup slices tracked
+    # by PLE-248 (Enforce the deferred ruff rules):
+    #   https://linear.app/plerionplatforms/issue/PLE-248
+    # Ticket 3 (T201, print → logging) is tracked by PLE-336:
+    #   https://linear.app/plerionplatforms/issue/PLE-336
+    # Lifting a rule = remove it here in python-devkit's canonical config,
+    # release, and run sync-ruff in every consuming repo.
+
+    # ── Ticket 1: Auto-fix formatting & type modernization ───────────────
+    # Zero risk. Purely mechanical, all auto-fixable via ruff --fix.
+    "COM812",   # missing trailing commas
+    "I001",     # import sorting
+    "ISC003",   # explicit string concatenation
+    "RUF031",   # parenthesized tuple in subscript
+    "TC001",    # move import into TYPE_CHECKING block
+    "TC002",    # move third-party import into TYPE_CHECKING block
+    "TC003",    # move stdlib import into TYPE_CHECKING block
+    "TC006",    # move typing import into TYPE_CHECKING block (PEP 695)
+    "TC008",    # move import into TYPE_CHECKING block (quoted annotation)
+    "UP006",    # use X instead of typing.X
+    "UP007",    # use X | Y instead of Union
+    "UP011",    # unnecessary parentheses to functools.lru_cache
+    "UP015",    # unnecessary open mode parameters
+    "UP017",    # use datetime.UTC alias
+    "UP034",    # extraneous parentheses
+    "UP035",    # deprecated import (use collections.abc, etc.)
+    "UP040",    # use PEP 695 type alias
+    "UP042",    # use PEP 695 type parameters
+    "UP045",    # use X | None instead of Optional
+
+    # ── Ticket 2: Auto-fix code simplifications ──────────────────────────
+    # Very low risk. Auto-fixable with trivial semantic changes.
+    "C401",     # unnecessary generator — use set/dict comprehension
+    "C416",     # unnecessary comprehension — use list/dict
+    "ERA001",   # commented-out code
+    "FURB101",  # read-text can replace open+read
+    "FURB103",  # write-text can replace open+write
+    "FURB110",  # use ternary instead of try/except for default
+    "FURB113",  # use list.extend instead of repeated append
+    "FURB118",  # use operator module instead of lambda
+    "LOG004",   # use __name__ as logger name
+    "PERF401",  # use list comprehension instead of manual append
+    "PIE810",   # unnecessary spread of single-element starred
+    "PLC0207",  # use a single __all__ definition
+    "PLC1901",  # compare to empty string using falsy check
+    "PLR1711",  # useless return at end of function
+    "PLR6104",  # use augmented assignment
+    "PLR6201",  # use a set literal for membership test
+    "PLW1510",  # subprocess.run without explicit check= argument
+    "PLW1514",  # open without explicit encoding
+    "PT001",    # use @pytest.fixture over @pytest.fixture()
+    "PT018",    # composite assertion — split into multiple asserts
+    "PTH101",   # os.chmod → Path.chmod
+    "PTH111",   # os.path.expanduser → Path.expanduser
+    "PTH112",   # os.path.isdir → Path.is_dir
+    "PTH118",   # os.path.join → Path /
+    "PTH123",   # open() → Path.open()
+    "PTH201",   # pathlib.Path(".")
+    "RET501",   # unnecessary explicit return None
+    "RET504",   # unnecessary assignment before return
+    "RET505",   # unnecessary else after return
+    "RET506",   # unnecessary else after raise
+    "RET507",   # unnecessary else after continue
+    "RSE102",   # unnecessary parentheses on raised exception
+    "RUF005",   # consider spread operator instead of concatenation
+    "RUF010",   # use explicit conversion flag in f-string
+    "RUF015",   # prefer next() over single-element slice
+    "RUF029",   # function is declared async but has no await
+    "RUF052",   # local variable is assigned but never used (underscore prefix)
+    "RUF056",   # unnecessary default value for keyword argument
+    "SIM102",   # collapsible if statements
+    "SIM105",   # use contextlib.suppress instead of try/except/pass
+    "SIM115",   # use context manager for opening files
+    "SIM117",   # use single with statement for multiple context managers
+    "SIM118",   # use key in dict instead of key in dict.keys()
+    "TID252",   # prefer absolute imports over relative
+
+    # ── Ticket 3: print → logging ────────────────────────────────────────
+    # All code should use logging, including CLI scripts.
+    "T201",     # print found
+
+    # ── Ticket 4: Exception message interpolation ────────────────────────
+    # Remove f-strings from exception messages — use string literals.
+    "EM102",    # f-string in exception message
+
+    # ── Ticket 5: Missing __init__.py + shebangs ─────────────────────────
+    # Add __init__.py to installable packages; remove vestigial shebangs.
+    "INP001",   # implicit namespace package — add __init__.py
+    "EXE001",   # shebang present but file not executable
+
+    # ── Ticket 6: Type ignore specificity ────────────────────────────────
+    # Replace blanket type: ignore with specific error codes.
+    "PGH003",   # blanket type: ignore
+
+    # ── Ticket 7: Boolean trap refactoring ───────────────────────────────
+    # Change function signatures — callers must update too.
+    "FBT001",   # boolean positional argument
+    "FBT002",   # boolean default value in function definition
+    "FBT003",   # boolean positional value in call
+
+    # ── Ticket 8: Exception handling patterns ────────────────────────────
+    # Behavioral changes to error handling.
+    "B020",     # loop variable overwritten by except
+    "B903",     # generator should use yield from
+    "B904",     # raise without from inside except
+    "B905",     # zip() without strict= parameter
+    "BLE001",   # blind except Exception
+    "S101",     # assert outside tests
+    "TRY002",   # create custom exception class
+    "TRY300",   # try/except/return — move return into else
+
+    # ── Ticket 9: Complexity, naming & refactoring ───────────────────────
+    # Structural changes requiring judgment.
+    "A001",     # builtin shadowing (dir, bytes)
+    "ARG001",   # unused function argument
+    "ARG002",   # unused method argument
+    "C901",     # function too complex
+    "E501",     # line too long
+    "N802",     # function name should be lowercase
+    "N806",     # variable in function should be lowercase
+    "N815",     # mixed-case variable in class scope
+    "N818",     # exception name should end in Error
+    "PLC0415",  # import not at top level
+    "PLE0704",  # bare raise not inside except handler
+    "PLR1702",  # too many nested blocks
+    "PLR2004",  # magic value used in comparison
+    "PLR6301",  # method could be function or static method
+    "PLW0603",  # global statement
+    "PLW2901",  # loop variable overwritten
+    "RUF001",   # ambiguous unicode — replace with ASCII
+    "RUF003",   # ambiguous unicode in comment
+    "S106",     # possible hardcoded password
+    "S108",     # probable insecure temp file/dir usage
+    "S110",     # try/except/pass on broad exception
+    "S202",     # use of tarfile.extractall
+    # S404/S603: prerequisite — bash.py needs env, stderr=STDOUT merge, and no-raise-with-capture
+    # before context_sha.py, deptry_check.py, test_context_sha.py, list_debug_targets.py can migrate
+    "S404",     # suspicious subprocess import
+    "S603",     # subprocess call with non-literal
+    "S606",     # starting process without shell
+    "S607",     # starting process with partial path
+]
+
+[lint.per-file-ignores]
+# Tests use assert as the standard pytest mechanism; fixtures take arguments
+# that pytest consumes implicitly; pytest-style test classes need no self use
+"**/tests/**" = ["S101", "ARG001", "ARG002", "PLR6301"]
+
+[lint.ruff]
+# RUF067 in strict mode: __init__.py files must be empty — no re-exports, no
+# side effects. Consumers import submodule paths (from pkg.mod import thing);
+# the package layout is the public surface.
+strictly-empty-init-modules = true
+
+[lint.flake8-builtins]
+ignorelist = ["id", "map"]

bashrun-0.1.2/ruff.toml

@@ -0,0 +1 @@
+extend = "ruff.base.toml"

{bashrun-0.1.0 → bashrun-0.1.2}/src/bashrun/bash.py

@@ -1,4 +1,4 @@
-# ruff: noqa: S404, S603, S606, T201, PLW0717, PLW1510 — this module is the project's subprocess wrapper
+# ruff: noqa: S404, S603, S606, T201, PLC0414, PLW0717, PLW1510 — this module is the project's subprocess wrapper (PLC0414: the same-name alias is pyright's explicit-re-export idiom for CalledProcessError)
 import os
 import re
 import shlex
@@ -7,7 +7,7 @@ import subprocess
 import sys
 from contextlib import ExitStack
 from pathlib import Path
-from subprocess import CalledProcessError, Popen, TimeoutExpired
+from subprocess import CalledProcessError as CalledProcessError, Popen, TimeoutExpired
 from typing import NoReturn
 
 

{bashrun-0.1.0 → bashrun-0.1.2}/tests/test_bash.py

@@ -6,7 +6,7 @@ import tempfile
 from pathlib import Path
 
 import pytest
-from bashrun import (
+from bashrun.bash import (
     CalledProcessError,
     bash,
     bash_check,
@@ -67,7 +67,7 @@ class TestBash:
                 [
                     sys.executable,
                     "-c",
-                    f"from pathlib import Path; from bashrun import bash; bash('pwd', cwd=Path('{tmpdir}'))",
+                    f"from pathlib import Path; from bashrun.bash import bash; bash('pwd', cwd=Path('{tmpdir}'))",
                 ],
                 capture_output=True,
                 text=True,
@@ -76,7 +76,7 @@ class TestBash:
 
     def test_passes_stdin_text(self):
         result = subprocess.run(
-            [sys.executable, "-c", "from bashrun import bash; bash('cat', stdin_text='streamed input')"],
+            [sys.executable, "-c", "from bashrun.bash import bash; bash('cat', stdin_text='streamed input')"],
             capture_output=True,
             text=True,
         )
@@ -137,7 +137,7 @@ class TestBashNoRaise:
 class TestBashHandoff:
     def test_stdout_contains_output(self):
         result = subprocess.run(
-            [sys.executable, "-c", "from bashrun import bash_handoff; bash_handoff('echo handoff_test')"],
+            [sys.executable, "-c", "from bashrun.bash import bash_handoff; bash_handoff('echo handoff_test')"],
             capture_output=True,
             text=True,
         )
@@ -145,7 +145,7 @@ class TestBashHandoff:
 
     def test_exit_code_matches(self):
         result = subprocess.run(
-            [sys.executable, "-c", "from bashrun import bash_handoff; bash_handoff('sh -c \"exit 42\"')"],
+            [sys.executable, "-c", "from bashrun.bash import bash_handoff; bash_handoff('sh -c \"exit 42\"')"],
             capture_output=True,
             text=True,
         )
@@ -157,7 +157,7 @@ class TestBashHandoff:
                 [
                     sys.executable,
                     "-c",
-                    f"from pathlib import Path; from bashrun import bash_handoff; bash_handoff('pwd', cwd=Path('{tmpdir}'))",
+                    f"from pathlib import Path; from bashrun.bash import bash_handoff; bash_handoff('pwd', cwd=Path('{tmpdir}'))",
                 ],
                 capture_output=True,
                 text=True,

bashrun-0.1.0/ruff.toml

@@ -1,57 +0,0 @@
-target-version = "py313"
-line-length = 120
-preview = true
-
-[lint]
-select = ["ALL"]
-ignore = [
-    # Type annotations — basedpyright strict mode handles this
-    "ANN",
-    # No docstrings, no copyright headers
-    "D",
-    "DOC",
-    "CPY",
-    # TODO/FIXME comment formatting
-    "TD",
-    "FIX",
-    # Exception message ergonomics — literal-indirection and custom-class churn without benefit
-    "EM101",
-    "EM102",
-    "TRY003",
-    # Class attribute names never conflict with builtins via self.x
-    "A003",
-    # Function-size counters — C901 already covers structural complexity
-    "PLR0911",
-    "PLR0912",
-    "PLR0913",
-    "PLR0914",
-    "PLR0915",
-    "PLR0917",
-    # Boolean parameters read fine as keyword-only flags here
-    "FBT001",
-    "FBT002",
-    "FBT003",
-    # Relative imports are the intra-package convention
-    "TID252",
-    # Formatter-owned; enforced by `ruff format`
-    "COM812",
-    "I001",
-    # Magic values in comparisons are readable here
-    "PLR2004",
-    # The formatter owns wrapping; long string literals and URLs stay on one line
-    "E501",
-    # src-layout tests need no __init__.py
-    "INP001",
-    # Runtime-used typing imports stay at module level
-    "TC001",
-    "TC002",
-    "TC003",
-    # Small literal tuples read fine in membership tests
-    "PLR6201",
-]
-
-[lint.per-file-ignores]
-"tests/**" = ["S101", "PLR6301"]
-
-[lint.flake8-builtins]
-ignorelist = ["id", "map"]

bashrun-0.1.0/src/bashrun/__init__.py

@@ -1,23 +0,0 @@
-from .bash import (
-    CalledProcessError,
-    bash,
-    bash_check,
-    bash_check_stream,
-    bash_handoff,
-    bash_no_raise,
-    bash_output,
-    bash_pipe,
-    first_stderr_line,
-)
-
-__all__ = [
-    "CalledProcessError",
-    "bash",
-    "bash_check",
-    "bash_check_stream",
-    "bash_handoff",
-    "bash_no_raise",
-    "bash_output",
-    "bash_pipe",
-    "first_stderr_line",
-]