PackageCommands (10 of 16)

PackageCommandsclassdataclass#

Re-exported from ocx_sdk._clientView source

exec_asyncmethodasync#

View source

async def exec_async(refs: Sequence[PackageLike], argv: Sequence[str], *, platform: str | None = None, clean: bool = False, private: bool = False, env: Mapping[str, EnvValue] | None = None, lazy_mode: LazyMode | None = None, records_dir: str | Path | None = None, records_name: str | None = None, capture: bool = True, check: bool = True, timeout: MaybeTimeout = UNSET) -> CommandResult

Run a command in a packages’ environment, on the event loop.

Parameters

Name	Type	Default	Description
refs	Sequence[PackageLike]	required	Package identifiers to compose.
argv	Sequence[str]	required	The command and its arguments. Must not be empty.
platform	str | None	None	The platform to resolve against.
clean	bool	False	Strip the ambient parent environment before composing.
private	bool	False	Compose the private surface — ocx’s --self.
env	Mapping[str, EnvValue] | None	None	Extra [env] entries for this call.
lazy_mode	LazyMode | None	None	When content downloads — now, or on first use.
records_dir	str | Path | None	None	Write an execution record — the resolved closure and executable — under this directory. None leaves it to [records] dir and OCX_RECORDS_DIR; with none of the three, no record is written.
records_name	str | None	None	The record’s filename template, over {time}, {host}, {pid} and {rand}. None leaves it to [records] name and OCX_RECORDS_NAME.
capture	bool	True	Pipe and capture both streams.
check	bool	True	Raise on a non-zero child exit instead of returning it.
timeout	MaybeTimeout	UNSET	Seconds for the whole run. Omitted takes the config’s.

Returns

CommandResult

The child’s exit code and, under capture, its output.

Raises

ValueError

argv is empty, or the handle carries an on_log callback, which v0.1 refuses on async paths.

OcxProcessError

The child exited non-zero under check.

OcxTimeoutError

The timeout expired.