From: Jules Tamagnan <jtamagnan@gmail.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 23609@debbugs.gnu.org, dgutov@yandex.ru
Subject: bug#23609: 25.0.92; Python eldoc freeze
Date: Tue, 31 May 2016 13:35:27 -0400 [thread overview]
Message-ID: <86shwyqgf4.fsf@gmail.com> (raw)
In-Reply-To: <838tyuzkhp.fsf@gnu.org> (Eli Zaretskii's message of "Sat, 28 May 2016 10:53:38 +0300")
Eli Zaretskii <eliz@gnu.org> writes:
> Thanks. We should try making the message text shorter, so it fits on
> a single line.
>
>> We could also perhaps make it such that if the timeout variable were
>> negative then instead of permanently stopping eldoc it would only
>> return, like you had suggested. A boolean defcustom could also be
>> used for that if we want.
>
> I don't see any significant advantage either way.
>
>> Also 'python-eldoc--get-doc' could be renamed to not be private if we
>> expect somebody to want to change it
>
> Yes, that variable should not be private if users are expected to set
> it. Alternatively, we could add a simple command to set the variable
> non-nil, which might also help making the message text shorter.
I've improved the documentation, added the boolean to make the timeout
permanent and shortened the messages
index 5aeefe4..d555e21 100644
--- a/lisp/progmodes/python.el
+++ b/lisp/progmodes/python.el
@@ -4293,12 +4293,45 @@ python-eldoc--get-doc-at-point
(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)
+
+(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)
+
(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 current 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'.
next prev parent reply other threads:[~2016-05-31 17:35 UTC|newest]
Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-05-24 15:34 bug#23609: 25.0.92; Python eldoc freeze Jules Tamagnan
2016-05-25 6:11 ` Andreas Röhler
2016-05-25 15:18 ` Jules Tamagnan
2016-05-25 15:33 ` Andreas Röhler
2016-05-26 15:52 ` Jules Tamagnan
2016-05-26 16:31 ` Eli Zaretskii
2016-05-26 16:37 ` Dmitry Gutov
2016-05-26 16:48 ` Eli Zaretskii
2016-05-26 17:13 ` Jules Tamagnan
2016-05-27 9:23 ` Eli Zaretskii
2016-05-27 14:41 ` Eli Zaretskii
2016-05-27 14:52 ` Jules Tamagnan
2016-05-27 19:06 ` Eli Zaretskii
2016-05-27 15:42 ` Glenn Morris
2016-05-27 18:41 ` Eli Zaretskii
2016-05-27 16:12 ` Jules Tamagnan
2016-05-27 16:18 ` Dmitry Gutov
2016-05-27 17:12 ` Jules Tamagnan
2016-05-27 18:26 ` Dmitry Gutov
2016-05-27 18:39 ` Jules Tamagnan
2016-05-27 18:50 ` Dmitry Gutov
2016-05-27 18:57 ` Jules Tamagnan
2016-05-27 19:05 ` Eli Zaretskii
2016-05-27 19:13 ` Jules Tamagnan
2016-05-27 19:30 ` Eli Zaretskii
2016-05-27 19:43 ` Jules Tamagnan
2016-05-27 19:49 ` Eli Zaretskii
2016-05-27 20:19 ` Jules Tamagnan
2016-05-28 7:53 ` Eli Zaretskii
2016-05-31 17:35 ` Jules Tamagnan [this message]
2016-06-06 14:08 ` Jules Tamagnan
2016-06-06 15:15 ` Eli Zaretskii
2016-06-10 9:10 ` Eli Zaretskii
2016-05-27 6:09 ` Andreas Röhler
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=86shwyqgf4.fsf@gmail.com \
--to=jtamagnan@gmail.com \
--cc=23609@debbugs.gnu.org \
--cc=dgutov@yandex.ru \
--cc=eliz@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.