shlax 1.0.0

Why?

In Python we now have async subprocesses which allows to execute several subprocesses at the same time. The purpose of this library is to:

• provide an acceptable asyncio subprocess wrapper for my syntaxic taste,

• can stream stderr and stdout in real time while capturing it,

• real time output must be prefixed for when you execute several commands at the time so that you know which line is for which process, like with docker-compose logs,

• output coloration in real time with regexps to make even more readable.

This code was copy/pasted between projects and finally extracted on its own.

Usage

from shlax import Subprocess
proc = await Subprocess('echo hi').wait()
print(proc.rc, proc.out, proc.err, proc.out_raw, proc.err_raw)

proc = Subprocess('echo hi')
await proc.start()  # start the process
await proc.wait()   # wait for completion

from shlax import Proc
proc = await Proc('echo hi').wait()

proc = await Subprocess('echo hi', quiet=True).wait()

proc0 = Subprocess('find /', prefix='first')
proc1 = Subprocess('find /', prefix='second')
await asyncio.gather(proc0.wait(), proc1.wait())

import sys
regexps = {
    '^(.*).py$': '{cyan}\\1',
}
await asyncio.gather(*[
    Subprocess(
        f'find {path}',
        regexps=regexps,
    ).wait()
    for path in sys.path
])

Where is the rest?

Shlax used to be the name of a much more ambitious poc-project that has been extracted in two projects with clear boundaries, namely sysplan and podplan which are still in alpha state, but Shlax as it is feature complete and stable.