Class BytesLogger

src/structlog/_output.py:250–351

r""" Writes bytes into a file. Useful if you follow `current logging best practices ` together with a formatter that returns bytes (e.g. `orjson `_). Args: file: File to print to. (default: `sys.stdout`\ ``.buffer``

class BytesLogger:
    r"""
    Writes bytes into a file.

    Useful if you follow `current logging best practices
    <logging-best-practices>` together with a formatter that returns bytes
    (e.g. `orjson <https://github.com/ijl/orjson>`_).

    Args:
        file: File to print to. (default: `sys.stdout`\ ``.buffer``)

        name:
            Optional name for the logger. If provided, it will be picked up
            as the logger&#x27;s name when used with
            `structlog.stdlib.add_logger_name()` without using standard
            library integration. ``BytesLogger`` itself does nothing with it.

    .. versionadded:: 20.2.0

    .. versionadded:: 26.1.0 The ``name`` attribute.
    """

    __slots__ = ("_file", "_flush", "_lock", "_write", "name")

    def __init__(
        self, file: BinaryIO | None = None, *, name: str | None = None
    ):
        self._file = file or sys.stdout.buffer
        self._write = self._file.write
        self._flush = self._file.flush

        self.name = name

        self._lock = _get_lock_for_file(self._file)

    def __getstate__(self) -> tuple[str, str | None]:
        """
        Our __getattr__ magic makes this necessary.
        """
        if self._file is sys.stdout.buffer:
            return "stdout", self.name

        if self._file is sys.stderr.buffer:
            return "stderr", self.name

        raise PicklingError(
            "Only BytesLoggers to sys.stdout and sys.stderr can be pickled."
        )

    def __setstate__(self, state: Any) -> None:
        """
        Our __getattr__ magic makes this necessary.
        """
        if isinstance(state, str):
            name = None
        else:
            state, name = state