os
Provides a platform-independent interface to host operating system functionality. Functions in this package expect and return host paths.
The path module provides functions to manipulate host paths.
- os.environ() dict
Returns a mapping object where keys and values are strings that represent the process environment. This mapping is captured at startup time.
- os.look_path(file: str) str | None
Search for an executable named file in the directories named by the PATH environment variable. If file contains a slash, it is tried directly and the PATH is not consulted. Otherwise, on success, the result is an absolute path.
- Parameters:
file – the name of the executable to find
- Returns:
the absolute path to file if found or None if not found.
- os.exec(command: list[str], cwd: str = None, env: dict = None, try_: bool = None) str | None
Run an executable. If the process fails, the calling module will abort unless try_ is set to True, in which case the contents of standard error will be returned.
- Parameters:
command – a list of strings indicating the executable to run and its arguments (e.g. [“dawn”, “build”]).
cwd – the working directory for the command. Defaults to the calling module’s directory.
env – any environment variables to set when running the command.
try_ – when True, the calling module will not be aborted if the process fails.
- Returns:
the contents of standard error if try_ is set and None otherwise. To capture the process’s output, use output.
- os.output(command: list[str], cwd: str = None, env: dict = None, try_: bool = None) str
Run an executable and return its output. If the process fails, the calling module will abort unless try_ is set to True, in which case the contents of standard error will be returned.
- Parameters:
command – a list of strings indicating the executable to run and its arguments (e.g. [“dawn”, “build”]).
cwd – the working directory for the command. Defaults to the calling module’s directory.
env – any environment variables to set when running the command.
try_ – when True, the calling module will not be aborted if the process fails.
- Returns:
the contents of standard output if try_ is not truthy and the process succeeds. If try_ is truthy, output returns (stdout, True) if the process succeeds and (stderr, False) if the process fails.
- os.exists(path: str) bool
Returns true if a file exists at the given path.
- os.getcwd() str
Returns the current OS working directory. This is typically the path of the directory containing the root module on the callstack.
- os.mkdir(path: str, mode: int = None) None
Create a directory named path with numeric mode mode.
- os.makedirs(path: str, mode: int = None) None
Recursive directory creation function. Like mkdir(), but makes all intermediate-level directories needed to contain the leaf directory.