Project (1 of 6)

Projectclassdataclass#

Re-exported from ocx_sdk._clientView source

removemethod#

View source

def remove(*names: PackageLike, group: str | None = None, timeout: MaybeTimeout = UNSET, retry: MaybeRetry = UNSET) -> tuple[ToolRow, ...]

Remove tool bindings from ocx.toml.

Parameters

Name	Type	Default	Description
*names	PackageLike	()	Binding names or fully-qualified identifiers.
group	str | None	None	The group to target. None searches every group and fails when a name appears in more than one.
timeout	MaybeTimeout	UNSET	Seconds per attempt. Omitted takes the config’s.
retry	MaybeRetry	UNSET	Retry policy. None opts out; omitted takes the config’s.

Returns

tuple[ToolRow, ...]

The lock rows the call wrote — empty when nothing changed.

spawn_asyncmethodasync#

View source

async def spawn_async(argv: Sequence[str], *, names: Iterable[str] = (), groups: Iterable[str] = (), clean: bool = False, env: Mapping[str, EnvValue] | None = None, lazy_mode: LazyMode | None = None, pinned: bool | None = None, records_dir: str | Path | None = None, records_name: str | None = None, **popen_kw: Any) -> asyncio.subprocess.Process

Start a command in the project’s environment, on the event loop.

Parameters

Name	Type	Default	Description
argv	Sequence[str]	required	The command and its arguments. Must not be empty.
names	Iterable[str]	()	Bindings to compose.
groups	Iterable[str]	()	Groups to compose.
clean	bool	False	Strip the ambient parent environment before composing.
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.
pinned	bool | None	None	Resolve through pinned digests — see exec.
records_dir	str | Path | None	None	Write an execution record here — see exec.
records_name	str | None	None	The record’s filename template — see exec.
**popen_kw	Any	{}	Forwarded to the subprocess factory. args, shell, and executable are rejected.

Returns

asyncio.subprocess.Process

The running child.

Raises

ValueError

argv is empty, or a rejected keyword was passed.