Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

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


Release history Release notifications

History Node

1.0.11

History Node

1.0.10

History Node

1.0.9

History Node

1.0.7

History Node

1.0.6

History Node

1.0.5

History Node

1.0.4

History Node

1.0.1

This version
History Node

1.0.0

History Node

0.0.0a13

History Node

0.0.0a12

History Node

0.0.0a11

History Node

0.0.0a10

History Node

0.0.0a9

History Node

0.0.0a8

History Node

0.0.0a7

History Node

0.0.0a6

History Node

0.0.0a5

History Node

0.0.0a4

History Node

0.0.0a1

History Node

0.0.0a0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
cmdinter-1.0.0-py3-none-any.whl (5.2 kB) Copy SHA256 hash SHA256 Wheel 3.6 Oct 12, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page