mirror of
https://chromium.googlesource.com/chromium/tools/depot_tools.git
synced 2026-01-11 02:31:29 +00:00
3ec220caca
I'm looking at caffeinating more long-running depot_tools commands on Mac, which use a variety of `subprocess` APIs; one implementation strategy I'm considering is to wrap more of them, including `subprocess.run`, but the most obvious name to wrap `subprocess.run` into is already taken! I think it makes the most sense to name the `caffeinate` function(s) after the `subprocess` call it wraps. The callers to other parts of `subprocess` use more of the features exposed by those APIs. For consistency, I am plumbing through more of `subprocess.call`'s identifiable behaviors here, too: * command-to-invoke parameter is named "args" * as explicitly checked in cpython's subprocess.py's `_posix_spawn`:77cb39e0c7/Lib/subprocess.py (L1816)also allow `str`, `bytes`, and `os.PathLike` for the type of `args`, converting the non-list-like types into a single-element list * use kwargs packing and unpacking to forward other parameters into `subprocess.call` kwargs packing does not provide perfect emulation as implemented:77cb39e0c7/Lib/subprocess.py (L386)`timeout` could be provided as a positional parameter. However, Python documents all subprocess.call parameters as keyword only: https://docs.python.org/3.12/library/subprocess.html#older-high-level-api ...specifically because they don't want to bother distinguishing between parameters "local" to a higher-level `subprocess` helper and those that get forwarded (via `**kwargs`) to the underlying `Popen`, so I think it is reasonable to follow their lead on that. Bug: 462507017 Change-Id: Ia520ced7f8188c23c38826d22ccf20a3c52ddfc5 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/tools/depot_tools/+/7181621 Reviewed-by: Junji Watanabe <jwata@google.com> Commit-Queue: Adam Norberg <norberg@google.com>
depot_tools
Tools for Chromium development. Requires Python 3.8+.
gsutil: Python 3.9–3.13 required.
Tools
The most important tools are:
fetch: Agclientwrapper to checkout a project. Usefetch --helpfor more details.gclient: A meta-checkout tool. Think repo or git submodules, except that it support OS-specific rules, e.g. do not checkout Windows only dependencies when checking out for Android. Usegclient helpfor more details and README.gclient.md.git cl: A code review tool to interact with Rietveld or Gerrit. Usegit cl helpfor more details and README.git-cl.md.roll-dep: A gclient dependency management tool to submit a dep roll, updating a dependency to a newer revision.
There are a lot of git utilities included.
Also, includes shell script/batch file for tools required to build chromium, e.g.
gn: a meta-build system that generates build files for Ninjaautoninja: a wrapper forsisoandninja.siso: a build tool that aims to significantly speed up Chromium's build.ninja: a small build system with a focus on speed. deprecated by Siso.
These shell script/batch file runs python script with python-bin/python3
that find binaries in chromium checkout, and run with proper setup/check.
To use these wrappers, you need to initialize/bootstrap depot_tools (using
gclient, update_depot_tools or ensure_bootstrap).
Installing
See set-up documentation.
depot_tools is also available in
-
chromium's third_party/depot_tools: propagated by autoroller.
-
on builder: infra_internal/recipe_bundles/chrome-internal.googlesource.com/chrome/tools/build bundles depot_tools. propagated by build_internal recipe roller
These depot_tools would not be initialized/bootstrapped (i.e. no
python-bin/python3 binary available), so the build tool wrapper won't work,
unless it is explicitly initialized by ensure_bootstrap.
Or, directly call the python script instead of using the shell script/batch
file.
Updating
depot_tools updates itself automatically when running gclient tool. To
disable auto update, set the environment variable DEPOT_TOOLS_UPDATE=0 or
run ./update_depot_tools_toggle.py --disable.
To update package manually, run update_depot_tools.bat on Windows,
or ./update_depot_tools on Linux or Mac.
Running gclient will install python3 binary.
Contributing
To contribute change for review:
git new-branch <somename>
# Hack
git add .
git commit -a -m "Fixes goat teleporting"
# find reviewers
git cl owners
git log -- <yourfiles>
# Request a review.
git cl upload -r reviewer1@chromium.org,reviewer2@chromium.org --send-mail
# Edit change description if needed.
git cl desc
# If change is approved, flag it to be committed.
git cl set-commit
# If change needs more work.
git rebase-update
...
git cl upload -t "Fixes goat teleporter destination to be Australia"
See also open bugs, open reviews, forum or report problems.
cpplint.py
Until 2018, our cpplint.py was a copy of the upstream version at
https://github.com/google/styleguide/tree/gh-pages/cpplint. Unfortunately, that
repository is not maintained any more.
If you want to update cpplint.py in depot_tools, just upload a patch to do
so. We will figure out a long-term strategy via issue https://crbug.com/916550.