shshsh 1.0.6

bridge of python and shell

shshsh 🐍❤️🐚

Shshsh is a bridge connects python and shell.

• A simple way to write shell commands in Python.
• Flexibility.
• Support for directly chaining a Python function in a pipeline.

Installation

To install shshsh with pip, run: pip install shshsh

To install shshsh with conda, run: conda install shshsh -c conda-forge

To install shshsh from source, clone the repository and run: pip install poetry;poetry install

⚠️ If you are using python3.8: Be very careful with python function Pipe, there are known bugs!

Basic Usage

You can use I >> "[command]" or Sh("[command]")in any Python project.

Here's an example of getting all file which name contains "test":

from shshsh import I, IZ

for filename in I >> "ls" | "grep test":
    print(filename)

# zero mode, split line by "\x00"
for filename in IZ >> "ls" | "grep test":
    print(filename)

Also, you can safely pass parameter without worrying about command injection; shshsh will help you escape all bash control characters:

from shshsh import I
from sys import stdout

res = (I >> "echo #{}") % "dangerous; cat /etc/passwd" | stdout
res.wait()
# dangerous; cat /etc/passwd

To operate on the current working directory (cwd):

from shshsh.utils import cwd

# change dir
after_change_path = cwd("../../")

# to get current cwd, just don't give any parameter
cwd()

Python functions or iterables can be part of the chain. You no longer have to search Google (or chatgpt) repeatedly to write sed or awk 😇:

from shshsh import I
from sys import stdout

# as map function
def add_suffix(line: str) -> str:
    return line + ".py"

res = I >> "ls -alh" | add_suffix | "grep test" | stdout
res.wait()

# as data source
def data_source():
    for i in range(10):
        yield f"test{i}"

res = I >> data_source() | "grep test1" | stdout
res.wait()

By default, stderr will directly redirect to current Python process's stderr.

But you can also keep its result using the redirect expr >= for stderr and > for stdout:

from shshsh import I, keep

res = I >> "ls not_exist" >= keep
res.wait()

print(res.stderr.read())

The redirect expression can redirect the stream to any kind of IO object:

from shshsh import I

with open("res", "w") as f:
    # redirect stdout to file.
    res = I >> "echo 123" > f
    # redirect stderr to file.
    res1 = I >> "ls not_exist" >= f
    res1.wait()
    res.wait()