# logging

Python API: `depthai_nodes.logging`

## Classes

### LogLevel

Log-level names accepted by depthai-nodes configuration.

#### Attributes

##### CRITICAL

##### DEBUG

##### ERR

##### INFO

##### WARN

## Functions

### get_log_level

```python
def get_log_level(level_str: str | None) -> LogLevel | None:
```

Parse a case-insensitive logging level.

Parameters

 * `level_str` (`str | None`): Level name, or `None`. DepthAI `OFF` maps to `WARN` and `TRACE` maps to `INFO`.

Returns

 * `LogLevel | None`: Matching `LogLevel`, or `None` for an omitted level.

Raises

 * `ValueError`: If the name is not recognized.

### get_logger

```python
def get_logger(name: str | None = None) -> logging.Logger:
```

Get the package logger or one of its children.

Parameters

 * `name` (`str | None`): Optional child name below the `depthai-nodes` logger.

Returns

 * `logging.Logger`: The package logger when no name is supplied, otherwise its named child.

### setup_logging

```python
def setup_logging(level: str | None = None, file: str | None = None):
```

Globally configures logging for depthai_nodes package.

Parameters

 * `level` (`str | None`): Logging level. One of "CRITICAL", "DEBUG", "ERR", "INFO", and "WARN". Can be changed using
   "DEPTHAI_NODES_LEVEL" env variable. If not set defaults to "DEPTHAI_LEVEL" if set or "WARN".
 * `file` (`str | None`): Path to a file where logs will be saved. If None, logs will not be saved. Defaults to None.
