command-executor

Usage

Please refer to the Documentation to learn how to use command-executor. Basicly, command_executor provides some Python classes to make it easier to start processes / commands and handling errors and output. In addition, input validation for command parameters is possible.

Requirements

python-command-executor supports Python 3 only. No other dependencies are required.

Prepare for development

A Python 3 interpreter is required in addition to poetry.

$ poetry install

Now you’re ready to run the tests:

$ make tests

All Contents

Usage

Note

TODO: Add usage examples for command classes.

API Reference

Command

class command_executor.command.Command(**kwargs)

Bases: object

process = None

command = 'true'

ignore_output = True

fail_silently = False

required_parameters = None

stdout = -1

stderr = -1

execute(ignore_output=None, fail_silently=None, stdin=None, **kwargs)

validate_parameters()

get_parameters()

get_command()

handle_output(output)

property pid

Exceptions

exception command_executor.exceptions.CommandError

Bases: Exception

exception command_executor.exceptions.CommandExecutionError(code, stderr, command)

Bases: CommandError

exception command_executor.exceptions.CommandParameterError

Bases: CommandError

Changelog

0.1.0 - 2019-01-10

• Improved support for background / forking processes.

0.0.1 - 2018-08-08

• Initial release of command-executor

Indices and tables

• Index

• Module Index

• Search Page