Module Import alias ImportFrom alias ImportFrom alias Import alias ImportFrom alias ImportFrom alias alias ImportFrom alias alias ImportFrom alias ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad body Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Return BinOpMod Str TupleLoad AttributeLoad AttributeLoad NameLoad attr attr IfExp Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr Str decorator_list FunctionDef arguments args NameParam defaults body Expr Str If CompareIsNot Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad body Expr Call AttributeLoad NameLoad attr Return CompareIsNot AttributeLoad NameLoad attr NameLoad decorator_list Assign NameStore NameLoad FunctionDef arguments args NameParam defaults body Expr Str If CompareIsNot AttributeLoad NameLoad attr NameLoad body Return Assign TupleStore AttributeStore NameLoad attr AttributeStore NameLoad attr AttributeStore NameLoad attr Call NameLoad AttributeLoad NameLoad attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults body Expr Str Expr Call AttributeLoad NameLoad attr Return AttributeLoad NameLoad attr decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Expr Call AttributeLoad NameLoad attr Return AttributeLoad NameLoad attr decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Expr Call AttributeLoad NameLoad attr Return AttributeLoad NameLoad attr decorator_list NameLoad decorator_list ClassDef bases NameLoad body Assign NameStore TupleLoad Str FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore Dict For NameStore AttributeLoad AttributeLoad NameLoad attr attr body Assign NameStore Call NameLoad NameLoad Str TupleLoad If Call NameLoad NameLoad NameLoad body Assign NameStore TupleLoad NameLoad For NameStore NameLoad body If CompareNotEq SubscriptLoad NameLoad Index Num Str body Assign SubscriptStore NameLoad Index NameLoad Call NameLoad NameLoad NameLoad Assign NameStore GeneratorExp Call AttributeLoad Str attr NameLoad SubscriptLoad NameLoad Index NameLoad comprehension NameStore NameLoad Return Call AttributeLoad Str attr AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad Str attr NameLoad decorator_list FunctionDef arguments args NameParam defaults vararg kwarg body Return Call NameLoad NameLoad NameLoad decorator_list NameLoad decorator_list ClassDef bases NameLoad body Expr Str Assign NameStore TupleLoad Str Str FunctionDef arguments args NameParam NameParam defaults Num kwarg body Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Return Call NameLoad Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr decorator_list decorator_list Assign NameStore Call NameLoad Expr Str ClassDef bases NameLoad body Expr Str Assign NameStore TupleLoad Str FunctionDef arguments args NameParam NameParam defaults Num body Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Call NameLoad keyword AttributeLoad NameLoad attr keyword NameLoad keyword NameLoad keyword NameLoad decorator_list decorator_list Assign NameStore Call NameLoad ClassDef bases NameLoad body Expr Str Assign NameStore TupleLoad Str Str FunctionDef arguments args NameParam NameParam NameParam defaults Num NameLoad body Expr Str Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body With Call AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr keyword NameLoad keyword NameLoad keyword NameLoad NameStore body Assign NameStore ListLoad Assign NameStore ListLoad Assign NameStore AttributeLoad NameLoad attr Assign NameStore AttributeLoad NameLoad attr Assign NameStore Dict NameLoad NameLoad NameLoad NameLoad Assign NameStore Dict NameLoad NameLoad AttributeLoad NameLoad attr AttributeLoad NameLoad attr While CompareIs Call AttributeLoad NameLoad attr NameLoad body Assign TupleStore NameStore NameStore NameStore Call NameLoad TupleLoad NameLoad NameLoad TupleLoad TupleLoad For NameStore NameLoad body Assign NameStore SubscriptLoad NameLoad Index NameLoad Assign TupleStore NameStore NameStore Call NameLoad NameLoad Num If UnaryOpNot NameLoad body Continue Expr Call AttributeLoad SubscriptLoad NameLoad Index NameLoad attr NameLoad If UnaryOpNot AttributeLoad NameLoad attr body Expr Call AttributeLoad SubscriptLoad NameLoad Index NameLoad attr Expr Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call AttributeLoad Str attr ListComp Call AttributeLoad NameLoad attr Str comprehension NameStore NameLoad Assign NameStore Call AttributeLoad Str attr ListComp Call AttributeLoad NameLoad attr Str comprehension NameStore NameLoad Return TupleLoad AttributeLoad NameLoad attr NameLoad NameLoad decorator_list decorator_list Assign NameStore Call NameLoad ClassDef bases NameLoad body Expr Str Assign NameStore TupleLoad Str Str FunctionDef arguments args NameParam NameParam NameParam defaults Num NameLoad body Expr Str Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults vararg kwarg body Return Call NameLoad NameLoad NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam defaults body TryExcept body If AttributeLoad NameLoad attr body Expr Call NameLoad keyword AttributeLoad NameLoad attr keyword NameLoad keyword NameLoad keyword NameLoad orelse Expr Call NameLoad keyword AttributeLoad NameLoad attr Return NameLoad handlers ExceptHandler type NameLoad body Return NameLoad decorator_list decorator_list Assign NameStore Call NameLoad ClassDef bases NameLoad body Expr Str Assign NameStore TupleLoad Str FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults vararg kwarg body Return Call NameLoad NameLoad NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam defaults body If AttributeLoad NameLoad attr body Return SubscriptLoad Call AttributeLoad NameLoad attr keyword NameLoad keyword NameLoad keyword NameLoad keyword NameLoad Index Num orelse Return SubscriptLoad Call AttributeLoad NameLoad attr keyword NameLoad Index Num decorator_list decorator_list Assign NameStore Call NameLoad ClassDef bases NameLoad body Expr Str Assign NameStore TupleLoad Str Str Str Str FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam defaults Str Str NameLoad NameLoad body Expr Str Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body If Call NameLoad NameLoad NameLoad body Assign NameStore AttributeLoad NameLoad attr Assign NameStore NameLoad Assign NameStore AttributeLoad NameLoad attr orelse If Call NameLoad NameLoad NameLoad body Assign NameStore AttributeLoad NameLoad attr Assign NameStore NameLoad Assign NameStore AttributeLoad NameLoad attr orelse Assign NameStore AttributeLoad NameLoad attr Assign NameStore AttributeLoad NameLoad attr Return Call AttributeLoad NameLoad attr NameLoad AttributeLoad NameLoad attr NameLoad AttributeLoad NameLoad attr NameLoad decorator_list decorator_list Assign NameStore Call NameLoad
N/A N/A os select select subprocess PIPE N/A sys itertools chain plumbum.commands.processes run_proc ProcessExecutionError plumbum.commands.base AppendingStdoutRedirection StdoutRedirection plumbum.lib read_fd_decode_safely Future N/A object N/A N/A Represents a "future result" of a running process. It basically wraps a ``Popen``
    object and the expected exit code, and provides poll(), wait(), returncode, stdout,
    and stderr.
     __init__ N/A N/A self proc expected_retcode timeout N/A None N/A N/A N/A self proc proc N/A N/A self _expected_retcode expected_retcode N/A N/A self _timeout timeout N/A N/A self _returncode None N/A N/A self _stdout None N/A N/A self _stderr None N/A __repr__ N/A N/A self N/A N/A N/A N/A <Future %r (%s)> N/A N/A N/A self proc argv N/A N/A N/A self ready N/A self _returncode running N/A poll N/A N/A self N/A N/A N/A Polls the underlying process for termination; returns ``False`` if still running,
        or ``True`` if terminated N/A N/A N/A N/A N/A self proc poll None N/A N/A N/A N/A self wait N/A N/A N/A self _returncode None N/A N/A ready poll wait N/A N/A self N/A N/A N/A Waits for the process to terminate; will raise a
        :class:`plumbum.commands.ProcessExecutionError` in case of failure N/A N/A N/A self _returncode None N/A N/A N/A N/A N/A self _returncode N/A self _stdout N/A self _stderr N/A run_proc N/A self proc N/A self _expected_retcode N/A self _timeout N/A stdout N/A N/A self N/A N/A N/A The process' stdout; accessing this property will wait for the process to finish N/A N/A N/A self wait N/A N/A self _stdout N/A property stderr N/A N/A self N/A N/A N/A The process' stderr; accessing this property will wait for the process to finish N/A N/A N/A self wait N/A N/A self _stderr N/A property returncode N/A N/A self N/A N/A N/A The process' returncode; accessing this property will wait for the process to finish N/A N/A N/A self wait N/A N/A self _returncode N/A property N/A ExecutionModifier N/A object N/A N/A __slots__ N/A __weakref__ __repr__ N/A N/A self N/A N/A N/A Automatically creates a representation for given subclass with slots.
        Ignore hidden properties. N/A slots N/A N/A cls N/A N/A self __class__ __mro__ N/A N/A slots_list N/A getattr cls __slots__ N/A N/A N/A isinstance slots_list str N/A N/A slots_list N/A slots_list N/A prop slots_list N/A N/A N/A N/A prop N/A 0 _ N/A N/A N/A slots N/A prop N/A getattr self prop N/A mystrs N/A N/A N/A {0} = {1} format name N/A slots N/A name N/A name slots N/A N/A N/A {0}({1}) format N/A N/A self __class__ __name__ N/A N/A ,  join mystrs N/A __call__ N/A N/A cls N/A args kwargs N/A N/A N/A cls args kwargs N/A classmethod N/A BG N/A ExecutionModifier N/A N/A 
    An execution modifier that runs the given command in the background, returning a
    :class:`Future <plumbum.commands.Future>` object. In order to mimic shell syntax, it applies
    when you right-and it with a command. If you wish to expect a different return code
    (other than the normal success indicate by 0), use ``BG(retcode)``. Example::

        future = sleep[5] & BG       # a future expecting an exit code of 0
        future = sleep[5] & BG(7)    # a future expecting an exit code of 7

    .. note::

       When processes run in the **background** (either via ``popen`` or
       :class:`& BG <plumbum.commands.BG>`), their stdout/stderr pipes might fill up,
       causing them to hang. If you know a process produces output, be sure to consume it
       every once in a while, using a monitoring thread/reactor in the background.
       For more info, see `#48 <https://github.com/tomerfiliba/plumbum/issues/48>`_
     N/A __slots__ N/A retcode kargs __init__ N/A N/A self retcode N/A 0 kargs N/A N/A N/A self retcode retcode N/A N/A self kargs kargs N/A __rand__ N/A N/A self cmd N/A N/A N/A N/A Future N/A N/A cmd popen N/A self kargs N/A self retcode N/A N/A N/A BG N/A BG N/A 
