pythonx.vim 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114
  1. " The Python provider helper
  2. if exists('s:loaded_pythonx_provider')
  3. finish
  4. endif
  5. let s:loaded_pythonx_provider = 1
  6. function! provider#pythonx#Require(host) abort
  7. " Python host arguments
  8. let prog = provider#python3#Prog()
  9. let args = [prog, '-c', 'import sys; sys.path = [p for p in sys.path if p != ""]; import neovim; neovim.start_host()']
  10. " Collect registered Python plugins into args
  11. let python_plugins = remote#host#PluginsForHost(a:host.name)
  12. for plugin in python_plugins
  13. call add(args, plugin.path)
  14. endfor
  15. return provider#Poll(args, a:host.orig_name, '$NVIM_PYTHON_LOG_FILE', {'overlapped': v:true})
  16. endfunction
  17. function! s:get_python_executable_from_host_var(major_version) abort
  18. return expand(get(g:, 'python'.(a:major_version == 3 ? '3' : execute("throw 'unsupported'")).'_host_prog', ''), v:true)
  19. endfunction
  20. function! s:get_python_candidates(major_version) abort
  21. return {
  22. \ 3: ['python3', 'python3.10', 'python3.9', 'python3.8', 'python3.7', 'python']
  23. \ }[a:major_version]
  24. endfunction
  25. " Returns [path_to_python_executable, error_message]
  26. function! provider#pythonx#Detect(major_version) abort
  27. return provider#pythonx#DetectByModule('neovim', a:major_version)
  28. endfunction
  29. " Returns [path_to_python_executable, error_message]
  30. function! provider#pythonx#DetectByModule(module, major_version) abort
  31. let python_exe = s:get_python_executable_from_host_var(a:major_version)
  32. if !empty(python_exe)
  33. return [exepath(expand(python_exe, v:true)), '']
  34. endif
  35. let candidates = s:get_python_candidates(a:major_version)
  36. let errors = []
  37. for exe in candidates
  38. let [result, error] = provider#pythonx#CheckForModule(exe, a:module, a:major_version)
  39. if result
  40. return [exe, error]
  41. endif
  42. " Accumulate errors in case we don't find any suitable Python executable.
  43. call add(errors, error)
  44. endfor
  45. " No suitable Python executable found.
  46. return ['', 'Could not load Python '.a:major_version.":\n".join(errors, "\n")]
  47. endfunction
  48. " Returns array: [prog_exitcode, prog_version]
  49. function! s:import_module(prog, module) abort
  50. let prog_version = system([a:prog, '-c' , printf(
  51. \ 'import sys; ' .
  52. \ 'sys.path = [p for p in sys.path if p != ""]; ' .
  53. \ 'sys.stdout.write(str(sys.version_info[0]) + "." + str(sys.version_info[1])); ' .
  54. \ 'import pkgutil; ' .
  55. \ 'exit(2*int(pkgutil.get_loader("%s") is None))',
  56. \ a:module)])
  57. return [v:shell_error, prog_version]
  58. endfunction
  59. " Returns array: [was_success, error_message]
  60. function! provider#pythonx#CheckForModule(prog, module, major_version) abort
  61. let prog_path = exepath(a:prog)
  62. if prog_path ==# ''
  63. return [0, a:prog . ' not found in search path or not executable.']
  64. endif
  65. let min_version = '3.7'
  66. " Try to load module, and output Python version.
  67. " Exit codes:
  68. " 0 module can be loaded.
  69. " 2 module cannot be loaded.
  70. " Otherwise something else went wrong (e.g. 1 or 127).
  71. let [prog_exitcode, prog_version] = s:import_module(a:prog, a:module)
  72. if prog_exitcode == 2 || prog_exitcode == 0
  73. " Check version only for expected return codes.
  74. if prog_version !~ '^' . a:major_version
  75. return [0, prog_path . ' is Python ' . prog_version . ' and cannot provide Python '
  76. \ . a:major_version . '.']
  77. elseif prog_version =~ '^' . a:major_version && str2nr(prog_version[2:]) < str2nr(min_version[2:])
  78. return [0, prog_path . ' is Python ' . prog_version . ' and cannot provide Python >= '
  79. \ . min_version . '.']
  80. endif
  81. endif
  82. if prog_exitcode == 2
  83. return [0, prog_path.' does not have the "' . a:module . '" module.']
  84. elseif prog_exitcode == 127
  85. " This can happen with pyenv's shims.
  86. return [0, prog_path . ' does not exist: ' . prog_version]
  87. elseif prog_exitcode
  88. return [0, 'Checking ' . prog_path . ' caused an unknown error. '
  89. \ . '(' . prog_exitcode . ', output: ' . prog_version . ')'
  90. \ . ' Report this at https://github.com/neovim/neovim']
  91. endif
  92. return [1, '']
  93. endfunction