Skip to content

Make setup_logging() more Jupyter-friendly. #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 10, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 28 additions & 15 deletions labscript_utils/setup_logging.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@
# #
#####################################################################
import sys, os
from io import UnsupportedOperation
import logging, logging.handlers
import warnings
from labscript_utils.ls_zprocess import Handler, ensure_connected_to_zlog


Expand Down Expand Up @@ -52,21 +54,32 @@ def setup_logging(program_name, log_level=logging.DEBUG, terminal_level=logging.
handler.setFormatter(formatter)
handler.setLevel(log_level)
logger.addHandler(handler)
if sys.stdout is not None and sys.stdout.fileno() >= 0:
stdout_handler = logging.StreamHandler(sys.stdout)
stdout_handler.setFormatter(formatter)
stdout_handler.setLevel(terminal_level)
logger.addHandler(stdout_handler)
if sys.stderr is not None and sys.stderr.fileno() >= 0:
# Send warnings and greater to stderr instead of stdout:
stdout_handler.addFilter(LessThanFilter(logging.WARNING))
sterr_handler = logging.StreamHandler(sys.stderr)
sterr_handler.setFormatter(formatter)
sterr_handler.setLevel(logging.WARNING)
logger.addHandler(sterr_handler)
try:
# Check that sys.stdout.fileno is callable, which is needed below. It is NOT
# callable in Jupyter notebooks.
stdout_fileno = sys.stdout.fileno()
except UnsupportedOperation:
# In this case the code is likely being run from a Jupyter notebook, warn the
# user that log messages won't be printed to stdout or stderr.
warnings.warn(
"Logging to stdout and stderr is disabled. See the log files for log messages."
)
else:
# Prevent bug on windows where writing to stdout without a command
# window causes a crash:
sys.stdout = sys.stderr = open(os.devnull, 'w')
if sys.stdout is not None and stdout_fileno >= 0:
stdout_handler = logging.StreamHandler(sys.stdout)
stdout_handler.setFormatter(formatter)
stdout_handler.setLevel(terminal_level)
logger.addHandler(stdout_handler)
if sys.stderr is not None and sys.stderr.fileno() >= 0:
# Send warnings and greater to stderr instead of stdout:
stdout_handler.addFilter(LessThanFilter(logging.WARNING))
sterr_handler = logging.StreamHandler(sys.stderr)
sterr_handler.setFormatter(formatter)
sterr_handler.setLevel(logging.WARNING)
logger.addHandler(sterr_handler)
else:
# Prevent bug on windows where writing to stdout without a command
# window causes a crash:
sys.stdout = sys.stderr = open(os.devnull, 'w')
logger.setLevel(logging.DEBUG)
return logger
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy