Skip to content

Commit 2120223

Browse files
committed
Remove references to deprecated dictionary access
cf. #60
1 parent acf7222 commit 2120223

File tree

1 file changed

+3
-7
lines changed

1 file changed

+3
-7
lines changed

procrunner/__init__.py

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@
2222
# subprocess.CompletedProcess object
2323
# - process can run in a custom environment, either as a modification of
2424
# the current environment or in a new environment from scratch
25-
# - stdin can be fed to the process, the returned dictionary contains
26-
# information how much was read by the process
25+
# - stdin can be fed to the process
2726
# - stdout and stderr is printed by default, can be disabled
2827
# - stdout and stderr can be passed to any arbitrary function for
2928
# live processing
@@ -310,8 +309,6 @@ class ReturnObject(subprocess.CompletedProcess):
310309
"""
311310
A subprocess.CompletedProcess-like object containing the executed
312311
command, stdout and stderr (both as bytestrings), and the exitcode.
313-
Further values such as process runtime can be accessed as dictionary
314-
values.
315312
The check_returncode() function raises an exception if the process
316313
exited with a non-zero exit code.
317314
"""
@@ -461,9 +458,8 @@ def run(
461458
instead of returning an object that can be checked
462459
for a timeout condition. Defaults to False, will be
463460
changed to True in a future release.
464-
:return: A ReturnObject() containing the executed command, stdout and stderr
465-
(both as bytestrings), and the exitcode. Further values such as
466-
process runtime can be accessed as dictionary values.
461+
:return: The exit code, stdout, stderr (separately, as byte strings)
462+
as a subprocess.CompletedProcess object.
467463
"""
468464

469465
time_start = time.strftime("%Y-%m-%d %H:%M:%S GMT", time.gmtime())

0 commit comments

Comments
 (0)