# logging

Python API: `luxonis_train.utils.logging`

通过 `luxonis_ml` 配置全局日志记录器。

## 函数

### setup_logging

```python
def setup_logging(*, file: PathType | None = None, use_rich: bool = True):
```

为包设置全局日志记录器。

此函数使用 `file` 和 `use_rich` 调用 `luxonis_ml.utils.setup_logging`。该函数执行以下步骤：

 * 它从 `LOG_LEVEL` 环境变量读取日志级别。对于无效级别，它会引发 `ValueError`。
 * 它删除现有的 `loguru` 处理程序。
 * 它添加一个控制台处理程序。此处理程序会跳过带有 `file_only` 额外信息的日志记录，例如来自 `logger.bind(file_only=True)` 的记录。
 * 当 `file` 不为 `None` 时，它会添加一个文件处理程序。此处理程序还会写入带有 `file_only` 额外信息的记录。
 * 它将 Python 警告发送到日志记录器。
 * 它安装一个异常钩子，用于打印未捕获的 `pydantic` 验证错误的摘要。环境变量 `LUXONISML_DISABLE_PRETTY_VALIDATION_ERRORS` 会关闭此钩子。

当 `use_rich` 为 `True` 时，记录的异常的富回溯不会显示 `lightning.pytorch`、`torch`、`pydantic` 和 `numpy` 帧的源代码。它们仍然会显示这些帧的文件和行。

包在加载其模块时会调用此函数。配置在验证 `rich_logging`
时会再次调用它。[LuxonisModel](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/core/core.md)
会使用运行的日志文件调用它。

参数

 * `file` (`PathType | None`): 日志文件的路径。日志记录器会追加到文件中。`None` 表示不写入日志文件。
 * `use_rich` (`bool`): 当为 `True` 时，使用富处理程序将控制台输出写入 `stdout`。当为 `False` 时，将纯日志行写入 `stderr`。
