ya-agent-environment
Environment abstractions for general agents.
ya-agent-environment provides the shared base interfaces used by YA agents:
EnvironmentFileOperatorShellResourceRegistry- resumable resources
- environment-owned temporary storage via
tmp_dirandresolve_tmp_path()
The Python import package is ya_agent_environment.
Environment and File Backend Contracts
Environment owns temporary-directory configuration and lifecycle. While entered,
env.tmp_dir exposes the agent-facing root (or None) and
env.resolve_tmp_path(relative_path) safely resolves a contained path, rejecting
absolute paths and parent traversal. Temporary paths are handled through the normal
FileOperator methods; there is no separate temporary-file operator or routing API.
Environment cleanup closes registered resources, the shell, and the file operator
before _teardown() releases backend/container and temporary-directory resources.
The same ordering is preserved after partial setup failures and during cancellation. The base class does not assume
a filesystem backing store and never deletes _tmp_dir itself: custom environments
must allocate their agent-facing temporary backend in _setup() and remove only owned
storage in _teardown().
A FileOperator implementation exposes one logical path space by implementing its
public abstract methods directly. read_bytes_stream() returns an AsyncIterator
directly, so consume the returned iterator without awaiting the method call.
Workspace-backed concrete environments allocate owned temporary instances below
.tmp/ya-agent-<id>. Each instance contains a self-ignoring .gitignore, and teardown
removes only that owned instance. Custom environments remain responsible for allocating
and tearing down their own temporary backend.
LocalFileOperator.walk_files() returns paths relative to default_path when possible
and directly reusable absolute paths for explicitly allowed roots outside it. glob and
grep may search those roots explicitly; root="." does not implicitly include
temporary storage.
Bounded Output
Shared output-bounding policy lives in ya_agent_environment.output. It provides
head/tail budget splitting, character and UTF-8 byte truncation, and incremental bounded
text accumulation. Shell ingestion and SDK previews should reuse these helpers instead
of defining independent truncation policies.
Shell Backend Contract
Custom Shell backends implement _create_process() and return an ExecutionHandle with stream, wait, and kill callbacks. Shell.execute() is the final public foreground boundary and must not be overridden: the base class owns process creation, timeout, cancellation, foreground/background registration, and session-reset cleanup. The foreground timeout budget begins before process creation, but shell-owned creation still resolves and terminates any eventual handle before reporting timeout. Class creation raises TypeError when final MRO resolution replaces execute(), so direct and mixin-based legacy overrides fail fast instead of silently bypassing lifecycle ownership; migrate their process creation into _create_process(). A wait callback must not report natural completion while owned descendants remain, and a kill callback must not return until backend execution is confirmed terminated; raising preserves the handle for a later reset retry. Backends must retain a stable execution identity through termination: a POSIX numeric PGID is no longer an ownership handle after its leader is reaped, so residual-group cleanup requires a live guardian or an equivalent platform-owned primitive.
Shell.start() returns a compact model-facing handle such as process-1. The handle is
sequential and unique within the current shell session; a successful
reset_background_processes() starts a fresh sequence. It is the only identifier
accepted by wait_process(), kill_process(), stdin, signal, status, and completion
APIs. It is not an OS PID, process-group ID, container exec identity, UUID, or durable
cross-session key. Those backend ownership identities remain private in
ExecutionHandle and transport-specific implementations. Foreground execution uses a
separate private identity and never consumes the model-facing sequence. A failed reset
retains both ownership state and the current sequence until termination is confirmed,
so a live handle is never reused.
Development
This package is maintained as a workspace member in ya-mono.
uv run python -m pytest packages/ya-agent-environment/tests -vv
uv run python -m pyright
uv build --package ya-agent-environment -o dist
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ya_agent_environment-2.9.0.tar.gz.
File metadata
- Download URL: ya_agent_environment-2.9.0.tar.gz
- Upload date:
- Size: 59.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
85fb17429dcda5c94e845c0d636ebc378a39abbb1b0b6c542e07d2eb556b6d6e
|
|
| MD5 |
e3aebabcbc901fd2b12728c12b7d1f4e
|
|
| BLAKE2b-256 |
786717d39c32ca1312d86a5f01fd515b49e58158e1528925c19dcfd358c697c8
|
File details
Details for the file ya_agent_environment-2.9.0-py3-none-any.whl.
File metadata
- Download URL: ya_agent_environment-2.9.0-py3-none-any.whl
- Upload date:
- Size: 38.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d27f62f02dddf41b7586060f3bff2e1128eb9ed46e236516f21989766f6832c0
|
|
| MD5 |
453f895968c0c321f244d4034795e2d8
|
|
| BLAKE2b-256 |
6f0fa943d813e02cd21e7a92591c9208593f8852b68d909ddbc7574398fffd13
|
