Skip to content

Commit 1437d36

Browse files
committed
Mention API extension in readme
1 parent 16d4e39 commit 1437d36

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.rst

+6-5
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ Creation from scratch:
110110
password='password', # str | None
111111
key=None, # type: paramiko.PKey | None
112112
keys=None, # type: Iterable[paramiko.PKey] | None
113-
key_filename=None, # type: List[str] | None
113+
key_filename=None, # type: list[str] | None
114114
passphrase=None, # str | None
115115
)
116116
@@ -240,9 +240,10 @@ Execution result object has a set of useful properties:
240240

241241
* `cmd` - Command
242242
* `exit_code` - Command return code. If possible to decode using enumerators for Linux -> it used.
243+
* `ok` -> `bool`. Command return code is 0 (EX_OK).
243244
* `stdin` -> `str`. Text representation of stdin.
244-
* `stdout` -> `Tuple[bytes]`. Raw stdout output.
245-
* `stderr` -> `Tuple[bytes]`. Raw stderr output.
245+
* `stdout` -> `tuple[bytes]`. Raw stdout output.
246+
* `stderr` -> `tuple[bytes]`. Raw stderr output.
246247
* `stdout_bin` -> `bytearray`. Binary stdout output.
247248
* `stderr_bin` -> `bytearray`. Binary stderr output.
248249
* `stdout_str` -> `str`. Text representation of output.
@@ -273,7 +274,7 @@ Possible to call commands in parallel on multiple hosts if it's not produce huge
273274

274275
.. code-block:: python
275276
276-
results: Dict[Tuple[str, int], ExecResult] = SSHClient.execute_together(
277+
results: dict[tuple[str, int], ExecResult] = SSHClient.execute_together(
277278
remotes, # type: Iterable[SSHClient]
278279
command, # type: str | Iterable[str]
279280
timeout=1 * 60 * 60, # type: type: int | float | None
@@ -286,7 +287,7 @@ Possible to call commands in parallel on multiple hosts if it's not produce huge
286287
log_mask_re=None, # str | None
287288
exception_class=ParallelCallProcessError # type[ParallelCallProcessError]
288289
)
289-
results # type: dict[Tuple[str, int], exec_result.ExecResult]
290+
results # type: dict[tuple[str, int], exec_result.ExecResult]
290291
291292
Results is a dict with keys = (hostname, port) and and results in values.
292293
By default execute_together raises exception if unexpected return code on any remote.

0 commit comments

Comments
 (0)