mirror of
https://github.com/dense-analysis/ale
synced 2024-12-13 01:46:34 +00:00
138 lines
5.2 KiB
Plaintext
138 lines
5.2 KiB
Plaintext
===============================================================================
|
|
ALE Python Integration *ale-python-options*
|
|
|
|
|
|
-------------------------------------------------------------------------------
|
|
Global Options
|
|
|
|
g:ale_virtualenv_dir_names *g:ale_virtualenv_dir_names*
|
|
*b:ale_virtualenv_dir_names*
|
|
|
|
Type: |List|
|
|
Default: `['.env', 'env', 've-py3', 've', 'virtualenv']`
|
|
|
|
A list of directory names to be used when searching upwards from Python
|
|
files to discover virtulenv directories with. For directory named `'foo'`,
|
|
ALE will search for `'foo/bin/activate'` in all directories on and above
|
|
the directory containing the Python file to find virtualenv paths.
|
|
|
|
|
|
-------------------------------------------------------------------------------
|
|
flake8 *ale-python-flake8*
|
|
|
|
g:ale_python_flake8_executable *g:ale_python_flake8_executable*
|
|
*b:ale_python_flake8_executable*
|
|
Type: |String|
|
|
Default: `'flake8'`
|
|
|
|
This variable can be changed to modify the executable used for flake8.
|
|
|
|
|
|
g:ale_python_flake8_options *g:ale_python_flake8_options*
|
|
*b:ale_python_flake8_options*
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable can be changed to add command-line arguments to the flake8
|
|
invocation.
|
|
|
|
For example, to dynamically switch between programs targeting Python 2 and
|
|
Python 3, you may want to set >
|
|
|
|
let g:ale_python_flake8_executable = 'python3' " or 'python' for Python 2
|
|
let g:ale_python_flake8_options = '-m flake8'
|
|
<
|
|
after making sure it's installed for the appropriate Python versions (e.g.
|
|
`python3 -m pip install --user flake8`).
|
|
|
|
|
|
g:ale_python_flake8_use_global *g:ale_python_flake8_use_global*
|
|
*b:ale_python_flake8_use_global*
|
|
Type: |Number|
|
|
Default: `0`
|
|
|
|
This variable controls whether or not ALE will search for flake8 in a
|
|
virtualenv directory first. If this variable is set to `1`, then ALE will
|
|
always use |g:ale_python_flake8_executable| for the executable path.
|
|
|
|
Both variables can be set with `b:` buffer variables instead.
|
|
|
|
|
|
-------------------------------------------------------------------------------
|
|
mypy *ale-python-mypy*
|
|
|
|
g:ale_python_mypy_executable *g:ale_python_mypy_executable*
|
|
*b:ale_python_mypy_executable*
|
|
Type: |String|
|
|
Default: `'mypy'`
|
|
|
|
This variable can be changed to modify the executable used for mypy.
|
|
|
|
|
|
g:ale_python_mypy_options *g:ale_python_mypy_options*
|
|
*b:ale_python_mypy_options*
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable can be changed to add command-line arguments to the mypy
|
|
invocation.
|
|
|
|
|
|
g:ale_python_mypy_use_global *g:ale_python_mypy_use_global*
|
|
*b:ale_python_mypy_use_global*
|
|
Type: |Number|
|
|
Default: `0`
|
|
|
|
This variable controls whether or not ALE will search for mypy in a
|
|
virtualenv directory first. If this variable is set to `1`, then ALE will
|
|
always use |g:ale_python_mypy_executable| for the executable path.
|
|
|
|
Both variables can be set with `b:` buffer variables instead.
|
|
|
|
|
|
-------------------------------------------------------------------------------
|
|
pylint *ale-python-pylint*
|
|
|
|
g:ale_python_pylint_executable *g:ale_python_pylint_executable*
|
|
*b:ale_python_pylint_executable*
|
|
Type: |String|
|
|
Default: `'pylint'`
|
|
|
|
This variable can be changed to modify the executable used for pylint.
|
|
|
|
|
|
g:ale_python_pylint_options *g:ale_python_pylint_options*
|
|
*b:ale_python_pylint_options*
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable can be changed to add command-line arguments to the pylint
|
|
invocation.
|
|
|
|
For example, to dynamically switch between programs targeting Python 2 and
|
|
Python 3, you may want to set >
|
|
|
|
let g:ale_python_pylint_executable = 'python3' " or 'python' for Python 2
|
|
let g:ale_python_pylint_options = '-rcfile /path/to/pylint.rc'
|
|
" The virtualenv detection needs to be disabled.
|
|
let g:ale_python_pylint_use_global = 0
|
|
|
|
after making sure it's installed for the appropriate Python versions (e.g.
|
|
`python3 -m pip install --user pylint`).
|
|
|
|
|
|
g:ale_python_pylint_use_global *g:ale_python_pylint_use_global*
|
|
*b:ale_python_pylint_use_global*
|
|
Type: |Number|
|
|
Default: `0`
|
|
|
|
This variable controls whether or not ALE will search for pylint in a
|
|
virtualenv directory first. If this variable is set to `1`, then ALE will
|
|
always use |g:ale_python_pylint_executable| for the executable path.
|
|
|
|
Both variables can be set with `b:` buffer variables instead.
|
|
|
|
|
|
-------------------------------------------------------------------------------
|
|
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|