InTheForest/chromium_depot_tools
1
0
Fork 0
mirror of https://chromium.googlesource.com/chromium/tools/depot_tools.git synced 2026-01-11 18:51:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix multiline comment formatting

Browse Source 
Many incorrectly formatted comments exist from the switch to
4 space indent: https://crrev.com/c/4836379

Bug: 1514505
Change-Id: I6366f9da812919bd35b999f18fa8a49b7a66c09b
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/tools/depot_tools/+/5153633
Commit-Queue: Gavin Mak <gavinmak@google.com>
Reviewed-by: Josip Sokcevic <sokcevic@chromium.org>
This commit is contained in:
Gavin Mak
2024-01-02 20:19:55 +00:00
committed by LUCI CQ
parent 31a590e0cd
commit edba22d4eb
62 changed files with 2762 additions and 2744 deletions
Download Patch File Download Diff File Expand all files Collapse all files

92
bootstrap/bootstrap.py
View File

@@ -54,15 +54,15 @@ class Template(
def maybe_install(self, name, dst_path):
"""Installs template |name| to |dst_path| if it has changed.
This loads the template |name| from THIS_DIR, resolves template parameters,
and installs it to |dst_path|. See `maybe_update` for more information.
This loads the template |name| from THIS_DIR, resolves template parameters,
and installs it to |dst_path|. See `maybe_update` for more information.
Args:
name (str): The name of the template to install.
dst_path (str): The destination filesystem path.
Args:
name (str): The name of the template to install.
dst_path (str): The destination filesystem path.
Returns (bool): True if |dst_path| was updated, False otherwise.
"""
Returns (bool): True if |dst_path| was updated, False otherwise.
"""
template_path = os.path.join(THIS_DIR, name)
with open(template_path, 'r', encoding='utf8') as fd:
t = string.Template(fd.read())
@@ -72,17 +72,17 @@ class Template(
def maybe_update(content, dst_path):
"""Writes |content| to |dst_path| if |dst_path| does not already match.
This function will ensure that there is a file at |dst_path| containing
|content|. If |dst_path| already exists and contains |content|, no operation
will be performed, preserving filesystem modification times and avoiding
potential write contention.
This function will ensure that there is a file at |dst_path| containing
|content|. If |dst_path| already exists and contains |content|, no operation
will be performed, preserving filesystem modification times and avoiding
potential write contention.
Args:
content (str): The file content.
dst_path (str): The destination filesystem path.
Args:
content (str): The file content.
dst_path (str): The destination filesystem path.
Returns (bool): True if |dst_path| was updated, False otherwise.
"""
Returns (bool): True if |dst_path| was updated, False otherwise.
"""
# If the path already exists and matches the new content, refrain from
# writing a new one.
if os.path.exists(dst_path):
@@ -100,14 +100,14 @@ def maybe_update(content, dst_path):
def maybe_copy(src_path, dst_path):
"""Writes the content of |src_path| to |dst_path| if needed.
See `maybe_update` for more information.
See `maybe_update` for more information.
Args:
src_path (str): The content source filesystem path.
dst_path (str): The destination filesystem path.
Args:
src_path (str): The content source filesystem path.
dst_path (str): The destination filesystem path.
Returns (bool): True if |dst_path| was updated, False otherwise.
"""
Returns (bool): True if |dst_path| was updated, False otherwise.
"""
with open(src_path, 'r', encoding='utf-8') as fd:
content = fd.read()
return maybe_update(content, dst_path)
@@ -116,21 +116,21 @@ def maybe_copy(src_path, dst_path):
def call_if_outdated(stamp_path, stamp_version, fn):
"""Invokes |fn| if the stamp at |stamp_path| doesn't match |stamp_version|.
This can be used to keep a filesystem record of whether an operation has been
performed. The record is stored at |stamp_path|. To invalidate a record,
change the value of |stamp_version|.
This can be used to keep a filesystem record of whether an operation has been
performed. The record is stored at |stamp_path|. To invalidate a record,
change the value of |stamp_version|.
After |fn| completes successfully, |stamp_path| will be updated to match
|stamp_version|, preventing the same update from happening in the future.
After |fn| completes successfully, |stamp_path| will be updated to match
|stamp_version|, preventing the same update from happening in the future.
Args:
stamp_path (str): The filesystem path of the stamp file.
stamp_version (str): The desired stamp version.
fn (callable): A callable to invoke if the current stamp version doesn't
match |stamp_version|.
Args:
stamp_path (str): The filesystem path of the stamp file.
stamp_version (str): The desired stamp version.
fn (callable): A callable to invoke if the current stamp version doesn't
match |stamp_version|.
Returns (bool): True if an update occurred.
"""
Returns (bool): True if an update occurred.
"""
stamp_version = stamp_version.strip()
if os.path.isfile(stamp_path):
@@ -149,13 +149,13 @@ def call_if_outdated(stamp_path, stamp_version, fn):
def _in_use(path):
"""Checks if a Windows file is in use.
When Windows is using an executable, it prevents other writers from
modifying or deleting that executable. We can safely test for an in-use
file by opening it in write mode and checking whether or not there was
an error.
When Windows is using an executable, it prevents other writers from
modifying or deleting that executable. We can safely test for an in-use
file by opening it in write mode and checking whether or not there was
an error.
Returns (bool): True if the file was in use, False if not.
"""
Returns (bool): True if the file was in use, False if not.
"""
try:
with open(path, 'r+'):
return False
@@ -165,7 +165,7 @@ def _in_use(path):
def _toolchain_in_use(toolchain_path):
"""Returns (bool): True if a toolchain rooted at |path| is in use.
"""
"""
# Look for Python files that may be in use.
for python_dir in (
os.path.join(toolchain_path, 'python', 'bin'), # CIPD
@@ -225,11 +225,11 @@ def _safe_rmtree(path):
def clean_up_old_installations(skip_dir):
"""Removes Python installations other than |skip_dir|.
This includes an "in-use" check against the "python.exe" in a given directory
to avoid removing Python executables that are currently ruinning. We need
this because our Python bootstrap may be run after (and by) other software
that is using the bootstrapped Python!
"""
This includes an "in-use" check against the "python.exe" in a given directory
to avoid removing Python executables that are currently ruinning. We need
this because our Python bootstrap may be run after (and by) other software
that is using the bootstrapped Python!
"""
root_contents = os.listdir(ROOT_DIR)
for f in ('win_tools-*_bin', 'python27*_bin', 'git-*_bin',
'bootstrap-*_bin'):