Skip to content

Support pyenv in pyls #1393

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Feb 10, 2020
Merged

Support pyenv in pyls #1393

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f6566aa
In custom settings, support lambda function and pass workspace to it
15cm Feb 8, 2020
d4c2530
Support pyenv for pyls
15cm Feb 8, 2020
e862da3
Add an option to specify pyls environment; Fixes on pyls pyenv support
15cm Feb 8, 2020
9cabe53
Merge `lsp-register-custom-settings` in lsp-pyls
15cm Feb 8, 2020
699ef49
For lsp-client-settings values, supports function and extracts lambda…
15cm Feb 9, 2020
f7220e4
Disable pyenv integration for pyls by default. Add checks before call…
15cm Feb 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions lsp-mode.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5418,7 +5418,7 @@ WORKSPACE is the active workspace."
(lsp--error "Failed to apply edits with message %s" (error-message-string err))
:json-false))))
((string= method "workspace/configuration")
(lsp--build-workspace-configuration-response params))
(with-lsp-workspace workspace (lsp--build-workspace-configuration-response params)))
((string= method "workspace/workspaceFolders")
(let ((folders (or (-> workspace
(lsp--workspace-client)
Expand Down Expand Up @@ -6490,10 +6490,11 @@ changing the value of `foo'."

(defun lsp-register-custom-settings (props)
"Register PROPS.
PROPS is list of triple (path value boolean?) where PATH is the
path to the property, VALUE is either a literal value or symbol
used to retrieve the value, and BOOLEAN? is an optional flag that
should be non-nil for boolean settings."
PROPS is list of triple (path value boolean?) where PATH is the path to the
property; VALUE can be a literal value, symbol to be evaluated, or lambda
function to be called; BOOLEAN? is an optional flag that should be non-nil for
boolean settings, when it is nil the property will be ignored if the VALUE is
nil."
(let ((-compare-fn #'lsp--compare-setting-path))
(setq lsp-client-settings (-uniq (append props lsp-client-settings)))))

Expand All @@ -6520,11 +6521,13 @@ TBL - a hash table, PATHS is the path to the nested VALUE."
(when (s-matches? (concat section "\\..*") path)
(let* ((symbol-value (if (symbolp variable)
(symbol-value variable)
variable))
(if (functionp variable)
(funcall variable) variable)))
(value (if (and boolean? (not symbol-value))
:json-false
symbol-value)))
(lsp-ht-set ret (s-split "\\." path) value))))
(when (or boolean? value)
(lsp-ht-set ret (s-split "\\." path) value)))))
lsp-client-settings)
ret))

Expand Down
127 changes: 82 additions & 45 deletions lsp-pyls.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,12 @@
:group 'lsp-pyls
:package-version '(lsp-mode . "6.1"))

(defcustom lsp-pyls-pyenv-command-path "pyenv"
"Executable path to pyenv"
:type 'string
:group 'lsp-pyls
:package-version '(lsp-mode . "6.3"))

(defcustom lsp-pyls-plugins-jedi-completion-enabled t
"Enable or disable the plugin."
:type 'boolean
Expand Down Expand Up @@ -353,53 +359,84 @@ parameters referenced in config."
:group 'lsp-pyls
:package-version '(lsp-mode . "6.3"))

(defcustom lsp-pyls-plugins-jedi-use-pyenv-environment t
"If enabled, pass the environment got by pyenv to jedi"
:type 'boolean
:group 'lsp-pyls
:package-version '(lsp-mode . "6.3"))

(defcustom lsp-pyls-plugins-jedi-environment nil
"Specify the environment that jedi runs on where <environmeent>/bin/python
should be the python executable. This option will be prioritized over
`lsp-pyls-plugins-jedi-use-pyenv-environment'."
:type 'string
:group 'lsp-pyls
:package-version '(lsp-mode . "6.3"))

(lsp-register-custom-settings
'(("pyls.rope.ropeFolder" lsp-pyls-rope-rope-folder)
("pyls.rope.extensionModules" lsp-pyls-rope-extension-modules)
("pyls.plugins.autopep8.enabled" lsp-pyls-plugins-autopep8-enabled t)
("pyls.plugins.yapf.enabled" lsp-pyls-plugins-yapf-enabled t)
("pyls.plugins.rope_completion.enabled" lsp-pyls-plugins-rope-completion-enabled t)
("pyls.plugins.pyflakes.enabled" lsp-pyls-plugins-pyflakes-enabled t)
("pyls.plugins.pydocstyle.matchDir" lsp-pyls-plugins-pydocstyle-match-dir)
("pyls.plugins.pydocstyle.match" lsp-pyls-plugins-pydocstyle-match)
("pyls.plugins.pydocstyle.select" lsp-pyls-plugins-pydocstyle-select)
("pyls.plugins.pydocstyle.ignore" lsp-pyls-plugins-pydocstyle-ignore)
("pyls.plugins.pydocstyle.addSelect" lsp-pyls-plugins-pydocstyle-add-select)
("pyls.plugins.pydocstyle.addIgnore" lsp-pyls-plugins-pydocstyle-add-ignore)
("pyls.plugins.pydocstyle.convention" lsp-pyls-plugins-pydocstyle-convention)
("pyls.plugins.pydocstyle.enabled" lsp-pyls-plugins-pydocstyle-enabled t)
("pyls.plugins.pycodestyle.maxLineLength" lsp-pyls-plugins-pycodestyle-max-line-length)
("pyls.plugins.pycodestyle.hangClosing" lsp-pyls-plugins-pycodestyle-hang-closing t)
("pyls.plugins.pycodestyle.ignore" lsp-pyls-plugins-pycodestyle-ignore)
("pyls.plugins.pycodestyle.select" lsp-pyls-plugins-pycodestyle-select)
("pyls.plugins.pycodestyle.filename" lsp-pyls-plugins-pycodestyle-filename)
("pyls.plugins.pycodestyle.exclude" lsp-pyls-plugins-pycodestyle-exclude)
("pyls.plugins.pycodestyle.enabled" lsp-pyls-plugins-pycodestyle-enabled t)
("pyls.plugins.pylint.enabled" lsp-pyls-plugins-pylint-enabled t)
("pyls.plugins.pylint.args" lsp-pyls-plugins-pylint-args)
("pyls.plugins.flake8.enabled" lsp-pyls-plugins-flake8-enabled)
("pyls.plugins.flake8.exclude" lsp-pyls-plugins-flake8-exclude)
("pyls.plugins.flake8.filename" lsp-pyls-plugins-flake8-filename)
("pyls.plugins.flake8.hangClosing" lsp-pyls-plugins-flake8-hang-closing)
("pyls.plugins.flake8.ignore" lsp-pyls-plugins-flake8-ignore)
("pyls.plugins.flake8.maxLineLength" lsp-pyls-plugins-flake8-max-line-length)
("pyls.plugins.flake8.select" lsp-pyls-plugins-flake8-select)
("pyls.plugins.flake8.config" lsp-pyls-plugins-flake8-config)
("pyls.plugins.preload.modules" lsp-pyls-plugins-preload-modules)
("pyls.plugins.preload.enabled" lsp-pyls-plugins-preload-enabled t)
("pyls.plugins.mccabe.threshold" lsp-pyls-plugins-mccabe-threshold)
("pyls.plugins.mccabe.enabled" lsp-pyls-plugins-mccabe-enabled t)
("pyls.plugins.jedi_symbols.all_scopes" lsp-pyls-plugins-jedi-symbols-all-scopes t)
("pyls.plugins.jedi_symbols.enabled" lsp-pyls-plugins-jedi-symbols-enabled t)
("pyls.plugins.jedi_signature_help.enabled" lsp-pyls-plugins-jedi-signature-help-enabled t)
("pyls.plugins.jedi_references.enabled" lsp-pyls-plugins-jedi-references-enabled t)
("pyls.plugins.jedi_hover.enabled" lsp-pyls-plugins-jedi-hover-enabled t)
("pyls.plugins.jedi_definition.follow_builtin_imports" lsp-pyls-plugins-jedi-definition-follow-builtin-imports t)
("pyls.plugins.jedi_definition.follow_imports" lsp-pyls-plugins-jedi-definition-follow-imports t)
("pyls.plugins.jedi_definition.enabled" lsp-pyls-plugins-jedi-definition-enabled t)
("pyls.plugins.jedi_completion.include_params" lsp-pyls-plugins-jedi-completion-include-params t)
("pyls.plugins.jedi_completion.enabled" lsp-pyls-plugins-jedi-completion-enabled t)
("pyls.configurationSources" lsp-pyls-configuration-sources)))
("pyls.rope.extensionModules" lsp-pyls-rope-extension-modules)
("pyls.plugins.autopep8.enabled" lsp-pyls-plugins-autopep8-enabled t)
("pyls.plugins.yapf.enabled" lsp-pyls-plugins-yapf-enabled t)
("pyls.plugins.rope_completion.enabled" lsp-pyls-plugins-rope-completion-enabled t)
("pyls.plugins.pyflakes.enabled" lsp-pyls-plugins-pyflakes-enabled t)
("pyls.plugins.pydocstyle.matchDir" lsp-pyls-plugins-pydocstyle-match-dir)
("pyls.plugins.pydocstyle.match" lsp-pyls-plugins-pydocstyle-match)
("pyls.plugins.pydocstyle.select" lsp-pyls-plugins-pydocstyle-select)
("pyls.plugins.pydocstyle.ignore" lsp-pyls-plugins-pydocstyle-ignore)
("pyls.plugins.pydocstyle.addSelect" lsp-pyls-plugins-pydocstyle-add-select)
("pyls.plugins.pydocstyle.addIgnore" lsp-pyls-plugins-pydocstyle-add-ignore)
("pyls.plugins.pydocstyle.convention" lsp-pyls-plugins-pydocstyle-convention)
("pyls.plugins.pydocstyle.enabled" lsp-pyls-plugins-pydocstyle-enabled t)
("pyls.plugins.pycodestyle.maxLineLength" lsp-pyls-plugins-pycodestyle-max-line-length)
("pyls.plugins.pycodestyle.hangClosing" lsp-pyls-plugins-pycodestyle-hang-closing t)
("pyls.plugins.pycodestyle.ignore" lsp-pyls-plugins-pycodestyle-ignore)
("pyls.plugins.pycodestyle.select" lsp-pyls-plugins-pycodestyle-select)
("pyls.plugins.pycodestyle.filename" lsp-pyls-plugins-pycodestyle-filename)
("pyls.plugins.pycodestyle.exclude" lsp-pyls-plugins-pycodestyle-exclude)
("pyls.plugins.pycodestyle.enabled" lsp-pyls-plugins-pycodestyle-enabled t)
("pyls.plugins.pylint.enabled" lsp-pyls-plugins-pylint-enabled t)
("pyls.plugins.pylint.args" lsp-pyls-plugins-pylint-args)
("pyls.plugins.flake8.enabled" lsp-pyls-plugins-flake8-enabled)
("pyls.plugins.flake8.exclude" lsp-pyls-plugins-flake8-exclude)
("pyls.plugins.flake8.filename" lsp-pyls-plugins-flake8-filename)
("pyls.plugins.flake8.hangClosing" lsp-pyls-plugins-flake8-hang-closing)
("pyls.plugins.flake8.ignore" lsp-pyls-plugins-flake8-ignore)
("pyls.plugins.flake8.maxLineLength" lsp-pyls-plugins-flake8-max-line-length)
("pyls.plugins.flake8.select" lsp-pyls-plugins-flake8-select)
("pyls.plugins.flake8.config" lsp-pyls-plugins-flake8-config)
("pyls.plugins.preload.modules" lsp-pyls-plugins-preload-modules)
("pyls.plugins.preload.enabled" lsp-pyls-plugins-preload-enabled t)
("pyls.plugins.mccabe.threshold" lsp-pyls-plugins-mccabe-threshold)
("pyls.plugins.mccabe.enabled" lsp-pyls-plugins-mccabe-enabled t)
("pyls.plugins.jedi_symbols.all_scopes" lsp-pyls-plugins-jedi-symbols-all-scopes t)
("pyls.plugins.jedi_symbols.enabled" lsp-pyls-plugins-jedi-symbols-enabled t)
("pyls.plugins.jedi_signature_help.enabled" lsp-pyls-plugins-jedi-signature-help-enabled t)
("pyls.plugins.jedi_references.enabled" lsp-pyls-plugins-jedi-references-enabled t)
("pyls.plugins.jedi_hover.enabled" lsp-pyls-plugins-jedi-hover-enabled t)
("pyls.plugins.jedi_definition.follow_builtin_imports" lsp-pyls-plugins-jedi-definition-follow-builtin-imports t)
("pyls.plugins.jedi_definition.follow_imports" lsp-pyls-plugins-jedi-definition-follow-imports t)
("pyls.plugins.jedi_definition.enabled" lsp-pyls-plugins-jedi-definition-enabled t)
("pyls.plugins.jedi_completion.include_params" lsp-pyls-plugins-jedi-completion-include-params t)
("pyls.plugins.jedi_completion.enabled" lsp-pyls-plugins-jedi-completion-enabled t)
("pyls.configurationSources" lsp-pyls-configuration-sources)
("pyls.plugins.jedi.environment"
(lambda ()
(if lsp-pyls-plugins-jedi-environment
lsp-pyls-plugins-jedi-environment
(when lsp-pyls-plugins-jedi-use-pyenv-environment
(let ((pyenv-version (getenv "PYENV_VERSION"))
(root (lsp-seq-first (lsp-find-roots-for-workspace lsp--cur-workspace (lsp-session)))))
(when root
(setenv "PYENV_VERSION" nil)
(let ((python-env (f-parent
(f-parent
(shell-command-to-string
(format "PYENV_DIR='%s' %s which python"
root lsp-pyls-pyenv-command-path))))))
(lsp--info "Configure pyls with environment: %s" python-env)
(setenv "PYENV_VERSION" pyenv-version)
python-env)))))))))

(lsp-register-client
(make-lsp-client :new-connection (lsp-stdio-connection
Expand Down