procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix eldoc-related freezes in python mode

Browse source 
* lisp/progmodes/python.el (python-eldoc-get-doc): New defvar.
(python-eldoc-function-timeout)
(python-eldoc-function-timeout-permanent): New defcustoms.
(python-eldoc-function): If python-eldoc--get-doc-at-point times
out, effectively turn off ElDoc in current buffer.  (Bug#23609)
This commit is contained in:
Jules Tamagnan 2016-06-10 12:08:29 +03:00 • committed by Eli Zaretskii
parent d59bcbc00b
commit 66d556b518
1 changed files with 37 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
lisp/progmodes/python.el
View file

@ -4292,12 +4292,47 @@ returns will be used. If not FORCE-PROCESS is passed what
(unless (zerop (length docstring))
docstring)))))
(defvar-local python-eldoc-get-doc t
"Non-nil means eldoc should fetch the documentation
automatically. Set to nil by `python-eldoc-function' if
`python-eldoc-function-timeout-permanent' is non-nil and
`python-eldoc-function' times out.")
(defcustom python-eldoc-function-timeout 1
"Timeout for `python-eldoc-function' in seconds."
:group 'python
:type 'integer
:version "25.1")
(defcustom python-eldoc-function-timeout-permanent t
"Non-nil means that when `python-eldoc-function' times out
`python-eldoc-get-doc' will be set to nil"
:group 'python
:type 'boolean
:version "25.1")
(defun python-eldoc-function ()
"`eldoc-documentation-function' for Python.
For this to work as best as possible you should call
`python-shell-send-buffer' from time to time so context in
inferior Python process is updated properly."
(python-eldoc--get-doc-at-point))
inferior Python process is updated properly.
If `python-eldoc-function-timeout' seconds elapse before this
function returns then if
`python-eldoc-function-timeout-permanent' is non-nil
`python-eldoc-get-doc' will be set to nil and eldoc will no
longer return the documentation at the point automatically.
Set `python-eldoc-get-doc' to t to reenable eldoc documentation
fetching"
(when python-eldoc-get-doc
(with-timeout (python-eldoc-function-timeout
(if python-eldoc-function-timeout-permanent
(progn
(message "Eldoc echo-area display muted in this buffer, see `python-eldoc-function'")
(setq python-eldoc-get-doc nil))
(message "`python-eldoc-function' timed out, see `python-eldoc-function-timeout'")))
(python-eldoc--get-doc-at-point))))
(defun python-eldoc-at-point (symbol)
"Get help on SYMBOL using `help'.