nipoppy.logger.NipoppyLogger¶
- class nipoppy.logger.NipoppyLogger(*args, **kwargs)¶
Custom logger for Nipoppy.
- add_file_handler(file)¶
Add a file handler to the logger.
- Parameters:
file (Path) – The file path to write the log to.
- Returns:
The nipoppy logger
- Return type:
Self
- failure(message, args=None, **kwargs)¶
Log a failure message.
Standardize format for failure messages.
- Parameters:
message (str) – The message to log.
- Return type:
None
- set_verbose(verbose)¶
Set the logging level for stdout.
- Parameters:
verbose (bool) – If True, set verbose to DEBUG, else to INFO.
- Returns:
The nipoppy logger
- Return type:
Self
- success(message, args=None, **kwargs)¶
Log a success message.
Standardize format for success messages.
- Parameters:
message (str) – The message to log.
- Return type:
None
- warning(message, args=None, **kwargs)¶
Log a warning message.
Standardize format for warning messages.
- Parameters:
message (str) – The message to log.
- Return type:
None
- stderr_handler¶