Skip to content

Set the logging filename based upon --select-output #202

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.

Sign up for GitHub

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 1 commit into from
Sep 27, 2024
Merged

Set the logging filename based upon --select-output #202

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 10 additions & 9 deletions build_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -567,18 +567,19 @@ def parse_args():
return args


def setup_logging(log_directory: Path):
def setup_logging(log_directory: Path, select_output: str | None):
"""Setup logging to stderr if run by a human, or to a file if run from a cron."""
log_format = "%(asctime)s %(levelname)s: %(message)s"
if sys.stderr.isatty():
logging.basicConfig(
format="%(asctime)s %(levelname)s: %(message)s", stream=sys.stderr
)
logging.basicConfig(format=log_format, stream=sys.stderr)
else:
log_directory.mkdir(parents=True, exist_ok=True)
handler = logging.handlers.WatchedFileHandler(log_directory / "docsbuild.log")
handler.setFormatter(
logging.Formatter("%(asctime)s %(levelname)s: %(message)s")
)
if select_output is None:
filename = log_directory / "docsbuild.log"
else:
filename = log_directory / f"docsbuild-{select_output}.log"
handler = logging.handlers.WatchedFileHandler(filename)
handler.setFormatter(logging.Formatter(log_format))
logging.getLogger().addHandler(handler)
logging.getLogger().setLevel(logging.DEBUG)

Expand Down Expand Up @@ -1206,7 +1207,7 @@ def _checkout_name(select_output: str | None) -> str:
def main():
"""Script entry point."""
args = parse_args()
setup_logging(args.log_directory)
setup_logging(args.log_directory, args.select_output)

if args.select_output is None:
build_docs_with_lock(args, "build_docs.lock")
Expand Down