1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
;;; lsp-pyright.el --- Python LSP client using Pyright -*- lexical-binding: t; -*-
;; Copyright (C) 2020 emacs-lsp maintainers
;; Author: Arif Rezai, Vincent Zhang, Andrew Christianson
;; Version: 0.2.0
;; Package-Version: 20220411.1753
;; Package-Commit: ab7369d96f4d7d058d0e06e743f86fda8ecc191c
;; Package-Requires: ((emacs "26.1") (lsp-mode "7.0") (dash "2.18.0") (ht "2.0"))
;; Homepage: https://github.com/emacs-lsp/lsp-pyright
;; Keywords: languages, tools, lsp
;; This file is not part of GNU Emacs
;; This file is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 3, or (at your option)
;; any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; For a full copy of the GNU General Public License
;; see <https://www.gnu.org/licenses/>.
;;
;;; Commentary:
;;
;; Pyright language server.
;;
;;; Code:
(require 'lsp-mode)
(require 'dash)
(require 'ht)
;; Group declaration
(defgroup lsp-pyright nil
"LSP support for python using the Pyright Language Server."
:group 'lsp-mode
:link '(url-link "https://github.com/microsoft/pyright"))
(defcustom lsp-pyright-langserver-command-args '("--stdio")
"Command to start pyright-langserver."
:type '(repeat string)
:group 'lsp-pyright)
(defcustom lsp-pyright-disable-language-services nil
"Disables all language services except for \"hover\"."
:type 'boolean
:group 'lsp-pyright)
(defcustom lsp-pyright-disable-organize-imports nil
"Disables the \"Organize Imports\" command."
:type 'boolean
:group 'lsp-pyright)
(defcustom lsp-pyright-use-library-code-for-types t
"Determines whether to analyze library code.
In order to extract type information in the absence of type stub files.
This can add significant overhead and may result in
poor-quality type information.
The default value for this option is true."
:type 'boolean
:group 'lsp-pyright)
(defcustom lsp-pyright-diagnostic-mode "openFilesOnly"
"Determines pyright diagnostic mode.
Whether pyright analyzes (and reports errors for) all files
in the workspace, as indicated by the config file.
If this option is set to \"openFilesOnly\", pyright analyzes only open files."
:type '(choice
(const "openFilesOnly")
(const "workspace"))
:group 'lsp-pyright)
(defcustom lsp-pyright-typechecking-mode "basic"
"Determines the default type-checking level used by pyright.
This can be overridden in the configuration file."
:type '(choice
(const "off")
(const "basic")
(const "strict"))
:group 'lsp-pyright)
(defcustom lsp-pyright-log-level "info"
"Determines the default log level used by pyright.
This can be overridden in the configuration file."
:type '(choice
(const "error")
(const "warning")
(const "info")
(const "trace"))
:group 'lsp-pyright)
(defcustom lsp-pyright-auto-search-paths t
"Determines whether pyright automatically adds common search paths.
i.e: Paths like \"src\" if there are no execution environments defined in the
config file."
:type 'boolean
:group 'lsp-pyright)
(defcustom lsp-pyright-extra-paths []
"Paths to add to the default execution environment extra paths.
If there are no execution environments defined in the config file."
:type 'lsp-string-vector
:group 'lsp-pyright)
(make-variable-buffer-local 'lsp-pyright-extra-paths)
(defcustom lsp-pyright-auto-import-completions t
"Determines whether pyright offers auto-import completions."
:type 'boolean
:group 'lsp-pyright)
(defcustom lsp-pyright-stub-path ""
"Path to directory containing custom type stub files."
:type 'directory
:group 'lsp-pyright)
(defcustom lsp-pyright-venv-path nil
"Path to folder with subdirectories that contain virtual environments.
Virtual Envs specified in pyrightconfig.json will be looked up in this path."
:type '(choice (const :tag "None" nil) file)
:group 'lsp-pyright)
(defcustom lsp-pyright-venv-directory nil
"Folder with subdirectories that contain virtual environments.
Virtual Envs specified in pyrightconfig.json will be looked up in this path."
:type '(choice (const :tag "None" nil) directory)
:group 'lsp-pyright)
(defcustom lsp-pyright-typeshed-paths []
"Paths to look for typeshed modules.
Pyright currently honors only the first path in the array."
:type 'lsp-string-vector
:group 'lsp-pyright)
(defcustom lsp-pyright-multi-root t
"If non nil, lsp-pyright will be started in multi-root mode."
:type 'boolean
:group 'lsp-pyright)
(defcustom lsp-pyright-python-executable-cmd "python"
"Command to specify the Python command for pyright.
Similar to the `python-shell-interpreter', but used only with mspyls.
Useful when there are multiple python versions in system.
e.g, there are `python2' and `python3', both in system PATH,
and the default `python' links to python2,
set as `python3' to let ms-pyls use python 3 environments."
:type 'string
:group 'lsp-pyright)
(defcustom lsp-pyright-prefer-remote-env t
"If non nil, lsp-pyright will perfer remote python environment.
Only available in Emacs 27 and above."
:type 'boolean
:group 'lsp-pyright)
(defun lsp-pyright-locate-venv ()
"Look for virtual environments local to the workspace."
(or lsp-pyright-venv-path
(and lsp-pyright-venv-directory
(-when-let (venv-base-directory (locate-dominating-file default-directory lsp-pyright-venv-directory))
(concat venv-base-directory lsp-pyright-venv-directory)))
(-when-let (venv-base-directory (locate-dominating-file default-directory "venv/"))
(concat venv-base-directory "venv"))
(-when-let (venv-base-directory (locate-dominating-file default-directory ".venv/"))
(concat venv-base-directory ".venv"))))
(defun lsp-pyright-locate-python ()
"Look for python executable cmd to the workspace."
(or (executable-find (f-expand "bin/python" (lsp-pyright-locate-venv)))
(with-no-warnings
(if (>= emacs-major-version 27)
(executable-find lsp-pyright-python-executable-cmd lsp-pyright-prefer-remote-env)
(executable-find lsp-pyright-python-executable-cmd)))))
(defun lsp-pyright--begin-progress-callback (workspace &rest _)
"Log begin progress information.
Current LSP WORKSPACE should be passed in."
(when lsp-progress-via-spinner
(with-lsp-workspace workspace
(--each (lsp--workspace-buffers workspace)
(when (buffer-live-p it)
(with-current-buffer it
(lsp--spinner-start)))))
)
(lsp-log "Pyright language server is analyzing..."))
(defun lsp-pyright--report-progress-callback (_workspace params)
"Log report progress information.
First element of PARAMS will be passed into `lsp-log'."
(when (and (arrayp params) (> (length params) 0))
(lsp-log (aref params 0))))
(defun lsp-pyright--end-progress-callback (workspace &rest _)
"Log end progress information.
Current LSP WORKSPACE should be passed in."
(when lsp-progress-via-spinner
(with-lsp-workspace workspace
(--each (lsp--workspace-buffers workspace)
(when (buffer-live-p it)
(with-current-buffer it
(lsp--spinner-stop)))))
)
(lsp-log "Pyright language server is analyzing...done"))
(lsp-register-custom-settings
`(("pyright.disableLanguageServices" lsp-pyright-disable-language-services t)
("pyright.disableOrganizeImports" lsp-pyright-disable-organize-imports t)
("python.analysis.autoImportCompletions" lsp-pyright-auto-import-completions t)
("python.analysis.typeshedPaths" lsp-pyright-typeshed-paths)
("python.analysis.stubPath" lsp-pyright-stub-path)
("python.analysis.useLibraryCodeForTypes" lsp-pyright-use-library-code-for-types t)
("python.analysis.diagnosticMode" lsp-pyright-diagnostic-mode)
("python.analysis.typeCheckingMode" lsp-pyright-typechecking-mode)
("python.analysis.logLevel" lsp-pyright-log-level)
("python.analysis.autoSearchPaths" lsp-pyright-auto-search-paths t)
("python.analysis.extraPaths" lsp-pyright-extra-paths)
("python.pythonPath" lsp-pyright-locate-python)
;; We need to send empty string, otherwise pyright-langserver fails with parse error
("python.venvPath" (lambda () (or lsp-pyright-venv-path "")))))
(lsp-dependency 'pyright
'(:system "pyright-langserver")
'(:npm :package "pyright"
:path "pyright-langserver"))
(lsp-register-client
(make-lsp-client
:new-connection (lsp-stdio-connection (lambda ()
(cons (lsp-package-path 'pyright)
lsp-pyright-langserver-command-args)))
:major-modes '(python-mode)
:server-id 'pyright
:multi-root lsp-pyright-multi-root
:priority 3
:initialized-fn (lambda (workspace)
(with-lsp-workspace workspace
;; we send empty settings initially, LSP server will ask for the
;; configuration of each workspace folder later separately
(lsp--set-configuration
(make-hash-table :test 'equal))))
:download-server-fn (lambda (_client callback error-callback _update?)
(lsp-package-ensure 'pyright callback error-callback))
:notification-handlers (lsp-ht ("pyright/beginProgress" 'lsp-pyright--begin-progress-callback)
("pyright/reportProgress" 'lsp-pyright--report-progress-callback)
("pyright/endProgress" 'lsp-pyright--end-progress-callback))))
(provide 'lsp-pyright)
;;; lsp-pyright.el ends here
|
