paths.py 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135
  1. # Copyright (C) 2015 YouCompleteMe contributors.
  2. #
  3. # This file is part of YouCompleteMe.
  4. #
  5. # YouCompleteMe is free software: you can redistribute it and/or modify
  6. # it under the terms of the GNU General Public License as published by
  7. # the Free Software Foundation, either version 3 of the License, or
  8. # (at your option) any later version.
  9. #
  10. # YouCompleteMe is distributed in the hope that it will be useful,
  11. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. # GNU General Public License for more details.
  14. #
  15. # You should have received a copy of the GNU General Public License
  16. # along with YouCompleteMe. If not, see <http://www.gnu.org/licenses/>.
  17. from __future__ import unicode_literals
  18. from __future__ import print_function
  19. from __future__ import division
  20. from __future__ import absolute_import
  21. from future import standard_library
  22. standard_library.install_aliases()
  23. from builtins import * # noqa
  24. import os
  25. import sys
  26. import vim
  27. import functools
  28. import re
  29. # Can't import these from setup.py because it makes nosetests go crazy.
  30. DIR_OF_CURRENT_SCRIPT = os.path.dirname( os.path.abspath( __file__ ) )
  31. DIR_OF_YCMD = os.path.join( DIR_OF_CURRENT_SCRIPT, '..', '..', 'third_party',
  32. 'ycmd' )
  33. WIN_PYTHON_PATH = os.path.join( sys.exec_prefix, 'python.exe' )
  34. PYTHON_BINARY_REGEX = re.compile(
  35. r'python((2(\.[67])?)|(3(\.[3-9])?))?(.exe)?$' )
  36. def Memoize( obj ):
  37. cache = obj.cache = {}
  38. @functools.wraps( obj )
  39. def memoizer( *args, **kwargs ):
  40. key = str( args ) + str( kwargs )
  41. if key not in cache:
  42. cache[ key ] = obj( *args, **kwargs )
  43. return cache[ key ]
  44. return memoizer
  45. @Memoize
  46. def PathToPythonInterpreter():
  47. from ycmd import utils
  48. python_interpreter = vim.eval( 'g:ycm_server_python_interpreter' )
  49. if python_interpreter:
  50. if IsPythonVersionCorrect( python_interpreter ):
  51. return python_interpreter
  52. raise RuntimeError( "Path in 'g:ycm_server_python_interpreter' option "
  53. "does not point to a valid Python 2.6+ or 3.3+." )
  54. python_interpreter = _PathToPythonUsedDuringBuild()
  55. if IsPythonVersionCorrect( python_interpreter ):
  56. return python_interpreter
  57. # On UNIX platforms, we use sys.executable as the Python interpreter path.
  58. # We cannot use sys.executable on Windows because for unknown reasons, it
  59. # returns the Vim executable. Instead, we use sys.exec_prefix to deduce the
  60. # interpreter path.
  61. python_interpreter = ( WIN_PYTHON_PATH if utils.OnWindows() else
  62. sys.executable )
  63. if IsPythonVersionCorrect( python_interpreter ):
  64. return python_interpreter
  65. # As a last resort, we search python in the PATH. We prefer Python 2 over 3
  66. # for the sake of backwards compatibility with ycm_extra_conf.py files out
  67. # there; few people wrote theirs to work on py3.
  68. # So we check 'python2' before 'python' because on some distributions (Arch
  69. # Linux for example), python refers to python3.
  70. python_interpreter = utils.PathToFirstExistingExecutable( [ 'python2',
  71. 'python',
  72. 'python3' ] )
  73. if IsPythonVersionCorrect( python_interpreter ):
  74. return python_interpreter
  75. raise RuntimeError( "Cannot find Python 2.6+ or 3.3+. You can set its path "
  76. "using the 'g:ycm_server_python_interpreter' "
  77. "option." )
  78. def _PathToPythonUsedDuringBuild():
  79. from ycmd import utils
  80. try:
  81. filepath = os.path.join( DIR_OF_YCMD, 'PYTHON_USED_DURING_BUILDING' )
  82. return utils.ReadFile( filepath ).strip()
  83. # We need to check for IOError for Python2 and OSError for Python3
  84. except ( IOError, OSError ):
  85. return None
  86. def EndsWithPython( path ):
  87. """Check if given path ends with a python 2.6+ or 3.3+ name."""
  88. return path and PYTHON_BINARY_REGEX.search( path ) is not None
  89. def IsPythonVersionCorrect( path ):
  90. """Check if given path is the Python interpreter version 2.6+ or 3.3+."""
  91. from ycmd import utils
  92. if not EndsWithPython( path ):
  93. return False
  94. command = [ path,
  95. '-c',
  96. "import sys;"
  97. "major, minor = sys.version_info[ :2 ];"
  98. "good_python = ( major == 2 and minor >= 6 ) "
  99. "or ( major == 3 and minor >= 3 ) or major > 3;"
  100. # If this looks weird, remember that:
  101. # int( True ) == 1
  102. # int( False ) == 0
  103. "sys.exit( not good_python )" ]
  104. return utils.SafePopen( command ).wait() == 0
  105. def PathToServerScript():
  106. return os.path.join( DIR_OF_YCMD, 'ycmd' )