State.get_log_file_path#
- State.get_log_file_path(file_name: str, prefix: bool = True) Path #
Get the log file path for this process.
This method is not purely a pass-through to this state’s filesystem, as it also potentially adds a prefix to the filename based on the state.
- Parameters:
- file_namestr
The name of the desired log file.
- prefixbool, default True
Whether to add a prefix to the desired log file name. This is simply a boolean flag for whether to add the prefix, the actual value of the prefix id drawn from the “log_file_prefix” key within this state. If that key is not set, no prefix is added regardless of the value of this argument.
- Returns:
- Path