perago.require_dir

perago.require_dir(path)

Require one workspace-relative directory to exist.

Parameters:

pathstr or os.PathLike[str]

Workspace-relative directory path using / separators.

Returns:

Workspace guardrail

Guardrail consumed by perago.WorkspaceSpec.

Raises:

TaskDefinitionError

If path is empty, absolute, contains .., or uses unsupported separators.

参数:

path (str | PathLike[str])

返回类型:

_WorkspaceGuardrail

参见

require_file

Require one file.

require_glob

Require files matching a glob.

forbid_glob

Reject files matching a glob.

Examples

>>> WorkspaceSpec(prefix="audio/render", pre=[require_dir("raw")])
WorkspaceSpec(...)