sh Package

local Module

class xal.sh.local.LocalShProvider(resource_factory=<class 'xal.sh.resource.ShCommand'>)

Bases: xal.sh.provider.ShProvider

make_command_instance(command)

Return a ShCommand instance related to command arguments.

run(command)

Execute Cmd resource.

run_command_instance(command)

Run Command instance.

supports(session)

Return True if session is local.

provider Module

Base stuff for providers that handle commands.

exception xal.sh.provider.CommandNotFound

Bases: exceptions.Exception

Command not found.

class xal.sh.provider.ShProvider(resource_factory=<class 'xal.sh.resource.ShCommand'>)

Bases: xal.provider.ResourceProvider

Base class for command provider.

run(command, *args)

resource Module

Command resource.

class xal.sh.resource.ShCommand(arguments=[], stdin=None, stdout=None, stderr=None, *args, **kwargs)

Bases: xal.resource.Resource

arguments = None

Actual command and arguments, iterable.

command

pipe(other)

stderr = None

Errors.

stdin = None

Input.

stdout = None

Output.

class xal.sh.resource.ShPipe(arguments=[], stdin=None, stdout=None, stderr=None, *args, **kwargs)

Bases: xal.sh.resource.ShCommand

command

class xal.sh.resource.ShResult

Bases: object

return_code = None

Return code. O (zero) means success.

stderr = None

Errors.

stdout = None

Output.

succeeded

Boolean indicating whether last execution succeeded.