vim/YouCompleteMe
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Auto merge of #2205 - vheon:document-find-executable, r=micbou

Browse Source 
[RFC] Document find first executable for ycm_python_binary_path

# PR Prelude

Thank you for working on YCM! :)

**Please complete these steps and check these boxes (by putting an `x` inside
the brackets) _before_ filing your PR:**

- [x] I have read and understood YCM's [CONTRIBUTING][cont] document.
- [x] I have read and understood YCM's [CODE_OF_CONDUCT][code] document.
- [x] I have included tests for the changes in my PR. If not, I have included a
  rationale for why I haven't.
- [x] **I understand my PR may be closed if it becomes obvious I didn't
  actually perform all of these steps.**

# Why this change is necessary and useful

This will document the enhancement that https://github.com/Valloric/ycmd/pull/429 brought to YCM. When this will be ready I will update the vim documentation too.

[Please explain **in detail** why the changes in this PR are needed.]

[cont]: https://github.com/Valloric/YouCompleteMe/blob/master/CONTRIBUTING.md
[code]: https://github.com/Valloric/YouCompleteMe/blob/master/CODE_OF_CONDUCT.md

<!-- Reviewable:start -->
---
This change is [<img src="https://reviewable.io/review_button.svg" height="35" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/valloric/youcompleteme/2205)
<!-- Reviewable:end -->
This commit is contained in:
Homu 2016-06-16 06:34:09 +09:00
commit 7101afc239
3 changed files with 58 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -961,6 +961,20 @@ binary to use. For example, to provide Python 3 completion in your project, set:
let g:ycm_python_binary_path = '/usr/bin/python3'
```
If the value of `g:ycm_python_binary_path` is an absolute path like above it
will be used as-is, but if it's an executable name it will be searched through
the PATH. So for example if you set:
```viml
let g:ycm_python_binary_path = 'python'
```
YCM will use the first `python` executable it finds in the PATH to run
[jedi][]. This means that if you are in a virtual environment and you start vim
in that directory, the first `python` that YCM will find will be the one in the
virtual environment, so [jedi][] will be able to provide completions for every
package you have in the virtual environment.
### Semantic Completion for Other Languages
Python, C#, Go, Rust, and TypeScript are supported natively by YouCompleteMe
@ -2352,9 +2366,12 @@ Python 2.6, 2.7 or 3.3+).
Default: `''`
```viml
let g:ycm_python_binary_path = '/usr/bin/python3'
let g:ycm_python_binary_path = 'python'
```
NOTE: the settings above will make YCM use the first `python` executable
found through the PATH.
FAQ
---
@ -2820,6 +2837,16 @@ a [bug][vim_win-python2.7.11-bug]. Follow this [workaround]
[vim_win-python2.7.11-bug_workaround] or use a different version (Python 2.7.9
does not suffer from the bug).
### I can't complete python packages in a virtual environment.
This means that the Python used to run [JediHTTP][] is not the Python of the
virtual environment you're in. To resolve this you either set
`g:ycm_python_binary_path` to the absolute path of the Python binary in your
virtual environment or since virtual environment will put that Python
executable first in your PATH when the virtual environment is active then if
you set `g:ycm_python_binary_path` to just `'python'` it will be found as the
first Python and used to run [JediHTTP][].
Contributor Code of Conduct
---------------------------

30
doc/youcompleteme.txt
View File

@ -162,6 +162,7 @@ attempt to load the C runtime library incorrectly.' |R6034-An-application-has-ma
16. I hear that YCM only supports Python 2, is that true? |youcompleteme-i-hear-that-ycm-only-supports-python-2-is-that-true|
17. On Windows I get "E887: Sorry, this command is disabled, the Python's site
module could not be loaded" |E887:-Sorry-this-command-is-disabled-the-Python-s-site-module-could-not-be-loaded|
18. I can't complete python packages in a virtual environment. |youcompleteme-i-cant-complete-python-packages-in-virtual-environment.|
13. Contributor Code of Conduct |youcompleteme-contributor-code-of-conduct|
14. Contact |youcompleteme-contact|
15. License |youcompleteme-license|
@ -1212,6 +1213,18 @@ set:
>
let g:ycm_python_binary_path = '/usr/bin/python3'
<
If the value of |g:ycm_python_binary_path| is an absolute path like above it
will be used as-is, but if it's an executable name it will be searched through
the PATH. So for example if you set:
>
let g:ycm_python_binary_path = 'python'
<
YCM will use the first 'python' executable it finds in the PATH to run jedi
[6]. This means that if you are in a virtual environment and you start vim in
that directory, the first 'python' that YCM will find will be the one in the
virtual environment, so jedi [6] will be able to provide completions for every
package you have in the virtual environment.
-------------------------------------------------------------------------------
*youcompleteme-semantic-completion-for-other-languages*
Semantic Completion for Other Languages ~
@ -2589,8 +2602,11 @@ Python 2.6, 2.7 or 3.3+).
Default: "''"
>
let g:ycm_python_binary_path = '/usr/bin/python3'
let g:ycm_python_binary_path = 'python'
<
NOTE: the settings above will make YCM use the first 'python' executable found
through the PATH.
===============================================================================
*youcompleteme-faq*
FAQ ~
@ -3102,6 +3118,18 @@ If you are running vim on Windows with Python 2.7.11, this is likely caused by
a bug [62]. Follow this workaround [63] or use a different version (Python
2.7.9 does not suffer from the bug).
-------------------------------------------------------------------------------
*youcompleteme-i-cant-complete-python-packages-in-virtual-environment.*
I can't complete python packages in a virtual environment. ~
This means that the Python used to run JediHTTP [7] is not the Python of the
virtual environment you're in. To resolve this you either set
|g:ycm_python_binary_path| to the absolute path of the Python binary in your
virtual environment or since virtual environment will put that Python
executable first in your PATH when the virtual environment is active then if
you set |g:ycm_python_binary_path| to just "'python'" it will be found as the
first Python and used to run JediHTTP [7].
===============================================================================
*youcompleteme-contributor-code-of-conduct*
Contributor Code of Conduct ~

2
third_party/ycmd vendored

@ -1 +1 @@
Subproject commit 22f229c91f7e3e6b60da521104bc0a31fc72951d
Subproject commit b7484dfabe606841a0bd84c1b0b2944ff9f14c57