diff --git a/docs/cmd.rst b/docs/cmd.rst new file mode 100644 index 0000000..7ae322b --- /dev/null +++ b/docs/cmd.rst @@ -0,0 +1,16 @@ +Cmd +------- + +.. function:: pydu.cmd.execute(cmd, wait=True, shell=True) + + Execute cmd based on ``subprocess.Popen``. + If ``wait`` is True, ``execute`` will return the tuple of ``(returncode, stdout)``. + Note, ``stderr`` is redirected to ``stdout``. If ``wait`` is False, ``execute`` + will return object of ``Popen``. + ``shell`` is same to parameter of ``Popen``. + + >>> from pydu.cmd import execute + >>> execute('echo hello') + (0, b'hello\r\n') # Python 3 + >>> execute('echo hello', wait=False) + diff --git a/docs/index.rst b/docs/index.rst index 75fbc58..9aa3c3c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,6 +21,7 @@ Content :maxdepth: 1 archive + cmd compat dict misc