Workspace Paths
SandboxWorkspaceScope
dataclass
Immutable model-facing relative-path base for one sandbox run.
This scope changes only how relative paths are anchored. The owning sandbox session and its existing workspace policy remain responsible for access validation and filesystem operations.
ソースコード位置: src/agents/sandbox/workspace_paths.py
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 | |
from_cwd
classmethod
from_cwd(
cwd: str | PurePath | None,
) -> SandboxWorkspaceScope
Create a scope from an optional workspace-relative working directory.
anchor
Anchor a relative sandbox path beneath this scope's working directory.
ソースコード位置: src/agents/sandbox/workspace_paths.py
model_path
Render a workspace-root-relative path relative to the model-facing cwd.
ソースコード位置: src/agents/sandbox/workspace_paths.py
model_resource_path
model_resource_path(
*,
workspace_root: str | PurePath,
workspace_relative_path: str | PurePath,
) -> PurePosixPath
Render a session-owned workspace resource for model-facing instructions.
Without a run cwd, preserve the existing workspace-root-relative representation. With a run cwd, use an absolute sandbox path so the resource remains addressable after a shell command selects a nested workdir or changes directory.
ソースコード位置: src/agents/sandbox/workspace_paths.py
display_path
display_path(
*,
original_path: str | PurePath,
workspace_relative_path: str | PurePath,
) -> PurePosixPath
Render a tool result path without changing existing absolute-input display behavior.
ソースコード位置: src/agents/sandbox/workspace_paths.py
SandboxPathGrant
Bases: BaseModel
Extra absolute path access outside the sandbox workspace.
path is the POSIX path visible inside the sandbox. host_path is an optional
native host source used for local materialization and Docker bind mounts.
ソースコード位置: src/agents/sandbox/workspace_paths.py
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 | |
WorkspacePathPolicy
Validate and format paths that are interpreted relative to a sandbox workspace root.
ソースコード位置: src/agents/sandbox/workspace_paths.py
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 | |
absolute_workspace_path
Return an absolute workspace path without following symlinks.
Examples with root /workspace:
- absolute_workspace_path("src/app.py") returns /workspace/src/app.py.
- absolute_workspace_path("/workspace/src/app.py") returns /workspace/src/app.py.
- absolute_workspace_path("/tmp/app.py") raises InvalidManifestPathError.
ソースコード位置: src/agents/sandbox/workspace_paths.py
relative_path
Return a path relative to the workspace root.
Examples with root /workspace:
- relative_path("src/app.py") returns src/app.py.
- relative_path("/workspace/src/app.py") returns src/app.py.
- relative_path("/workspace") returns ..
ソースコード位置: src/agents/sandbox/workspace_paths.py
normalize_path
normalize_path(
path: str | PurePath,
*,
for_write: bool = False,
resolve_symlinks: bool = False,
) -> Path
Return a validated absolute path under the workspace or an extra grant.
resolve_symlinks follows symlinks on the host filesystem. Use it only when the sandbox
workspace is a real local host directory, such as UnixLocalSandboxSession.
ソースコード位置: src/agents/sandbox/workspace_paths.py
normalize_sandbox_path
Return a validated POSIX path for a Unix-like remote sandbox filesystem.
ソースコード位置: src/agents/sandbox/workspace_paths.py
sandbox_root
root_is_existing_host_path
Return whether the configured root currently exists on the host filesystem.
extra_path_grant_rules
Return normalized extra grant roots and access modes for remote realpath checks.
ソースコード位置: src/agents/sandbox/workspace_paths.py
coerce_posix_path
Return a POSIX-flavored path for sandbox filesystem paths.
ソースコード位置: src/agents/sandbox/workspace_paths.py
windows_absolute_path
Return a Windows absolute path when the input uses Windows absolute syntax.
ソースコード位置: src/agents/sandbox/workspace_paths.py
posix_path_as_path
posix_path_for_error
sandbox_path_str
normalize_sandbox_cwd
Validate and normalize a run working directory relative to the workspace root.
ソースコード位置: src/agents/sandbox/workspace_paths.py
sandbox_path_grant_host_path
sandbox_path_grant_host_path(
grant: SandboxPathGrant,
) -> Path
Return and validate the native host path used by a sandbox path grant.