feluxe / cmdi Goto Github PK

The code needs some more comments to make clear what it does in some areas.

Currently you catch this in the wrapper function:

                except Exception as e:
                    print(e, file=err)

                    if not catch_err:
                        sys.exit(1)

                    result = CmdResult(
                        val=None,
                        code=1,
                        name=name,
                        status=Status.error,
                        color=StatusColor.red,
                        out=kwargs.get('_out'),
                        err=kwargs.get('_err'),
                    )

You could add subprocess.CalledProcessError which gives you:

returncode
Exit status of the child process. If the process exited due to a signal, this will be the negative signal number.

cmd
Command that was used to spawn the child process.

output
Output of the child process if it was captured by run() or check_output(). Otherwise, None.

stdout
Alias for output, for symmetry with stderr.

stderr
Stderr output of the child process if it was captured by run(). Otherwise, None.

More: https://docs.python.org/3/library/subprocess.html#subprocess.CalledProcessError

Some functions are not typed at all.

I find the reading experience for the documentation unsmooth. It should get an update...