Skip to content

Stream handler

This page is auto-generated for HandlerType.Stream.

This type resolves to multiple specs/factories.

Spec 1

  • Handler type: Stream (stream)
  • Handler class: StreamHandler
  • Handler class FQDN: logging.StreamHandler
  • Factory: _build_stdout_handler
  • Factory FQDN: daqpytools.logging.handlers._build_stdout_handler
  • Fallback types: stream, lstdout
  • Summary: Build a stdout stream handler.

Factory API

daqpytools.logging.handlers._build_stdout_handler(**_)

Build a stdout stream handler.

Parameters:

Name Type Description Default
**_ object

Additional forwarded keyword arguments. Ignored by this factory.

{}

Returns:

Type Description
Handler

A logging.StreamHandler writing to sys.stdout.

Source code in daqpytools/logging/handlers.py
def _build_stdout_handler(**_: object) -> logging.Handler:
    """Build a stdout stream handler.

    Args:
        **_: Additional forwarded keyword arguments. Ignored by this factory.

    Returns:
        A ``logging.StreamHandler`` writing to ``sys.stdout``.
    """
    handler = logging.StreamHandler(sys.stdout)
    handler.setFormatter(LoggingFormatter())
    return handler

Spec 2

  • Handler type: Stream (stream)
  • Handler class: StreamHandler
  • Handler class FQDN: logging.StreamHandler
  • Factory: _build_stderr_handler
  • Factory FQDN: daqpytools.logging.handlers._build_stderr_handler
  • Fallback types: stream, lstderr
  • Summary: Build a stderr stream handler.

Factory API

daqpytools.logging.handlers._build_stderr_handler(**_)

Build a stderr stream handler.

Parameters:

Name Type Description Default
**_ object

Additional forwarded keyword arguments. Ignored by this factory.

{}

Returns:

Type Description
Handler

A logging.StreamHandler writing to sys.stderr with

Handler

ERROR level.

Source code in daqpytools/logging/handlers.py
def _build_stderr_handler(**_: object) -> logging.Handler:
    """Build a stderr stream handler.

    Args:
        **_: Additional forwarded keyword arguments. Ignored by this factory.

    Returns:
        A ``logging.StreamHandler`` writing to ``sys.stderr`` with
        ``ERROR`` level.
    """
    handler = logging.StreamHandler(sys.stderr)
    handler.setFormatter(LoggingFormatter())
    handler.setLevel(logging.ERROR)
    return handler