mirror of
https://github.com/bentoml/OpenLLM.git
synced 2026-01-31 19:02:10 -05:00
c7f4dc7bb2
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
101 lines
3.6 KiB
Python
Generated
101 lines
3.6 KiB
Python
Generated
"""This type stub file was generated by pyright."""
|
|
|
|
from .. import utils
|
|
|
|
class ExecApiMixin:
|
|
@utils.check_resource("container")
|
|
def exec_create(
|
|
self,
|
|
container,
|
|
cmd,
|
|
stdout=...,
|
|
stderr=...,
|
|
stdin=...,
|
|
tty=...,
|
|
privileged=...,
|
|
user=...,
|
|
environment=...,
|
|
workdir=...,
|
|
detach_keys=...,
|
|
):
|
|
"""Sets up an exec instance in a running container.
|
|
|
|
Args:
|
|
container (str): Target container where exec instance will be
|
|
created
|
|
cmd (str or list): Command to be executed
|
|
stdout (bool): Attach to stdout. Default: ``True``
|
|
stderr (bool): Attach to stderr. Default: ``True``
|
|
stdin (bool): Attach to stdin. Default: ``False``
|
|
tty (bool): Allocate a pseudo-TTY. Default: False
|
|
privileged (bool): Run as privileged.
|
|
user (str): User to execute command as. Default: root
|
|
environment (dict or list): A dictionary or a list of strings in
|
|
the following format ``["PASSWORD=xxx"]`` or
|
|
``{"PASSWORD": "xxx"}``.
|
|
workdir (str): Path to working directory for this exec session
|
|
detach_keys (str): Override the key sequence for detaching
|
|
a container. Format is a single character `[a-Z]`
|
|
or `ctrl-<value>` where `<value>` is one of:
|
|
`a-z`, `@`, `^`, `[`, `,` or `_`.
|
|
~/.docker/config.json is used by default.
|
|
|
|
Returns:
|
|
(dict): A dictionary with an exec ``Id`` key.
|
|
|
|
Raises:
|
|
:py:class:`docker.errors.APIError`
|
|
If the server returns an error.
|
|
"""
|
|
...
|
|
def exec_inspect(self, exec_id):
|
|
"""Return low-level information about an exec command.
|
|
|
|
Args:
|
|
exec_id (str): ID of the exec instance
|
|
|
|
Returns:
|
|
(dict): Dictionary of values returned by the endpoint.
|
|
|
|
Raises:
|
|
:py:class:`docker.errors.APIError`
|
|
If the server returns an error.
|
|
"""
|
|
...
|
|
def exec_resize(self, exec_id, height=..., width=...): # -> None:
|
|
"""Resize the tty session used by the specified exec command.
|
|
|
|
Args:
|
|
exec_id (str): ID of the exec instance
|
|
height (int): Height of tty session
|
|
width (int): Width of tty session
|
|
"""
|
|
...
|
|
@utils.check_resource("exec_id")
|
|
def exec_start(self, exec_id, detach=..., tty=..., stream=..., socket=..., demux=...): # -> CancellableStream:
|
|
"""Start a previously set up exec instance.
|
|
|
|
Args:
|
|
exec_id (str): ID of the exec instance
|
|
detach (bool): If true, detach from the exec command.
|
|
Default: False
|
|
tty (bool): Allocate a pseudo-TTY. Default: False
|
|
stream (bool): Return response data progressively as an iterator
|
|
of strings, rather than a single string.
|
|
socket (bool): Return the connection socket to allow custom
|
|
read/write operations. Must be closed by the caller when done.
|
|
demux (bool): Return stdout and stderr separately
|
|
|
|
Returns:
|
|
(generator or str or tuple): If ``stream=True``, a generator
|
|
yielding response chunks. If ``socket=True``, a socket object for
|
|
the connection. A string containing response data otherwise. If
|
|
``demux=True``, a tuple with two elements of type byte: stdout and
|
|
stderr.
|
|
|
|
Raises:
|
|
:py:class:`docker.errors.APIError`
|
|
If the server returns an error.
|
|
"""
|
|
...
|