Skip to main content

A "command interface" for functions.

Project description

# cmdinter

### Description

This is a library that can be used to apply a *command interface* to functions.
`cmdinter` was created for the `buildlib` package.

#### CmdFuncResult

A cmd function should return a `CmdFuncResult` object:

class CmdFuncResult(NamedTuple):
return_code: int
return_msg: str
return_val: Any

`return_msg`, contains a cmd summary with a Status flag (see Status below).
E.g.:

[OK] Run apt-get install.
[Error] pip install package x.
[Skip] Mount hard drive. Drive alrady mounted.

`return_code` Unix convention...

`return_val` Some value the function returns.

#### Status

Status flags that can be used as `return_msg` prefix.

class Status(object):
ok: str = '[OK]'
error = '[ERROR]'
skip = '[SKIP]'

#### run_cmd()


def run_cmd(
silent: bool = False,
return_stdout: bool = False,
catch_err: bool = False,
) -> Callable:
"""
This function works in combination with function that return a
'CmdFuncResult' object. With `run_cmd()` you get a some more control over
these functions.

Call it like this:

run_cmd(silent=True, return_stdout=True)(my_func, args, kwargs)

@silent: Mute child output of child function if set to True.
@return_stdout: Return stdout of child function.
@catch_err: Catch errors that are raised by child functions and return error
message with 'CmdResult' object.
"""


#### CmdResult

A cmd should return a `CmdResult`.

class CmdResult(NamedTuple):
return_val: Any
return_code: int
return_msg: str
output: Optional[str]
error: Optional[str]
traceback: Optional[str]

This is an extended version of `CmdFuncResult`.

`output` In case you return stdout from a child function, it's stored here.
`error` In case use the `catch_err` option to catch errors from a child function, it's stored here.
`traceback` Error traceback is stored here.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

cmdinter-1.0.0-py3-none-any.whl (5.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page