Files
chromium_depot_tools/recipes/recipe_modules/depot_tools/api.py
Junji Watanabe 9d77ca716f [recipe] Remove depot_tools.{ninja_path, autoninja_path} recipe APIs
I have replaced all the references, and there should be no references to these APIs anymore.

A PSA has been sent already.
http://g/chromium-dev-internal/n2IL0Mbh0E8

Bug: 1340825
Change-Id: Ife882f4427f8841cacb9a70a99dbd6a90c741da2
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/tools/depot_tools/+/4194896
Reviewed-by: Takuto Ikuta <tikuta@chromium.org>
Commit-Queue: Junji Watanabe <jwata@google.com>
Reviewed-by: Gavin Mak <gavinmak@google.com>
2023-01-30 03:00:48 +00:00

67 lines
1.7 KiB
Python

# Copyright 2016 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.
"""The `depot_tools` module provides safe functions to access paths within
the depot_tools repo."""
import contextlib
from recipe_engine import recipe_api
class DepotToolsApi(recipe_api.RecipeApi):
def __init__(self, **kwargs):
super(DepotToolsApi, self).__init__(**kwargs);
self._cipd_bin_setup_called = False
@property
def download_from_google_storage_path(self):
return self.repo_resource('download_from_google_storage.py')
@property
def upload_to_google_storage_path(self):
return self.repo_resource('upload_to_google_storage.py')
@property
def root(self):
"""Returns (Path): The "depot_tools" root directory."""
return self.repo_resource()
@property
def cros_path(self):
return self.repo_resource('cros')
@property
def gn_py_path(self):
return self.repo_resource('gn.py')
# TODO(dnj): Remove this once everything uses the "gsutil" recipe module
# version.
@property
def gsutil_py_path(self):
return self.repo_resource('gsutil.py')
@property
def presubmit_support_py_path(self):
return self.repo_resource('presubmit_support.py')
@contextlib.contextmanager
def on_path(self):
"""Use this context manager to put depot_tools on $PATH.
Example:
```python
with api.depot_tools.on_path():
# run some steps
```
"""
# By default Depot Tools do not auto update on the bots.
# (crbug/1090603)
with self.m.context(
**{'env_suffixes': {
'PATH': [self.root],
'DEPOT_TOOLS_UPDATE': '0'
}}):
yield