build/find_depot_tools.py

   1 #!/usr/bin/env python3
   2 # Copyright 2011 The Chromium Authors
   3 # Use of this source code is governed by a BSD-style license that can be
   4 # found in the LICENSE file.
   5 """Small utility function to find depot_tools and add it to the python path.
   6
   7 Will throw an ImportError exception if depot_tools can't be found since it
   8 imports breakpad.
   9
  10 This can also be used as a standalone script to print out the depot_tools
  11 directory location.
  12 """
  13
  14
  15 import os
  16 import sys
  17
  18
  19 # Path to //src
  20 SRC = os.path.abspath(os.path.join(os.path.dirname(__file__), os.pardir))
  21
  22
  23 def IsRealDepotTools(path):
  24   expanded_path = os.path.expanduser(path)
  25   return os.path.isfile(os.path.join(expanded_path, 'gclient.py'))
  26
  27
  28 def add_depot_tools_to_path():
  29   """Search for depot_tools and add it to sys.path."""
  30   # First, check if we have a DEPS'd in "depot_tools".
  31   deps_depot_tools = os.path.join(SRC, 'third_party', 'depot_tools')
  32   if IsRealDepotTools(deps_depot_tools):
  33     # Put the pinned version at the start of the sys.path, in case there
  34     # are other non-pinned versions already on the sys.path.
  35     sys.path.insert(0, deps_depot_tools)
  36     return deps_depot_tools
  37
  38   # Then look if depot_tools is already in PYTHONPATH.
  39   for i in sys.path:
  40     if i.rstrip(os.sep).endswith('depot_tools') and IsRealDepotTools(i):
  41       return i
  42   # Then look if depot_tools is in PATH, common case.
  43   for i in os.environ['PATH'].split(os.pathsep):
  44     if IsRealDepotTools(i):
  45       sys.path.append(i.rstrip(os.sep))
  46       return i
  47   # Rare case, it's not even in PATH, look upward up to root.
  48   root_dir = os.path.dirname(os.path.abspath(__file__))
  49   previous_dir = os.path.abspath(__file__)
  50   while root_dir and root_dir != previous_dir:
  51     i = os.path.join(root_dir, 'depot_tools')
  52     if IsRealDepotTools(i):
  53       sys.path.append(i)
  54       return i
  55     previous_dir = root_dir
  56     root_dir = os.path.dirname(root_dir)
  57   print('Failed to find depot_tools', file=sys.stderr)
  58   return None
  59
  60 DEPOT_TOOLS_PATH = add_depot_tools_to_path()
  61
  62 # pylint: disable=W0611
  63 import breakpad
  64
  65
  66 def main():
  67   if DEPOT_TOOLS_PATH is None:
  68     return 1
  69   print(DEPOT_TOOLS_PATH)
  70   return 0
  71
  72
  73 if __name__ == '__main__':
  74   sys.exit(main())