cleanup and fix package build. fix unicode escape for 3.12

Author: adamhl8

.gitignore

@@ -1,8 +1,5 @@
 __pycache__
-__pypackages__
+.python-version
 .pytest_cache
 .ruff_cache
-.pdm-python
-build
 dist
-pypi-*

pdm.lock

@@ -1,6 +1,6 @@
 [project]
 name = "python-shellrunner"
-version = "0.3.2"
+version = "0.3.3"
 description = "Write safe shell scripts in Python."
 authors = [
     {name = "adamhl8", email = "adamhl@pm.me"},
@@ -28,42 +28,46 @@ keywords = ["shell", "scripting", "bash", "zsh", "fish"]
 "Source" = "https://github.com/adamhl8/python-shellrunner"
 "Bug Tracker" = "https://github.com/adamhl8/python-shellrunner/issues"
 
-[tool.pdm.dev-dependencies]
-dev = [
-    "black>=23.3.0",
-    "ruff>=0.0.261",
-    "pytest>=7.3.1",
+[tool.rye]
+managed = true
+dev-dependencies = [
+    "black>=23.9.1",
+    "ruff>=0.0.292",
+    "pytest>=7.4.2",
     "pyroma>=4.2",
-    "types-psutil>=5.9.5.11",
+    "types-psutil>=5.9.5.16",
 ]
 
-[tool.pdm.scripts]
-test = {cmd = "pytest src"}
-pyright = {shell = "pyright src"}
-ruff = {cmd = "ruff check src"}
-lint = {composite = ["pyright", "ruff"]}
-format = {cmd = "black src"}
-pyroma = {cmd = "pyroma ."}
-
-[tool.pytest.ini_options]
-pythonpath = ["src"]
+[tool.rye.scripts]
+test = "pytest shellrunner"
+"lint:pyright" = "pyright ."
+"lint:ruff" = "ruff check ."
+lint = { chain = ["lint:pyright", "lint:ruff"] }
+format = "black ."
+"lint:pyroma" = "pyroma ."
 
 [tool.pyright]
 typeCheckingMode = "strict"
-extraPaths = ["__pypackages__/3.10/lib", "src"]
+
+[tool.black]
+line-length = 120
+target-version = ["py312"]
 
 [tool.ruff]
 line-length = 120
-target-version = "py310"
+target-version = "py312"
 select = ["E", "F", "W", "I", "N", "UP", "BLE", "FBT", "B", "A", "COM", "C4", "T10", "EM", "EXE", "ISC", "ICN", "G",
 "INP", "PIE", "PYI", "PT", "Q", "RSE", "RET", "SLF", "SIM", "TID", "TCH", "ARG", "PTH", "ERA", "PL", "PLC", "PLE",
 "PLR", "PLW", "TRY", "RUF"]
 ignore = ["E501", "PLR0915", "PLR0912", "PLR0913", "PLC1901"]
 
-[tool.black]
-line-length = 120
-target-version = ["py310"]
-
 [build-system]
-requires = ["pdm-backend"]
-build-backend = "pdm.backend"
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build]
+packages = ["shellrunner"]
+exclude = ["test*.py"]
+
+[tool.hatch.metadata]
+allow-direct-references = true

pyproject.toml

@@ -0,0 +1,34 @@
+# generated by rye
+# use `rye lock` or `rye sync` to update this lockfile
+#
+# last locked with the following flags:
+#   pre: false
+#   features: []
+#   all-features: false
+
+-e file:.
+black==23.9.1
+build==1.0.3
+certifi==2023.7.22
+charset-normalizer==3.3.0
+click==8.1.7
+docutils==0.20.1
+idna==3.4
+iniconfig==2.0.0
+mypy-extensions==1.0.0
+packaging==23.2
+pathspec==0.11.2
+platformdirs==3.11.0
+pluggy==1.3.0
+psutil==5.9.5
+pygments==2.16.1
+pyproject-hooks==1.0.0
+pyroma==4.2
+pytest==7.4.2
+requests==2.31.0
+ruff==0.0.292
+trove-classifiers==2023.9.19
+types-psutil==5.9.5.16
+urllib3==2.0.6
+# The following packages are considered to be unsafe in a requirements file:
+setuptools==68.2.2

requirements-dev.lock

@@ -0,0 +1,10 @@
+# generated by rye
+# use `rye lock` or `rye sync` to update this lockfile
+#
+# last locked with the following flags:
+#   pre: false
+#   features: []
+#   all-features: false
+
+-e file:.
+psutil==5.9.5

requirements.lock

@@ -0,0 +1,10 @@
+from ._exceptions import ShellCommandError, ShellCommandResult, ShellResolutionError, ShellRunnerError
+from ._shellrunner import run as X  # noqa: N812
+
+__all__ = [
+    "ShellCommandError",
+    "ShellCommandResult",
+    "ShellResolutionError",
+    "ShellRunnerError",
+    "X",
+]

shellrunner/__init__.py

@@ -0,0 +1,27 @@
+from typing import NamedTuple
+
+
+class ShellCommandResult(NamedTuple):
+    out: str
+    status: int
+    pipestatus: list[int]
+
+
+class ShellRunnerError(RuntimeError):
+    pass
+
+
+class ShellCommandError(ShellRunnerError):
+    def __init__(self, message: str, result: ShellCommandResult):
+        super().__init__(message)
+        self.out = result.out
+        self.status = result.status
+        self.pipestatus = result.pipestatus
+
+
+class ShellResolutionError(ShellRunnerError):
+    pass
+
+
+class EnvironmentVariableError(ShellRunnerError):
+    pass

shellrunner/_exceptions.py

@@ -2,12 +2,9 @@
 import sys
 from inspect import cleandoc
 
-from helpers import (
+from ._exceptions import ShellCommandError, ShellCommandResult, ShellResolutionError, ShellRunnerError
+from ._utils import (
     Env,
-    ShellCommandError,
-    ShellCommandResult,
-    ShellResolutionError,
-    ShellRunnerError,
     get_parent_shell_path,
     resolve_option,
     resolve_shell_path,
@@ -21,7 +18,7 @@
 # show_commands (Optional) - If True, the current command will be printed before execution. | Default is True
 
 
-def X(  # noqa: N802
+def run(
     command: str | list[str],
     *,
     shell: str | None = None,
@@ -52,13 +49,13 @@ def X(  # noqa: N802
     # The only way to reliably stop executing commands on an error is to exit from the shell itself. Killing the subprocess does not happen nearly fast enough.
     # To do this, we append a command for each command that is passed in. Ultimately, we need to get PIPESTATUS, process it, and exit based on that. PIPESTATUS looks like: "0 1 0".
     # We don't need to also get $?/$status because PIPESTATUS gives the status of single command anyway.
-    # Rather than write a separate script for each shell to process PIPESTATUS (e.g. bash would requier a different script than fish), we can pass PIPESTATUS into a python script.
+    # Rather than write a separate script for each shell to process PIPESTATUS (e.g. bash would require a different script than fish), we can pass PIPESTATUS into a python script.
     # We execute this python script by passing it to the parent python executable (sys.executable) via the -c flag.
     # The following python code (status_check) takes in PIPESTATUS, prints it (so we can capture it from stdout later on), loops through each status, and exits (with a non-zero status if there is one).
     status_check = r"""
         import sys
         pipestatus = sys.argv[1]
-        print(b'\\u2f4c'.decode('unicode_escape') + f' : {pipestatus} : ' + b'\\u2f8f'.decode('unicode_escape'), end='')
+        print('\u2f4c' + f' : {pipestatus} : ' + '\u2f8f', end='')
         for status in [int(x) for x in pipestatus.split()]:
             if status != 0: sys.exit(status)
     """
@@ -77,12 +74,12 @@ def X(  # noqa: N802
     pipestatus_var = status_var
     if shell_name == "bash":
         pipestatus_var = r"${PIPESTATUS[*]}"
-    if shell_name == "zsh" or shell_name == "fish":
+    if shell_name in ("zsh", "fish"):
         status_var = r"$status"
         pipestatus_var = r"$pipestatus"
 
     # If check argument is false, we won't exit after a non-zero exit status.
-    # When run in shell that masks pipeline errors (e.g. bash), status_var will be 0 even though an error may have occured in a pipeline. Ultimately this doesn't matter because we don't care about the exit status of the shell itself.
+    # When run in shell that masks pipeline errors (e.g. bash), status_var will be 0 even though an error may have occurred in a pipeline. Ultimately this doesn't matter because we don't care about the exit status of the shell itself.
     exit_command = f' || exit "{status_var}"' if check else ""
 
     # This command is appended after each passed in command. If status_check exits with a non-zero status, we exit the shell.
@@ -119,7 +116,7 @@ def X(  # noqa: N802
             raise ShellRunnerError(message)
 
         capture_output = True
-        # If we are still receving output or poll() is None, we know the command is still running.
+        # If we are still receiving output or poll() is None, we know the command is still running.
         # We must use stdout.read(1) rather than readline() in order to properly print commands that prompt the user for input. We must also forcibly flush the stream in the print statement for the same reason.
         while (out := process.stdout.read(1)) or process.poll() is None:
             # If we detect our marker, we know we are done with the previous command and have printed PIPESTATUS. Capture stdout to pipestatus instead.
@@ -142,7 +139,7 @@ def X(  # noqa: N802
                     pipestatus_list = [int(x) for x in pipestatus.split()]
                 capture_output = True
 
-    # If we don't recieve any exit status, something went wrong.
+    # If we don't receive any exit status, something went wrong.
     if not pipestatus_list:
         message = "Something went wrong. Failed to capture an exit status."
         raise ShellRunnerError(message)

src/shellrunner.py renamed to shellrunner/_shellrunner.py

@@ -1,35 +1,11 @@
 import os
 from pathlib import Path
 from shutil import which
-from typing import NamedTuple, TypeVar
+from typing import TypeVar
 
 from psutil import Process
 
-
-class ShellCommandResult(NamedTuple):
-    out: str
-    status: int
-    pipestatus: list[int]
-
-
-class ShellRunnerError(RuntimeError):
-    pass
-
-
-class ShellCommandError(ShellRunnerError):
-    def __init__(self, message: str, result: ShellCommandResult):
-        super().__init__(message)
-        self.out = result.out
-        self.status = result.status
-        self.pipestatus = result.pipestatus
-
-
-class ShellResolutionError(ShellRunnerError):
-    pass
-
-
-class EnvironmentVariableError(ShellRunnerError):
-    pass
+from ._exceptions import EnvironmentVariableError, ShellResolutionError
 
 
 # Returns the full path of parent process/shell. That way commands are executed using the same shell that invoked this script.

src/helpers.py renamed to shellrunner/_utils.py

@@ -5,8 +5,11 @@
 from typing import NamedTuple
 
 import pytest
-from helpers import EnvironmentVariableError, ShellCommandError, ShellResolutionError, get_parent_shell_path
-from shellrunner import X
+
+from shellrunner import ShellCommandError, ShellResolutionError, X
+
+from ._exceptions import EnvironmentVariableError
+from ._utils import get_parent_shell_path
 
 
 class ShellInfo(NamedTuple):
@@ -128,7 +131,7 @@ def test_pipeline_with_unknown_command_raises_error(self, shell: str, shell_comm
         assert str(cm.value).startswith(shell_command_error_message)
         assert cm.value.status == 127
         # fish will not run a pipeline whatsoever if any command is unknown so we will only ever get one status.
-        if shell == "sh" or shell == "fish":
+        if shell in ("sh", "fish"):
             assert cm.value.pipestatus == [127]
         else:
             assert cm.value.pipestatus == [0, 127]