mirror of
https://chromium.googlesource.com/chromium/tools/depot_tools.git
synced 2026-01-11 02:31:29 +00:00
3d401c263f
Since fetches involve multiple subprocess calls, any of which can be slow, the per-subprocess caffeination strategy does not seem suitable -- the Mac might sleep as soon as the wake lock is dropped, before it starts a new one. This instead implements a context manager to allow caffeinating a scope. To allow flag control, caffeinate.scope takes an argument that decides whether or not it should actually do anything useful; it looks silly, but the alternative is to interfere with flag parsing more or to require users to write separate codepaths to decide whether to enter the context manager scope or not; the "use the context manager in a mode where it does not do anything" prevents this. Bug: 462507017 Change-Id: Icc5bb9cadda30b5a120f112b10bf96ffd3b6550f Reviewed-on: https://chromium-review.googlesource.com/c/chromium/tools/depot_tools/+/7183647 Reviewed-by: Gavin Mak <gavinmak@google.com> Commit-Queue: Adam Norberg <norberg@google.com>
60 lines
1.9 KiB
Python
60 lines
1.9 KiB
Python
# Copyright 2025 The Chromium Authors. All rights reserved.
|
|
# Use of this source code is governed by a BSD-style license that can be
|
|
# found in the LICENSE file.
|
|
|
|
import contextlib
|
|
import os
|
|
import subprocess
|
|
import sys
|
|
|
|
_NO_CAFFEINATE_FLAG = '--no-caffeinate'
|
|
|
|
_HELP_MESSAGE = f"""\
|
|
caffeinate:
|
|
{_NO_CAFFEINATE_FLAG} do not prepend `caffeinate` to ninja command
|
|
"""
|
|
|
|
|
|
def call(args, **call_kwargs):
|
|
"""Runs a command (via subprocess.call) with `caffeinate` if it's on macOS."""
|
|
if sys.platform == 'darwin':
|
|
if isinstance(args, (str, bytes, os.PathLike)):
|
|
args = [args]
|
|
if '-h' in args or '--help' in args:
|
|
print(_HELP_MESSAGE, file=sys.stderr)
|
|
if _NO_CAFFEINATE_FLAG in args:
|
|
args.remove(_NO_CAFFEINATE_FLAG)
|
|
else:
|
|
args = ['caffeinate'] + args
|
|
return subprocess.call(args, **call_kwargs)
|
|
|
|
|
|
@contextlib.contextmanager
|
|
def scope(actually_caffeinate=True):
|
|
"""Acts as a context manager keeping a Mac awake, unless flagged off.
|
|
|
|
If the process is not running on a Mac, or `actually_caffeinate` is falsey,
|
|
this acts as a context manager that does nothing. The `actually_caffeinate`
|
|
flag is provided so command line flags can control the caffeinate behavior
|
|
without requiring weird plumbing to use or not use the context manager.
|
|
|
|
If running on a Mac while actually_caffeinate is True (the default), this
|
|
runs `caffeinate` in a separate process, which is terminated when the
|
|
context manager exits.
|
|
"""
|
|
if sys.platform != 'darwin' or not actually_caffeinate:
|
|
# Behave like a no-op context manager.
|
|
yield False
|
|
return
|
|
|
|
cmd = ['caffeinate', '-i', '-w', str(os.getpid())]
|
|
|
|
proc = subprocess.Popen(cmd,
|
|
stdin=subprocess.DEVNULL,
|
|
stdout=subprocess.DEVNULL,
|
|
stderr=subprocess.DEVNULL)
|
|
try:
|
|
yield True
|
|
finally:
|
|
proc.terminate()
|