-
Notifications
You must be signed in to change notification settings - Fork 260
/
elpy-rpc.el
1193 lines (1059 loc) · 47.8 KB
/
elpy-rpc.el
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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; elpy-rpc.el --- RPC protocol for elpy -*- lexical-binding: t -*-
;;
;; Copyright (C) 2012-2019 Jorgen Schaefer
;;
;; Author: Jorgen Schaefer <contact@jorgenschaefer.de>, Rainer Gemulla <rgemulla@gmx.de>, Gaby Launay <gaby.launay@protonmail.com>
;; URL: https://github.com/jorgenschaefer/elpy
;;
;; This program 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
;; of the License, 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.
;;
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;
;;; Commentary:
;;
;; elpy-rpc is a simple JSON-based RPC protocol. It's mostly JSON-RPC
;; 1.0, except we do not implement the full protocol as we do not need
;; all the features. Emacs starts a Python subprocess which runs a
;; special module. The module reads JSON-RPC requests and responds
;; with JSON-RPC responses.
;;
;;; Code:
(require 'json)
(require 'pyvenv)
(defcustom elpy-rpc-maximum-buffer-age (* 5 60)
"Seconds after which Elpy automatically closes an unused RPC buffer.
Elpy creates RPC buffers over time, depending on python interpreters
and the project root. When there are many projects being worked on,
these can accumulate. Setting this variable to an integer will close
buffers and processes when they have not been used for this amount of
seconds.
Setting this variable to nil will disable the behavior."
:type '(choice (const :tag "Never" nil)
integer)
:group 'elpy)
(defcustom elpy-rpc-large-buffer-size 4096
"Size for a source buffer up to which it will be sent directly.
The Elpy RPC protocol uses JSON as the serialization format.
Large buffers take a long time to encode, so Elpy can transmit
them via temporary files. If a buffer is larger than this value,
it is sent via a temporary file."
:type 'integer
:safe #'integerp
:group 'elpy)
(defcustom elpy-rpc-ignored-buffer-size 102400
"Size for a source buffer over which Elpy completion will not work.
To provide completion, Elpy's backends have to parse the whole
file every time. For very large files, this is slow, and can make
Emacs laggy. Elpy will simply not work on buffers larger than
this to prevent this from happening."
:type 'integer
:safe #'integerp
:group 'elpy)
(defcustom elpy-rpc-python-command (if (equal system-type 'windows-nt)
(or (executable-find "py")
(executable-find "pythonw")
"python")
(if (executable-find "python")
"python"
;; Fallback on systems where python is not
;; symlinked to python3.
"python3"))
"The Python interpreter for the RPC backend.
This should NOT be an interactive shell like ipython or jupyter.
As the RPC should be independent of any virtual environment, Elpy
will try to use the system interpreter if it exists. If you wish
to use a specific python interpreter (from a virtual environment
for example), set this to the full interpreter path."
:type '(choice (const :tag "python" "python")
(const :tag "python2" "python2")
(const :tag "python3" "python3")
(const :tag "pythonw (Python on Windows)" "pythonw")
(const :tag "py (other Python on Windows)" "py")
(string :tag "Other"))
:safe (lambda (val)
(member val '("python" "python2" "python3" "pythonw")))
;; Make sure there is no obsolete rpc running
:set (lambda (var val) ;
(set-default var val)
(when (and (fboundp 'elpy-rpc-restart)
(not (autoloadp #'elpy-rpc-restart)))
(elpy-rpc-restart)))
:group 'elpy)
(defcustom elpy-rpc-pythonpath (file-name-directory load-file-name)
"A directory to add to the PYTHONPATH for the RPC process.
This should be a directory where the elpy module can be found. If
this is nil, it's assumed elpy can be found in the standard path.
Usually, there is no need to change this."
:type 'directory
:safe #'file-directory-p
:group 'elpy)
(defcustom elpy-rpc-timeout 1
"Number of seconds to wait for a response when blocking.
When Elpy blocks Emacs to wait for a response from the RPC
process, it will assume it won't come or wait too long after this
many seconds. On a slow computer, or if you have a large project,
you might want to increase this.
A setting of nil means to block indefinitely."
:type '(choice (const :tag "Block indefinitely" nil)
integer)
:safe (lambda (val)
(or (integerp val)
(null val)))
:group 'elpy)
(defcustom elpy-rpc-error-timeout 30
"Minimum number of seconds between error popups.
When Elpy encounters an error in the backend, it will display a
lengthy description of the problem for a bug report. This hangs
Emacs for a moment, and can be rather annoying if it happens
repeatedly while editing a source file.
If this variabl is non-nil, Elpy will not display the error
message again within this amount of seconds."
:type 'integer
:group 'elpy)
(defvar elpy-rpc--call-id 0
"Call id of the last call to `elpy-rpc`.
Used to associate responses to callbacks.")
(make-variable-buffer-local 'elpy-rpc--call-id)
(defvar elpy-rpc--buffer-p nil
"Non-nil if the current buffer is an elpy-rpc buffer.")
(make-variable-buffer-local 'elpy-rpc--buffer-p)
(defvar elpy-rpc--buffer nil
"The elpy-rpc buffer associated with this buffer.")
(make-variable-buffer-local 'elpy-rpc--buffer)
(defvar elpy-rpc--backend-library-root nil
"The project root used by this backend.")
(make-variable-buffer-local 'elpy-rpc--backend-library-root)
(defvar elpy-rpc--backend-python-command nil
"The Python interpreter used by this backend.")
(make-variable-buffer-local 'elpy-rpc--backend-python-command)
(defvar elpy-rpc--backend-callbacks nil
"The callbacks registered for calls to the current backend.
This maps call IDs to functions.")
(make-variable-buffer-local 'elpy-rpc--backend-callbacks)
(defvar elpy-rpc--last-call nil
"The time of the last RPC call issued for this backend.")
(make-variable-buffer-local 'elpy-rpc--last-call)
(defvar elpy-rpc--last-error-popup nil
"The last time an error popup happened.")
(defvar elpy-rpc--jedi-available nil
"Whether jedi is available or not.")
;;;;;;;;;;;;;;;;;;;
;;; RPC virualenv
(defcustom elpy-rpc-virtualenv-path 'default
"Path to the virtualenv used by the RPC.
Can be `default' (create a dedicated virtualenv in
\".emacs.d/elpy\"), `system' (use the system environment),
`current' (use the currently active environment), a virtualenv
path or a function returning a virtualenv path.
If the default virtual environment does not exist, it will be
created using `elpy-rpc-python-command' and populated with the
needed packages from `elpy-rpc--get-package-list'."
:type '(choice (const :tag "Dedicated environment" default)
(const :tag "Global environment" system)
(const :tag "Current environment" current)
(string :tag "Virtualenv path")
(function :tag "Function returning the virtualenv path"))
:group 'elpy)
(defun elpy-rpc-default-virtualenv-path ()
"Return the default virtualenv path."
(expand-file-name (locate-user-emacs-file "elpy/rpc-venv")))
(defun elpy-rpc-get-virtualenv-path ()
"Return the RPC virutalenv path to use."
(cond
((eq elpy-rpc-virtualenv-path 'default)
(elpy-rpc-default-virtualenv-path))
((or (eq elpy-rpc-virtualenv-path 'system)
(eq elpy-rpc-virtualenv-path 'global)) ;; for backward compatibility
(let ((exec-path (reverse exec-path)))
(directory-file-name
(file-name-directory
(directory-file-name
(file-name-directory
(executable-find elpy-rpc-python-command)))))))
((eq elpy-rpc-virtualenv-path 'current)
(directory-file-name
(file-name-directory
(directory-file-name
(file-name-directory
(executable-find elpy-rpc-python-command))))))
((stringp elpy-rpc-virtualenv-path)
(expand-file-name elpy-rpc-virtualenv-path))
((functionp elpy-rpc-virtualenv-path)
(expand-file-name (funcall elpy-rpc-virtualenv-path)))
(t
(error "Invalid value for `elpy-rpc-virtualenv-path', please set it to a proper value using customize"))))
(defun elpy-rpc--get-package-list ()
"Return the list of packages to be installed in the RPC virtualenv."
(let ((rpc-python-version (elpy-rpc--get-python-version)))
(if (version< rpc-python-version "3.6.0")
'("jedi" "flake8" "autopep8" "yapf")
'("jedi" "flake8" "autopep8" "yapf" "black"))))
(defun elpy-rpc--get-python-version ()
"Return the RPC python version."
(with-temp-buffer
(call-process elpy-rpc-python-command nil t nil "--version")
(goto-char (point-min))
(re-search-forward "Python \\([0-9.]+\\)")
(match-string 1)))
(defmacro with-elpy-rpc-virtualenv-activated (&rest body)
"Run BODY with Elpy's RPC virtualenv activated.
During the execution of BODY the following variables are available:
- `current-environment': current environment path.
- `current-environment-binaries': current environment python binaries path.
- `current-environment-is-deactivated': non-nil if the current
environment has been deactivated (it is not if the RPC environment and
the current environment are the same)."
`(if (not (executable-find elpy-rpc-python-command))
(error "Cannot find executable '%s', please set 'elpy-rpc-python-command' to an existing executable." elpy-rpc-python-command)
(let* ((pyvenv-post-activate-hooks (remq 'elpy-rpc--disconnect
pyvenv-post-activate-hooks))
(pyvenv-post-deactivate-hooks (remq 'elpy-rpc--disconnect
pyvenv-post-deactivate-hooks))
(venv-was-activated pyvenv-virtual-env)
(current-environment-binaries (executable-find
elpy-rpc-python-command))
(current-environment (directory-file-name (file-name-directory (directory-file-name (file-name-directory current-environment-binaries)))))
;; No need to change of venv if they are the same
(same-venv (or (string= current-environment
(elpy-rpc-get-virtualenv-path))
(file-equal-p current-environment
(elpy-rpc-get-virtualenv-path))))
current-environment-is-deactivated)
;; If different than the current one, try to activate the RPC virtualenv
(unless same-venv
(condition-case err
(pyvenv-activate (elpy-rpc-get-or-create-virtualenv))
((error quit) (if venv-was-activated
(pyvenv-activate venv-was-activated)
(pyvenv-deactivate))))
(setq current-environment-is-deactivated t))
(let (venv-err result)
;; Run BODY and catch errors and quit to avoid keeping the RPC
;; virtualenv activated
(condition-case err
(setq result (progn ,@body))
(error (setq venv-err
(if (stringp err)
err
(car (cdr err)))))
(quit nil))
;; Reactivate the previous environment if necessary
(unless same-venv
(if venv-was-activated
(pyvenv-activate venv-was-activated)
(pyvenv-deactivate)))
;; Raise errors that could have happened in BODY
(when venv-err
(error venv-err))
result))))
(defun elpy-rpc-get-or-create-virtualenv ()
"Return Elpy's RPC virtualenv.
Create the virtualenv if it does not exist yet.
Update the virtualenv if the variable `elpy-rpc-python-command' has
changed since the virtualenv creation.
An additional file `elpy-rpc-python-path-command' is added in the
virtualenv directory in order to keep track of the python
binaries used to create the virtualenv."
(let* ((rpc-venv-path (elpy-rpc-get-virtualenv-path))
(is-venv-exist (file-exists-p rpc-venv-path))
(is-default-rpc-venv
(and rpc-venv-path
(string= rpc-venv-path
(elpy-rpc-default-virtualenv-path))))
(venv-python-path-command-file
(concat (file-name-as-directory rpc-venv-path)
"elpy-rpc-python-path-command"))
(venv-python-path-command
(when (file-exists-p venv-python-path-command-file)
(with-temp-buffer
(insert-file-contents venv-python-path-command-file)
(buffer-string))))
(venv-need-update
(and is-venv-exist
is-default-rpc-venv
(not (string= venv-python-path-command
elpy-rpc-python-command))))
(venv-creation-allowed
(and (or (not is-venv-exist) venv-need-update)
(or is-default-rpc-venv
(y-or-n-p
(format "`elpy-rpc-virtualenv-path' was set to '%s', but this virtualenv does not exist, create it ? " rpc-venv-path))))))
;; Delete the rpc virtualenv if obsolete
(when venv-need-update
(delete-directory rpc-venv-path t)
(setq is-venv-exist nil))
;; Create a new rpc venv if necessary
(unless is-venv-exist
(if (not venv-creation-allowed)
(message "Please indicate the virtualenv you wish to use with `elpy-rpc-virtualenv-path'.")
(let ((deact-venv pyvenv-virtual-env))
(message "Elpy is %s the RPC virtualenv ('%s')"
(if venv-need-update "updating" "creating")
rpc-venv-path)
(elpy-rpc--create-virtualenv rpc-venv-path)
;; Make sure the rpc venv is deacivated on quit
(condition-case nil
(progn
(pyvenv-activate rpc-venv-path)
;; Add file to keep track of the `elpy-rpc-python-command` used
(with-temp-file venv-python-path-command-file
(insert elpy-rpc-python-command))
;; safeguard to be sure we don't install stuff in the wrong venv
(when (file-equal-p pyvenv-virtual-env rpc-venv-path)
(elpy-rpc--install-dependencies))
(elpy-rpc-restart))
(quit nil))
;; Deactivate the rpc venv
(if deact-venv
(pyvenv-activate (directory-file-name deact-venv))
(pyvenv-deactivate))
(message "Done"))))
rpc-venv-path))
(defun elpy-rpc--create-virtualenv (rpc-venv-path)
"Create a virtualenv for the RPC in RPC-VENV-PATH."
;; venv cannot create a proper virtualenv from inside another virtualenv
(let* ((elpy-rpc-virtualenv-path 'system)
success
(elpy-venv-buffname-visible "*elpy-virtualenv*")
(elpy-venv-buffname (concat " " elpy-venv-buffname-visible)))
(when (get-buffer elpy-venv-buffname)
(kill-buffer elpy-venv-buffname))
(when (get-buffer elpy-venv-buffname-visible)
(kill-buffer elpy-venv-buffname-visible))
(with-elpy-rpc-virtualenv-activated
(cond
((and (= 0 (call-process elpy-rpc-python-command nil nil nil
"-m" "venv" "-h"))
;; see https://github.com/jorgenschaefer/elpy/issues/1756
(= 0 (call-process elpy-rpc-python-command nil nil nil
"-m" "ensurepip" "-h")))
(with-current-buffer (get-buffer-create elpy-venv-buffname)
(insert (concat "Running '" elpy-rpc-python-command " -m venv "
rpc-venv-path "':\n\n"))
(setq success (call-process elpy-rpc-python-command nil t t
"-m" "venv" rpc-venv-path))))
((executable-find "virtualenv")
(with-current-buffer (get-buffer-create elpy-venv-buffname)
(insert (concat "Running 'virtualenv -p "
elpy-rpc-python-command " " rpc-venv-path
"':\n\n"))
(setq success (call-process "virtualenv" nil t t "-p"
elpy-rpc-python-command rpc-venv-path))))
(t
(error "Elpy needs the 'virtualenv' or 'venv' python packages to create its virtualenv. Please install one of them or disable the dedicated virtualenv with `(setq elpy-rpc-virtualenv-path 'current)`"))))
;; warn us if something wrong happened
(unless (= 0 success)
(with-current-buffer elpy-venv-buffname
(rename-buffer elpy-venv-buffname-visible)
(goto-char (point-max))
(insert
(concat
"\n\n"
"Elpy failed to install its dedicated virtualenv due to the above\n"
"error. If the error details does not help you fixing it, You can\n"
"report this problem on Elpy repository on github.\n"
"In the meantime, setting the `elpy-rpc-virtualenv-path' option to\n"
"either `system' or `current' should temporarily fix the issue.")))
(error (concat "Elpy failed to create its dedicated virtualenv. "
"Please check the `" elpy-venv-buffname-visible
"' buffer.")))))
(defun elpy-rpc--install-dependencies ()
"Install the RPC dependencies in the current virtualenv."
(if (y-or-n-p "Automatically install the RPC dependencies from PyPI (needed for completion, autoformatting and documentation) ? ")
(with-temp-buffer
(message "Elpy is installing the RPC dependencies...")
(when (/= (apply 'call-process elpy-rpc-python-command
nil t nil
"-m" "pip" "install" "--upgrade"
(elpy-rpc--get-package-list))
0)
(message "Elpy failed to install some of the RPC dependencies, please use `elpy-config' to install them.\n%s" (buffer-string))
))
(message "Some of Elpy's functionnalities will not work, please use `elpy-config' to install the needed python dependencies.")))
(defun elpy-rpc-reinstall-virtualenv ()
"Re-install the RPC virtualenv."
(interactive)
(let ((rpc-venv-path (elpy-rpc-get-virtualenv-path)))
(when
(cond
((or (eq elpy-rpc-virtualenv-path 'system)
(eq elpy-rpc-virtualenv-path 'global)) ;; backward compatibility
(error "Cannot reinstall the system environment, please reinstall the necessary packages manually"))
((string= (elpy-rpc-default-virtualenv-path) rpc-venv-path)
t)
(t
(y-or-n-p (format "Are you sure you want to reinstall the virtualenv in '%s' (every manual modifications will be lost) ? " rpc-venv-path))))
(delete-directory rpc-venv-path t)
(elpy-rpc-get-or-create-virtualenv))))
(defun elpy-rpc--pip-missing ()
"Return t if pip is not installed in the RPC virtualenv."
(let* ((rpc-venv-path (file-name-as-directory
(elpy-rpc-get-virtualenv-path)))
(base-pip-scripts (concat rpc-venv-path
(file-name-as-directory "Scripts")
"pip"))
(base-pip-bin (concat rpc-venv-path
(file-name-as-directory "bin")
"pip")))
(not (or
(file-exists-p base-pip-scripts)
(file-exists-p base-pip-bin)
(file-exists-p (concat base-pip-scripts ".exe"))
(file-exists-p (concat base-pip-bin ".exe"))))))
;;;;;;;;;;;;;;;;;;;
;;; Promise objects
(defvar elpy-promise-marker (make-symbol "*elpy-promise*")
"An uninterned symbol marking an Elpy promise object.")
(defun elpy-promise (success &optional error)
"Return a new promise.
A promise is an object with a success and error callback. If the
promise is resolved using `elpy-promise-resolve', the SUCCESS
callback is called with the given value. The current buffer is
restored, too.
If the promise is rejected using `elpy-promise-reject', the ERROR
callback is called. For this function, the current buffer is not
necessarily restored, as it is also called when the buffer does
not exist anymore."
(vector elpy-promise-marker ; 0 id
success ; 1 success-callback
error ; 2 error-callback
(current-buffer) ; 3 current-buffer
nil ; 4 run
))
(defun elpy-promise-p (obj)
"Return non-nil if OBJ is a promise object."
(and (vectorp obj)
(= (length obj) 5)
(eq (aref obj 0) elpy-promise-marker)))
(defsubst elpy-promise-success-callback (promise)
"Return the success callback for PROMISE."
(aref promise 1))
(defsubst elpy-promise-error-callback (promise)
"Return the error callback for PROMISE."
(aref promise 2))
(defsubst elpy-promise-buffer (promise)
"Return the buffer for PROMISE."
(aref promise 3))
(defsubst elpy-promise-resolved-p (promise)
"Return non-nil if the PROMISE has been resolved or rejected."
(aref promise 4))
(defsubst elpy-promise-set-resolved (promise)
"Mark PROMISE as having been resolved."
(aset promise 4 t))
(defun elpy-promise-resolve (promise value)
"Resolve PROMISE with VALUE."
(unless (elpy-promise-resolved-p promise)
(unwind-protect
(let ((success-callback (elpy-promise-success-callback promise)))
(when success-callback
(condition-case err
(with-current-buffer (elpy-promise-buffer promise)
(funcall success-callback value))
(error
(elpy-promise-reject promise err)))))
(elpy-promise-set-resolved promise))))
(defun elpy-promise-reject (promise reason)
"Reject PROMISE because of REASON."
(unless (elpy-promise-resolved-p promise)
(unwind-protect
(let ((error-callback (elpy-promise-error-callback promise)))
(when error-callback
(if (buffer-live-p (elpy-promise-buffer promise))
(with-current-buffer (elpy-promise-buffer promise)
(funcall error-callback reason))
(with-temp-buffer
(funcall error-callback reason)))))
(elpy-promise-set-resolved promise))))
(defun elpy-promise-wait (promise &optional timeout)
"Wait for PROMISE to be resolved, for up to TIMEOUT seconds.
This will accept process output while waiting.
This will wait for the current Elpy RPC process specifically, as
Emacs currently has a bug where it can wait for the entire time
of the timeout, even if output arrives.
See http://debbugs.gnu.org/cgi/bugreport.cgi?bug=17647"
(let ((end-time (when timeout
(time-add (current-time)
(seconds-to-time timeout))))
(process (get-buffer-process (elpy-rpc--get-rpc-buffer))))
(while (and (not (elpy-promise-resolved-p promise))
(or (not end-time)
(time-less-p (current-time)
end-time)))
(accept-process-output process timeout))))
;;;;;;;;;;;;;;;;;
;;; Elpy RPC
(defun elpy-rpc (method params &optional success error)
"Call METHOD with PARAMS in the backend.
If SUCCESS and optionally ERROR is given, return immediately and
call those when a result is available. Otherwise, wait for a
result and return that."
(unless error
(setq error #'elpy-rpc--default-error-callback))
(if success
(elpy-rpc--call method params success error)
(elpy-rpc--call-blocking method params)))
(defun elpy-rpc--call-blocking (method-name params)
"Call METHOD-NAME with PARAMS in the current RPC backend.
Returns the result, blocking until this arrived."
(let* ((result-arrived nil)
(error-occured nil)
(result-value nil)
(error-object nil)
(promise (elpy-rpc--call method-name params
(lambda (result)
(setq result-value result
result-arrived t))
(lambda (err)
(setq error-object err
error-occured t)))))
(elpy-promise-wait promise elpy-rpc-timeout)
(cond
(error-occured
(elpy-rpc--default-error-callback error-object))
(result-arrived
result-value)
(t
(error "Timeout during RPC call %s from backend"
method-name)))))
(defun elpy-rpc--call (method-name params success error)
"Call METHOD-NAME with PARAMS in the current RPC backend.
When a result is available, SUCCESS will be called with that
value as its sole argument. If an error occurs, ERROR will be
called with the error list.
Returns a PROMISE object."
(let ((promise (elpy-promise success error)))
(with-current-buffer (elpy-rpc--get-rpc-buffer)
(setq elpy-rpc--call-id (1+ elpy-rpc--call-id)
elpy-rpc--last-call (float-time))
(elpy-rpc--register-callback elpy-rpc--call-id promise)
(process-send-string
(get-buffer-process (current-buffer))
(let ((json-encoding-pretty-print nil)) ;; Link to bug https://github.com/jorgenschaefer/elpy/issues/1521
(concat (json-encode `((id . ,elpy-rpc--call-id)
(method . ,method-name)
(params . ,params)))
"\n"))))
promise))
(defun elpy-rpc--register-callback (call-id promise)
"Register for PROMISE to be called when CALL-ID returns.
Must be called in an elpy-rpc buffer."
(unless elpy-rpc--buffer-p
(error "Must be called in RPC buffer"))
(unless elpy-rpc--backend-callbacks
(setq elpy-rpc--backend-callbacks (make-hash-table :test #'equal)))
(puthash call-id promise elpy-rpc--backend-callbacks))
(defun elpy-rpc--get-rpc-buffer ()
"Return the RPC buffer associated with the current buffer,
creating one if necessary."
(unless (elpy-rpc--process-buffer-p elpy-rpc--buffer)
(setq elpy-rpc--buffer
(or (elpy-rpc--find-buffer (elpy-library-root)
elpy-rpc-python-command)
(elpy-rpc--open (elpy-library-root)
elpy-rpc-python-command))))
elpy-rpc--buffer)
(defun elpy-rpc--process-buffer-p (buffer)
"Return non-nil when BUFFER is a live elpy-rpc process buffer.
If BUFFER is a buffer for an elpy-rpc process, but the process
died, this will kill the process and buffer."
(cond
((or (not buffer)
(not (buffer-live-p buffer)))
nil)
((not (buffer-local-value 'elpy-rpc--buffer-p buffer))
nil)
((and (get-buffer-process buffer)
(process-live-p (get-buffer-process buffer)))
t)
(t
(ignore-errors
(kill-process (get-buffer-process buffer)))
(ignore-errors
(kill-buffer buffer))
nil)))
(defun elpy-rpc--find-buffer (library-root python-command)
"Return an existing RPC buffer for this project root and command."
(catch 'return
(let ((full-python-command (executable-find python-command)))
(dolist (buf (buffer-list))
(when (and (elpy-rpc--process-buffer-p buf)
(equal (buffer-local-value 'elpy-rpc--backend-library-root
buf)
library-root)
(equal (buffer-local-value 'elpy-rpc--backend-python-command
buf)
full-python-command))
(throw 'return buf))))
nil))
(defun elpy-rpc--open (library-root python-command)
"Start a new RPC process and return the associated buffer."
(elpy-rpc--cleanup-buffers)
(with-elpy-rpc-virtualenv-activated
(let* ((full-python-command (executable-find python-command))
(name (format " *elpy-rpc [project:%s environment:%s]*"
library-root
current-environment))
(new-elpy-rpc-buffer (generate-new-buffer name))
(proc nil))
(unless full-python-command
(error "Can't find Python command, configure `elpy-rpc-python-command'"))
(with-current-buffer new-elpy-rpc-buffer
(setq elpy-rpc--buffer-p t
elpy-rpc--buffer (current-buffer)
elpy-rpc--backend-library-root library-root
elpy-rpc--backend-python-command full-python-command
default-directory "/"
proc (condition-case err
(let ((process-connection-type nil)
(process-environment (elpy-rpc--environment)))
(start-process name
(current-buffer)
full-python-command
"-W" "ignore"
"-m" "elpy.__main__"))
(error
(elpy-config-error
"Elpy can't start Python (%s: %s)"
(car err) (cadr err)))))
(set-process-query-on-exit-flag proc nil)
(set-process-sentinel proc #'elpy-rpc--sentinel)
(set-process-filter proc #'elpy-rpc--filter)
(elpy-rpc-init library-root
(when current-environment-is-deactivated
current-environment-binaries)
(lambda (result)
(setq elpy-rpc--jedi-available
(cdr (assq 'jedi_available result))))))
new-elpy-rpc-buffer)))
(defun elpy-rpc--cleanup-buffers ()
"Close RPC buffers that have not been used in five minutes."
(when elpy-rpc-maximum-buffer-age
(let ((old (- (float-time)
elpy-rpc-maximum-buffer-age)))
(dolist (buffer (buffer-list))
(when (and (elpy-rpc--process-buffer-p buffer)
(< (or (buffer-local-value 'elpy-rpc--last-call buffer)
old)
old))
(ignore-errors
(kill-process (get-buffer-process buffer)))
(ignore-errors
(kill-buffer buffer)))))))
(defun elpy-rpc--sentinel (process event)
"The sentinel for the RPC process.
As process sentinels are only ever called when the process
terminates, this will call the error handler of all registered
RPC calls with the event."
(let ((buffer (process-buffer process))
(err (list 'process-sentinel (substring event 0 -1))))
(when (and buffer
(buffer-live-p buffer))
(with-current-buffer buffer
(when elpy-rpc--backend-callbacks
(maphash (lambda (_call-id promise)
(ignore-errors
(elpy-promise-reject promise err)))
elpy-rpc--backend-callbacks)
(setq elpy-rpc--backend-callbacks nil))))))
(defun elpy-rpc--filter (process output)
"The filter for the RPC process."
(let ((buffer (process-buffer process)))
(when (and buffer
(buffer-live-p buffer))
(with-current-buffer buffer
(goto-char (point-max))
(insert output)
(while (progn
(goto-char (point-min))
(search-forward "\n" nil t))
(let ((line-end (point))
(json nil)
(did-read-json nil))
(goto-char (point-min))
(condition-case _err
(progn
(setq json (let ((json-array-type 'list)
(json-false nil)
(json-encoding-pretty-print nil)) ;; Link to bug https://github.com/jorgenschaefer/elpy/issues/1521
(json-read)))
(if (listp json)
(setq line-end (1+ (point))
did-read-json t)
(goto-char (point-min))))
(error
(goto-char (point-min))))
(cond
(did-read-json
(delete-region (point-min) line-end)
(elpy-rpc--handle-json json))
((looking-at "elpy-rpc ready\n")
(replace-match "")
(elpy-rpc--check-backend-version "1.1"))
((looking-at "elpy-rpc ready (\\([^ ]*\\))\n")
(let ((rpc-version (match-string 1)))
(replace-match "")
(elpy-rpc--check-backend-version rpc-version)))
((looking-at ".*No module named elpy\n")
(replace-match "")
(elpy-config-error "Elpy module not found"))
(t
(let ((line (buffer-substring (point-min)
line-end)))
(delete-region (point-min) line-end)
(elpy-rpc--handle-unexpected-line line))))))))))
(defmacro elpy-insert--popup (buffer-name &rest body)
"Pop up a help buffer named BUFFER-NAME and execute BODY in it."
(declare (indent 1))
`(with-help-window ,buffer-name
(with-current-buffer standard-output
,@body)))
(defun elpy-rpc--check-backend-version (rpc-version)
"Check that we are using the right version."
(unless (equal rpc-version elpy-version)
(elpy-insert--popup "*Elpy Version Mismatch*"
(elpy-insert--header "Elpy Version Mismatch")
(elpy-insert--para
"You are not using the same version of Elpy in Emacs Lisp "
"compared to Python. This can cause random problems. Please "
"do make sure to use compatible versions.\n\n"
"This often happens because you have an obsolete elpy python "
"package installed on your system/virtualenv. This package "
"shadows the elpy python package shipped with elpy, leading "
"to this mismatch. If it is the case, uninstalling the elpy "
"python package (with pip for example) should resolve the issue.\n")
(insert
"\n"
"Elpy Emacs Lisp version: " elpy-version "\n"
"Elpy Python version....: " rpc-version "\n"))))
(defun elpy-rpc--handle-unexpected-line (line)
"Handle an unexpected line from the backend.
This is usually an error or backtrace."
(let ((buf (get-buffer "*Elpy Output*")))
(unless buf
(elpy-insert--popup "*Elpy Output*"
(elpy-insert--header "Output from Backend")
(elpy-insert--para
"There was some unexpected output from the Elpy backend. "
"This is usually not a problem and should usually not be "
"reported as a bug with Elpy. You can safely hide this "
"buffer and ignore it. You can also see the output below "
"in case there is an actual problem.\n\n")
(elpy-insert--header "Output")
(setq buf (current-buffer))))
(with-current-buffer buf
(goto-char (point-max))
(let ((inhibit-read-only t))
(insert line)))))
(defun elpy-rpc--handle-json (json)
"Handle a single JSON object from the RPC backend."
(let ((call-id (cdr (assq 'id json)))
(error-object (cdr (assq 'error json)))
(result (cdr (assq 'result json))))
(let ((promise (gethash call-id elpy-rpc--backend-callbacks)))
(unless promise
(error "Received a response for unknown call-id %s" call-id))
(remhash call-id elpy-rpc--backend-callbacks)
(if error-object
(elpy-promise-reject promise error-object)
(elpy-promise-resolve promise result)))))
(defun elpy-rpc--default-error-callback (error-object)
"Display an error from the RPC backend."
;; We actually might get an (error "foo") thing here.
(if (and (consp error-object)
(not (consp (car error-object))))
(signal (car error-object) (cdr error-object))
(let ((message (cdr (assq 'message error-object)))
(code (cdr (assq 'code error-object)))
(data (cdr (assq 'data error-object))))
(cond
((not (numberp code))
(error "Bad response from RPC: %S" error-object))
((< code 300)
(message "Elpy warning: %s" message))
((< code 500)
(error "Elpy error: %s" message))
((and elpy-rpc-error-timeout
elpy-rpc--last-error-popup
(<= (float-time)
(+ elpy-rpc--last-error-popup
elpy-rpc-error-timeout)))
(message "Elpy error popup ignored, see `elpy-rpc-error-timeout': %s"
message))
((not elpy-disable-backend-error-display)
(let ((config (elpy-config--get-config)))
(elpy-insert--popup "*Elpy Error*"
(elpy-insert--header "Elpy Error")
(elpy-insert--para
"The backend encountered an unexpected error. This indicates "
"a bug in Elpy. Please open a bug report with the data below "
"in the Elpy bug tracker:")
(insert "\n"
"\n")
(insert-button
"https://github.com/jorgenschaefer/elpy/issues/new"
'action (lambda (button)
(browse-url (button-get button 'url)))
'url "https://github.com/jorgenschaefer/elpy/issues/new")
(insert "\n"
"\n"
"```\n")
(elpy-insert--header "Error Message")
(insert message "\n\n")
(elpy-insert--header "Configuration")
(elpy-config--insert-configuration-table config)
(let ((traceback (cdr (assq 'traceback data))))
(when traceback
(insert "\n")
(elpy-insert--header "Traceback")
(insert traceback)))
(let ((jedi-info (cdr (assq 'jedi_debug_info data))))
(when jedi-info
(insert "\n")
(elpy-insert--header "Jedi Debug Information")
(pcase (cdr (assq 'debug_info jedi-info))
(`nil (insert "Jedi did not emit any debug info.\n"))
(infos
(dolist (outstr infos)
(insert outstr "\n"))))
(insert "\n"
"```\n"
"\n"
"Reproduction:\n"
"\n")
(let ((method (cdr (assq 'method jedi-info)))
(source (cdr (assq 'source jedi-info)))
(script-args (cdr (assq 'script_args jedi-info))))
(insert "```Python\n")
(insert "import jedi\n"
"\n"
"source = '''\\\n"
source
"'''\n"
"\n"
"script = jedi.Script(" script-args ")\n"
"script." method "()\n"))))
(unless (= 0 (current-column))
(insert "\n"))
(insert "```"))
(setq elpy-rpc--last-error-popup (float-time))))))))
(defun elpy-rpc--environment ()
"Return a `process-environment' for the RPC process.
This includes `elpy-rpc-pythonpath' in the PYTHONPATH, if set."
(if (or (not elpy-rpc-pythonpath)
(not (file-exists-p (expand-file-name "elpy/__init__.py"
elpy-rpc-pythonpath))))
process-environment
(let* ((old-pythonpath (getenv "PYTHONPATH"))
(new-pythonpath (if old-pythonpath
(concat elpy-rpc-pythonpath
path-separator
old-pythonpath)
elpy-rpc-pythonpath)))
(cons (concat "PYTHONPATH=" new-pythonpath)
(append process-environment
(when (and (string-equal system-type "windows-nt")
(>= (string-match-p
(regexp-quote "utf-8")
(format "%s" buffer-file-coding-system))) 0)
(list
"PYTHONIOENCODING=utf-8"
"PYTHONLEGACYWINDOWSSTDIO=1")))))))
(defun elpy-rpc--buffer-contents ()
"Return the contents of the current buffer.
This returns either a string, or a file object for the RPC
protocol if the buffer is larger than
`elpy-rpc-large-buffer-size'."
(if (< (buffer-size) elpy-rpc-large-buffer-size)
(buffer-string)
(let ((file-name (make-temp-file "elpy-rpc-"))
(coding-system-for-write 'utf-8))
(write-region nil nil file-name nil :nomessage)
`((filename . ,file-name)
(delete_after_use . t)))))
(defun elpy-rpc--region-contents ()
"Return the selected region as a string."
(if (use-region-p)
(buffer-substring (region-beginning) (region-end))))
(defun elpy-rpc--disconnect ()
"Disconnect rpc process from elpy buffers."
(dolist (buf (buffer-list))
(with-current-buffer buf
(when elpy-mode
(setq elpy-rpc--buffer nil)))))
;; RPC API functions
(defun elpy-rpc-restart ()
"Restart all RPC processes."
(interactive)
(dolist (buffer (buffer-list))
(when (elpy-rpc--process-buffer-p buffer)
(ignore-errors
(kill-process (get-buffer-process buffer)))
(ignore-errors
(kill-buffer buffer)))))