An execution modifier that runs the given command in the background, returning a
:class:`Future <plumbum.commands.Future>` object. In order to mimic shell syntax, it applies
when you right-and it with a command. If you wish to expect a different return code
(other than the normal success indicate by 0), use ``BG(retcode)``. Example::

    future = sleep[5] & BG       # a future expecting an exit code of 0
    future = sleep[5] & BG(7)    # a future expecting an exit code of 7

.. note::

   When processes run in the **background** (either via ``popen`` or
   :class:`& BG <plumbum.commands.BG>`), their stdout/stderr pipes might fill up,
   causing them to hang. If you know a process produces output, be sure to consume it
   every once in a while, using a monitoring thread/reactor in the background.
   For more info, see `#48 <https://github.com/tomerfiliba/plumbum/issues/48>`_
 FG N/A ExecutionModifier N/A N/A 
    An execution modifier that runs the given command in the foreground, passing it the
    current process' stdin, stdout and stderr. Useful for interactive programs that require
    a TTY. There is no return value.

    In order to mimic shell syntax, it applies when you right-and it with a command.
    If you wish to expect a different return code (other than the normal success indicate by 0),
    use ``FG(retcode)``. Example::

        vim & FG       # run vim in the foreground, expecting an exit code of 0
        vim & FG(7)    # run vim in the foreground, expecting an exit code of 7
     N/A __slots__ N/A retcode __init__ N/A N/A self retcode N/A 0 N/A N/A N/A self retcode retcode N/A __rand__ N/A N/A self cmd N/A N/A N/A N/A cmd retcode N/A self retcode stdin None stdout None stderr None N/A N/A N/A FG N/A FG TEE N/A ExecutionModifier N/A N/A Run a command, dumping its stdout/stderr to the current process's stdout
    and stderr, but ALSO return them.  Useful for interactive programs that
    expect a TTY but also have valuable output.

    Use as:

        ls["-l"] & TEE

    Returns a tuple of (return code, stdout, stderr), just like ``run()``.
     N/A __slots__ N/A retcode buffered __init__ N/A N/A self retcode buffered N/A 0 True N/A N/A `retcode` is the return code to expect to mean "success".  Set
        `buffered` to False to disable line-buffering the output, which may
        cause stdout and stderr to become more entangled than usual.
         N/A N/A self retcode retcode N/A N/A self buffered buffered N/A __rand__ N/A N/A self cmd N/A N/A N/A N/A N/A cmd bgrun retcode N/A self retcode stdin None stdout PIPE stderr PIPE p N/A N/A outbuf N/A N/A errbuf N/A N/A out N/A p stdout N/A err N/A p stderr N/A buffers N/A out err outbuf errbuf N/A tee_to N/A out err N/A sys stdout N/A sys stderr N/A N/A N/A N/A p poll None N/A N/A N/A ready _ _ N/A select N/A out err N/A N/A N/A fd ready N/A N/A buf N/A buffers N/A fd N/A N/A data text N/A read_fd_decode_safely fd 4096 N/A N/A data N/A N/A N/A N/A N/A N/A tee_to N/A fd write text N/A N/A N/A self buffered N/A N/A N/A N/A N/A tee_to N/A fd flush N/A N/A N/A buf append data N/A stdout N/A N/A join N/A N/A N/A x decode utf-8 N/A x outbuf N/A stderr N/A N/A join N/A N/A N/A x decode utf-8 N/A x errbuf N/A N/A N/A p returncode stdout stderr N/A N/A N/A TEE N/A TEE TF N/A ExecutionModifier N/A N/A 
    An execution modifier that runs the given command, but returns True/False depending on the retcode.
    This returns True if the expected exit code is returned, and false if it is not.
    This is useful for checking true/false bash commands.

    If you wish to expect a different return code (other than the normal success indicate by 0),
    use ``TF(retcode)``. If you want to run the process in the forground, then use
    ``TF(FG=True)``.

    Example::

        local['touch']['/root/test'] & TF * Returns False, since this cannot be touched
        local['touch']['/root/test'] & TF(1) # Returns True
        local['touch']['/root/test'] & TF(FG=True) * Returns False, will show error message
     N/A __slots__ N/A retcode FG __init__ N/A N/A self retcode FG N/A 0 False N/A N/A `retcode` is the return code to expect to mean "success".  Set
        `FG` to True to run in the foreground.
         N/A N/A self retcode retcode N/A N/A self FG FG N/A __call__ N/A N/A cls N/A args kwargs N/A N/A N/A cls args kwargs N/A classmethod __rand__ N/A N/A self cmd N/A N/A N/A N/A N/A N/A self FG N/A N/A N/A cmd retcode N/A self retcode stdin None stdout None stderr None N/A N/A N/A cmd retcode N/A self retcode N/A True N/A N/A N/A ProcessExecutionError N/A N/A False N/A N/A N/A TF N/A TF RETCODE N/A ExecutionModifier N/A N/A 
    An execution modifier that runs the given command, causing it to run and return the retcode.
    This is useful for working with bash commands that have important retcodes but not very
    useful output.

    If you want to run the process in the forground, then use ``RETCODE(FG=True)``.

    Example::

        local['touch']['/root/test'] & RETCODE # Returns 1, since this cannot be touched
        local['touch']['/root/test'] & RETCODE(FG=True) * Returns 1, will show error message
     N/A __slots__ N/A foreground __init__ N/A N/A self FG N/A False N/A N/A `FG` to True to run in the foreground.
         N/A N/A self foreground FG N/A __call__ N/A N/A cls N/A args kwargs N/A N/A N/A cls args kwargs N/A classmethod __rand__ N/A N/A self cmd N/A N/A N/A N/A self foreground N/A N/A N/A N/A N/A cmd run retcode None stdin None stdout None stderr None N/A 0 N/A N/A N/A N/A N/A cmd run retcode None N/A 0 N/A N/A N/A RETCODE N/A RETCODE NOHUP N/A ExecutionModifier N/A N/A 
    An execution modifier that runs the given command in the background, disconnected
    from the current process, returning a
    standard popen object. It will keep running even if you close the current process.
    In order to slightly mimic shell syntax, it applies
    when you right-and it with a command. If you wish to use a diffent working directory
    or different stdout, stderr, you can use named arguments. The default is ``NOHUP(
    cwd=local.cwd, stdout='nohup.out', stderr=None)``. If stderr is None, stderr will be
    sent to stdout. Use ``os.devnull`` for null output. Will respect redirected output.
    Example::

        sleep[5] & NOHUP                       # Outputs to nohup.out
        sleep[5] & NOHUP(stdout=os.devnull)    # No output

    The equivelent bash command would be

    .. code-block:: bash

        nohup sleep 5 &

     N/A __slots__ N/A cwd stdout stderr append __init__ N/A N/A self cwd stdout stderr append N/A . nohup.out None True N/A N/A  Set ``cwd``, ``stdout``, or ``stderr``.
        Runs as a forked process. You can set ``append=False``, too.
         N/A N/A self cwd cwd N/A N/A self stdout stdout N/A N/A self stderr stderr N/A N/A self append append N/A __rand__ N/A N/A self cmd N/A N/A N/A N/A isinstance cmd StdoutRedirection N/A N/A stdout N/A cmd file N/A append False N/A cmd N/A cmd cmd N/A N/A N/A isinstance cmd AppendingStdoutRedirection N/A N/A stdout N/A cmd file N/A append True N/A cmd N/A cmd cmd N/A N/A stdout N/A self stdout N/A append N/A self append N/A N/A N/A cmd nohup cmd N/A self cwd stdout N/A self stderr append N/A N/A N/A NOHUP N/A NOHUP