1 ;;; python.el --- Python's flying circus support for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 2003-2015 Free Software Foundation, Inc.
5 ;; Author: Fabián E. Gallina <fgallina@gnu.org>
6 ;; URL: https://github.com/fgallina/python.el
8 ;; Package-Requires: ((emacs "24.1") (cl-lib "1.0"))
9 ;; Maintainer: emacs-devel@gnu.org
11 ;; Keywords: languages
13 ;; This file is part of GNU Emacs.
15 ;; GNU Emacs is free software: you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published
17 ;; by the Free Software Foundation, either version 3 of the License,
18 ;; or (at your option) any later version.
20 ;; GNU Emacs is distributed in the hope that it will be useful, but
21 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23 ;; General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
30 ;; Major mode for editing Python files with some fontification and
31 ;; indentation bits extracted from original Dave Love's python.el
32 ;; found in GNU/Emacs.
34 ;; Implements Syntax highlighting, Indentation, Movement, Shell
35 ;; interaction, Shell completion, Shell virtualenv support, Shell
36 ;; package support, Shell syntax highlighting, Pdb tracking, Symbol
37 ;; completion, Skeletons, FFAP, Code Check, Eldoc, Imenu.
39 ;; Syntax highlighting: Fontification of code is provided and supports
40 ;; python's triple quoted strings properly.
42 ;; Indentation: Automatic indentation with indentation cycling is
43 ;; provided, it allows you to navigate different available levels of
44 ;; indentation by hitting <tab> several times. Also electric-indent-mode
45 ;; is supported such that when inserting a colon the current line is
46 ;; dedented automatically if needed.
48 ;; Movement: `beginning-of-defun' and `end-of-defun' functions are
49 ;; properly implemented. There are also specialized
50 ;; `forward-sentence' and `backward-sentence' replacements called
51 ;; `python-nav-forward-block', `python-nav-backward-block'
52 ;; respectively which navigate between beginning of blocks of code.
53 ;; Extra functions `python-nav-forward-statement',
54 ;; `python-nav-backward-statement',
55 ;; `python-nav-beginning-of-statement', `python-nav-end-of-statement',
56 ;; `python-nav-beginning-of-block', `python-nav-end-of-block' and
57 ;; `python-nav-if-name-main' are included but no bound to any key. At
58 ;; last but not least the specialized `python-nav-forward-sexp' allows
59 ;; easy navigation between code blocks. If you prefer `cc-mode'-like
60 ;; `forward-sexp' movement, setting `forward-sexp-function' to nil is
61 ;; enough, You can do that using the `python-mode-hook':
63 ;; (add-hook 'python-mode-hook
64 ;; (lambda () (setq forward-sexp-function nil)))
66 ;; Shell interaction: is provided and allows opening Python shells
67 ;; inside Emacs and executing any block of code of your current buffer
68 ;; in that inferior Python process.
70 ;; Besides that only the standard CPython (2.x and 3.x) shell and
71 ;; IPython are officially supported out of the box, the interaction
72 ;; should support any other readline based Python shells as well
73 ;; (e.g. Jython and PyPy have been reported to work). You can change
74 ;; your default interpreter and commandline arguments by setting the
75 ;; `python-shell-interpreter' and `python-shell-interpreter-args'
76 ;; variables. This example enables IPython globally:
78 ;; (setq python-shell-interpreter "ipython"
79 ;; python-shell-interpreter-args "-i")
81 ;; Using the "console" subcommand to start IPython in server-client
82 ;; mode is known to fail intermittently due a bug on IPython itself
83 ;; (see URL `http://debbugs.gnu.org/cgi/bugreport.cgi?bug=18052#27').
84 ;; There seems to be a race condition in the IPython server (A.K.A
85 ;; kernel) when code is sent while it is still initializing, sometimes
86 ;; causing the shell to get stalled. With that said, if an IPython
87 ;; kernel is already running, "console --existing" seems to work fine.
89 ;; Running IPython on Windows needs more tweaking. The way you should
90 ;; set `python-shell-interpreter' and `python-shell-interpreter-args'
91 ;; is as follows (of course you need to modify the paths according to
94 ;; (setq python-shell-interpreter "C:\\Python27\\python.exe"
95 ;; python-shell-interpreter-args
96 ;; "-i C:\\Python27\\Scripts\\ipython-script.py")
98 ;; Missing or delayed output used to happen due to differences between
99 ;; Operating Systems' pipe buffering (e.g. CPython 3.3.4 in Windows 7.
100 ;; See URL `http://debbugs.gnu.org/cgi/bugreport.cgi?bug=17304'). To
101 ;; avoid this, the `python-shell-unbuffered' defaults to non-nil and
102 ;; controls whether `python-shell-calculate-process-environment'
103 ;; should set the "PYTHONUNBUFFERED" environment variable on startup:
104 ;; See URL `https://docs.python.org/3/using/cmdline.html#cmdoption-u'.
106 ;; The interaction relies upon having prompts for input (e.g. ">>> "
107 ;; and "... " in standard Python shell) and output (e.g. "Out[1]: " in
108 ;; IPython) detected properly. Failing that Emacs may hang but, in
109 ;; the case that happens, you can recover with \\[keyboard-quit]. To
110 ;; avoid this issue, a two-step prompt autodetection mechanism is
111 ;; provided: the first step is manual and consists of a collection of
112 ;; regular expressions matching common prompts for Python shells
113 ;; stored in `python-shell-prompt-input-regexps' and
114 ;; `python-shell-prompt-output-regexps', and dir-local friendly vars
115 ;; `python-shell-prompt-regexp', `python-shell-prompt-block-regexp',
116 ;; `python-shell-prompt-output-regexp' which are appended to the
117 ;; former automatically when a shell spawns; the second step is
118 ;; automatic and depends on the `python-shell-prompt-detect' helper
119 ;; function. See its docstring for details on global variables that
120 ;; modify its behavior.
122 ;; Shell completion: hitting tab will try to complete the current
123 ;; word. The two built-in mechanisms depend on Python's readline
124 ;; module: the "native" completion is tried first and is activated
125 ;; when `python-shell-completion-native-enable' is non-nil, the
126 ;; current `python-shell-interpreter' is not a member of the
127 ;; `python-shell-completion-native-disabled-interpreters' variable and
128 ;; `python-shell-completion-native-setup' succeeds; the "fallback" or
129 ;; "legacy" mechanism works by executing Python code in the background
130 ;; and enables auto-completion for shells that do not support
131 ;; receiving escape sequences (with some limitations, i.e. completion
132 ;; in blocks does not work). The code executed for the "fallback"
133 ;; completion can be found in `python-shell-completion-setup-code' and
134 ;; `python-shell-completion-string-code' variables. Their default
135 ;; values enable completion for both CPython and IPython, and probably
136 ;; any readline based shell (it's known to work with PyPy). If your
137 ;; Python installation lacks readline (like CPython for Windows),
138 ;; installing pyreadline (URL `http://ipython.org/pyreadline.html')
139 ;; should suffice. To troubleshoot why you are not getting any
140 ;; completions, you can try the following in your Python shell:
142 ;; >>> import readline, rlcompleter
144 ;; If you see an error, then you need to either install pyreadline or
145 ;; setup custom code that avoids that dependency.
147 ;; Shell virtualenv support: The shell also contains support for
148 ;; virtualenvs and other special environment modifications thanks to
149 ;; `python-shell-process-environment' and `python-shell-exec-path'.
150 ;; These two variables allows you to modify execution paths and
151 ;; environment variables to make easy for you to setup virtualenv rules
152 ;; or behavior modifications when running shells. Here is an example
153 ;; of how to make shell processes to be run using the /path/to/env/
156 ;; (setq python-shell-process-environment
158 ;; (format "PATH=%s" (mapconcat
161 ;; (cons (getenv "PATH")
162 ;; '("/path/to/env/bin/")))
164 ;; "VIRTUAL_ENV=/path/to/env/"))
165 ;; (python-shell-exec-path . ("/path/to/env/bin/"))
167 ;; Since the above is cumbersome and can be programmatically
168 ;; calculated, the variable `python-shell-virtualenv-root' is
169 ;; provided. When this variable is set with the path of the
170 ;; virtualenv to use, `process-environment' and `exec-path' get proper
171 ;; values in order to run shells inside the specified virtualenv. So
172 ;; the following will achieve the same as the previous example:
174 ;; (setq python-shell-virtualenv-root "/path/to/env/")
176 ;; Also the `python-shell-extra-pythonpaths' variable have been
177 ;; introduced as simple way of adding paths to the PYTHONPATH without
178 ;; affecting existing values.
180 ;; Shell package support: you can enable a package in the current
181 ;; shell so that relative imports work properly using the
182 ;; `python-shell-package-enable' command.
184 ;; Shell remote support: remote Python shells are started with the
185 ;; correct environment for files opened remotely through tramp, also
186 ;; respecting dir-local variables provided `enable-remote-dir-locals'
187 ;; is non-nil. The logic for this is transparently handled by the
188 ;; `python-shell-with-environment' macro.
190 ;; Shell syntax highlighting: when enabled current input in shell is
191 ;; highlighted. The variable `python-shell-font-lock-enable' controls
192 ;; activation of this feature globally when shells are started.
193 ;; Activation/deactivation can be also controlled on the fly via the
194 ;; `python-shell-font-lock-toggle' command.
196 ;; Pdb tracking: when you execute a block of code that contains some
197 ;; call to pdb (or ipdb) it will prompt the block of code and will
198 ;; follow the execution of pdb marking the current line with an arrow.
200 ;; Symbol completion: you can complete the symbol at point. It uses
201 ;; the shell completion in background so you should run
202 ;; `python-shell-send-buffer' from time to time to get better results.
204 ;; Skeletons: skeletons are provided for simple inserting of things like class,
205 ;; def, for, import, if, try, and while. These skeletons are
206 ;; integrated with abbrev. If you have `abbrev-mode' activated and
207 ;; `python-skeleton-autoinsert' is set to t, then whenever you type
208 ;; the name of any of those defined and hit SPC, they will be
209 ;; automatically expanded. As an alternative you can use the defined
210 ;; skeleton commands: `python-skeleton-<foo>'.
212 ;; FFAP: You can find the filename for a given module when using ffap
213 ;; out of the box. This feature needs an inferior python shell
216 ;; Code check: Check the current file for errors with `python-check'
217 ;; using the program defined in `python-check-command'.
219 ;; Eldoc: returns documentation for object at point by using the
220 ;; inferior python subprocess to inspect its documentation. As you
221 ;; might guessed you should run `python-shell-send-buffer' from time
222 ;; to time to get better results too.
224 ;; Imenu: There are two index building functions to be used as
225 ;; `imenu-create-index-function': `python-imenu-create-index' (the
226 ;; default one, builds the alist in form of a tree) and
227 ;; `python-imenu-create-flat-index'. See also
228 ;; `python-imenu-format-item-label-function',
229 ;; `python-imenu-format-parent-item-label-function',
230 ;; `python-imenu-format-parent-item-jump-label-function' variables for
231 ;; changing the way labels are formatted in the tree version.
233 ;; If you used python-mode.el you may miss auto-indentation when
234 ;; inserting newlines. To achieve the same behavior you have two
237 ;; 1) Enable the minor-mode `electric-indent-mode' (enabled by
238 ;; default) and use RET. If this mode is disabled use
239 ;; `newline-and-indent', bound to C-j.
241 ;; 2) Add the following hook in your .emacs:
243 ;; (add-hook 'python-mode-hook
245 ;; (define-key python-mode-map "\C-m" 'newline-and-indent)))
247 ;; I'd recommend the first one since you'll get the same behavior for
248 ;; all modes out-of-the-box.
252 ;; Add this to your .emacs:
254 ;; (add-to-list 'load-path "/folder/containing/file")
261 (require 'ansi-color
)
267 ;; Avoid compiler warnings
268 (defvar view-return-to-alist
)
269 (defvar compilation-error-regexp-alist
)
270 (defvar outline-heading-end-regexp
)
272 (autoload 'comint-mode
"comint")
273 (autoload 'help-function-arglist
"help-fns")
276 (add-to-list 'auto-mode-alist
(cons (purecopy "\\.py\\'") 'python-mode
))
278 (add-to-list 'interpreter-mode-alist
(cons (purecopy "python[0-9.]*") 'python-mode
))
281 "Python Language's flying circus support for Emacs."
284 :link
'(emacs-commentary-link "python"))
290 (unless (fboundp 'prog-widen
)
294 (unless (fboundp 'prog-first-column
)
295 (defun prog-first-column ()
301 (defvar python-mode-map
302 (let ((map (make-sparse-keymap)))
304 (define-key map
[remap backward-sentence
] 'python-nav-backward-block
)
305 (define-key map
[remap forward-sentence
] 'python-nav-forward-block
)
306 (define-key map
[remap backward-up-list
] 'python-nav-backward-up-list
)
307 (define-key map
[remap mark-defun
] 'python-mark-defun
)
308 (define-key map
"\C-c\C-j" 'imenu
)
310 (define-key map
"\177" 'python-indent-dedent-line-backspace
)
311 (define-key map
(kbd "<backtab>") 'python-indent-dedent-line
)
312 (define-key map
"\C-c<" 'python-indent-shift-left
)
313 (define-key map
"\C-c>" 'python-indent-shift-right
)
315 (define-key map
"\C-c\C-tc" 'python-skeleton-class
)
316 (define-key map
"\C-c\C-td" 'python-skeleton-def
)
317 (define-key map
"\C-c\C-tf" 'python-skeleton-for
)
318 (define-key map
"\C-c\C-ti" 'python-skeleton-if
)
319 (define-key map
"\C-c\C-tm" 'python-skeleton-import
)
320 (define-key map
"\C-c\C-tt" 'python-skeleton-try
)
321 (define-key map
"\C-c\C-tw" 'python-skeleton-while
)
323 (define-key map
"\C-c\C-p" 'run-python
)
324 (define-key map
"\C-c\C-s" 'python-shell-send-string
)
325 (define-key map
"\C-c\C-r" 'python-shell-send-region
)
326 (define-key map
"\C-\M-x" 'python-shell-send-defun
)
327 (define-key map
"\C-c\C-c" 'python-shell-send-buffer
)
328 (define-key map
"\C-c\C-l" 'python-shell-send-file
)
329 (define-key map
"\C-c\C-z" 'python-shell-switch-to-shell
)
330 ;; Some util commands
331 (define-key map
"\C-c\C-v" 'python-check
)
332 (define-key map
"\C-c\C-f" 'python-eldoc-at-point
)
334 (substitute-key-definition 'complete-symbol
'completion-at-point
336 (easy-menu-define python-menu map
"Python Mode menu"
338 :help
"Python-specific Features"
339 ["Shift region left" python-indent-shift-left
:active mark-active
340 :help
"Shift region left by a single indentation step"]
341 ["Shift region right" python-indent-shift-right
:active mark-active
342 :help
"Shift region right by a single indentation step"]
344 ["Start of def/class" beginning-of-defun
345 :help
"Go to start of outermost definition around point"]
346 ["End of def/class" end-of-defun
347 :help
"Go to end of definition around point"]
348 ["Mark def/class" mark-defun
349 :help
"Mark outermost definition around point"]
350 ["Jump to def/class" imenu
351 :help
"Jump to a class or function definition"]
355 ["Start interpreter" run-python
356 :help
"Run inferior Python process in a separate buffer"]
357 ["Switch to shell" python-shell-switch-to-shell
358 :help
"Switch to running inferior Python process"]
359 ["Eval string" python-shell-send-string
360 :help
"Eval string in inferior Python session"]
361 ["Eval buffer" python-shell-send-buffer
362 :help
"Eval buffer in inferior Python session"]
363 ["Eval region" python-shell-send-region
364 :help
"Eval region in inferior Python session"]
365 ["Eval defun" python-shell-send-defun
366 :help
"Eval defun in inferior Python session"]
367 ["Eval file" python-shell-send-file
368 :help
"Eval file in inferior Python session"]
369 ["Debugger" pdb
:help
"Run pdb under GUD"]
371 ["Check file" python-check
372 :help
"Check file for errors"]
373 ["Help on symbol" python-eldoc-at-point
374 :help
"Get help on symbol at point"]
375 ["Complete symbol" completion-at-point
376 :help
"Complete symbol before point"]))
378 "Keymap for `python-mode'.")
381 ;;; Python specialized rx
384 (defconst python-rx-constituents
385 `((block-start .
,(rx symbol-start
386 (or "def" "class" "if" "elif" "else" "try"
387 "except" "finally" "for" "while" "with")
389 (dedenter .
,(rx symbol-start
390 (or "elif" "else" "except" "finally")
392 (block-ender .
,(rx symbol-start
394 "break" "continue" "pass" "raise" "return")
396 (decorator .
,(rx line-start
(* space
) ?
@ (any letter ?_
)
398 (defun .
,(rx symbol-start
(or "def" "class") symbol-end
))
399 (if-name-main .
,(rx line-start
"if" (+ space
) "__name__"
400 (+ space
) "==" (+ space
)
401 (any ?
' ?
\") "__main__" (any ?
' ?
\")
403 (symbol-name .
,(rx (any letter ?_
) (* (any word ?_
))))
404 (open-paren .
,(rx (or "{" "[" "(")))
405 (close-paren .
,(rx (or "}" "]" ")")))
406 (simple-operator .
,(rx (any ?
+ ?- ?
/ ?
& ?^ ?~ ?| ?
* ?
< ?
> ?
= ?%
)))
407 ;; FIXME: rx should support (not simple-operator).
408 (not-simple-operator .
,(rx
410 (any ?
+ ?- ?
/ ?
& ?^ ?~ ?| ?
* ?
< ?
> ?
= ?%
))))
411 ;; FIXME: Use regexp-opt.
412 (operator .
,(rx (or "+" "-" "/" "&" "^" "~" "|" "*" "<" ">"
413 "=" "%" "**" "//" "<<" ">>" "<=" "!="
414 "==" ">=" "is" "not")))
415 ;; FIXME: Use regexp-opt.
416 (assignment-operator .
,(rx (or "=" "+=" "-=" "*=" "/=" "//=" "%=" "**="
417 ">>=" "<<=" "&=" "^=" "|=")))
418 (string-delimiter .
,(rx (and
419 ;; Match even number of backslashes.
420 (or (not (any ?
\\ ?
\' ?
\")) point
421 ;; Quotes might be preceded by a escaped quote.
422 (and (or (not (any ?
\\)) point
) ?
\\
423 (* ?
\\ ?
\\) (any ?
\' ?
\")))
425 ;; Match single or triple quotes of any kind.
426 (group (or "\"" "\"\"\"" "'" "'''")))))
427 (coding-cookie .
,(rx line-start ?
# (* space
)
429 ;; # coding=<encoding name>
430 (: "coding" (or ?
: ?
=) (* space
) (group-n 1 (+ (or word ?-
))))
431 ;; # -*- coding: <encoding name> -*-
432 (: "-*-" (* space
) "coding:" (* space
)
433 (group-n 1 (+ (or word ?-
))) (* space
) "-*-")
434 ;; # vim: set fileencoding=<encoding name> :
435 (: "vim:" (* space
) "set" (+ space
)
436 "fileencoding" (* space
) ?
= (* space
)
437 (group-n 1 (+ (or word ?-
))) (* space
) ":")))))
438 "Additional Python specific sexps for `python-rx'")
440 (defmacro python-rx
(&rest regexps
)
441 "Python mode specialized rx macro.
442 This variant of `rx' supports common Python named REGEXPS."
443 (let ((rx-constituents (append python-rx-constituents rx-constituents
)))
444 (cond ((null regexps
)
447 (rx-to-string `(and ,@regexps
) t
))
449 (rx-to-string (car regexps
) t
))))))
452 ;;; Font-lock and syntax
455 (defun python-syntax--context-compiler-macro (form type
&optional syntax-ppss
)
458 `(let ((ppss (or ,syntax-ppss
(syntax-ppss))))
459 (and (nth 4 ppss
) (nth 8 ppss
))))
461 `(let ((ppss (or ,syntax-ppss
(syntax-ppss))))
462 (and (nth 3 ppss
) (nth 8 ppss
))))
464 `(nth 1 (or ,syntax-ppss
(syntax-ppss))))
467 (defun python-syntax-context (type &optional syntax-ppss
)
468 "Return non-nil if point is on TYPE using SYNTAX-PPSS.
469 TYPE can be `comment', `string' or `paren'. It returns the start
470 character address of the specified TYPE."
471 (declare (compiler-macro python-syntax--context-compiler-macro
))
472 (let ((ppss (or syntax-ppss
(syntax-ppss))))
474 (`comment
(and (nth 4 ppss
) (nth 8 ppss
)))
475 (`string
(and (nth 3 ppss
) (nth 8 ppss
)))
476 (`paren
(nth 1 ppss
))
479 (defun python-syntax-context-type (&optional syntax-ppss
)
480 "Return the context type using SYNTAX-PPSS.
481 The type returned can be `comment', `string' or `paren'."
482 (let ((ppss (or syntax-ppss
(syntax-ppss))))
484 ((nth 8 ppss
) (if (nth 4 ppss
) 'comment
'string
))
485 ((nth 1 ppss
) 'paren
))))
487 (defsubst python-syntax-comment-or-string-p
(&optional ppss
)
488 "Return non-nil if PPSS is inside 'comment or 'string."
489 (nth 8 (or ppss
(syntax-ppss))))
491 (defsubst python-syntax-closing-paren-p
()
492 "Return non-nil if char after point is a closing paren."
493 (= (syntax-class (syntax-after (point)))
494 (syntax-class (string-to-syntax ")"))))
496 (define-obsolete-function-alias
497 'python-info-ppss-context
#'python-syntax-context
"24.3")
499 (define-obsolete-function-alias
500 'python-info-ppss-context-type
#'python-syntax-context-type
"24.3")
502 (define-obsolete-function-alias
503 'python-info-ppss-comment-or-string-p
504 #'python-syntax-comment-or-string-p
"24.3")
506 (defun python-font-lock-syntactic-face-function (state)
507 "Return syntactic face given STATE."
509 (if (python-info-docstring-p state
)
511 font-lock-string-face
)
512 font-lock-comment-face
))
514 (defvar python-font-lock-keywords
518 "and" "del" "from" "not" "while" "as" "elif" "global" "or" "with"
519 "assert" "else" "if" "pass" "yield" "break" "except" "import" "class"
520 "in" "raise" "continue" "finally" "is" "return" "def" "for" "lambda"
525 ;; False, None, and True are listed as keywords on the Python 3
526 ;; documentation, but since they also qualify as constants they are
527 ;; fontified like that in order to keep font-lock consistent between
534 (,(rx symbol-start
"def" (1+ space
) (group (1+ (or word ?_
))))
535 (1 font-lock-function-name-face
))
537 (,(rx symbol-start
"class" (1+ space
) (group (1+ (or word ?_
))))
538 (1 font-lock-type-face
))
542 "Ellipsis" "False" "None" "NotImplemented" "True" "__debug__"
543 ;; copyright, license, credits, quit and exit are added by the site
544 ;; module and they are not intended to be used in programs
545 "copyright" "credits" "exit" "license" "quit")
546 symbol-end
) . font-lock-constant-face
)
548 (,(rx line-start
(* (any " \t")) (group "@" (1+ (or word ?_
))
549 (0+ "." (1+ (or word ?_
)))))
550 (1 font-lock-type-face
))
551 ;; Builtin Exceptions
554 "ArithmeticError" "AssertionError" "AttributeError" "BaseException"
555 "DeprecationWarning" "EOFError" "EnvironmentError" "Exception"
556 "FloatingPointError" "FutureWarning" "GeneratorExit" "IOError"
557 "ImportError" "ImportWarning" "IndexError" "KeyError"
558 "KeyboardInterrupt" "LookupError" "MemoryError" "NameError"
559 "NotImplementedError" "OSError" "OverflowError"
560 "PendingDeprecationWarning" "ReferenceError" "RuntimeError"
561 "RuntimeWarning" "StopIteration" "SyntaxError" "SyntaxWarning"
562 "SystemError" "SystemExit" "TypeError" "UnboundLocalError"
563 "UnicodeDecodeError" "UnicodeEncodeError" "UnicodeError"
564 "UnicodeTranslateError" "UnicodeWarning" "UserWarning" "VMSError"
565 "ValueError" "Warning" "WindowsError" "ZeroDivisionError"
569 "BufferError" "BytesWarning" "IndentationError" "ResourceWarning"
571 symbol-end
) . font-lock-type-face
)
575 "abs" "all" "any" "bin" "bool" "callable" "chr" "classmethod"
576 "compile" "complex" "delattr" "dict" "dir" "divmod" "enumerate"
577 "eval" "filter" "float" "format" "frozenset" "getattr" "globals"
578 "hasattr" "hash" "help" "hex" "id" "input" "int" "isinstance"
579 "issubclass" "iter" "len" "list" "locals" "map" "max" "memoryview"
580 "min" "next" "object" "oct" "open" "ord" "pow" "print" "property"
581 "range" "repr" "reversed" "round" "set" "setattr" "slice" "sorted"
582 "staticmethod" "str" "sum" "super" "tuple" "type" "vars" "zip"
585 "basestring" "cmp" "execfile" "file" "long" "raw_input" "reduce"
586 "reload" "unichr" "unicode" "xrange" "apply" "buffer" "coerce"
589 "ascii" "bytearray" "bytes" "exec"
591 "__all__" "__doc__" "__name__" "__package__")
592 symbol-end
) . font-lock-builtin-face
)
594 ;; support for a = b = c = 5
596 (let ((re (python-rx (group (+ (any word ?. ?_
)))
597 (? ?\
[ (+ (not (any ?\
]))) ?\
]) (* space
)
598 assignment-operator
))
600 (while (and (setq res
(re-search-forward re limit t
))
601 (or (python-syntax-context 'paren
)
602 (equal (char-after (point)) ?
=))))
604 (1 font-lock-variable-name-face nil nil
))
605 ;; support for a, b, c = (1, 2, 3)
607 (let ((re (python-rx (group (+ (any word ?. ?_
))) (* space
)
608 (* ?
, (* space
) (+ (any word ?. ?_
)) (* space
))
609 ?
, (* space
) (+ (any word ?. ?_
)) (* space
)
610 assignment-operator
))
612 (while (and (setq res
(re-search-forward re limit t
))
613 (goto-char (match-end 1))
614 (python-syntax-context 'paren
)))
616 (1 font-lock-variable-name-face nil nil
))))
618 (defconst python-syntax-propertize-function
619 (syntax-propertize-rules
620 ((python-rx string-delimiter
)
621 (0 (ignore (python-syntax-stringify))))))
623 (defsubst python-syntax-count-quotes
(quote-char &optional point limit
)
624 "Count number of quotes around point (max is 3).
625 QUOTE-CHAR is the quote char to count. Optional argument POINT is
626 the point where scan starts (defaults to current point), and LIMIT
627 is used to limit the scan."
630 (or (not limit
) (< (+ point i
) limit
))
631 (eq (char-after (+ point i
)) quote-char
))
635 (defun python-syntax-stringify ()
636 "Put `syntax-table' property correctly on single/triple quotes."
637 (let* ((num-quotes (length (match-string-no-properties 1)))
639 (backward-char num-quotes
)
641 (forward-char num-quotes
)))
642 (string-start (and (not (nth 4 ppss
)) (nth 8 ppss
)))
643 (quote-starting-pos (- (point) num-quotes
))
644 (quote-ending-pos (point))
647 (python-syntax-count-quotes
648 (char-before) string-start quote-starting-pos
))))
649 (cond ((and string-start
(= num-closing-quotes
0))
650 ;; This set of quotes doesn't match the string starting
654 ;; This set of quotes delimit the start of a string.
655 (put-text-property quote-starting-pos
(1+ quote-starting-pos
)
656 'syntax-table
(string-to-syntax "|")))
657 ((= num-quotes num-closing-quotes
)
658 ;; This set of quotes delimit the end of a string.
659 (put-text-property (1- quote-ending-pos
) quote-ending-pos
660 'syntax-table
(string-to-syntax "|")))
661 ((> num-quotes num-closing-quotes
)
662 ;; This may only happen whenever a triple quote is closing
663 ;; a single quoted string. Add string delimiter syntax to
665 (put-text-property quote-starting-pos quote-ending-pos
666 'syntax-table
(string-to-syntax "|"))))))
668 (defvar python-mode-syntax-table
669 (let ((table (make-syntax-table)))
670 ;; Give punctuation syntax to ASCII that normally has symbol
671 ;; syntax or has word syntax and isn't a letter.
672 (let ((symbol (string-to-syntax "_"))
673 (sst (standard-syntax-table)))
676 (if (equal symbol
(aref sst i
))
677 (modify-syntax-entry i
"." table
)))))
678 (modify-syntax-entry ?$
"." table
)
679 (modify-syntax-entry ?%
"." table
)
681 (modify-syntax-entry ?
# "<" table
)
682 (modify-syntax-entry ?
\n ">" table
)
683 (modify-syntax-entry ?
' "\"" table
)
684 (modify-syntax-entry ?
` "$" table
)
686 "Syntax table for Python files.")
688 (defvar python-dotty-syntax-table
689 (let ((table (make-syntax-table python-mode-syntax-table
)))
690 (modify-syntax-entry ?.
"w" table
)
691 (modify-syntax-entry ?_
"w" table
)
693 "Dotty syntax table for Python files.
694 It makes underscores and dots word constituent chars.")
699 (defcustom python-indent-offset
4
700 "Default indentation offset for Python."
705 (defcustom python-indent-guess-indent-offset t
706 "Non-nil tells Python mode to guess `python-indent-offset' value."
711 (defcustom python-indent-guess-indent-offset-verbose t
712 "Non-nil means to emit a warning when indentation guessing fails."
717 (defcustom python-indent-trigger-commands
718 '(indent-for-tab-command yas-expand yas
/expand
)
719 "Commands that might trigger a `python-indent-line' call."
720 :type
'(repeat symbol
)
723 (define-obsolete-variable-alias
724 'python-indent
'python-indent-offset
"24.3")
726 (define-obsolete-variable-alias
727 'python-guess-indent
'python-indent-guess-indent-offset
"24.3")
729 (defvar python-indent-current-level
0
730 "Deprecated var available for compatibility.")
732 (defvar python-indent-levels
'(0)
733 "Deprecated var available for compatibility.")
735 (make-obsolete-variable
736 'python-indent-current-level
737 "The indentation API changed to avoid global state.
738 The function `python-indent-calculate-levels' does not use it
739 anymore. If you were defadvising it and or depended on this
740 variable for indentation customizations, refactor your code to
741 work on `python-indent-calculate-indentation' instead."
744 (make-obsolete-variable
745 'python-indent-levels
746 "The indentation API changed to avoid global state.
747 The function `python-indent-calculate-levels' does not use it
748 anymore. If you were defadvising it and or depended on this
749 variable for indentation customizations, refactor your code to
750 work on `python-indent-calculate-indentation' instead."
753 (defun python-indent-guess-indent-offset ()
754 "Guess and set `python-indent-offset' for the current buffer."
759 (goto-char (point-min))
761 (while (and (not block-end
)
763 (python-rx line-start block-start
) nil t
))
765 (not (python-syntax-context-type))
767 (goto-char (line-end-position))
768 (python-util-forward-comment -
1)
769 (if (equal (char-before) ?
:)
772 (when (python-info-block-continuation-line-p)
773 (while (and (python-info-continuation-line-p)
776 (python-util-forward-comment -
1)
777 (when (equal (char-before) ?
:)
779 (setq block-end
(point-marker))))
782 (goto-char block-end
)
783 (python-util-forward-comment)
784 (current-indentation))))
785 (if (and indentation
(not (zerop indentation
)))
786 (set (make-local-variable 'python-indent-offset
) indentation
)
787 (when python-indent-guess-indent-offset-verbose
788 (message "Can't guess python-indent-offset, using defaults: %s"
789 python-indent-offset
))))))))
791 (defun python-indent-context ()
792 "Get information about the current indentation context.
793 Context is returned in a cons with the form (STATUS . START).
795 STATUS can be one of the following:
801 - Point is after a comment line.
802 - START is the position of the \"#\" character.
804 - Point is inside string.
805 - START is the position of the first quote that starts it.
807 - No possible indentation case matches.
808 - START is always zero.
811 - Fallback case when point is inside paren.
812 - START is the first non space char position *after* the open paren.
813 :inside-paren-at-closing-nested-paren
814 - Point is on a line that contains a nested paren closer.
815 - START is the position of the open paren it closes.
816 :inside-paren-at-closing-paren
817 - Point is on a line that contains a paren closer.
818 - START is the position of the open paren.
819 :inside-paren-newline-start
820 - Point is inside a paren with items starting in their own line.
821 - START is the position of the open paren.
822 :inside-paren-newline-start-from-block
823 - Point is inside a paren with items starting in their own line
825 - START is the position of the open paren.
828 - Fallback case when point is after backslash.
829 - START is the char after the position of the backslash.
830 :after-backslash-assignment-continuation
831 - Point is after a backslashed assignment.
832 - START is the char after the position of the backslash.
833 :after-backslash-block-continuation
834 - Point is after a backslashed block continuation.
835 - START is the char after the position of the backslash.
836 :after-backslash-dotted-continuation
837 - Point is after a backslashed dotted continuation. Previous
838 line must contain a dot to align with.
839 - START is the char after the position of the backslash.
840 :after-backslash-first-line
841 - First line following a backslashed continuation.
842 - START is the char after the position of the backslash.
845 - Point is after a line containing a block ender.
846 - START is the position where the ender starts.
848 - Point is after a line starting a block.
849 - START is the position where the block starts.
851 - Point is after a simple line.
852 - START is the position where the previous line starts.
853 :at-dedenter-block-start
854 - Point is on a line starting a dedenter block.
855 - START is the position where the dedenter block starts."
858 (let ((ppss (save-excursion
862 ;; Beginning of buffer.
863 ((= (line-number-at-pos) 1)
866 ((let ((start (python-syntax-context 'string ppss
)))
868 (cons (if (python-info-docstring-p)
870 :inside-string
) start
))))
872 ((let* ((start (python-syntax-context 'paren ppss
))
879 (= (line-number-at-pos)
881 (python-util-forward-comment)
882 (line-number-at-pos))))))))
885 ;; Current line only holds the closing paren.
887 (skip-syntax-forward " ")
888 (when (and (python-syntax-closing-paren-p)
891 (not (python-syntax-context 'paren
))))
892 (cons :inside-paren-at-closing-paren start
))))
893 ;; Current line only holds a closing paren for nested.
895 (back-to-indentation)
896 (python-syntax-closing-paren-p))
897 (cons :inside-paren-at-closing-nested-paren start
))
898 ;; This line starts from a opening block in its own line.
904 (back-to-indentation)
905 (looking-at (python-rx block-start
))))
907 :inside-paren-newline-start-from-block start
))))
909 (cons :inside-paren-newline-start start
))
911 (t (cons :inside-paren
913 (goto-char (1+ start
))
914 (skip-syntax-forward "(" 1)
915 (skip-syntax-forward " ")
918 ((let ((start (when (not (python-syntax-comment-or-string-p ppss
))
919 (python-info-line-ends-backslash-p
920 (1- (line-number-at-pos))))))
923 ;; Continuation of dotted expression.
925 (back-to-indentation)
926 (when (eq (char-after) ?\.
)
927 ;; Move point back until it's not inside a paren.
931 (python-syntax-context 'paren
))))
932 (goto-char (line-end-position))
933 (while (and (search-backward
934 "." (line-beginning-position) t
)
935 (python-syntax-context-type)))
936 ;; Ensure previous statement has dot to align with.
937 (when (and (eq (char-after) ?\.
)
938 (not (python-syntax-context-type)))
939 (cons :after-backslash-dotted-continuation
(point))))))
940 ;; Continuation of block definition.
941 ((let ((block-continuation-start
942 (python-info-block-continuation-line-p)))
943 (when block-continuation-start
945 (goto-char block-continuation-start
)
947 (python-rx block-start
(* space
))
948 (line-end-position) t
)
949 (cons :after-backslash-block-continuation
(point))))))
950 ;; Continuation of assignment.
951 ((let ((assignment-continuation-start
952 (python-info-assignment-continuation-line-p)))
953 (when assignment-continuation-start
955 (goto-char assignment-continuation-start
)
956 (cons :after-backslash-assignment-continuation
(point))))))
957 ;; First line after backslash continuation start.
960 (when (or (= (line-number-at-pos) 1)
961 (not (python-info-beginning-of-backslash
962 (1- (line-number-at-pos)))))
963 (cons :after-backslash-first-line start
))))
965 (t (cons :after-backslash start
))))))
966 ;; After beginning of block.
967 ((let ((start (save-excursion
968 (back-to-indentation)
969 (python-util-forward-comment -
1)
970 (when (equal (char-before) ?
:)
971 (python-nav-beginning-of-block)))))
973 (cons :after-block-start start
))))
974 ;; At dedenter statement.
975 ((let ((start (python-info-dedenter-statement-p)))
977 (cons :at-dedenter-block-start start
))))
978 ;; After normal line, comment or ender (default case).
980 (back-to-indentation)
981 (skip-chars-backward " \t\n")
984 (python-nav-beginning-of-statement)
986 (cond ((python-info-current-line-comment-p)
989 (goto-char (line-end-position))
990 (python-util-forward-comment -
1)
991 (python-nav-beginning-of-statement)
992 (looking-at (python-rx block-ender
)))
997 (defun python-indent--calculate-indentation ()
998 "Internal implementation of `python-indent-calculate-indentation'.
999 May return an integer for the maximum possible indentation at
1000 current context or a list of integers. The latter case is only
1001 happening for :at-dedenter-block-start context since the
1002 possibilities can be narrowed to specific indentation points."
1006 (pcase (python-indent-context)
1007 (`(:no-indent .
,_
) (prog-first-column)) ; usually 0
1012 :inside-paren-at-closing-paren
1013 :inside-paren-at-closing-nested-paren
) .
,start
)
1014 ;; Copy previous indentation.
1016 (current-indentation))
1017 (`(:inside-docstring .
,start
)
1018 (let* ((line-indentation (current-indentation))
1021 (current-indentation))))
1022 (max line-indentation base-indent
)))
1023 (`(,(or :after-block-start
1024 :after-backslash-first-line
1025 :inside-paren-newline-start
) .
,start
)
1026 ;; Add one indentation level.
1028 (+ (current-indentation) python-indent-offset
))
1029 (`(,(or :inside-paren
1030 :after-backslash-block-continuation
1031 :after-backslash-assignment-continuation
1032 :after-backslash-dotted-continuation
) .
,start
)
1033 ;; Use the column given by the context.
1036 (`(:after-block-end .
,start
)
1037 ;; Subtract one indentation level.
1039 (- (current-indentation) python-indent-offset
))
1040 (`(:at-dedenter-block-start .
,_
)
1041 ;; List all possible indentation levels from opening blocks.
1042 (let ((opening-block-start-points
1043 (python-info-dedenter-opening-block-positions)))
1044 (if (not opening-block-start-points
)
1045 (prog-first-column) ; if not found default to first column
1046 (mapcar (lambda (pos)
1049 (current-indentation)))
1050 opening-block-start-points
))))
1051 (`(,(or :inside-paren-newline-start-from-block
) .
,start
)
1052 ;; Add two indentation levels to make the suite stand out.
1054 (+ (current-indentation) (* python-indent-offset
2)))))))
1056 (defun python-indent--calculate-levels (indentation)
1057 "Calculate levels list given INDENTATION.
1058 Argument INDENTATION can either be an integer or a list of
1059 integers. Levels are returned in ascending order, and in the
1060 case INDENTATION is a list, this order is enforced."
1061 (if (listp indentation
)
1062 (sort (copy-sequence indentation
) #'<)
1063 (nconc (number-sequence (prog-first-column) (1- indentation
)
1064 python-indent-offset
)
1065 (list indentation
))))
1067 (defun python-indent--previous-level (levels indentation
)
1068 "Return previous level from LEVELS relative to INDENTATION."
1069 (let* ((levels (sort (copy-sequence levels
) #'>))
1070 (default (car levels
)))
1072 (dolist (level levels
)
1073 (when (funcall #'< level indentation
)
1074 (throw 'return level
)))
1077 (defun python-indent-calculate-indentation (&optional previous
)
1078 "Calculate indentation.
1079 Get indentation of PREVIOUS level when argument is non-nil.
1080 Return the max level of the cycle when indentation reaches the
1082 (let* ((indentation (python-indent--calculate-indentation))
1083 (levels (python-indent--calculate-levels indentation
)))
1085 (python-indent--previous-level levels
(current-indentation))
1087 (apply #'max levels
)
1088 (prog-first-column)))))
1090 (defun python-indent-line (&optional previous
)
1091 "Internal implementation of `python-indent-line-function'.
1092 Use the PREVIOUS level when argument is non-nil, otherwise indent
1093 to the maximum available level. When indentation is the minimum
1094 possible and PREVIOUS is non-nil, cycle back to the maximum
1096 (let ((follow-indentation-p
1097 ;; Check if point is within indentation.
1098 (and (<= (line-beginning-position) (point))
1099 (>= (+ (line-beginning-position)
1100 (current-indentation))
1104 (python-indent-calculate-indentation previous
))
1105 (python-info-dedenter-opening-block-message))
1106 (when follow-indentation-p
1107 (back-to-indentation))))
1109 (defun python-indent-calculate-levels ()
1110 "Return possible indentation levels."
1111 (python-indent--calculate-levels
1112 (python-indent--calculate-indentation)))
1114 (defun python-indent-line-function ()
1115 "`indent-line-function' for Python mode.
1116 When the variable `last-command' is equal to one of the symbols
1117 inside `python-indent-trigger-commands' it cycles possible
1118 indentation levels from right to left."
1120 (and (memq this-command python-indent-trigger-commands
)
1121 (eq last-command this-command
))))
1123 (defun python-indent-dedent-line ()
1124 "De-indent current line."
1126 (when (and (not (bolp))
1127 (not (python-syntax-comment-or-string-p))
1128 (= (current-indentation) (current-column)))
1129 (python-indent-line t
)
1132 (defun python-indent-dedent-line-backspace (arg)
1133 "De-indent current line.
1134 Argument ARG is passed to `backward-delete-char-untabify' when
1135 point is not in between the indentation."
1137 (unless (python-indent-dedent-line)
1138 (backward-delete-char-untabify arg
)))
1140 (put 'python-indent-dedent-line-backspace
'delete-selection
'supersede
)
1142 (defun python-indent-region (start end
)
1143 "Indent a Python region automagically.
1145 Called from a program, START and END specify the region to indent."
1146 (let ((deactivate-mark nil
))
1149 (setq end
(point-marker))
1151 (or (bolp) (forward-line 1))
1152 (while (< (point) end
)
1153 (or (and (bolp) (eolp))
1155 ;; Skip if previous line is empty or a comment.
1157 (let ((line-is-comment-p
1158 (python-info-current-line-comment-p)))
1161 (or (and (python-info-current-line-comment-p)
1162 ;; Unless this line is a comment too.
1163 (not line-is-comment-p
))
1164 (python-info-current-line-empty-p)))))
1165 ;; Don't mess with strings, unless it's the
1166 ;; enclosing set of quotes or a docstring.
1167 (or (not (python-syntax-context 'string
))
1171 (current-indentation)
1172 (python-syntax-count-quotes (char-after) (point))))
1173 (string-to-syntax "|"))
1174 (python-info-docstring-p))
1175 ;; Skip if current line is a block start, a
1176 ;; dedenter or block ender.
1178 (back-to-indentation)
1181 (or block-start dedenter block-ender
))))))
1182 (python-indent-line)))
1184 (move-marker end nil
))))
1186 (defun python-indent-shift-left (start end
&optional count
)
1187 "Shift lines contained in region START END by COUNT columns to the left.
1188 COUNT defaults to `python-indent-offset'. If region isn't
1189 active, the current line is shifted. The shifted region includes
1190 the lines in which START and END lie. An error is signaled if
1191 any lines in the region are indented less than COUNT columns."
1194 (list (region-beginning) (region-end) current-prefix-arg
)
1195 (list (line-beginning-position) (line-end-position) current-prefix-arg
)))
1197 (setq count
(prefix-numeric-value count
))
1198 (setq count python-indent-offset
))
1200 (let ((deactivate-mark nil
))
1203 (while (< (point) end
)
1204 (if (and (< (current-indentation) count
)
1205 (not (looking-at "[ \t]*$")))
1206 (user-error "Can't shift all lines enough"))
1208 (indent-rigidly start end
(- count
))))))
1210 (defun python-indent-shift-right (start end
&optional count
)
1211 "Shift lines contained in region START END by COUNT columns to the right.
1212 COUNT defaults to `python-indent-offset'. If region isn't
1213 active, the current line is shifted. The shifted region includes
1214 the lines in which START and END lie."
1217 (list (region-beginning) (region-end) current-prefix-arg
)
1218 (list (line-beginning-position) (line-end-position) current-prefix-arg
)))
1219 (let ((deactivate-mark nil
))
1220 (setq count
(if count
(prefix-numeric-value count
)
1221 python-indent-offset
))
1222 (indent-rigidly start end count
)))
1224 (defun python-indent-post-self-insert-function ()
1225 "Adjust indentation after insertion of some characters.
1226 This function is intended to be added to `post-self-insert-hook.'
1227 If a line renders a paren alone, after adding a char before it,
1228 the line will be re-indented automatically if needed."
1229 (when (and electric-indent-mode
1230 (eq (char-before) last-command-event
))
1232 ;; Electric indent inside parens
1235 (let ((paren-start (python-syntax-context 'paren
)))
1236 ;; Check that point is inside parens.
1239 ;; Filter the case where input is happening in the same
1240 ;; line where the open paren is.
1241 (= (line-number-at-pos)
1242 (line-number-at-pos paren-start
)))))
1243 ;; When content has been added before the closing paren or a
1244 ;; comma has been inserted, it's ok to do the trick.
1246 (memq (char-after) '(?\
) ?\
] ?\
}))
1247 (eq (char-before) ?
,)))
1249 (goto-char (line-beginning-position))
1250 (let ((indentation (python-indent-calculate-indentation)))
1251 (when (and (numberp indentation
) (< (current-indentation) indentation
))
1252 (indent-line-to indentation
)))))
1254 ((and (eq ?
: last-command-event
)
1255 (memq ?
: electric-indent-chars
)
1256 (not current-prefix-arg
)
1257 ;; Trigger electric colon only at end of line
1259 ;; Avoid re-indenting on extra colon
1260 (not (equal ?
: (char-before (1- (point)))))
1261 (not (python-syntax-comment-or-string-p)))
1262 ;; Just re-indent dedenters
1263 (let ((dedenter-pos (python-info-dedenter-statement-p))
1264 (current-pos (point)))
1267 (goto-char dedenter-pos
)
1268 (python-indent-line)
1269 (unless (= (line-number-at-pos dedenter-pos
)
1270 (line-number-at-pos current-pos
))
1271 ;; Reindent region if this is a multiline statement
1272 (python-indent-region dedenter-pos current-pos
)))))))))
1277 (defun python-mark-defun (&optional allow-extend
)
1278 "Put mark at end of this defun, point at beginning.
1279 The defun marked is the one that contains point or follows point.
1281 Interactively (or with ALLOW-EXTEND non-nil), if this command is
1282 repeated or (in Transient Mark mode) if the mark is active, it
1283 marks the next defun after the ones already marked."
1285 (when (python-info-looking-at-beginning-of-defun)
1287 (mark-defun allow-extend))
1292 (defvar python-nav-beginning-of-defun-regexp
1293 (python-rx line-start
(* space
) defun
(+ space
) (group symbol-name
))
1294 "Regexp matching class or function definition.
1295 The name of the defun should be grouped so it can be retrieved
1296 via `match-string'.")
1298 (defun python-nav--beginning-of-defun (&optional arg
)
1299 "Internal implementation of `python-nav-beginning-of-defun'.
1300 With positive ARG search backwards, else search forwards."
1301 (when (or (null arg
) (= arg
0)) (setq arg
1))
1302 (let* ((re-search-fn (if (> arg
0)
1303 #'re-search-backward
1304 #'re-search-forward
))
1305 (line-beg-pos (line-beginning-position))
1306 (line-content-start (+ line-beg-pos
(current-indentation)))
1307 (pos (point-marker))
1312 (not (python-info-looking-at-beginning-of-defun))
1313 (python-nav-backward-block)))
1314 (or (and (python-info-looking-at-beginning-of-defun)
1315 (+ (current-indentation) python-indent-offset
))
1319 (when (and (< arg
0)
1320 (python-info-looking-at-beginning-of-defun))
1322 (while (and (funcall re-search-fn
1323 python-nav-beginning-of-defun-regexp nil t
)
1324 (or (python-syntax-context-type)
1325 ;; Handle nested defuns when moving
1326 ;; backwards by checking indentation.
1328 (not (= (current-indentation) 0))
1329 (>= (current-indentation) beg-indentation
)))))
1330 (and (python-info-looking-at-beginning-of-defun)
1331 (or (not (= (line-number-at-pos pos
)
1332 (line-number-at-pos)))
1333 (and (>= (point) line-beg-pos
)
1334 (<= (point) line-content-start
)
1335 (> pos line-content-start
)))))))
1337 (or (beginning-of-line 1) t
)
1338 (and (goto-char pos
) nil
))))
1340 (defun python-nav-beginning-of-defun (&optional arg
)
1341 "Move point to `beginning-of-defun'.
1342 With positive ARG search backwards else search forward.
1343 ARG nil or 0 defaults to 1. When searching backwards,
1344 nested defuns are handled with care depending on current
1345 point position. Return non-nil if point is moved to
1346 `beginning-of-defun'."
1347 (when (or (null arg
) (= arg
0)) (setq arg
1))
1349 (while (and (not (= arg
0))
1350 (let ((keep-searching-p
1351 (python-nav--beginning-of-defun arg)))
1352 (when (and keep-searching-p
(null found
))
1355 (setq arg
(if (> arg
0) (1- arg
) (1+ arg
))))
1358 (defun python-nav-end-of-defun ()
1359 "Move point to the end of def or class.
1360 Returns nil if point is not in a def or class."
1362 (let ((beg-defun-indent)
1364 (when (or (python-info-looking-at-beginning-of-defun)
1365 (python-nav-beginning-of-defun 1)
1366 (python-nav-beginning-of-defun -1))
1367 (setq beg-defun-indent
(current-indentation))
1369 (python-nav-end-of-statement)
1370 (python-util-forward-comment 1)
1371 (and (> (current-indentation) beg-defun-indent
)
1373 (python-util-forward-comment -
1)
1375 ;; Ensure point moves forward.
1376 (and (> beg-pos
(point)) (goto-char beg-pos
)))))
1378 (defun python-nav--syntactically (fn poscompfn
&optional contextfn
)
1379 "Move point using FN avoiding places with specific context.
1380 FN must take no arguments. POSCOMPFN is a two arguments function
1381 used to compare current and previous point after it is moved
1382 using FN, this is normally a less-than or greater-than
1383 comparison. Optional argument CONTEXTFN defaults to
1384 `python-syntax-context-type' and is used for checking current
1385 point context, it must return a non-nil value if this point must
1387 (let ((contextfn (or contextfn
'python-syntax-context-type
))
1388 (start-pos (point-marker))
1393 (and (funcall fn
) (point-marker)))
1394 (context (funcall contextfn
)))
1395 (cond ((and (not context
) newpos
1396 (or (and (not prev-pos
) newpos
)
1397 (and prev-pos newpos
1398 (funcall poscompfn newpos prev-pos
))))
1399 (throw 'found
(point-marker)))
1400 ((and newpos context
)
1401 (setq prev-pos
(point)))
1402 (t (when (not newpos
) (goto-char start-pos
))
1403 (throw 'found nil
))))))))
1405 (defun python-nav--forward-defun (arg)
1406 "Internal implementation of python-nav-{backward,forward}-defun.
1407 Uses ARG to define which function to call, and how many times
1410 (while (and (> arg
0)
1412 (python-nav--syntactically
1415 python-nav-beginning-of-defun-regexp nil t
))
1417 (setq arg
(1- arg
)))
1418 (while (and (< arg
0)
1420 (python-nav--syntactically
1423 python-nav-beginning-of-defun-regexp nil t
))
1425 (setq arg
(1+ arg
)))
1428 (defun python-nav-backward-defun (&optional arg
)
1429 "Navigate to closer defun backward ARG times.
1430 Unlikely `python-nav-beginning-of-defun' this doesn't care about
1431 nested definitions."
1433 (python-nav--forward-defun (- (or arg
1))))
1435 (defun python-nav-forward-defun (&optional arg
)
1436 "Navigate to closer defun forward ARG times.
1437 Unlikely `python-nav-beginning-of-defun' this doesn't care about
1438 nested definitions."
1440 (python-nav--forward-defun (or arg
1)))
1442 (defun python-nav-beginning-of-statement ()
1443 "Move to start of current statement."
1445 (back-to-indentation)
1446 (let* ((ppss (syntax-ppss))
1449 (python-syntax-context 'paren ppss
)
1450 (python-syntax-context 'string ppss
))))
1453 (goto-char context-point
)
1454 (python-nav-beginning-of-statement))
1457 (python-info-line-ends-backslash-p))
1459 (python-nav-beginning-of-statement))))
1462 (defun python-nav-end-of-statement (&optional noend
)
1463 "Move to end of current statement.
1464 Optional argument NOEND is internal and makes the logic to not
1465 jump to the end of line when moving forward searching for the end
1468 (let (string-start bs-pos
)
1469 (while (and (or noend
(goto-char (line-end-position)))
1471 (cond ((setq string-start
(python-syntax-context 'string
))
1472 (goto-char string-start
)
1473 (if (python-syntax-context 'paren
)
1474 ;; Ended up inside a paren, roll again.
1475 (python-nav-end-of-statement t
)
1476 ;; This is not inside a paren, move to the
1477 ;; end of this string.
1478 (goto-char (+ (point)
1479 (python-syntax-count-quotes
1480 (char-after (point)) (point))))
1481 (or (re-search-forward (rx (syntax string-delimiter
)) nil t
)
1482 (goto-char (point-max)))))
1483 ((python-syntax-context 'paren
)
1484 ;; The statement won't end before we've escaped
1485 ;; at least one level of parenthesis.
1487 (goto-char (scan-lists (point) 1 -
1))
1488 (scan-error (goto-char (nth 3 err
)))))
1489 ((setq bs-pos
(python-info-line-ends-backslash-p))
1491 (forward-line 1))))))
1494 (defun python-nav-backward-statement (&optional arg
)
1495 "Move backward to previous statement.
1496 With ARG, repeat. See `python-nav-forward-statement'."
1498 (or arg
(setq arg
1))
1499 (python-nav-forward-statement (- arg
)))
1501 (defun python-nav-forward-statement (&optional arg
)
1502 "Move forward to next statement.
1503 With ARG, repeat. With negative argument, move ARG times
1504 backward to previous statement."
1506 (or arg
(setq arg
1))
1508 (python-nav-end-of-statement)
1509 (python-util-forward-comment)
1510 (python-nav-beginning-of-statement)
1511 (setq arg
(1- arg
)))
1513 (python-nav-beginning-of-statement)
1514 (python-util-forward-comment -
1)
1515 (python-nav-beginning-of-statement)
1516 (setq arg
(1+ arg
))))
1518 (defun python-nav-beginning-of-block ()
1519 "Move to start of current block."
1521 (let ((starting-pos (point)))
1523 (python-nav-beginning-of-statement)
1524 (looking-at (python-rx block-start
)))
1526 ;; Go to first line beginning a statement
1527 (while (and (not (bobp))
1528 (or (and (python-nav-beginning-of-statement) nil
)
1529 (python-info-current-line-comment-p)
1530 (python-info-current-line-empty-p)))
1532 (let ((block-matching-indent
1533 (- (current-indentation) python-indent-offset
)))
1535 (and (python-nav-backward-block)
1536 (> (current-indentation) block-matching-indent
)))
1537 (if (and (looking-at (python-rx block-start
))
1538 (= (current-indentation) block-matching-indent
))
1540 (and (goto-char starting-pos
) nil
))))))
1542 (defun python-nav-end-of-block ()
1543 "Move to end of current block."
1545 (when (python-nav-beginning-of-block)
1546 (let ((block-indentation (current-indentation)))
1547 (python-nav-end-of-statement)
1548 (while (and (forward-line 1)
1550 (or (and (> (current-indentation) block-indentation
)
1551 (or (python-nav-end-of-statement) t
))
1552 (python-info-current-line-comment-p)
1553 (python-info-current-line-empty-p))))
1554 (python-util-forward-comment -
1)
1557 (defun python-nav-backward-block (&optional arg
)
1558 "Move backward to previous block of code.
1559 With ARG, repeat. See `python-nav-forward-block'."
1561 (or arg
(setq arg
1))
1562 (python-nav-forward-block (- arg
)))
1564 (defun python-nav-forward-block (&optional arg
)
1565 "Move forward to next block of code.
1566 With ARG, repeat. With negative argument, move ARG times
1567 backward to previous block."
1569 (or arg
(setq arg
1))
1570 (let ((block-start-regexp
1571 (python-rx line-start
(* whitespace
) block-start
))
1572 (starting-pos (point)))
1574 (python-nav-end-of-statement)
1576 (re-search-forward block-start-regexp nil t
)
1577 (python-syntax-context-type)))
1578 (setq arg
(1- arg
)))
1580 (python-nav-beginning-of-statement)
1582 (re-search-backward block-start-regexp nil t
)
1583 (python-syntax-context-type)))
1584 (setq arg
(1+ arg
)))
1585 (python-nav-beginning-of-statement)
1586 (if (not (looking-at (python-rx block-start
)))
1587 (and (goto-char starting-pos
) nil
)
1588 (and (not (= (point) starting-pos
)) (point-marker)))))
1590 (defun python-nav--lisp-forward-sexp (&optional arg
)
1591 "Standard version `forward-sexp'.
1592 It ignores completely the value of `forward-sexp-function' by
1593 setting it to nil before calling `forward-sexp'. With positive
1594 ARG move forward only one sexp, else move backwards."
1595 (let ((forward-sexp-function)
1596 (arg (if (or (not arg
) (> arg
0)) 1 -
1)))
1597 (forward-sexp arg
)))
1599 (defun python-nav--lisp-forward-sexp-safe (&optional arg
)
1600 "Safe version of standard `forward-sexp'.
1601 When at end of sexp (i.e. looking at a opening/closing paren)
1602 skips it instead of throwing an error. With positive ARG move
1603 forward only one sexp, else move backwards."
1604 (let* ((arg (if (or (not arg
) (> arg
0)) 1 -
1))
1606 (if (> arg
0) (python-rx close-paren
) (python-rx open-paren
)))
1608 (if (> arg
0) #'re-search-forward
#'re-search-backward
)))
1610 (python-nav--lisp-forward-sexp arg
)
1612 (while (and (funcall search-fn paren-regexp nil t
)
1613 (python-syntax-context 'paren
)))))))
1615 (defun python-nav--forward-sexp (&optional dir safe skip-parens-p
)
1616 "Move to forward sexp.
1617 With positive optional argument DIR direction move forward, else
1618 backwards. When optional argument SAFE is non-nil do not throw
1619 errors when at end of sexp, skip it instead. With optional
1620 argument SKIP-PARENS-P force sexp motion to ignore parenthesized
1621 expressions when looking at them in either direction."
1622 (setq dir
(or dir
1))
1624 (let* ((forward-p (if (> dir
0)
1625 (and (setq dir
1) t
)
1626 (and (setq dir -
1) nil
)))
1627 (context-type (python-syntax-context-type)))
1629 ((memq context-type
'(string comment
))
1630 ;; Inside of a string, get out of it.
1631 (let ((forward-sexp-function))
1632 (forward-sexp dir
)))
1633 ((and (not skip-parens-p
)
1634 (or (eq context-type
'paren
)
1636 (eq (syntax-class (syntax-after (point)))
1637 (car (string-to-syntax "(")))
1638 (eq (syntax-class (syntax-after (1- (point))))
1639 (car (string-to-syntax ")"))))))
1640 ;; Inside a paren or looking at it, lisp knows what to do.
1642 (python-nav--lisp-forward-sexp-safe dir
)
1643 (python-nav--lisp-forward-sexp dir
)))
1645 ;; This part handles the lispy feel of
1646 ;; `python-nav-forward-sexp'. Knowing everything about the
1647 ;; current context and the context of the next sexp tries to
1648 ;; follow the lisp sexp motion commands in a symmetric manner.
1651 ((python-info-beginning-of-block-p) 'block-start
)
1652 ((python-info-end-of-block-p) 'block-end
)
1653 ((python-info-beginning-of-statement-p) 'statement-start
)
1654 ((python-info-end-of-statement-p) 'statement-end
)))
1658 (python-nav--lisp-forward-sexp-safe dir
)
1659 (python-nav--lisp-forward-sexp dir
))
1663 (goto-char next-sexp-pos
)
1665 ((python-info-beginning-of-block-p) 'block-start
)
1666 ((python-info-end-of-block-p) 'block-end
)
1667 ((python-info-beginning-of-statement-p) 'statement-start
)
1668 ((python-info-end-of-statement-p) 'statement-end
)
1669 ((python-info-statement-starts-block-p) 'starts-block
)
1670 ((python-info-statement-ends-block-p) 'ends-block
)))))
1672 (cond ((and (not (eobp))
1673 (python-info-current-line-empty-p))
1674 (python-util-forward-comment dir
)
1675 (python-nav--forward-sexp dir safe skip-parens-p
))
1676 ((eq context
'block-start
)
1677 (python-nav-end-of-block))
1678 ((eq context
'statement-start
)
1679 (python-nav-end-of-statement))
1680 ((and (memq context
'(statement-end block-end
))
1681 (eq next-sexp-context
'ends-block
))
1682 (goto-char next-sexp-pos
)
1683 (python-nav-end-of-block))
1684 ((and (memq context
'(statement-end block-end
))
1685 (eq next-sexp-context
'starts-block
))
1686 (goto-char next-sexp-pos
)
1687 (python-nav-end-of-block))
1688 ((memq context
'(statement-end block-end
))
1689 (goto-char next-sexp-pos
)
1690 (python-nav-end-of-statement))
1691 (t (goto-char next-sexp-pos
)))
1692 (cond ((and (not (bobp))
1693 (python-info-current-line-empty-p))
1694 (python-util-forward-comment dir
)
1695 (python-nav--forward-sexp dir safe skip-parens-p
))
1696 ((eq context
'block-end
)
1697 (python-nav-beginning-of-block))
1698 ((eq context
'statement-end
)
1699 (python-nav-beginning-of-statement))
1700 ((and (memq context
'(statement-start block-start
))
1701 (eq next-sexp-context
'starts-block
))
1702 (goto-char next-sexp-pos
)
1703 (python-nav-beginning-of-block))
1704 ((and (memq context
'(statement-start block-start
))
1705 (eq next-sexp-context
'ends-block
))
1706 (goto-char next-sexp-pos
)
1707 (python-nav-beginning-of-block))
1708 ((memq context
'(statement-start block-start
))
1709 (goto-char next-sexp-pos
)
1710 (python-nav-beginning-of-statement))
1711 (t (goto-char next-sexp-pos
))))))))))
1713 (defun python-nav-forward-sexp (&optional arg safe skip-parens-p
)
1714 "Move forward across expressions.
1715 With ARG, do it that many times. Negative arg -N means move
1716 backward N times. When optional argument SAFE is non-nil do not
1717 throw errors when at end of sexp, skip it instead. With optional
1718 argument SKIP-PARENS-P force sexp motion to ignore parenthesized
1719 expressions when looking at them in either direction (forced to t
1720 in interactive calls)."
1722 (or arg
(setq arg
1))
1723 ;; Do not follow parens on interactive calls. This hack to detect
1724 ;; if the function was called interactively copes with the way
1725 ;; `forward-sexp' works by calling `forward-sexp-function', losing
1726 ;; interactive detection by checking `current-prefix-arg'. The
1727 ;; reason to make this distinction is that lisp functions like
1728 ;; `blink-matching-open' get confused causing issues like the one in
1729 ;; Bug#16191. With this approach the user gets a symmetric behavior
1730 ;; when working interactively while called functions expecting
1731 ;; paren-based sexp motion work just fine.
1735 (memq real-this-command
1737 #'forward-sexp
#'backward-sexp
1738 #'python-nav-forward-sexp
#'python-nav-backward-sexp
1739 #'python-nav-forward-sexp-safe
#'python-nav-backward-sexp
))))
1741 (python-nav--forward-sexp 1 safe skip-parens-p
)
1742 (setq arg
(1- arg
)))
1744 (python-nav--forward-sexp -
1 safe skip-parens-p
)
1745 (setq arg
(1+ arg
))))
1747 (defun python-nav-backward-sexp (&optional arg safe skip-parens-p
)
1748 "Move backward across expressions.
1749 With ARG, do it that many times. Negative arg -N means move
1750 forward N times. When optional argument SAFE is non-nil do not
1751 throw errors when at end of sexp, skip it instead. With optional
1752 argument SKIP-PARENS-P force sexp motion to ignore parenthesized
1753 expressions when looking at them in either direction (forced to t
1754 in interactive calls)."
1756 (or arg
(setq arg
1))
1757 (python-nav-forward-sexp (- arg
) safe skip-parens-p
))
1759 (defun python-nav-forward-sexp-safe (&optional arg skip-parens-p
)
1760 "Move forward safely across expressions.
1761 With ARG, do it that many times. Negative arg -N means move
1762 backward N times. With optional argument SKIP-PARENS-P force
1763 sexp motion to ignore parenthesized expressions when looking at
1764 them in either direction (forced to t in interactive calls)."
1766 (python-nav-forward-sexp arg t skip-parens-p
))
1768 (defun python-nav-backward-sexp-safe (&optional arg skip-parens-p
)
1769 "Move backward safely across expressions.
1770 With ARG, do it that many times. Negative arg -N means move
1771 forward N times. With optional argument SKIP-PARENS-P force sexp
1772 motion to ignore parenthesized expressions when looking at them in
1773 either direction (forced to t in interactive calls)."
1775 (python-nav-backward-sexp arg t skip-parens-p
))
1777 (defun python-nav--up-list (&optional dir
)
1778 "Internal implementation of `python-nav-up-list'.
1779 DIR is always 1 or -1 and comes sanitized from
1780 `python-nav-up-list' calls."
1781 (let ((context (python-syntax-context-type))
1782 (forward-p (> dir
0)))
1784 ((memq context
'(string comment
)))
1785 ((eq context
'paren
)
1786 (let ((forward-sexp-function))
1788 ((and forward-p
(python-info-end-of-block-p))
1789 (let ((parent-end-pos
1791 (let ((indentation (and
1792 (python-nav-beginning-of-block)
1793 (current-indentation))))
1794 (while (and indentation
1796 (>= (current-indentation) indentation
)
1797 (python-nav-backward-block)))
1798 (python-nav-end-of-block)))))
1799 (and (> (or parent-end-pos
(point)) (point))
1800 (goto-char parent-end-pos
))))
1801 (forward-p (python-nav-end-of-block))
1802 ((and (not forward-p
)
1803 (> (current-indentation) 0)
1804 (python-info-beginning-of-block-p))
1805 (let ((prev-block-pos
1807 (let ((indentation (current-indentation)))
1808 (while (and (python-nav-backward-block)
1809 (>= (current-indentation) indentation
))))
1811 (and (> (point) prev-block-pos
)
1812 (goto-char prev-block-pos
))))
1813 ((not forward-p
) (python-nav-beginning-of-block)))))
1815 (defun python-nav-up-list (&optional arg
)
1816 "Move forward out of one level of parentheses (or blocks).
1817 With ARG, do this that many times.
1818 A negative argument means move backward but still to a less deep spot.
1819 This command assumes point is not in a string or comment."
1821 (or arg
(setq arg
1))
1823 (python-nav--up-list 1)
1824 (setq arg
(1- arg
)))
1826 (python-nav--up-list -
1)
1827 (setq arg
(1+ arg
))))
1829 (defun python-nav-backward-up-list (&optional arg
)
1830 "Move backward out of one level of parentheses (or blocks).
1831 With ARG, do this that many times.
1832 A negative argument means move forward but still to a less deep spot.
1833 This command assumes point is not in a string or comment."
1835 (or arg
(setq arg
1))
1836 (python-nav-up-list (- arg
)))
1838 (defun python-nav-if-name-main ()
1839 "Move point at the beginning the __main__ block.
1840 When \"if __name__ == '__main__':\" is found returns its
1841 position, else returns nil."
1843 (let ((point (point))
1844 (found (catch 'found
1845 (goto-char (point-min))
1846 (while (re-search-forward
1847 (python-rx line-start
1849 "__name__" (+ space
)
1851 (group-n 1 (or ?
\" ?
\'))
1852 "__main__" (backref 1) (* space
) ":")
1854 (when (not (python-syntax-context-type))
1856 (throw 'found t
))))))
1859 (ignore (goto-char point
)))))
1862 ;;; Shell integration
1864 (defcustom python-shell-buffer-name
"Python"
1865 "Default buffer name for Python interpreter."
1870 (defcustom python-shell-interpreter
"python"
1871 "Default Python interpreter for shell."
1875 (defcustom python-shell-internal-buffer-name
"Python Internal"
1876 "Default buffer name for the Internal Python interpreter."
1881 (defcustom python-shell-interpreter-args
"-i"
1882 "Default arguments for the Python interpreter."
1886 (defcustom python-shell-interpreter-interactive-arg
"-i"
1887 "Interpreter argument to force it to run interactively."
1891 (defcustom python-shell-prompt-detect-enabled t
1892 "Non-nil enables autodetection of interpreter prompts."
1897 (defcustom python-shell-prompt-detect-failure-warning t
1898 "Non-nil enables warnings when detection of prompts fail."
1903 (defcustom python-shell-prompt-input-regexps
1904 '(">>> " "\\.\\.\\. " ; Python
1905 "In \\[[0-9]+\\]: " ; IPython
1906 " \\.\\.\\.: " ; IPython
1907 ;; Using ipdb outside IPython may fail to cleanup and leave static
1908 ;; IPython prompts activated, this adds some safeguard for that.
1909 "In : " "\\.\\.\\.: ")
1910 "List of regular expressions matching input prompts."
1911 :type
'(repeat string
)
1914 (defcustom python-shell-prompt-output-regexps
1916 "Out\\[[0-9]+\\]: " ; IPython
1917 "Out :") ; ipdb safeguard
1918 "List of regular expressions matching output prompts."
1919 :type
'(repeat string
)
1922 (defcustom python-shell-prompt-regexp
">>> "
1923 "Regular expression matching top level input prompt of Python shell.
1924 It should not contain a caret (^) at the beginning."
1927 (defcustom python-shell-prompt-block-regexp
"\\.\\.\\. "
1928 "Regular expression matching block input prompt of Python shell.
1929 It should not contain a caret (^) at the beginning."
1932 (defcustom python-shell-prompt-output-regexp
""
1933 "Regular expression matching output prompt of Python shell.
1934 It should not contain a caret (^) at the beginning."
1937 (defcustom python-shell-prompt-pdb-regexp
"[(<]*[Ii]?[Pp]db[>)]+ "
1938 "Regular expression matching pdb input prompt of Python shell.
1939 It should not contain a caret (^) at the beginning."
1942 (define-obsolete-variable-alias
1943 'python-shell-enable-font-lock
'python-shell-font-lock-enable
"25.1")
1945 (defcustom python-shell-font-lock-enable t
1946 "Should syntax highlighting be enabled in the Python shell buffer?
1947 Restart the Python shell after changing this variable for it to take effect."
1952 (defcustom python-shell-unbuffered t
1953 "Should shell output be unbuffered?.
1954 When non-nil, this may prevent delayed and missing output in the
1955 Python shell. See commentary for details."
1960 (defcustom python-shell-process-environment nil
1961 "List of overridden environment variables for subprocesses to inherit.
1962 Each element should be a string of the form ENVVARNAME=VALUE.
1963 When this variable is non-nil, values are exported into the
1964 process environment before starting it. Any variables already
1965 present in the current environment are superseded by variables
1967 :type
'(repeat string
)
1970 (defcustom python-shell-extra-pythonpaths nil
1971 "List of extra pythonpaths for Python shell.
1972 When this variable is non-nil, values added at the beginning of
1973 the PYTHONPATH before starting processes. Any values present
1974 here that already exists in PYTHONPATH are moved to the beginning
1975 of the list so that they are prioritized when looking for
1977 :type
'(repeat string
)
1980 (defcustom python-shell-exec-path nil
1981 "List of paths for searching executables.
1982 When this variable is non-nil, values added at the beginning of
1983 the PATH before starting processes. Any values present here that
1984 already exists in PATH are moved to the beginning of the list so
1985 that they are prioritized when looking for executables."
1986 :type
'(repeat string
)
1989 (defcustom python-shell-remote-exec-path nil
1990 "List of paths to be ensured remotely for searching executables.
1991 When this variable is non-nil, values are exported into remote
1992 hosts PATH before starting processes. Values defined in
1993 `python-shell-exec-path' will take precedence to paths defined
1994 here. Normally you wont use this variable directly unless you
1995 plan to ensure a particular set of paths to all Python shell
1996 executed through tramp connections."
1997 :type
'(repeat string
)
2000 (defcustom python-shell-virtualenv-root nil
2001 "Path to virtualenv root.
2002 This variable, when set to a string, makes the environment to be
2003 modified such that shells are started within the specified
2005 :type
'(choice (const nil
) string
)
2008 (define-obsolete-variable-alias
2009 'python-shell-virtualenv-path
'python-shell-virtualenv-root
"25.1")
2011 (defcustom python-shell-setup-codes nil
2012 "List of code run by `python-shell-send-setup-codes'."
2013 :type
'(repeat symbol
)
2016 (defcustom python-shell-compilation-regexp-alist
2017 `((,(rx line-start
(1+ (any " \t")) "File \""
2018 (group (1+ (not (any "\"<")))) ; avoid `<stdin>' &c
2019 "\", line " (group (1+ digit
)))
2021 (,(rx " in file " (group (1+ not-newline
)) " on line "
2024 (,(rx line-start
"> " (group (1+ (not (any "(\"<"))))
2025 "(" (group (1+ digit
)) ")" (1+ (not (any "("))) "()")
2027 "`compilation-error-regexp-alist' for inferior Python."
2028 :type
'(alist string
)
2031 (defmacro python-shell--add-to-path-with-priority
(pathvar paths
)
2032 "Modify PATHVAR and ensure PATHS are added only once at beginning."
2033 `(dolist (path (reverse ,paths
))
2034 (cl-delete path
,pathvar
:test
#'string
=)
2035 (cl-pushnew path
,pathvar
:test
#'string
=)))
2037 (defun python-shell-calculate-pythonpath ()
2038 "Calculate the PYTHONPATH using `python-shell-extra-pythonpaths'."
2040 (tramp-compat-split-string
2041 (or (getenv "PYTHONPATH") "") path-separator
)))
2042 (python-shell--add-to-path-with-priority
2043 pythonpath python-shell-extra-pythonpaths
)
2044 (mapconcat 'identity pythonpath path-separator
)))
2046 (defun python-shell-calculate-process-environment ()
2047 "Calculate `process-environment' or `tramp-remote-process-environment'.
2048 Prepends `python-shell-process-environment', sets extra
2049 pythonpaths from `python-shell-extra-pythonpaths' and sets a few
2050 virtualenv related vars. If `default-directory' points to a
2051 remote host, the returned value is intended for
2052 `tramp-remote-process-environment'."
2053 (let* ((remote-p (file-remote-p default-directory
))
2054 (process-environment (if remote-p
2055 tramp-remote-process-environment
2056 process-environment
))
2057 (virtualenv (when python-shell-virtualenv-root
2058 (directory-file-name python-shell-virtualenv-root
))))
2059 (dolist (env python-shell-process-environment
)
2060 (pcase-let ((`(,key
,value
) (split-string env
"=")))
2061 (setenv key value
)))
2062 (when python-shell-unbuffered
2063 (setenv "PYTHONUNBUFFERED" "1"))
2064 (when python-shell-extra-pythonpaths
2065 (setenv "PYTHONPATH" (python-shell-calculate-pythonpath)))
2066 (if (not virtualenv
)
2068 (setenv "PYTHONHOME" nil
)
2069 (setenv "VIRTUAL_ENV" virtualenv
))
2070 process-environment
))
2072 (defun python-shell-calculate-exec-path ()
2073 "Calculate `exec-path'.
2074 Prepends `python-shell-exec-path' and adds the binary directory
2075 for virtualenv if `python-shell-virtualenv-root' is set. If
2076 `default-directory' points to a remote host, the returned value
2077 appends `python-shell-remote-exec-path' instead of `exec-path'."
2078 (let ((new-path (copy-sequence
2079 (if (file-remote-p default-directory
)
2080 python-shell-remote-exec-path
2082 (python-shell--add-to-path-with-priority
2083 new-path python-shell-exec-path
)
2084 (if (not python-shell-virtualenv-root
)
2086 (python-shell--add-to-path-with-priority
2088 (list (expand-file-name "bin" python-shell-virtualenv-root
)))
2091 (defun python-shell-tramp-refresh-remote-path (vec paths
)
2092 "Update VEC's remote-path giving PATHS priority."
2093 (let ((remote-path (tramp-get-connection-property vec
"remote-path" nil
)))
2095 (python-shell--add-to-path-with-priority remote-path paths
)
2096 (tramp-set-connection-property vec
"remote-path" remote-path
)
2097 (tramp-set-remote-path vec
))))
2099 (defun python-shell-tramp-refresh-process-environment (vec env
)
2100 "Update VEC's process environment with ENV."
2101 ;; Stolen from `tramp-open-connection-setup-interactive-shell'.
2102 (let ((env (append (when (fboundp #'tramp-get-remote-locale
)
2103 ;; Emacs<24.4 compat.
2104 (list (tramp-get-remote-locale vec
)))
2105 (copy-sequence env
)))
2106 (tramp-end-of-heredoc
2107 (if (boundp 'tramp-end-of-heredoc
)
2108 tramp-end-of-heredoc
2109 (md5 tramp-end-of-output
)))
2112 (setq item
(tramp-compat-split-string (car env
) "="))
2113 (setcdr item
(mapconcat 'identity
(cdr item
) "="))
2114 (if (and (stringp (cdr item
)) (not (string-equal (cdr item
) "")))
2115 (push (format "%s %s" (car item
) (cdr item
)) vars
)
2116 (push (car item
) unset
))
2117 (setq env
(cdr env
)))
2121 (format "while read var val; do export $var=$val; done <<'%s'\n%s\n%s"
2122 tramp-end-of-heredoc
2123 (mapconcat 'identity vars
"\n")
2124 tramp-end-of-heredoc
)
2128 vec
(format "unset %s" (mapconcat 'identity unset
" ")) t
))))
2130 (defmacro python-shell-with-environment
(&rest body
)
2131 "Modify shell environment during execution of BODY.
2132 Temporarily sets `process-environment' and `exec-path' during
2133 execution of body. If `default-directory' points to a remote
2134 machine then modifies `tramp-remote-process-environment' and
2135 `python-shell-remote-exec-path' instead."
2136 (declare (indent 0) (debug (body)))
2137 (let ((vec (make-symbol "vec")))
2140 (when (file-remote-p default-directory
)
2142 (tramp-dissect-file-name default-directory
'noexpand
))))
2143 (process-environment
2146 (python-shell-calculate-process-environment)))
2150 (python-shell-calculate-exec-path)))
2151 (tramp-remote-process-environment
2153 (python-shell-calculate-process-environment)
2154 tramp-remote-process-environment
)))
2155 (when (tramp-get-connection-process ,vec
)
2156 ;; For already existing connections, the new exec path must
2157 ;; be re-set, otherwise it won't take effect. One example
2158 ;; of such case is when remote dir-locals are read and
2159 ;; *then* subprocesses are triggered within the same
2161 (python-shell-tramp-refresh-remote-path
2162 ,vec
(python-shell-calculate-exec-path))
2163 ;; The `tramp-remote-process-environment' variable is only
2164 ;; effective when the started process is an interactive
2165 ;; shell, otherwise (like in the case of processes started
2166 ;; with `process-file') the environment is not changed.
2167 ;; This makes environment modifications effective
2169 (python-shell-tramp-refresh-process-environment
2170 ,vec tramp-remote-process-environment
))
2171 ,(macroexp-progn body
)))))
2173 (defvar python-shell--prompt-calculated-input-regexp nil
2174 "Calculated input prompt regexp for inferior python shell.
2175 Do not set this variable directly, instead use
2176 `python-shell-prompt-set-calculated-regexps'.")
2178 (defvar python-shell--prompt-calculated-output-regexp nil
2179 "Calculated output prompt regexp for inferior python shell.
2180 Do not set this variable directly, instead use
2181 `python-shell-set-prompt-regexp'.")
2183 (defun python-shell-prompt-detect ()
2184 "Detect prompts for the current `python-shell-interpreter'.
2185 When prompts can be retrieved successfully from the
2186 `python-shell-interpreter' run with
2187 `python-shell-interpreter-interactive-arg', returns a list of
2188 three elements, where the first two are input prompts and the
2189 last one is an output prompt. When no prompts can be detected
2190 and `python-shell-prompt-detect-failure-warning' is non-nil,
2191 shows a warning with instructions to avoid hangs and returns nil.
2192 When `python-shell-prompt-detect-enabled' is nil avoids any
2193 detection and just returns nil."
2194 (when python-shell-prompt-detect-enabled
2195 (python-shell-with-environment
2196 (let* ((code (concat
2198 "ps = [getattr(sys, 'ps%s' % i, '') for i in range(1,4)]\n"
2199 ;; JSON is built manually for compatibility
2200 "ps_json = '\\n[\"%s\", \"%s\", \"%s\"]\\n' % tuple(ps)\n"
2203 (interpreter python-shell-interpreter
)
2204 (interpreter-arg python-shell-interpreter-interactive-arg
)
2207 ;; TODO: improve error handling by using
2208 ;; `condition-case' and displaying the error message to
2209 ;; the user in the no-prompts warning.
2211 (let ((code-file (python-shell--save-temp-file code
)))
2212 ;; Use `process-file' as it is remote-host friendly.
2220 (delete-file code-file
)))
2224 (dolist (line (split-string output
"\n" t
))
2226 ;; Check if current line is a valid JSON array
2227 (and (string= (substring line
0 2) "[\"")
2229 ;; Return prompts as a list, not vector
2230 (append (json-read-from-string line
) nil
)))))
2231 ;; The list must contain 3 strings, where the first
2232 ;; is the input prompt, the second is the block
2233 ;; prompt and the last one is the output prompt. The
2234 ;; input prompt is the only one that can't be empty.
2235 (when (and (= (length res
) 3)
2236 (cl-every #'stringp res
)
2237 (not (string= (car res
) "")))
2238 (throw 'prompts res
))))
2240 (when (and (not prompts
)
2241 python-shell-prompt-detect-failure-warning
)
2243 '(python python-shell-prompt-regexp
)
2246 "Python shell prompts cannot be detected.\n"
2247 "If your emacs session hangs when starting python shells\n"
2248 "recover with `keyboard-quit' and then try fixing the\n"
2249 "interactive flag for your interpreter by adjusting the\n"
2250 "`python-shell-interpreter-interactive-arg' or add regexps\n"
2251 "matching shell prompts in the directory-local friendly vars:\n"
2252 " + `python-shell-prompt-regexp'\n"
2253 " + `python-shell-prompt-block-regexp'\n"
2254 " + `python-shell-prompt-output-regexp'\n"
2255 "Or alternatively in:\n"
2256 " + `python-shell-prompt-input-regexps'\n"
2257 " + `python-shell-prompt-output-regexps'")))
2260 (defun python-shell-prompt-validate-regexps ()
2261 "Validate all user provided regexps for prompts.
2262 Signals `user-error' if any of these vars contain invalid
2263 regexps: `python-shell-prompt-regexp',
2264 `python-shell-prompt-block-regexp',
2265 `python-shell-prompt-pdb-regexp',
2266 `python-shell-prompt-output-regexp',
2267 `python-shell-prompt-input-regexps',
2268 `python-shell-prompt-output-regexps'."
2269 (dolist (symbol (list 'python-shell-prompt-input-regexps
2270 'python-shell-prompt-output-regexps
2271 'python-shell-prompt-regexp
2272 'python-shell-prompt-block-regexp
2273 'python-shell-prompt-pdb-regexp
2274 'python-shell-prompt-output-regexp
))
2275 (dolist (regexp (let ((regexps (symbol-value symbol
)))
2279 (when (not (python-util-valid-regexp-p regexp
))
2280 (user-error "Invalid regexp %s in `%s'"
2283 (defun python-shell-prompt-set-calculated-regexps ()
2284 "Detect and set input and output prompt regexps.
2285 Build and set the values for `python-shell-input-prompt-regexp'
2286 and `python-shell-output-prompt-regexp' using the values from
2287 `python-shell-prompt-regexp', `python-shell-prompt-block-regexp',
2288 `python-shell-prompt-pdb-regexp',
2289 `python-shell-prompt-output-regexp',
2290 `python-shell-prompt-input-regexps',
2291 `python-shell-prompt-output-regexps' and detected prompts from
2292 `python-shell-prompt-detect'."
2293 (when (not (and python-shell--prompt-calculated-input-regexp
2294 python-shell--prompt-calculated-output-regexp
))
2295 (let* ((detected-prompts (python-shell-prompt-detect))
2297 (output-prompts nil
)
2301 (mapconcat #'identity
2304 (let ((length-a (length a
))
2305 (length-b (length b
)))
2306 (if (= length-a length-b
)
2308 (> (length a
) (length b
))))))
2311 ;; Validate ALL regexps
2312 (python-shell-prompt-validate-regexps)
2313 ;; Collect all user defined input prompts
2314 (dolist (prompt (append python-shell-prompt-input-regexps
2315 (list python-shell-prompt-regexp
2316 python-shell-prompt-block-regexp
2317 python-shell-prompt-pdb-regexp
)))
2318 (cl-pushnew prompt input-prompts
:test
#'string
=))
2319 ;; Collect all user defined output prompts
2320 (dolist (prompt (cons python-shell-prompt-output-regexp
2321 python-shell-prompt-output-regexps
))
2322 (cl-pushnew prompt output-prompts
:test
#'string
=))
2323 ;; Collect detected prompts if any
2324 (when detected-prompts
2325 (dolist (prompt (butlast detected-prompts
))
2326 (setq prompt
(regexp-quote prompt
))
2327 (cl-pushnew prompt input-prompts
:test
#'string
=))
2328 (cl-pushnew (regexp-quote
2329 (car (last detected-prompts
)))
2330 output-prompts
:test
#'string
=))
2331 ;; Set input and output prompt regexps from collected prompts
2332 (setq python-shell--prompt-calculated-input-regexp
2333 (funcall build-regexp input-prompts
)
2334 python-shell--prompt-calculated-output-regexp
2335 (funcall build-regexp output-prompts
)))))
2337 (defun python-shell-get-process-name (dedicated)
2338 "Calculate the appropriate process name for inferior Python process.
2339 If DEDICATED is t returns a string with the form
2340 `python-shell-buffer-name'[`buffer-name'] else returns the value
2341 of `python-shell-buffer-name'."
2343 (format "%s[%s]" python-shell-buffer-name
(buffer-name))
2344 python-shell-buffer-name
))
2346 (defun python-shell-internal-get-process-name ()
2347 "Calculate the appropriate process name for Internal Python process.
2348 The name is calculated from `python-shell-global-buffer-name' and
2350 (format "%s[%s]" python-shell-internal-buffer-name
(buffer-name)))
2352 (defun python-shell-calculate-command ()
2353 "Calculate the string used to execute the inferior Python process."
2355 (shell-quote-argument python-shell-interpreter
)
2356 python-shell-interpreter-args
))
2358 (define-obsolete-function-alias
2359 'python-shell-parse-command
2360 #'python-shell-calculate-command
"25.1")
2362 (defvar python-shell--package-depth
10)
2364 (defun python-shell-package-enable (directory package
)
2365 "Add DIRECTORY parent to $PYTHONPATH and enable PACKAGE."
2367 (let* ((dir (expand-file-name
2368 (read-directory-name
2370 (file-name-directory
2371 (or (buffer-file-name) default-directory
)))))
2372 (name (completing-read
2374 (python-util-list-packages
2375 dir python-shell--package-depth
))))
2377 (python-shell-send-string
2380 "import os.path;import sys;"
2381 "sys.path.append(os.path.dirname(os.path.dirname('''%s''')));"
2382 "__package__ = '''%s''';"
2384 directory package package
)
2385 (python-shell-get-process)))
2387 (defun python-shell-accept-process-output (process &optional timeout regexp
)
2388 "Accept PROCESS output with TIMEOUT until REGEXP is found.
2389 Optional argument TIMEOUT is the timeout argument to
2390 `accept-process-output' calls. Optional argument REGEXP
2391 overrides the regexp to match the end of output, defaults to
2392 `comint-prompt-regexp.'. Returns non-nil when output was
2395 This utility is useful in situations where the output may be
2396 received in chunks, since `accept-process-output' gives no
2397 guarantees they will be grabbed in a single call. An example use
2398 case for this would be the CPython shell start-up, where the
2399 banner and the initial prompt are received separately."
2400 (let ((regexp (or regexp comint-prompt-regexp
)))
2403 (when (not (accept-process-output process timeout
))
2406 regexp
(car (python-util-comint-last-prompt)))
2407 (throw 'found t
))))))
2409 (defun python-shell-comint-end-of-output-p (output)
2410 "Return non-nil if OUTPUT is ends with input prompt."
2412 ;; XXX: It seems on OSX an extra carriage return is attached
2413 ;; at the end of output, this handles that too.
2416 ;; Remove initial caret from calculated regexp
2417 (replace-regexp-in-string
2418 (rx string-start ?^
) ""
2419 python-shell--prompt-calculated-input-regexp
)
2423 (define-obsolete-function-alias
2424 'python-comint-output-filter-function
2425 'ansi-color-filter-apply
2428 (defun python-comint-postoutput-scroll-to-bottom (output)
2429 "Faster version of `comint-postoutput-scroll-to-bottom'.
2430 Avoids `recenter' calls until OUTPUT is completely sent."
2431 (when (and (not (string= "" output
))
2432 (python-shell-comint-end-of-output-p
2433 (ansi-color-filter-apply output
)))
2434 (comint-postoutput-scroll-to-bottom output
))
2437 (defvar python-shell--parent-buffer nil
)
2439 (defmacro python-shell-with-shell-buffer
(&rest body
)
2440 "Execute the forms in BODY with the shell buffer temporarily current.
2441 Signals an error if no shell buffer is available for current buffer."
2442 (declare (indent 0) (debug t
))
2443 (let ((shell-process (make-symbol "shell-process")))
2444 `(let ((,shell-process
(python-shell-get-process-or-error)))
2445 (with-current-buffer (process-buffer ,shell-process
)
2448 (defvar python-shell--font-lock-buffer nil
)
2450 (defun python-shell-font-lock-get-or-create-buffer ()
2451 "Get or create a font-lock buffer for current inferior process."
2452 (python-shell-with-shell-buffer
2453 (if python-shell--font-lock-buffer
2454 python-shell--font-lock-buffer
2456 (process-name (get-buffer-process (current-buffer)))))
2457 (generate-new-buffer
2458 (format " *%s-font-lock*" process-name
))))))
2460 (defun python-shell-font-lock-kill-buffer ()
2461 "Kill the font-lock buffer safely."
2462 (when (and python-shell--font-lock-buffer
2463 (buffer-live-p python-shell--font-lock-buffer
))
2464 (kill-buffer python-shell--font-lock-buffer
)
2465 (when (derived-mode-p 'inferior-python-mode
)
2466 (setq python-shell--font-lock-buffer nil
))))
2468 (defmacro python-shell-font-lock-with-font-lock-buffer
(&rest body
)
2469 "Execute the forms in BODY in the font-lock buffer.
2470 The value returned is the value of the last form in BODY. See
2471 also `with-current-buffer'."
2472 (declare (indent 0) (debug t
))
2473 `(python-shell-with-shell-buffer
2474 (save-current-buffer
2475 (when (not (and python-shell--font-lock-buffer
2476 (get-buffer python-shell--font-lock-buffer
)))
2477 (setq python-shell--font-lock-buffer
2478 (python-shell-font-lock-get-or-create-buffer)))
2479 (set-buffer python-shell--font-lock-buffer
)
2480 (when (not font-lock-mode
)
2482 (set (make-local-variable 'delay-mode-hooks
) t
)
2483 (let ((python-indent-guess-indent-offset nil
))
2484 (when (not (derived-mode-p 'python-mode
))
2488 (defun python-shell-font-lock-cleanup-buffer ()
2489 "Cleanup the font-lock buffer.
2490 Provided as a command because this might be handy if something
2491 goes wrong and syntax highlighting in the shell gets messed up."
2493 (python-shell-with-shell-buffer
2494 (python-shell-font-lock-with-font-lock-buffer
2497 (defun python-shell-font-lock-comint-output-filter-function (output)
2498 "Clean up the font-lock buffer after any OUTPUT."
2499 (if (and (not (string= "" output
))
2500 ;; Is end of output and is not just a prompt.
2502 (python-shell-comint-end-of-output-p
2503 (ansi-color-filter-apply output
))
2505 ;; If output is other than an input prompt then "real" output has
2506 ;; been received and the font-lock buffer must be cleaned up.
2507 (python-shell-font-lock-cleanup-buffer)
2508 ;; Otherwise just add a newline.
2509 (python-shell-font-lock-with-font-lock-buffer
2510 (goto-char (point-max))
2514 (defun python-shell-font-lock-post-command-hook ()
2515 "Fontifies current line in shell buffer."
2516 (let ((prompt-end (cdr (python-util-comint-last-prompt))))
2517 (when (and prompt-end
(> (point) prompt-end
)
2518 (process-live-p (get-buffer-process (current-buffer))))
2519 (let* ((input (buffer-substring-no-properties
2520 prompt-end
(point-max)))
2521 (deactivate-mark nil
)
2522 (start-pos prompt-end
)
2523 (buffer-undo-list t
)
2524 (font-lock-buffer-pos nil
)
2526 (python-shell-font-lock-with-font-lock-buffer
2527 (delete-region (line-beginning-position)
2529 (setq font-lock-buffer-pos
(point))
2531 ;; Ensure buffer is fontified, keeping it
2532 ;; compatible with Emacs < 24.4.
2533 (if (fboundp 'font-lock-ensure
)
2534 (funcall 'font-lock-ensure
)
2535 (font-lock-default-fontify-buffer))
2536 (buffer-substring font-lock-buffer-pos
2538 (replacement-length (length replacement
))
2540 ;; Inject text properties to get input fontified.
2541 (while (not (= i replacement-length
))
2542 (let* ((plist (text-properties-at i replacement
))
2543 (next-change (or (next-property-change i replacement
)
2544 replacement-length
))
2545 (plist (let ((face (plist-get plist
'face
)))
2548 ;; Replace FACE text properties with
2549 ;; FONT-LOCK-FACE so input is fontified.
2550 (plist-put plist
'face nil
)
2551 (plist-put plist
'font-lock-face face
)))))
2552 (set-text-properties
2553 (+ start-pos i
) (+ start-pos next-change
) plist
)
2554 (setq i next-change
)))))))
2556 (defun python-shell-font-lock-turn-on (&optional msg
)
2557 "Turn on shell font-lock.
2558 With argument MSG show activation message."
2560 (python-shell-with-shell-buffer
2561 (python-shell-font-lock-kill-buffer)
2562 (set (make-local-variable 'python-shell--font-lock-buffer
) nil
)
2563 (add-hook 'post-command-hook
2564 #'python-shell-font-lock-post-command-hook nil
'local
)
2565 (add-hook 'kill-buffer-hook
2566 #'python-shell-font-lock-kill-buffer nil
'local
)
2567 (add-hook 'comint-output-filter-functions
2568 #'python-shell-font-lock-comint-output-filter-function
2571 (message "Shell font-lock is enabled"))))
2573 (defun python-shell-font-lock-turn-off (&optional msg
)
2574 "Turn off shell font-lock.
2575 With argument MSG show deactivation message."
2577 (python-shell-with-shell-buffer
2578 (python-shell-font-lock-kill-buffer)
2579 (when (python-util-comint-last-prompt)
2580 ;; Cleanup current fontification
2581 (remove-text-properties
2582 (cdr (python-util-comint-last-prompt))
2584 '(face nil font-lock-face nil
)))
2585 (set (make-local-variable 'python-shell--font-lock-buffer
) nil
)
2586 (remove-hook 'post-command-hook
2587 #'python-shell-font-lock-post-command-hook
'local
)
2588 (remove-hook 'kill-buffer-hook
2589 #'python-shell-font-lock-kill-buffer
'local
)
2590 (remove-hook 'comint-output-filter-functions
2591 #'python-shell-font-lock-comint-output-filter-function
2594 (message "Shell font-lock is disabled"))))
2596 (defun python-shell-font-lock-toggle (&optional msg
)
2597 "Toggle font-lock for shell.
2598 With argument MSG show activation/deactivation message."
2600 (python-shell-with-shell-buffer
2601 (set (make-local-variable 'python-shell-font-lock-enable
)
2602 (not python-shell-font-lock-enable
))
2603 (if python-shell-font-lock-enable
2604 (python-shell-font-lock-turn-on msg
)
2605 (python-shell-font-lock-turn-off msg
))
2606 python-shell-font-lock-enable
))
2608 (defvar python-shell--first-prompt-received-output-buffer nil
)
2609 (defvar python-shell--first-prompt-received nil
)
2611 (defcustom python-shell-first-prompt-hook nil
2612 "Hook run upon first (non-pdb) shell prompt detection.
2613 This is the place for shell setup functions that need to wait for
2614 output. Since the first prompt is ensured, this helps the
2615 current process to not hang waiting for output by safeguarding
2616 interactive actions can be performed. This is useful to safely
2617 attach setup code for long-running processes that eventually
2622 (defun python-shell-comint-watch-for-first-prompt-output-filter (output)
2623 "Run `python-shell-first-prompt-hook' when first prompt is found in OUTPUT."
2624 (when (not python-shell--first-prompt-received
)
2625 (set (make-local-variable 'python-shell--first-prompt-received-output-buffer
)
2626 (concat python-shell--first-prompt-received-output-buffer
2627 (ansi-color-filter-apply output
)))
2628 (when (python-shell-comint-end-of-output-p
2629 python-shell--first-prompt-received-output-buffer
)
2631 (concat python-shell-prompt-pdb-regexp
(rx eos
))
2632 (or python-shell--first-prompt-received-output-buffer
""))
2633 ;; Skip pdb prompts and reset the buffer.
2634 (setq python-shell--first-prompt-received-output-buffer nil
)
2635 (set (make-local-variable 'python-shell--first-prompt-received
) t
)
2636 (setq python-shell--first-prompt-received-output-buffer nil
)
2637 (with-current-buffer (current-buffer)
2638 (let ((inhibit-quit nil
))
2639 (run-hooks 'python-shell-first-prompt-hook
))))))
2642 ;; Used to hold user interactive overrides to
2643 ;; `python-shell-interpreter' and `python-shell-interpreter-args' that
2644 ;; will be made buffer-local by `inferior-python-mode':
2645 (defvar python-shell--interpreter
)
2646 (defvar python-shell--interpreter-args
)
2648 (define-derived-mode inferior-python-mode comint-mode
"Inferior Python"
2649 "Major mode for Python inferior process.
2650 Runs a Python interpreter as a subprocess of Emacs, with Python
2651 I/O through an Emacs buffer. Variables `python-shell-interpreter'
2652 and `python-shell-interpreter-args' control which Python
2653 interpreter is run. Variables
2654 `python-shell-prompt-regexp',
2655 `python-shell-prompt-output-regexp',
2656 `python-shell-prompt-block-regexp',
2657 `python-shell-font-lock-enable',
2658 `python-shell-completion-setup-code',
2659 `python-shell-completion-string-code',
2660 `python-eldoc-setup-code', `python-eldoc-string-code',
2661 `python-ffap-setup-code' and `python-ffap-string-code' can
2662 customize this mode for different Python interpreters.
2664 This mode resets `comint-output-filter-functions' locally, so you
2665 may want to re-add custom functions to it using the
2666 `inferior-python-mode-hook'.
2668 You can also add additional setup code to be run at
2669 initialization of the interpreter via `python-shell-setup-codes'
2672 \(Type \\[describe-mode] in the process buffer for a list of commands.)"
2673 (when python-shell--parent-buffer
2674 (python-util-clone-local-variables python-shell--parent-buffer
))
2675 ;; Users can interactively override default values for
2676 ;; `python-shell-interpreter' and `python-shell-interpreter-args'
2677 ;; when calling `run-python'. This ensures values let-bound in
2678 ;; `python-shell-make-comint' are locally set if needed.
2679 (set (make-local-variable 'python-shell-interpreter
)
2680 (or python-shell--interpreter python-shell-interpreter
))
2681 (set (make-local-variable 'python-shell-interpreter-args
)
2682 (or python-shell--interpreter-args python-shell-interpreter-args
))
2683 (set (make-local-variable 'python-shell--prompt-calculated-input-regexp
) nil
)
2684 (set (make-local-variable 'python-shell--prompt-calculated-output-regexp
) nil
)
2685 (python-shell-prompt-set-calculated-regexps)
2686 (setq comint-prompt-regexp python-shell--prompt-calculated-input-regexp
)
2687 (set (make-local-variable 'comint-prompt-read-only
) t
)
2688 (setq mode-line-process
'(":%s"))
2689 (set (make-local-variable 'comint-output-filter-functions
)
2690 '(ansi-color-process-output
2691 python-shell-comint-watch-for-first-prompt-output-filter
2692 python-pdbtrack-comint-output-filter-function
2693 python-comint-postoutput-scroll-to-bottom
))
2694 (set (make-local-variable 'compilation-error-regexp-alist
)
2695 python-shell-compilation-regexp-alist
)
2696 (add-hook 'completion-at-point-functions
2697 #'python-shell-completion-at-point nil
'local
)
2698 (define-key inferior-python-mode-map
"\t"
2699 'python-shell-completion-complete-or-indent
)
2700 (make-local-variable 'python-pdbtrack-buffers-to-kill
)
2701 (make-local-variable 'python-pdbtrack-tracked-buffer
)
2702 (make-local-variable 'python-shell-internal-last-output
)
2703 (when python-shell-font-lock-enable
2704 (python-shell-font-lock-turn-on))
2705 (compilation-shell-minor-mode 1))
2707 (defun python-shell-make-comint (cmd proc-name
&optional show internal
)
2708 "Create a Python shell comint buffer.
2709 CMD is the Python command to be executed and PROC-NAME is the
2710 process name the comint buffer will get. After the comint buffer
2711 is created the `inferior-python-mode' is activated. When
2712 optional argument SHOW is non-nil the buffer is shown. When
2713 optional argument INTERNAL is non-nil this process is run on a
2714 buffer with a name that starts with a space, following the Emacs
2715 convention for temporary/internal buffers, and also makes sure
2716 the user is not queried for confirmation when the process is
2719 (python-shell-with-environment
2720 (let* ((proc-buffer-name
2721 (format (if (not internal
) "*%s*" " *%s*") proc-name
)))
2722 (when (not (comint-check-proc proc-buffer-name
))
2723 (let* ((cmdlist (split-string-and-unquote cmd
))
2724 (interpreter (car cmdlist
))
2725 (args (cdr cmdlist
))
2726 (buffer (apply #'make-comint-in-buffer proc-name proc-buffer-name
2727 interpreter nil args
))
2728 (python-shell--parent-buffer (current-buffer))
2729 (process (get-buffer-process buffer
))
2730 ;; Users can override the interpreter and args
2731 ;; interactively when calling `run-python', let-binding
2732 ;; these allows to have the new right values in all
2733 ;; setup code that is done in `inferior-python-mode',
2734 ;; which is important, especially for prompt detection.
2735 (python-shell--interpreter interpreter
)
2736 (python-shell--interpreter-args
2737 (mapconcat #'identity args
" ")))
2738 (with-current-buffer buffer
2739 (inferior-python-mode))
2740 (when show
(display-buffer buffer
))
2741 (and internal
(set-process-query-on-exit-flag process nil
))))
2742 proc-buffer-name
))))
2745 (defun run-python (&optional cmd dedicated show
)
2746 "Run an inferior Python process.
2748 Argument CMD defaults to `python-shell-calculate-command' return
2749 value. When called interactively with `prefix-arg', it allows
2750 the user to edit such value and choose whether the interpreter
2751 should be DEDICATED for the current buffer. When numeric prefix
2752 arg is other than 0 or 4 do not SHOW.
2754 For a given buffer and same values of DEDICATED, if a process is
2755 already running for it, it will do nothing. This means that if
2756 the current buffer is using a global process, the user is still
2757 able to switch it to use a dedicated one.
2759 Runs the hook `inferior-python-mode-hook' after
2760 `comint-mode-hook' is run. (Type \\[describe-mode] in the
2761 process buffer for a list of commands.)"
2763 (if current-prefix-arg
2765 (read-shell-command "Run Python: " (python-shell-calculate-command))
2766 (y-or-n-p "Make dedicated process? ")
2767 (= (prefix-numeric-value current-prefix-arg
) 4))
2768 (list (python-shell-calculate-command) nil t
)))
2770 (python-shell-make-comint
2771 (or cmd
(python-shell-calculate-command))
2772 (python-shell-get-process-name dedicated
) show
)))
2774 (defun run-python-internal ()
2775 "Run an inferior Internal Python process.
2776 Input and output via buffer named after
2777 `python-shell-internal-buffer-name' and what
2778 `python-shell-internal-get-process-name' returns.
2780 This new kind of shell is intended to be used for generic
2781 communication related to defined configurations; the main
2782 difference with global or dedicated shells is that these ones are
2783 attached to a configuration, not a buffer. This means that can
2784 be used for example to retrieve the sys.path and other stuff,
2785 without messing with user shells. Note that
2786 `python-shell-font-lock-enable' and `inferior-python-mode-hook'
2787 are set to nil for these shells, so setup codes are not sent at
2789 (let ((python-shell-font-lock-enable nil
)
2790 (inferior-python-mode-hook nil
))
2792 (python-shell-make-comint
2793 (python-shell-calculate-command)
2794 (python-shell-internal-get-process-name) nil t
))))
2796 (defun python-shell-get-buffer ()
2797 "Return inferior Python buffer for current buffer.
2798 If current buffer is in `inferior-python-mode', return it."
2799 (if (derived-mode-p 'inferior-python-mode
)
2801 (let* ((dedicated-proc-name (python-shell-get-process-name t
))
2802 (dedicated-proc-buffer-name (format "*%s*" dedicated-proc-name
))
2803 (global-proc-name (python-shell-get-process-name nil
))
2804 (global-proc-buffer-name (format "*%s*" global-proc-name
))
2805 (dedicated-running (comint-check-proc dedicated-proc-buffer-name
))
2806 (global-running (comint-check-proc global-proc-buffer-name
)))
2807 ;; Always prefer dedicated
2808 (or (and dedicated-running dedicated-proc-buffer-name
)
2809 (and global-running global-proc-buffer-name
)))))
2811 (defun python-shell-get-process ()
2812 "Return inferior Python process for current buffer."
2813 (get-buffer-process (python-shell-get-buffer)))
2815 (defun python-shell-get-process-or-error (&optional interactivep
)
2816 "Return inferior Python process for current buffer or signal error.
2817 When argument INTERACTIVEP is non-nil, use `user-error' instead
2818 of `error' with a user-friendly message."
2819 (or (python-shell-get-process)
2822 "Start a Python process first with ‘%s’ or ‘%s’."
2823 (substitute-command-keys "\\[run-python]")
2827 #'run-python overriding-local-map t
)))
2829 "No inferior Python process running."))))
2831 (defun python-shell-get-or-create-process (&optional cmd dedicated show
)
2832 "Get or create an inferior Python process for current buffer and return it.
2833 Arguments CMD, DEDICATED and SHOW are those of `run-python' and
2834 are used to start the shell. If those arguments are not
2835 provided, `run-python' is called interactively and the user will
2836 be asked for their values."
2837 (let ((shell-process (python-shell-get-process)))
2838 (when (not shell-process
)
2840 ;; XXX: Refactor code such that calling `run-python'
2841 ;; interactively is not needed anymore.
2842 (call-interactively 'run-python
)
2843 (run-python cmd dedicated show
)))
2844 (or shell-process
(python-shell-get-process))))
2847 #'python-shell-get-or-create-process
2848 "Instead call `python-shell-get-process' and create one if returns nil."
2851 (defvar python-shell-internal-buffer nil
2852 "Current internal shell buffer for the current buffer.
2853 This is really not necessary at all for the code to work but it's
2854 there for compatibility with CEDET.")
2856 (defvar python-shell-internal-last-output nil
2857 "Last output captured by the internal shell.
2858 This is really not necessary at all for the code to work but it's
2859 there for compatibility with CEDET.")
2861 (defun python-shell-internal-get-or-create-process ()
2862 "Get or create an inferior Internal Python process."
2863 (let ((proc-name (python-shell-internal-get-process-name)))
2864 (if (process-live-p proc-name
)
2865 (get-process proc-name
)
2866 (run-python-internal))))
2868 (define-obsolete-function-alias
2869 'python-proc
'python-shell-internal-get-or-create-process
"24.3")
2871 (define-obsolete-variable-alias
2872 'python-buffer
'python-shell-internal-buffer
"24.3")
2874 (define-obsolete-variable-alias
2875 'python-preoutput-result
'python-shell-internal-last-output
"24.3")
2877 (defun python-shell--save-temp-file (string)
2878 (let* ((temporary-file-directory
2879 (if (file-remote-p default-directory
)
2880 (concat (file-remote-p default-directory
) "/tmp")
2881 temporary-file-directory
))
2882 (temp-file-name (make-temp-file "py"))
2883 (coding-system-for-write (python-info-encoding)))
2884 (with-temp-file temp-file-name
2886 (delete-trailing-whitespace))
2889 (defun python-shell-send-string (string &optional process msg
)
2890 "Send STRING to inferior Python PROCESS.
2891 When optional argument MSG is non-nil, forces display of a
2892 user-friendly message if there's no process running; defaults to
2893 t when called interactively."
2895 (list (read-string "Python command: ") nil t
))
2896 (let ((process (or process
(python-shell-get-process-or-error msg
))))
2897 (if (string-match ".\n+." string
) ;Multiline.
2898 (let* ((temp-file-name (python-shell--save-temp-file string
))
2899 (file-name (or (buffer-file-name) temp-file-name
)))
2900 (python-shell-send-file file-name process temp-file-name t
))
2901 (comint-send-string process string
)
2902 (when (or (not (string-match "\n\\'" string
))
2903 (string-match "\n[ \t].*\n?\\'" string
))
2904 (comint-send-string process
"\n")))))
2906 (defvar python-shell-output-filter-in-progress nil
)
2907 (defvar python-shell-output-filter-buffer nil
)
2909 (defun python-shell-output-filter (string)
2910 "Filter used in `python-shell-send-string-no-output' to grab output.
2911 STRING is the output received to this point from the process.
2912 This filter saves received output from the process in
2913 `python-shell-output-filter-buffer' and stops receiving it after
2914 detecting a prompt at the end of the buffer."
2916 string
(ansi-color-filter-apply string
)
2917 python-shell-output-filter-buffer
2918 (concat python-shell-output-filter-buffer string
))
2919 (when (python-shell-comint-end-of-output-p
2920 python-shell-output-filter-buffer
)
2921 ;; Output ends when `python-shell-output-filter-buffer' contains
2922 ;; the prompt attached at the end of it.
2923 (setq python-shell-output-filter-in-progress nil
2924 python-shell-output-filter-buffer
2925 (substring python-shell-output-filter-buffer
2926 0 (match-beginning 0)))
2928 python-shell--prompt-calculated-output-regexp
2929 python-shell-output-filter-buffer
)
2930 ;; Some shells, like IPython might append a prompt before the
2931 ;; output, clean that.
2932 (setq python-shell-output-filter-buffer
2933 (substring python-shell-output-filter-buffer
(match-end 0)))))
2936 (defun python-shell-send-string-no-output (string &optional process
)
2937 "Send STRING to PROCESS and inhibit output.
2939 (let ((process (or process
(python-shell-get-process-or-error)))
2940 (comint-preoutput-filter-functions
2941 '(python-shell-output-filter))
2942 (python-shell-output-filter-in-progress t
)
2946 (python-shell-send-string string process
)
2947 (while python-shell-output-filter-in-progress
2948 ;; `python-shell-output-filter' takes care of setting
2949 ;; `python-shell-output-filter-in-progress' to NIL after it
2950 ;; detects end of output.
2951 (accept-process-output process
))
2953 python-shell-output-filter-buffer
2954 (setq python-shell-output-filter-buffer nil
)))
2955 (with-current-buffer (process-buffer process
)
2956 (comint-interrupt-subjob)))))
2958 (defun python-shell-internal-send-string (string)
2959 "Send STRING to the Internal Python interpreter.
2960 Returns the output. See `python-shell-send-string-no-output'."
2961 ;; XXX Remove `python-shell-internal-last-output' once CEDET is
2962 ;; updated to support this new mode.
2963 (setq python-shell-internal-last-output
2964 (python-shell-send-string-no-output
2965 ;; Makes this function compatible with the old
2966 ;; python-send-receive. (At least for CEDET).
2967 (replace-regexp-in-string "_emacs_out +" "" string
)
2968 (python-shell-internal-get-or-create-process))))
2970 (define-obsolete-function-alias
2971 'python-send-receive
'python-shell-internal-send-string
"24.3")
2973 (define-obsolete-function-alias
2974 'python-send-string
'python-shell-internal-send-string
"24.3")
2976 (defun python-shell-buffer-substring (start end
&optional nomain
)
2977 "Send buffer substring from START to END formatted for shell.
2978 This is a wrapper over `buffer-substring' that takes care of
2979 different transformations for the code sent to be evaluated in
2981 1. When optional argument NOMAIN is non-nil everything under an
2982 \"if __name__ == '__main__'\" block will be removed.
2983 2. When a subregion of the buffer is sent, it takes care of
2984 appending extra empty lines so tracebacks are correct.
2985 3. When the region sent is a substring of the current buffer, a
2986 coding cookie is added.
2987 4. Wraps indented regions under an \"if True:\" block so the
2988 interpreter evaluates them correctly."
2989 (let* ((start (save-excursion
2990 ;; Normalize start to the line beginning position.
2992 (line-beginning-position)))
2993 (substring (buffer-substring-no-properties start end
))
2994 (starts-at-point-min-p (save-restriction
2996 (= (point-min) start
)))
2997 (encoding (python-info-encoding))
2998 (toplevel-p (zerop (save-excursion
3000 (python-util-forward-comment 1)
3001 (current-indentation))))
3002 (fillstr (when (not starts-at-point-min-p
)
3004 (format "# -*- coding: %s -*-\n" encoding
)
3006 ;; Subtract 2 because of the coding cookie.
3007 (- (line-number-at-pos start
) 2) ?
\n)))))
3013 (goto-char (point-min))
3014 (when (not toplevel-p
)
3016 (delete-region (point) (line-end-position)))
3018 (let* ((if-name-main-start-end
3021 (when (python-nav-if-name-main)
3023 (progn (python-nav-forward-sexp-safe)
3024 ;; Include ending newline
3027 ;; Oh destructuring bind, how I miss you.
3028 (if-name-main-start (car if-name-main-start-end
))
3029 (if-name-main-end (cdr if-name-main-start-end
))
3030 (fillstr (make-string
3031 (- (line-number-at-pos if-name-main-end
)
3032 (line-number-at-pos if-name-main-start
)) ?
\n)))
3033 (when if-name-main-start-end
3034 (goto-char if-name-main-start
)
3035 (delete-region if-name-main-start if-name-main-end
)
3037 ;; Ensure there's only one coding cookie in the generated string.
3038 (goto-char (point-min))
3039 (when (looking-at-p (python-rx coding-cookie
))
3041 (when (looking-at-p (python-rx coding-cookie
))
3043 (line-beginning-position) (line-end-position))))
3044 (buffer-substring-no-properties (point-min) (point-max)))))
3046 (defun python-shell-send-region (start end
&optional send-main msg
)
3047 "Send the region delimited by START and END to inferior Python process.
3048 When optional argument SEND-MAIN is non-nil, allow execution of
3049 code inside blocks delimited by \"if __name__== '__main__':\".
3050 When called interactively SEND-MAIN defaults to nil, unless it's
3051 called with prefix argument. When optional argument MSG is
3052 non-nil, forces display of a user-friendly message if there's no
3053 process running; defaults to t when called interactively."
3055 (list (region-beginning) (region-end) current-prefix-arg t
))
3056 (let* ((string (python-shell-buffer-substring start end
(not send-main
)))
3057 (process (python-shell-get-process-or-error msg
))
3058 (original-string (buffer-substring-no-properties start end
))
3059 (_ (string-match "\\`\n*\\(.*\\)" original-string
)))
3060 (message "Sent: %s..." (match-string 1 original-string
))
3061 (python-shell-send-string string process
)))
3063 (defun python-shell-send-buffer (&optional send-main msg
)
3064 "Send the entire buffer to inferior Python process.
3065 When optional argument SEND-MAIN is non-nil, allow execution of
3066 code inside blocks delimited by \"if __name__== '__main__':\".
3067 When called interactively SEND-MAIN defaults to nil, unless it's
3068 called with prefix argument. When optional argument MSG is
3069 non-nil, forces display of a user-friendly message if there's no
3070 process running; defaults to t when called interactively."
3071 (interactive (list current-prefix-arg t
))
3074 (python-shell-send-region (point-min) (point-max) send-main msg
)))
3076 (defun python-shell-send-defun (&optional arg msg
)
3077 "Send the current defun to inferior Python process.
3078 When argument ARG is non-nil do not include decorators. When
3079 optional argument MSG is non-nil, forces display of a
3080 user-friendly message if there's no process running; defaults to
3081 t when called interactively."
3082 (interactive (list current-prefix-arg t
))
3084 (python-shell-send-region
3087 (while (and (or (python-nav-beginning-of-defun)
3088 (beginning-of-line 1))
3089 (> (current-indentation) 0)))
3091 (while (and (forward-line -
1)
3092 (looking-at (python-rx decorator
))))
3096 (or (python-nav-end-of-defun)
3102 (defun python-shell-send-file (file-name &optional process temp-file-name
3104 "Send FILE-NAME to inferior Python PROCESS.
3105 If TEMP-FILE-NAME is passed then that file is used for processing
3106 instead, while internally the shell will continue to use
3107 FILE-NAME. If TEMP-FILE-NAME and DELETE are non-nil, then
3108 TEMP-FILE-NAME is deleted after evaluation is performed. When
3109 optional argument MSG is non-nil, forces display of a
3110 user-friendly message if there's no process running; defaults to
3111 t when called interactively."
3114 (read-file-name "File to send: ") ; file-name
3116 nil
; temp-file-name
3119 (let* ((process (or process
(python-shell-get-process-or-error msg
)))
3120 (encoding (with-temp-buffer
3121 (insert-file-contents
3122 (or temp-file-name file-name
))
3123 (python-info-encoding)))
3124 (file-name (expand-file-name
3125 (or (file-remote-p file-name
'localname
)
3127 (temp-file-name (when temp-file-name
3129 (or (file-remote-p temp-file-name
'localname
)
3131 (python-shell-send-string
3134 "import codecs, os;"
3135 "__pyfile = codecs.open('''%s''', encoding='''%s''');"
3136 "__code = __pyfile.read().encode('''%s''');"
3138 (when (and delete temp-file-name
)
3139 (format "os.remove('''%s''');" temp-file-name
))
3140 "exec(compile(__code, '''%s''', 'exec'));")
3141 (or temp-file-name file-name
) encoding encoding file-name
)
3144 (defun python-shell-switch-to-shell (&optional msg
)
3145 "Switch to inferior Python process buffer.
3146 When optional argument MSG is non-nil, forces display of a
3147 user-friendly message if there's no process running; defaults to
3148 t when called interactively."
3151 (process-buffer (python-shell-get-process-or-error msg
)) nil t
))
3153 (defun python-shell-send-setup-code ()
3154 "Send all setup code for shell.
3155 This function takes the list of setup code to send from the
3156 `python-shell-setup-codes' list."
3157 (when python-shell-setup-codes
3158 (let ((process (python-shell-get-process))
3162 (cond ((stringp elt
) elt
)
3163 ((symbolp elt
) (symbol-value elt
))
3165 python-shell-setup-codes
3166 "\n\nprint ('python.el: sent setup code')"))))
3167 (python-shell-send-string code process
)
3168 (python-shell-accept-process-output process
))))
3170 (add-hook 'python-shell-first-prompt-hook
3171 #'python-shell-send-setup-code
)
3174 ;;; Shell completion
3176 (defcustom python-shell-completion-setup-code
3178 def __PYTHON_EL_get_completions(text):
3189 import builtins as __builtin__
3190 builtins = dir(__builtin__)
3192 is_ipython = ('__IPYTHON__' in builtins or
3193 '__IPYTHON__active' in builtins)
3194 splits = text.split()
3195 is_module = splits and splits[0] in ('from', 'import')
3197 if is_ipython and is_module:
3198 from IPython.core.completerlib import module_completion
3199 completions = module_completion(text.strip())
3200 elif is_ipython and '__IP' in builtins:
3201 completions = __IP.complete(text)
3202 elif is_ipython and 'get_ipython' in builtins:
3203 completions = get_ipython().Completer.all_completions(text)
3205 # Try to reuse current completer.
3206 completer = readline.get_completer()
3208 # importing rlcompleter sets the completer, use it as a
3209 # last resort to avoid breaking customizations.
3211 completer = readline.get_completer()
3212 if getattr(completer, 'PYTHON_EL_WRAPPED', False):
3213 completer.print_mode = False
3216 completion = completer(text, i)
3220 completions.append(completion)
3224 if getattr(completer, 'PYTHON_EL_WRAPPED', False):
3225 completer.print_mode = True
3227 "Code used to setup completion in inferior Python processes."
3231 (defcustom python-shell-completion-string-code
3232 "';'.join(__PYTHON_EL_get_completions('''%s'''))"
3233 "Python code used to get a string of completions separated by semicolons.
3234 The string passed to the function is the current python name or
3235 the full statement in the case of imports."
3239 (define-obsolete-variable-alias
3240 'python-shell-completion-module-string-code
3241 'python-shell-completion-string-code
3243 "Completion string code must also autocomplete modules.")
3245 (define-obsolete-variable-alias
3246 'python-shell-completion-pdb-string-code
3247 'python-shell-completion-string-code
3249 "Completion string code must work for (i)pdb.")
3251 (defcustom python-shell-completion-native-disabled-interpreters
3252 ;; PyPy's readline cannot handle some escape sequences yet.
3254 "List of disabled interpreters.
3255 When a match is found, native completion is disabled."
3256 :type
'(repeat string
))
3258 (defcustom python-shell-completion-native-enable t
3259 "Enable readline based native completion."
3262 (defcustom python-shell-completion-native-output-timeout
5.0
3263 "Time in seconds to wait for completion output before giving up."
3266 (defcustom python-shell-completion-native-try-output-timeout
1.0
3267 "Time in seconds to wait for *trying* native completion output."
3270 (defvar python-shell-completion-native-redirect-buffer
3271 " *Python completions redirect*"
3272 "Buffer to be used to redirect output of readline commands.")
3274 (defun python-shell-completion-native-interpreter-disabled-p ()
3275 "Return non-nil if interpreter has native completion disabled."
3276 (when python-shell-completion-native-disabled-interpreters
3278 (regexp-opt python-shell-completion-native-disabled-interpreters
)
3279 (file-name-nondirectory python-shell-interpreter
))))
3281 (defun python-shell-completion-native-try ()
3282 "Return non-nil if can trigger native completion."
3283 (let ((python-shell-completion-native-enable t
)
3284 (python-shell-completion-native-output-timeout
3285 python-shell-completion-native-try-output-timeout
))
3286 (python-shell-completion-native-get-completions
3287 (get-buffer-process (current-buffer))
3290 (defun python-shell-completion-native-setup ()
3291 "Try to setup native completion, return non-nil on success."
3292 (let ((process (python-shell-get-process)))
3293 (with-current-buffer (process-buffer process
)
3294 (python-shell-send-string "
3295 def __PYTHON_EL_native_completion_setup():
3303 import builtins as __builtin__
3305 builtins = dir(__builtin__)
3306 is_ipython = ('__IPYTHON__' in builtins or
3307 '__IPYTHON__active' in builtins)
3309 class __PYTHON_EL_Completer:
3310 '''Completer wrapper that prints candidates to stdout.
3312 It wraps an existing completer function and changes its behavior so
3313 that the user input is unchanged and real candidates are printed to
3316 Returned candidates are '0__dummy_completion__' and
3317 '1__dummy_completion__' in that order ('0__dummy_completion__' is
3318 returned repeatedly until all possible candidates are consumed).
3320 The real candidates are printed to stdout so that they can be
3321 easily retrieved through comint output redirect trickery.
3324 PYTHON_EL_WRAPPED = True
3326 def __init__(self, completer):
3327 self.completer = completer
3328 self.last_completion = None
3329 self.print_mode = True
3331 def __call__(self, text, state):
3333 # Set the first dummy completion.
3334 self.last_completion = None
3335 completion = '0__dummy_completion__'
3337 completion = self.completer(text, state - 1)
3340 if self.last_completion != '1__dummy_completion__':
3341 # When no more completions are available, returning a
3342 # dummy with non-sharing prefix allow to ensure output
3343 # while preventing changes to current input.
3344 # Coincidentally it's also the end of output.
3345 completion = '1__dummy_completion__'
3346 elif completion.endswith('('):
3347 # Remove parens on callables as it breaks completion on
3348 # arguments (e.g. str(Ari<tab>)).
3349 completion = completion[:-1]
3350 self.last_completion = completion
3353 '0__dummy_completion__', '1__dummy_completion__'):
3356 # For every non-dummy completion, return a repeated dummy
3357 # one and print the real candidate so it can be retrieved
3358 # by comint output filters.
3361 return '0__dummy_completion__'
3367 completer = readline.get_completer()
3370 # Used as last resort to avoid breaking customizations.
3372 completer = readline.get_completer()
3374 if completer and not getattr(completer, 'PYTHON_EL_WRAPPED', False):
3375 # Wrap the existing completer function only once.
3376 new_completer = __PYTHON_EL_Completer(completer)
3378 readline.set_completer(new_completer)
3380 # Try both initializations to cope with all IPython versions.
3381 # This works fine for IPython 3.x but not for earlier:
3382 readline.set_completer(new_completer)
3383 # IPython<3 hacks readline such that `readline.set_completer`
3384 # won't work. This workaround injects the new completer
3385 # function into the existing instance directly:
3386 instance = getattr(completer, 'im_self', completer.__self__)
3387 instance.rlcomplete = new_completer
3389 if readline.__doc__ and 'libedit' in readline.__doc__:
3390 readline.parse_and_bind('bind ^I rl_complete')
3392 readline.parse_and_bind('tab: complete')
3393 # Require just one tab to send output.
3394 readline.parse_and_bind('set show-all-if-ambiguous on')
3396 print ('python.el: native completion setup loaded')
3398 print ('python.el: native completion setup failed')
3400 __PYTHON_EL_native_completion_setup()" process
)
3402 (python-shell-accept-process-output
3403 process python-shell-completion-native-try-output-timeout
)
3406 (regexp-quote "python.el: native completion setup loaded") nil t
1)))
3407 (python-shell-completion-native-try)))))
3409 (defun python-shell-completion-native-turn-off (&optional msg
)
3410 "Turn off shell native completions.
3411 With argument MSG show deactivation message."
3413 (python-shell-with-shell-buffer
3414 (set (make-local-variable 'python-shell-completion-native-enable
) nil
)
3416 (message "Shell native completion is disabled, using fallback"))))
3418 (defun python-shell-completion-native-turn-on (&optional msg
)
3419 "Turn on shell native completions.
3420 With argument MSG show deactivation message."
3422 (python-shell-with-shell-buffer
3423 (set (make-local-variable 'python-shell-completion-native-enable
) t
)
3424 (python-shell-completion-native-turn-on-maybe msg
)))
3426 (defun python-shell-completion-native-turn-on-maybe (&optional msg
)
3427 "Turn on native completions if enabled and available.
3428 With argument MSG show activation/deactivation message."
3430 (python-shell-with-shell-buffer
3431 (when python-shell-completion-native-enable
3433 ((python-shell-completion-native-interpreter-disabled-p)
3434 (python-shell-completion-native-turn-off msg
))
3435 ((python-shell-completion-native-setup)
3437 (message "Shell native completion is enabled.")))
3439 '(python python-shell-completion-native-turn-on-maybe
)
3442 "Your `python-shell-interpreter' doesn't seem to "
3443 "support readline, yet `python-shell-completion-native' "
3444 (format "was t and %S is not part of the "
3445 (file-name-nondirectory python-shell-interpreter
))
3446 "`python-shell-completion-native-disabled-interpreters' "
3447 "list. Native completions have been disabled locally. "))
3448 (python-shell-completion-native-turn-off msg
))))))
3450 (defun python-shell-completion-native-turn-on-maybe-with-msg ()
3451 "Like `python-shell-completion-native-turn-on-maybe' but force messages."
3452 (python-shell-completion-native-turn-on-maybe t
))
3454 (add-hook 'python-shell-first-prompt-hook
3455 #'python-shell-completion-native-turn-on-maybe-with-msg
)
3457 (defun python-shell-completion-native-toggle (&optional msg
)
3458 "Toggle shell native completion.
3459 With argument MSG show activation/deactivation message."
3461 (python-shell-with-shell-buffer
3462 (if python-shell-completion-native-enable
3463 (python-shell-completion-native-turn-off msg
)
3464 (python-shell-completion-native-turn-on msg
))
3465 python-shell-completion-native-enable
))
3467 (defun python-shell-completion-native-get-completions (process import input
)
3468 "Get completions using native readline for PROCESS.
3469 When IMPORT is non-nil takes precedence over INPUT for
3471 (with-current-buffer (process-buffer process
)
3472 (let* ((input (or import input
))
3473 (original-filter-fn (process-filter process
))
3474 (redirect-buffer (get-buffer-create
3475 python-shell-completion-native-redirect-buffer
))
3477 (new-input (concat input trigger
))
3480 (+ (- (point-max) (comint-bol)) (length new-input
))))
3481 (delete-line-command (make-string input-length ?
\b))
3482 (input-to-send (concat new-input delete-line-command
)))
3483 ;; Ensure restoring the process filter, even if the user quits
3484 ;; or there's some other error.
3486 (with-current-buffer redirect-buffer
3487 ;; Cleanup the redirect buffer
3489 ;; Mimic `comint-redirect-send-command', unfortunately it
3490 ;; can't be used here because it expects a newline in the
3491 ;; command and that's exactly what we are trying to avoid.
3492 (let ((comint-redirect-echo-input nil
)
3493 (comint-redirect-completed nil
)
3494 (comint-redirect-perform-sanity-check nil
)
3495 (comint-redirect-insert-matching-regexp t
)
3496 (comint-redirect-finished-regexp
3497 "1__dummy_completion__[[:space:]]*\n")
3498 (comint-redirect-output-buffer redirect-buffer
))
3499 ;; Compatibility with Emacs 24.x. Comint changed and
3500 ;; now `comint-redirect-filter' gets 3 args. This
3501 ;; checks which version of `comint-redirect-filter' is
3502 ;; in use based on its args and uses `apply-partially'
3503 ;; to make it up for the 3 args case.
3505 (help-function-arglist 'comint-redirect-filter
)) 3)
3507 process
(apply-partially
3508 #'comint-redirect-filter original-filter-fn
))
3509 (set-process-filter process
#'comint-redirect-filter
))
3510 (process-send-string process input-to-send
)
3511 ;; Grab output until our dummy completion used as
3512 ;; output end marker is found.
3513 (when (python-shell-accept-process-output
3514 process python-shell-completion-native-output-timeout
3515 comint-redirect-finished-regexp
)
3516 (re-search-backward "0__dummy_completion__" nil t
)
3517 (cl-remove-duplicates
3519 (buffer-substring-no-properties
3520 (line-beginning-position) (point-min))
3521 "[ \f\t\n\r\v()]+" t
)
3523 (set-process-filter process original-filter-fn
)))))
3525 (defun python-shell-completion-get-completions (process import input
)
3526 "Do completion at point using PROCESS for IMPORT or INPUT.
3527 When IMPORT is non-nil takes precedence over INPUT for
3529 (setq input
(or import input
))
3530 (with-current-buffer (process-buffer process
)
3532 (python-util-strip-string
3533 (python-shell-send-string-no-output
3535 (concat python-shell-completion-setup-code
3536 "\nprint (" python-shell-completion-string-code
")")
3538 (when (> (length completions
) 2)
3539 (split-string completions
3540 "^'\\|^\"\\|;\\|'$\\|\"$" t
)))))
3542 (defun python-shell-completion-at-point (&optional process
)
3543 "Function for `completion-at-point-functions' in `inferior-python-mode'.
3544 Optional argument PROCESS forces completions to be retrieved
3545 using that one instead of current buffer's process."
3546 (setq process
(or process
(get-buffer-process (current-buffer))))
3547 (let* ((line-start (if (derived-mode-p 'inferior-python-mode
)
3548 ;; Working on a shell buffer: use prompt end.
3549 (cdr (python-util-comint-last-prompt))
3550 (line-beginning-position)))
3552 (when (string-match-p
3553 (rx (* space
) word-start
(or "from" "import") word-end space
)
3554 (buffer-substring-no-properties line-start
(point)))
3555 (buffer-substring-no-properties line-start
(point))))
3558 (if (not (re-search-backward
3560 (or whitespace open-paren close-paren string-delimiter
))
3564 (forward-char (length (match-string-no-properties 0)))
3567 (prompt-boundaries (python-util-comint-last-prompt))
3569 (with-current-buffer (process-buffer process
)
3570 (when prompt-boundaries
3571 (buffer-substring-no-properties
3572 (car prompt-boundaries
) (cdr prompt-boundaries
)))))
3574 (with-current-buffer (process-buffer process
)
3575 (cond ((or (null prompt
)
3576 (< (point) (cdr prompt-boundaries
)))
3578 ((or (not python-shell-completion-native-enable
)
3579 ;; Even if native completion is enabled, for
3580 ;; pdb interaction always use the fallback
3581 ;; mechanism since the completer is changed.
3582 ;; Also, since pdb interaction is single-line
3583 ;; based, this is enough.
3584 (string-match-p python-shell-prompt-pdb-regexp prompt
))
3585 #'python-shell-completion-get-completions
)
3586 (t #'python-shell-completion-native-get-completions
)))))
3588 (completion-table-dynamic
3591 process import-statement
)))))
3593 (define-obsolete-function-alias
3594 'python-shell-completion-complete-at-point
3595 'python-shell-completion-at-point
3598 (defun python-shell-completion-complete-or-indent ()
3599 "Complete or indent depending on the context.
3600 If content before pointer is all whitespace, indent.
3601 If not try to complete."
3603 (if (string-match "^[[:space:]]*$"
3604 (buffer-substring (comint-line-beginning-position)
3606 (indent-for-tab-command)
3607 (completion-at-point)))
3610 ;;; PDB Track integration
3612 (defcustom python-pdbtrack-activate t
3613 "Non-nil makes Python shell enable pdbtracking."
3618 (defcustom python-pdbtrack-stacktrace-info-regexp
3619 "> \\([^\"(<]+\\)(\\([0-9]+\\))\\([?a-zA-Z0-9_<>]+\\)()"
3620 "Regular expression matching stacktrace information.
3621 Used to extract the current line and module being inspected."
3626 (defvar python-pdbtrack-tracked-buffer nil
3627 "Variable containing the value of the current tracked buffer.
3628 Never set this variable directly, use
3629 `python-pdbtrack-set-tracked-buffer' instead.")
3631 (defvar python-pdbtrack-buffers-to-kill nil
3632 "List of buffers to be deleted after tracking finishes.")
3634 (defun python-pdbtrack-set-tracked-buffer (file-name)
3635 "Set the buffer for FILE-NAME as the tracked buffer.
3636 Internally it uses the `python-pdbtrack-tracked-buffer' variable.
3637 Returns the tracked buffer."
3638 (let ((file-buffer (get-file-buffer
3639 (concat (file-remote-p default-directory
)
3642 (setq python-pdbtrack-tracked-buffer file-buffer
)
3643 (setq file-buffer
(find-file-noselect file-name
))
3644 (when (not (member file-buffer python-pdbtrack-buffers-to-kill
))
3645 (add-to-list 'python-pdbtrack-buffers-to-kill file-buffer
)))
3648 (defun python-pdbtrack-comint-output-filter-function (output)
3649 "Move overlay arrow to current pdb line in tracked buffer.
3650 Argument OUTPUT is a string with the output from the comint process."
3651 (when (and python-pdbtrack-activate
(not (string= output
"")))
3652 (let* ((full-output (ansi-color-filter-apply
3653 (buffer-substring comint-last-input-end
(point-max))))
3657 (insert full-output
)
3658 ;; When the debugger encounters a pdb.set_trace()
3659 ;; command, it prints a single stack frame. Sometimes
3660 ;; it prints a bit of extra information about the
3661 ;; arguments of the present function. When ipdb
3662 ;; encounters an exception, it prints the _entire_ stack
3663 ;; trace. To handle all of these cases, we want to find
3664 ;; the _last_ stack frame printed in the most recent
3665 ;; batch of output, then jump to the corresponding
3666 ;; file/line number.
3667 (goto-char (point-max))
3668 (when (re-search-backward python-pdbtrack-stacktrace-info-regexp nil t
)
3669 (setq line-number
(string-to-number
3670 (match-string-no-properties 2)))
3671 (match-string-no-properties 1)))))
3672 (if (and file-name line-number
)
3673 (let* ((tracked-buffer
3674 (python-pdbtrack-set-tracked-buffer file-name
))
3675 (shell-buffer (current-buffer))
3676 (tracked-buffer-window (get-buffer-window tracked-buffer
))
3677 (tracked-buffer-line-pos))
3678 (with-current-buffer tracked-buffer
3679 (set (make-local-variable 'overlay-arrow-string
) "=>")
3680 (set (make-local-variable 'overlay-arrow-position
) (make-marker))
3681 (setq tracked-buffer-line-pos
(progn
3682 (goto-char (point-min))
3683 (forward-line (1- line-number
))
3685 (when tracked-buffer-window
3687 tracked-buffer-window tracked-buffer-line-pos
))
3688 (set-marker overlay-arrow-position tracked-buffer-line-pos
))
3689 (pop-to-buffer tracked-buffer
)
3690 (switch-to-buffer-other-window shell-buffer
))
3691 (when python-pdbtrack-tracked-buffer
3692 (with-current-buffer python-pdbtrack-tracked-buffer
3693 (set-marker overlay-arrow-position nil
))
3694 (mapc #'(lambda (buffer)
3695 (ignore-errors (kill-buffer buffer
)))
3696 python-pdbtrack-buffers-to-kill
)
3697 (setq python-pdbtrack-tracked-buffer nil
3698 python-pdbtrack-buffers-to-kill nil
)))))
3702 ;;; Symbol completion
3704 (defun python-completion-at-point ()
3705 "Function for `completion-at-point-functions' in `python-mode'.
3706 For this to work as best as possible you should call
3707 `python-shell-send-buffer' from time to time so context in
3708 inferior Python process is updated properly."
3709 (let ((process (python-shell-get-process)))
3711 (python-shell-completion-at-point process
))))
3713 (define-obsolete-function-alias
3714 'python-completion-complete-at-point
3715 'python-completion-at-point
3721 (defcustom python-fill-comment-function
'python-fill-comment
3722 "Function to fill comments.
3723 This is the function used by `python-fill-paragraph' to
3728 (defcustom python-fill-string-function
'python-fill-string
3729 "Function to fill strings.
3730 This is the function used by `python-fill-paragraph' to
3735 (defcustom python-fill-decorator-function
'python-fill-decorator
3736 "Function to fill decorators.
3737 This is the function used by `python-fill-paragraph' to
3742 (defcustom python-fill-paren-function
'python-fill-paren
3743 "Function to fill parens.
3744 This is the function used by `python-fill-paragraph' to
3749 (defcustom python-fill-docstring-style
'pep-257
3750 "Style used to fill docstrings.
3751 This affects `python-fill-string' behavior with regards to
3752 triple quotes positioning.
3754 Possible values are `django', `onetwo', `pep-257', `pep-257-nn',
3755 `symmetric', and nil. A value of nil won't care about quotes
3756 position and will treat docstrings a normal string, any other
3757 value may result in one of the following docstring styles:
3762 Process foo, return bar.
3766 Process foo, return bar.
3768 If processing fails throw ProcessingError.
3773 \"\"\"Process foo, return bar.\"\"\"
3776 Process foo, return bar.
3778 If processing fails throw ProcessingError.
3784 \"\"\"Process foo, return bar.\"\"\"
3786 \"\"\"Process foo, return bar.
3788 If processing fails throw ProcessingError.
3794 \"\"\"Process foo, return bar.\"\"\"
3796 \"\"\"Process foo, return bar.
3798 If processing fails throw ProcessingError.
3803 \"\"\"Process foo, return bar.\"\"\"
3806 Process foo, return bar.
3808 If processing fails throw ProcessingError.
3811 (const :tag
"Don't format docstrings" nil
)
3812 (const :tag
"Django's coding standards style." django
)
3813 (const :tag
"One newline and start and Two at end style." onetwo
)
3814 (const :tag
"PEP-257 with 2 newlines at end of string." pep-257
)
3815 (const :tag
"PEP-257 with 1 newline at end of string." pep-257-nn
)
3816 (const :tag
"Symmetric style." symmetric
))
3819 (memq val
'(django onetwo pep-257 pep-257-nn symmetric nil
))))
3821 (defun python-fill-paragraph (&optional justify
)
3822 "`fill-paragraph-function' handling multi-line strings and possibly comments.
3823 If any of the current line is in or at the end of a multi-line string,
3824 fill the string or the paragraph of it that point is in, preserving
3825 the string's indentation.
3826 Optional argument JUSTIFY defines if the paragraph should be justified."
3831 ((python-syntax-context 'comment
)
3832 (funcall python-fill-comment-function justify
))
3833 ;; Strings/Docstrings
3834 ((save-excursion (or (python-syntax-context 'string
)
3835 (equal (string-to-syntax "|")
3836 (syntax-after (point)))))
3837 (funcall python-fill-string-function justify
))
3839 ((equal (char-after (save-excursion
3840 (python-nav-beginning-of-statement))) ?
@)
3841 (funcall python-fill-decorator-function justify
))
3843 ((or (python-syntax-context 'paren
)
3844 (looking-at (python-rx open-paren
))
3846 (skip-syntax-forward "^(" (line-end-position))
3847 (looking-at (python-rx open-paren
))))
3848 (funcall python-fill-paren-function justify
))
3851 (defun python-fill-comment (&optional justify
)
3852 "Comment fill function for `python-fill-paragraph'.
3853 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
3854 (fill-comment-paragraph justify
))
3856 (defun python-fill-string (&optional justify
)
3857 "String fill function for `python-fill-paragraph'.
3858 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
3859 (let* ((str-start-pos
3862 (or (python-syntax-context 'string
)
3863 (and (equal (string-to-syntax "|")
3864 (syntax-after (point)))
3866 (num-quotes (python-syntax-count-quotes
3867 (char-after str-start-pos
) str-start-pos
))
3870 (goto-char (+ str-start-pos num-quotes
))
3871 (or (re-search-forward (rx (syntax string-delimiter
)) nil t
)
3872 (goto-char (point-max)))
3875 ;; Docstring styles may vary for oneliners and multi-liners.
3876 (> (count-matches "\n" str-start-pos str-end-pos
) 0))
3878 (pcase python-fill-docstring-style
3879 ;; delimiters-style is a cons cell with the form
3880 ;; (START-NEWLINES . END-NEWLINES). When any of the sexps
3881 ;; is NIL means to not add any newlines for start or end
3882 ;; of docstring. See `python-fill-docstring-style' for a
3883 ;; graphic idea of each style.
3884 (`django
(cons 1 1))
3885 (`onetwo
(and multi-line-p
(cons 1 2)))
3886 (`pep-257
(and multi-line-p
(cons nil
2)))
3887 (`pep-257-nn
(and multi-line-p
(cons nil
1)))
3888 (`symmetric
(and multi-line-p
(cons 1 1)))))
3889 (fill-paragraph-function))
3891 (narrow-to-region str-start-pos str-end-pos
)
3892 (fill-paragraph justify
))
3894 (when (and (python-info-docstring-p) python-fill-docstring-style
)
3895 ;; Add the number of newlines indicated by the selected style
3896 ;; at the start of the docstring.
3897 (goto-char (+ str-start-pos num-quotes
))
3898 (delete-region (point) (progn
3899 (skip-syntax-forward "> ")
3901 (and (car delimiters-style
)
3902 (or (newline (car delimiters-style
)) t
)
3903 ;; Indent only if a newline is added.
3904 (indent-according-to-mode))
3905 ;; Add the number of newlines indicated by the selected style
3906 ;; at the end of the docstring.
3907 (goto-char (if (not (= str-end-pos
(point-max)))
3908 (- str-end-pos num-quotes
)
3910 (delete-region (point) (progn
3911 (skip-syntax-backward "> ")
3913 (and (cdr delimiters-style
)
3914 ;; Add newlines only if string ends.
3915 (not (= str-end-pos
(point-max)))
3916 (or (newline (cdr delimiters-style
)) t
)
3917 ;; Again indent only if a newline is added.
3918 (indent-according-to-mode))))) t
)
3920 (defun python-fill-decorator (&optional _justify
)
3921 "Decorator fill function for `python-fill-paragraph'.
3922 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
3925 (defun python-fill-paren (&optional justify
)
3926 "Paren fill function for `python-fill-paragraph'.
3927 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
3929 (narrow-to-region (progn
3930 (while (python-syntax-context 'paren
)
3931 (goto-char (1- (point))))
3932 (line-beginning-position))
3934 (when (not (python-syntax-context 'paren
))
3936 (when (not (python-syntax-context 'paren
))
3937 (skip-syntax-backward "^)")))
3938 (while (and (python-syntax-context 'paren
)
3940 (goto-char (1+ (point))))
3942 (let ((paragraph-start "\f\\|[ \t]*$")
3943 (paragraph-separate ",")
3944 (fill-paragraph-function))
3945 (goto-char (point-min))
3946 (fill-paragraph justify
))
3949 (python-indent-line)
3950 (goto-char (line-end-position))))
3956 (defcustom python-skeleton-autoinsert nil
3957 "Non-nil means template skeletons will be automagically inserted.
3958 This happens when pressing \"if<SPACE>\", for example, to prompt for
3964 (define-obsolete-variable-alias
3965 'python-use-skeletons
'python-skeleton-autoinsert
"24.3")
3967 (defvar python-skeleton-available
'()
3968 "Internal list of available skeletons.")
3970 (define-abbrev-table 'python-mode-skeleton-abbrev-table
()
3971 "Abbrev table for Python mode skeletons."
3973 ;; Allow / inside abbrevs.
3974 :regexp
"\\(?:^\\|[^/]\\)\\<\\([[:word:]/]+\\)\\W*"
3975 ;; Only expand in code.
3976 :enable-function
(lambda ()
3978 (not (python-syntax-comment-or-string-p))
3979 python-skeleton-autoinsert
)))
3981 (defmacro python-skeleton-define
(name doc
&rest skel
)
3982 "Define a `python-mode' skeleton using NAME DOC and SKEL.
3983 The skeleton will be bound to python-skeleton-NAME and will
3984 be added to `python-mode-skeleton-abbrev-table'."
3985 (declare (indent 2))
3986 (let* ((name (symbol-name name
))
3987 (function-name (intern (concat "python-skeleton-" name
))))
3989 (define-abbrev python-mode-skeleton-abbrev-table
3990 ,name
"" ',function-name
:system t
)
3991 (setq python-skeleton-available
3992 (cons ',function-name python-skeleton-available
))
3993 (define-skeleton ,function-name
3995 (format "Insert %s statement." name
))
3998 (define-abbrev-table 'python-mode-abbrev-table
()
3999 "Abbrev table for Python mode."
4000 :parents
(list python-mode-skeleton-abbrev-table
))
4002 (defmacro python-define-auxiliary-skeleton
(name doc
&optional
&rest skel
)
4003 "Define a `python-mode' auxiliary skeleton using NAME DOC and SKEL.
4004 The skeleton will be bound to python-skeleton-NAME."
4005 (declare (indent 2))
4006 (let* ((name (symbol-name name
))
4007 (function-name (intern (concat "python-skeleton--" name
)))
4008 (msg (format-message
4009 "Add ‘%s’ clause? " name
)))
4012 `(< ,(format "%s:" name
) \n \n
4014 `(define-skeleton ,function-name
4016 (format "Auxiliary skeleton for %s statement." name
))
4018 (unless (y-or-n-p ,msg
)
4022 (python-define-auxiliary-skeleton else nil
)
4024 (python-define-auxiliary-skeleton except nil
)
4026 (python-define-auxiliary-skeleton finally nil
)
4028 (python-skeleton-define if nil
4032 ("other condition, %s: "
4036 '(python-skeleton--else) | ^
)
4038 (python-skeleton-define while nil
4042 '(python-skeleton--else) | ^
)
4044 (python-skeleton-define for nil
4048 '(python-skeleton--else) | ^
)
4050 (python-skeleton-define import nil
4051 "Import from module: "
4052 "from " str
& " " | -
5
4054 ("Identifier: " str
", ") -
2 \n _
)
4056 (python-skeleton-define try nil
4062 "except " str
":" \n
4065 '(python-skeleton--except)
4066 '(python-skeleton--else)
4067 '(python-skeleton--finally) | ^
)
4069 (python-skeleton-define def nil
4071 "def " str
"(" ("Parameter, %s: "
4072 (unless (equal ?\
( (char-before)) ", ")
4074 "\"\"\"" -
"\"\"\"" \n
4077 (python-skeleton-define class nil
4079 "class " str
"(" ("Inheritance, %s: "
4080 (unless (equal ?\
( (char-before)) ", ")
4084 "\"\"\"" -
"\"\"\"" \n
4087 (defun python-skeleton-add-menu-items ()
4088 "Add menu items to Python->Skeletons menu."
4089 (let ((skeletons (sort python-skeleton-available
'string
<)))
4090 (dolist (skeleton skeletons
)
4092 nil
'("Python" "Skeletons")
4094 "Insert %s" (nth 2 (split-string (symbol-name skeleton
) "-")))
4099 (defcustom python-ffap-setup-code
4101 def __FFAP_get_module_path(objstr):
4105 # NameError exceptions are delayed until this point.
4107 module = inspect.getmodule(obj)
4108 filename = module.__file__
4109 ext = os.path.splitext(filename)[1]
4110 if ext in ('.pyc', '.pyo'):
4111 # Point to the source file.
4112 filename = filename[:-1]
4113 if os.path.exists(filename):
4118 "Python code to get a module path."
4122 (defcustom python-ffap-string-code
4123 "__FFAP_get_module_path('''%s''')"
4124 "Python code used to get a string with the path of a module."
4128 (defun python-ffap-module-path (module)
4129 "Function for `ffap-alist' to return path for MODULE."
4131 (and (derived-mode-p 'inferior-python-mode
)
4132 (get-buffer-process (current-buffer)))
4133 (python-shell-get-process))))
4137 (python-shell-send-string-no-output
4139 python-ffap-setup-code
4140 "\nprint (" (format python-ffap-string-code module
) ")")
4142 (unless (zerop (length module-file
))
4143 (python-util-strip-string module-file
))))))
4147 (eval-after-load "ffap"
4149 (push '(python-mode . python-ffap-module-path
) ffap-alist
)
4150 (push '(inferior-python-mode . python-ffap-module-path
) ffap-alist
)))
4155 (defcustom python-check-command
4156 (or (executable-find "pyflakes")
4157 (executable-find "epylint")
4158 "install pyflakes, pylint or something else")
4159 "Command used to check a Python file."
4163 (defcustom python-check-buffer-name
4164 "*Python check: %s*"
4165 "Buffer name used for check commands."
4169 (defvar python-check-custom-command nil
4171 ;; XXX: Avoid `defvar-local' for compat with Emacs<24.3
4172 (make-variable-buffer-local 'python-check-custom-command
)
4174 (defun python-check (command)
4175 "Check a Python file (default current buffer's file).
4176 Runs COMMAND, a shell command, as if by `compile'.
4177 See `python-check-command' for the default."
4179 (list (read-string "Check command: "
4180 (or python-check-custom-command
4181 (concat python-check-command
" "
4182 (shell-quote-argument
4184 (let ((name (buffer-file-name)))
4186 (file-name-nondirectory name
)))
4188 (setq python-check-custom-command command
)
4189 (save-some-buffers (not compilation-ask-about-save
) nil
)
4190 (python-shell-with-environment
4191 (compilation-start command nil
4193 (format python-check-buffer-name command
)))))
4198 (defcustom python-eldoc-setup-code
4199 "def __PYDOC_get_help(obj):
4203 str_type = basestring
4206 if isinstance(obj, str_type):
4207 obj = eval(obj, globals())
4208 doc = inspect.getdoc(obj)
4209 if not doc and callable(obj):
4211 if inspect.isclass(obj) and hasattr(obj, '__init__'):
4212 target = obj.__init__
4218 args = inspect.formatargspec(
4219 *inspect.getargspec(target)
4222 doc = '{objtype} {name}{args}'.format(
4223 objtype=objtype, name=name, args=args
4226 doc = doc.splitlines()[0]
4230 "Python code to setup documentation retrieval."
4234 (defcustom python-eldoc-string-code
4235 "__PYDOC_get_help('''%s''')"
4236 "Python code used to get a string with the documentation of an object."
4240 (defun python-eldoc--get-symbol-at-point ()
4241 "Get the current symbol for eldoc.
4242 Returns the current symbol handling point within arguments."
4244 (let ((start (python-syntax-context 'paren
)))
4249 (memq (char-syntax (char-after)) '(?\ ?-
)))
4250 ;; Try to adjust to closest symbol if not in one.
4251 (python-util-forward-comment -
1)))
4252 (python-info-current-symbol t
)))
4254 (defun python-eldoc--get-doc-at-point (&optional force-input force-process
)
4255 "Internal implementation to get documentation at point.
4256 If not FORCE-INPUT is passed then what `python-eldoc--get-symbol-at-point'
4257 returns will be used. If not FORCE-PROCESS is passed what
4258 `python-shell-get-process' returns is used."
4259 (let ((process (or force-process
(python-shell-get-process))))
4261 (let* ((input (or force-input
4262 (python-eldoc--get-symbol-at-point)))
4265 ;; Prevent resizing the echo area when iPython is
4266 ;; enabled. Bug#18794.
4267 (python-util-strip-string
4268 (python-shell-send-string-no-output
4270 python-eldoc-setup-code
4271 "\nprint(" (format python-eldoc-string-code input
) ")")
4273 (unless (zerop (length docstring
))
4276 (defun python-eldoc-function ()
4277 "`eldoc-documentation-function' for Python.
4278 For this to work as best as possible you should call
4279 `python-shell-send-buffer' from time to time so context in
4280 inferior Python process is updated properly."
4281 (python-eldoc--get-doc-at-point))
4283 (defun python-eldoc-at-point (symbol)
4284 "Get help on SYMBOL using `help'.
4285 Interactively, prompt for symbol."
4287 (let ((symbol (python-eldoc--get-symbol-at-point))
4288 (enable-recursive-minibuffers t
))
4289 (list (read-string (if symbol
4290 (format "Describe symbol (default %s): " symbol
)
4291 "Describe symbol: ")
4293 (message (python-eldoc--get-doc-at-point symbol
)))
4298 (defun python-hideshow-forward-sexp-function (arg)
4299 "Python specific `forward-sexp' function for `hs-minor-mode'.
4300 Argument ARG is ignored."
4301 arg
; Shut up, byte compiler.
4302 (python-nav-end-of-defun)
4303 (unless (python-info-current-line-empty-p)
4309 (defvar python-imenu-format-item-label-function
4310 'python-imenu-format-item-label
4311 "Imenu function used to format an item label.
4312 It must be a function with two arguments: TYPE and NAME.")
4314 (defvar python-imenu-format-parent-item-label-function
4315 'python-imenu-format-parent-item-label
4316 "Imenu function used to format a parent item label.
4317 It must be a function with two arguments: TYPE and NAME.")
4319 (defvar python-imenu-format-parent-item-jump-label-function
4320 'python-imenu-format-parent-item-jump-label
4321 "Imenu function used to format a parent jump item label.
4322 It must be a function with two arguments: TYPE and NAME.")
4324 (defun python-imenu-format-item-label (type name
)
4325 "Return Imenu label for single node using TYPE and NAME."
4326 (format "%s (%s)" name type
))
4328 (defun python-imenu-format-parent-item-label (type name
)
4329 "Return Imenu label for parent node using TYPE and NAME."
4330 (format "%s..." (python-imenu-format-item-label type name
)))
4332 (defun python-imenu-format-parent-item-jump-label (type _name
)
4333 "Return Imenu label for parent node jump using TYPE and NAME."
4334 (if (string= type
"class")
4335 "*class definition*"
4336 "*function definition*"))
4338 (defun python-imenu--put-parent (type name pos tree
)
4339 "Add the parent with TYPE, NAME and POS to TREE."
4341 (funcall python-imenu-format-item-label-function type name
))
4343 (funcall python-imenu-format-parent-item-jump-label-function type name
)))
4346 (cons label
(cons (cons jump-label pos
) tree
)))))
4348 (defun python-imenu--build-tree (&optional min-indent prev-indent tree
)
4349 "Recursively build the tree of nested definitions of a node.
4350 Arguments MIN-INDENT, PREV-INDENT and TREE are internal and should
4351 not be passed explicitly unless you know what you are doing."
4352 (setq min-indent
(or min-indent
0)
4353 prev-indent
(or prev-indent python-indent-offset
))
4354 (let* ((pos (python-nav-backward-defun))
4356 (name (when (and pos
(looking-at python-nav-beginning-of-defun-regexp
))
4357 (let ((split (split-string (match-string-no-properties 0))))
4358 (setq type
(car split
))
4361 (funcall python-imenu-format-item-label-function type name
)))
4362 (indent (current-indentation))
4363 (children-indent-limit (+ python-indent-offset min-indent
)))
4365 ;; Nothing found, probably near to bobp.
4367 ((<= indent min-indent
)
4368 ;; The current indentation points that this is a parent
4369 ;; node, add it to the tree and stop recursing.
4370 (python-imenu--put-parent type name pos tree
))
4372 (python-imenu--build-tree
4375 (if (<= indent children-indent-limit
)
4376 ;; This lies within the children indent offset range,
4377 ;; so it's a normal child of its parent (i.e., not
4378 ;; a child of a child).
4379 (cons (cons label pos
) tree
)
4380 ;; Oh no, a child of a child?! Fear not, we
4381 ;; know how to roll. We recursively parse these by
4382 ;; swapping prev-indent and min-indent plus adding this
4383 ;; newly found item to a fresh subtree. This works, I
4386 (python-imenu--build-tree
4387 prev-indent indent
(list (cons label pos
)))
4390 (defun python-imenu-create-index ()
4391 "Return tree Imenu alist for the current Python buffer.
4392 Change `python-imenu-format-item-label-function',
4393 `python-imenu-format-parent-item-label-function',
4394 `python-imenu-format-parent-item-jump-label-function' to
4395 customize how labels are formatted."
4396 (goto-char (point-max))
4399 (while (setq tree
(python-imenu--build-tree))
4400 (setq index
(cons tree index
)))
4403 (defun python-imenu-create-flat-index (&optional alist prefix
)
4404 "Return flat outline of the current Python buffer for Imenu.
4405 Optional argument ALIST is the tree to be flattened; when nil
4406 `python-imenu-build-index' is used with
4407 `python-imenu-format-parent-item-jump-label-function'
4408 `python-imenu-format-parent-item-label-function'
4409 `python-imenu-format-item-label-function' set to
4410 (lambda (type name) name)
4411 Optional argument PREFIX is used in recursive calls and should
4412 not be passed explicitly.
4419 (\"decorator\" . 173)
4422 (\"wrapped_f\" . 393))))
4428 (\"decorator\" . 173)
4429 (\"decorator.wrap\" . 353)
4430 (\"decorator.wrapped_f\" . 393))"
4431 ;; Inspired by imenu--flatten-index-alist removed in revno 21853.
4436 (let ((name (if prefix
4437 (concat prefix
"." (car item
))
4440 (cond ((or (numberp pos
) (markerp pos
))
4441 (list (cons name pos
)))
4444 (cons name
(cdar pos
))
4445 (python-imenu-create-flat-index (cddr item
) name
))))))
4447 (let* ((fn (lambda (_type name
) name
))
4448 (python-imenu-format-item-label-function fn
)
4449 (python-imenu-format-parent-item-label-function fn
)
4450 (python-imenu-format-parent-item-jump-label-function fn
))
4451 (python-imenu-create-index))))))
4456 (defun python-info-current-defun (&optional include-type
)
4457 "Return name of surrounding function with Python compatible dotty syntax.
4458 Optional argument INCLUDE-TYPE indicates to include the type of the defun.
4459 This function can be used as the value of `add-log-current-defun-function'
4460 since it returns nil if point is not inside a defun."
4466 (starting-indentation (current-indentation))
4467 (starting-pos (point))
4472 (while (python-nav-beginning-of-defun 1)
4473 (when (save-match-data
4475 (or (not last-indent
)
4476 (< (current-indentation) last-indent
))
4480 ;; If this is the first run, we may add
4481 ;; the current defun at point.
4482 (setq first-run nil
)
4483 (goto-char starting-pos
)
4484 (python-nav-beginning-of-statement)
4485 (beginning-of-line 1)
4487 python-nav-beginning-of-defun-regexp
)))
4491 (+ (current-indentation)
4492 python-indent-offset
)))
4493 (if (< starting-indentation min-indent
)
4494 ;; If the starting indentation is not
4495 ;; within the min defun indent make the
4498 ;; Else go to the end of defun and add
4499 ;; up the current indentation to the
4501 (python-nav-end-of-defun)
4503 (if (>= (current-indentation) min-indent
)
4504 (1+ (current-indentation))
4506 (save-match-data (setq last-indent
(current-indentation)))
4507 (if (or (not include-type
) type
)
4508 (setq names
(cons (match-string-no-properties 1) names
))
4509 (let ((match (split-string (match-string-no-properties 0))))
4510 (setq type
(car match
))
4511 (setq names
(cons (cadr match
) names
)))))
4512 ;; Stop searching ASAP.
4513 (and (= (current-indentation) 0) (throw 'exit t
))))
4515 (concat (and type
(format "%s " type
))
4516 (mapconcat 'identity names
".")))))))
4518 (defun python-info-current-symbol (&optional replace-self
)
4519 "Return current symbol using dotty syntax.
4520 With optional argument REPLACE-SELF convert \"self\" to current
4523 (and (not (python-syntax-comment-or-string-p))
4524 (with-syntax-table python-dotty-syntax-table
4525 (let ((sym (symbol-at-point)))
4527 (substring-no-properties (symbol-name sym
))))))))
4529 (if (not replace-self
)
4531 (let ((current-defun (python-info-current-defun)))
4532 (if (not current-defun
)
4534 (replace-regexp-in-string
4535 (python-rx line-start word-start
"self" word-end ?.
)
4537 (mapconcat 'identity
4538 (butlast (split-string current-defun
"\\."))
4542 (defun python-info-statement-starts-block-p ()
4543 "Return non-nil if current statement opens a block."
4545 (python-nav-beginning-of-statement)
4546 (looking-at (python-rx block-start
))))
4548 (defun python-info-statement-ends-block-p ()
4549 "Return non-nil if point is at end of block."
4550 (let ((end-of-block-pos (save-excursion
4551 (python-nav-end-of-block)))
4552 (end-of-statement-pos (save-excursion
4553 (python-nav-end-of-statement))))
4554 (and end-of-block-pos end-of-statement-pos
4555 (= end-of-block-pos end-of-statement-pos
))))
4557 (defun python-info-beginning-of-statement-p ()
4558 "Return non-nil if point is at beginning of statement."
4559 (= (point) (save-excursion
4560 (python-nav-beginning-of-statement)
4563 (defun python-info-end-of-statement-p ()
4564 "Return non-nil if point is at end of statement."
4565 (= (point) (save-excursion
4566 (python-nav-end-of-statement)
4569 (defun python-info-beginning-of-block-p ()
4570 "Return non-nil if point is at beginning of block."
4571 (and (python-info-beginning-of-statement-p)
4572 (python-info-statement-starts-block-p)))
4574 (defun python-info-end-of-block-p ()
4575 "Return non-nil if point is at end of block."
4576 (and (python-info-end-of-statement-p)
4577 (python-info-statement-ends-block-p)))
4579 (define-obsolete-function-alias
4580 'python-info-closing-block
4581 'python-info-dedenter-opening-block-position
"24.4")
4583 (defun python-info-dedenter-opening-block-position ()
4584 "Return the point of the closest block the current line closes.
4585 Returns nil if point is not on a dedenter statement or no opening
4586 block can be detected. The latter case meaning current file is
4587 likely an invalid python file."
4588 (let ((positions (python-info-dedenter-opening-block-positions))
4589 (indentation (current-indentation))
4591 (while (and (not position
)
4594 (goto-char (car positions
))
4595 (if (<= (current-indentation) indentation
)
4596 (setq position
(car positions
))
4597 (setq positions
(cdr positions
)))))
4600 (defun python-info-dedenter-opening-block-positions ()
4601 "Return points of blocks the current line may close sorted by closer.
4602 Returns nil if point is not on a dedenter statement or no opening
4603 block can be detected. The latter case meaning current file is
4604 likely an invalid python file."
4606 (let ((dedenter-pos (python-info-dedenter-statement-p)))
4608 (goto-char dedenter-pos
)
4609 (let* ((pairs '(("elif" "elif" "if")
4610 ("else" "if" "elif" "except" "for" "while")
4611 ("except" "except" "try")
4612 ("finally" "else" "except" "try")))
4613 (dedenter (match-string-no-properties 0))
4614 (possible-opening-blocks (cdr (assoc-string dedenter pairs
)))
4615 (collected-indentations)
4618 (while (python-nav--syntactically
4620 (re-search-backward (python-rx block-start
) nil t
))
4622 (let ((indentation (current-indentation)))
4623 (when (and (not (memq indentation collected-indentations
))
4624 (or (not collected-indentations
)
4625 (< indentation
(apply #'min collected-indentations
))))
4626 (setq collected-indentations
4627 (cons indentation collected-indentations
))
4628 (when (member (match-string-no-properties 0)
4629 possible-opening-blocks
)
4630 (setq opening-blocks
(cons (point) opening-blocks
))))
4631 (when (zerop indentation
)
4632 (throw 'exit nil
)))))
4634 (nreverse opening-blocks
))))))
4636 (define-obsolete-function-alias
4637 'python-info-closing-block-message
4638 'python-info-dedenter-opening-block-message
"24.4")
4640 (defun python-info-dedenter-opening-block-message ()
4641 "Message the first line of the block the current statement closes."
4642 (let ((point (python-info-dedenter-opening-block-position)))
4646 (message "Closes %s" (save-excursion
4649 (point) (line-end-position))))))))
4651 (defun python-info-dedenter-statement-p ()
4652 "Return point if current statement is a dedenter.
4653 Sets `match-data' to the keyword that starts the dedenter
4656 (python-nav-beginning-of-statement)
4657 (when (and (not (python-syntax-context-type))
4658 (looking-at (python-rx dedenter
)))
4661 (defun python-info-line-ends-backslash-p (&optional line-number
)
4662 "Return non-nil if current line ends with backslash.
4663 With optional argument LINE-NUMBER, check that line instead."
4668 (python-util-goto-line line-number
))
4669 (while (and (not (eobp))
4670 (goto-char (line-end-position))
4671 (python-syntax-context 'paren
)
4672 (not (equal (char-before (point)) ?
\\)))
4674 (when (equal (char-before) ?
\\)
4677 (defun python-info-beginning-of-backslash (&optional line-number
)
4678 "Return the point where the backslashed line start.
4679 Optional argument LINE-NUMBER forces the line number to check against."
4684 (python-util-goto-line line-number
))
4685 (when (python-info-line-ends-backslash-p)
4686 (while (save-excursion
4687 (goto-char (line-beginning-position))
4688 (python-syntax-context 'paren
))
4690 (back-to-indentation)
4693 (defun python-info-continuation-line-p ()
4694 "Check if current line is continuation of another.
4695 When current line is continuation of another return the point
4696 where the continued line ends."
4700 (let* ((context-type (progn
4701 (back-to-indentation)
4702 (python-syntax-context-type)))
4703 (line-start (line-number-at-pos))
4704 (context-start (when context-type
4705 (python-syntax-context context-type
))))
4706 (cond ((equal context-type
'paren
)
4707 ;; Lines inside a paren are always a continuation line
4708 ;; (except the first one).
4709 (python-util-forward-comment -
1)
4711 ((member context-type
'(string comment
))
4712 ;; move forward an roll again
4713 (goto-char context-start
)
4714 (python-util-forward-comment)
4715 (python-info-continuation-line-p))
4717 ;; Not within a paren, string or comment, the only way
4718 ;; we are dealing with a continuation line is that
4719 ;; previous line contains a backslash, and this can
4720 ;; only be the previous line from current
4721 (back-to-indentation)
4722 (python-util-forward-comment -
1)
4723 (when (and (equal (1- line-start
) (line-number-at-pos))
4724 (python-info-line-ends-backslash-p))
4725 (point-marker))))))))
4727 (defun python-info-block-continuation-line-p ()
4728 "Return non-nil if current line is a continuation of a block."
4730 (when (python-info-continuation-line-p)
4732 (back-to-indentation)
4733 (when (looking-at (python-rx block-start
))
4736 (defun python-info-assignment-statement-p (&optional current-line-only
)
4737 "Check if current line is an assignment.
4738 With argument CURRENT-LINE-ONLY is non-nil, don't follow any
4739 continuations, just check the if current line is an assignment."
4742 (if current-line-only
4743 (back-to-indentation)
4744 (python-nav-beginning-of-statement))
4746 (re-search-forward (python-rx not-simple-operator
4748 (group not-simple-operator
))
4749 (line-end-position) t
)
4752 ;; The assignment operator should not be inside a string.
4753 (backward-char (length (match-string-no-properties 1)))
4754 (setq found
(not (python-syntax-context-type)))))
4756 (skip-syntax-forward " ")
4759 ;; TODO: rename to clarify this is only for the first continuation
4760 ;; line or remove it and move its body to `python-indent-context'.
4761 (defun python-info-assignment-continuation-line-p ()
4762 "Check if current line is the first continuation of an assignment.
4763 When current line is continuation of another with an assignment
4764 return the point of the first non-blank character after the
4767 (when (python-info-continuation-line-p)
4769 (python-info-assignment-statement-p t
))))
4771 (defun python-info-looking-at-beginning-of-defun (&optional syntax-ppss
)
4772 "Check if point is at `beginning-of-defun' using SYNTAX-PPSS."
4773 (and (not (python-syntax-context-type (or syntax-ppss
(syntax-ppss))))
4775 (beginning-of-line 1)
4776 (looking-at python-nav-beginning-of-defun-regexp
))))
4778 (defun python-info-current-line-comment-p ()
4779 "Return non-nil if current line is a comment line."
4781 (or (char-after (+ (line-beginning-position) (current-indentation))) ?_
)
4784 (defun python-info-current-line-empty-p ()
4785 "Return non-nil if current line is empty, ignoring whitespace."
4787 (beginning-of-line 1)
4789 (python-rx line-start
(* whitespace
)
4790 (group (* not-newline
))
4791 (* whitespace
) line-end
))
4792 (string-equal "" (match-string-no-properties 1))))
4794 (defun python-info-docstring-p (&optional syntax-ppss
)
4795 "Return non-nil if point is in a docstring.
4796 When optional argument SYNTAX-PPSS is given, use that instead of
4797 point's current `syntax-ppss'."
4798 ;;; https://www.python.org/dev/peps/pep-0257/#what-is-a-docstring
4800 (when (and syntax-ppss
(python-syntax-context 'string syntax-ppss
))
4801 (goto-char (nth 8 syntax-ppss
)))
4802 (python-nav-beginning-of-statement)
4804 (indentation (current-indentation))
4805 (backward-sexp-point)
4806 (re (concat "[uU]?[rR]?"
4807 (python-rx string-delimiter
))))
4809 (not (python-info-assignment-statement-p))
4811 ;; Allow up to two consecutive docstrings only.
4815 (while (save-excursion
4816 (python-nav-backward-sexp)
4817 (setq backward-sexp-point
(point))
4818 (and (= indentation
(current-indentation))
4819 (not (bobp)) ; Prevent infloop.
4821 (concat "[uU]?[rR]?"
4822 (python-rx string-delimiter
)))))
4823 ;; Previous sexp was a string, restore point.
4824 (goto-char backward-sexp-point
)
4827 (python-util-forward-comment -
1)
4828 (python-nav-beginning-of-statement)
4830 ((python-info-assignment-statement-p) t
)
4831 ((python-info-looking-at-beginning-of-defun))
4834 (defun python-info-encoding-from-cookie ()
4835 "Detect current buffer's encoding from its coding cookie.
4836 Returns the encoding as a symbol."
4837 (let ((first-two-lines
4841 (goto-char (point-min))
4843 (buffer-substring-no-properties
4846 (when (string-match (python-rx coding-cookie
) first-two-lines
)
4847 (intern (match-string-no-properties 1 first-two-lines
)))))
4849 (defun python-info-encoding ()
4850 "Return encoding for file.
4851 Try `python-info-encoding-from-cookie', if none is found then
4853 ;; If no encoding is defined, then it's safe to use UTF-8: Python 2
4854 ;; uses ASCII as default while Python 3 uses UTF-8. This means that
4855 ;; in the worst case scenario python.el will make things work for
4856 ;; Python 2 files with unicode data and no encoding defined.
4857 (or (python-info-encoding-from-cookie)
4861 ;;; Utility functions
4863 (defun python-util-goto-line (line-number)
4864 "Move point to LINE-NUMBER."
4865 (goto-char (point-min))
4866 (forward-line (1- line-number
)))
4868 ;; Stolen from org-mode
4869 (defun python-util-clone-local-variables (from-buffer &optional regexp
)
4870 "Clone local variables from FROM-BUFFER.
4871 Optional argument REGEXP selects variables to clone and defaults
4875 (and (symbolp (car pair
))
4876 (string-match (or regexp
"^python-")
4877 (symbol-name (car pair
)))
4878 (set (make-local-variable (car pair
))
4880 (buffer-local-variables from-buffer
)))
4882 (defvar comint-last-prompt-overlay
) ; Shut up, byte compiler.
4884 (defun python-util-comint-last-prompt ()
4885 "Return comint last prompt overlay start and end.
4886 This is for compatibility with Emacs < 24.4."
4887 (cond ((bound-and-true-p comint-last-prompt-overlay
)
4888 (cons (overlay-start comint-last-prompt-overlay
)
4889 (overlay-end comint-last-prompt-overlay
)))
4890 ((bound-and-true-p comint-last-prompt
)
4894 (defun python-util-forward-comment (&optional direction
)
4895 "Python mode specific version of `forward-comment'.
4896 Optional argument DIRECTION defines the direction to move to."
4897 (let ((comment-start (python-syntax-context 'comment
))
4898 (factor (if (< (or direction
0) 0)
4902 (goto-char comment-start
))
4903 (forward-comment factor
)))
4905 (defun python-util-list-directories (directory &optional predicate max-depth
)
4906 "List DIRECTORY subdirs, filtered by PREDICATE and limited by MAX-DEPTH.
4907 Argument PREDICATE defaults to `identity' and must be a function
4908 that takes one argument (a full path) and returns non-nil for
4909 allowed files. When optional argument MAX-DEPTH is non-nil, stop
4910 searching when depth is reached, else don't limit."
4911 (let* ((dir (expand-file-name directory
))
4912 (dir-length (length dir
))
4913 (predicate (or predicate
#'identity
))
4914 (to-scan (list dir
))
4917 (let ((current-dir (car to-scan
)))
4918 (when (funcall predicate current-dir
)
4919 (setq tally
(cons current-dir tally
)))
4920 (setq to-scan
(append (cdr to-scan
)
4921 (python-util-list-files
4922 current-dir
#'file-directory-p
)
4924 (when (and max-depth
4926 (length (split-string
4927 (substring current-dir dir-length
)
4929 (setq to-scan nil
))))
4932 (defun python-util-list-files (dir &optional predicate
)
4933 "List files in DIR, filtering with PREDICATE.
4934 Argument PREDICATE defaults to `identity' and must be a function
4935 that takes one argument (a full path) and returns non-nil for
4937 (let ((dir-name (file-name-as-directory dir
)))
4939 (mapcar (lambda (file-name)
4940 (let ((full-file-name (expand-file-name file-name dir-name
)))
4942 (not (member file-name
'("." "..")))
4943 (funcall (or predicate
#'identity
) full-file-name
))
4944 (list full-file-name
))))
4945 (directory-files dir-name
)))))
4947 (defun python-util-list-packages (dir &optional max-depth
)
4948 "List packages in DIR, limited by MAX-DEPTH.
4949 When optional argument MAX-DEPTH is non-nil, stop searching when
4950 depth is reached, else don't limit."
4951 (let* ((dir (expand-file-name dir
))
4952 (parent-dir (file-name-directory
4953 (directory-file-name
4954 (file-name-directory
4955 (file-name-as-directory dir
)))))
4956 (subpath-length (length parent-dir
)))
4959 (replace-regexp-in-string
4960 (rx (or ?
\\ ?
/)) "." (substring file-name subpath-length
)))
4961 (python-util-list-directories
4962 (directory-file-name dir
)
4964 (file-exists-p (expand-file-name "__init__.py" dir
)))
4967 (defun python-util-popn (lst n
)
4968 "Return LST first N elements.
4969 N should be an integer, when negative its opposite is used.
4970 When N is bigger than the length of LST, the list is
4972 (let* ((n (min (abs n
)))
4978 (setq acc
(cons (car lst
) acc
)
4983 (defun python-util-strip-string (string)
4984 "Strip STRING whitespace and newlines from end and beginning."
4985 (replace-regexp-in-string
4986 (rx (or (: string-start
(* (any whitespace ?
\r ?
\n)))
4987 (: (* (any whitespace ?
\r ?
\n)) string-end
)))
4991 (defun python-util-valid-regexp-p (regexp)
4992 "Return non-nil if REGEXP is valid."
4993 (ignore-errors (string-match regexp
"") t
))
4996 (defun python-electric-pair-string-delimiter ()
4997 (when (and electric-pair-mode
4998 (memq last-command-event
'(?
\" ?
\'))
5000 (while (eq (char-before (- (point) count
)) last-command-event
)
5003 (eq (char-after) last-command-event
))
5004 (save-excursion (insert (make-string 2 last-command-event
)))))
5006 (defvar electric-indent-inhibit
)
5009 (define-derived-mode python-mode prog-mode
"Python"
5010 "Major mode for editing Python files.
5012 \\{python-mode-map}"
5013 (set (make-local-variable 'tab-width
) 8)
5014 (set (make-local-variable 'indent-tabs-mode
) nil
)
5016 (set (make-local-variable 'comment-start
) "# ")
5017 (set (make-local-variable 'comment-start-skip
) "#+\\s-*")
5019 (set (make-local-variable 'parse-sexp-lookup-properties
) t
)
5020 (set (make-local-variable 'parse-sexp-ignore-comments
) t
)
5022 (set (make-local-variable 'forward-sexp-function
)
5023 'python-nav-forward-sexp
)
5025 (set (make-local-variable 'font-lock-defaults
)
5026 '(python-font-lock-keywords
5028 (font-lock-syntactic-face-function
5029 . python-font-lock-syntactic-face-function
)))
5031 (set (make-local-variable 'syntax-propertize-function
)
5032 python-syntax-propertize-function
)
5034 (set (make-local-variable 'indent-line-function
)
5035 #'python-indent-line-function
)
5036 (set (make-local-variable 'indent-region-function
) #'python-indent-region
)
5037 ;; Because indentation is not redundant, we cannot safely reindent code.
5038 (set (make-local-variable 'electric-indent-inhibit
) t
)
5039 (set (make-local-variable 'electric-indent-chars
)
5040 (cons ?
: electric-indent-chars
))
5042 ;; Add """ ... """ pairing to electric-pair-mode.
5043 (add-hook 'post-self-insert-hook
5044 #'python-electric-pair-string-delimiter
'append t
)
5046 (set (make-local-variable 'paragraph-start
) "\\s-*$")
5047 (set (make-local-variable 'fill-paragraph-function
)
5048 #'python-fill-paragraph
)
5050 (set (make-local-variable 'beginning-of-defun-function
)
5051 #'python-nav-beginning-of-defun
)
5052 (set (make-local-variable 'end-of-defun-function
)
5053 #'python-nav-end-of-defun
)
5055 (add-hook 'completion-at-point-functions
5056 #'python-completion-at-point nil
'local
)
5058 (add-hook 'post-self-insert-hook
5059 #'python-indent-post-self-insert-function
'append
'local
)
5061 (set (make-local-variable 'imenu-create-index-function
)
5062 #'python-imenu-create-index
)
5064 (set (make-local-variable 'add-log-current-defun-function
)
5065 #'python-info-current-defun
)
5067 (add-hook 'which-func-functions
#'python-info-current-defun
nil t
)
5069 (set (make-local-variable 'skeleton-further-elements
)
5071 (< '(backward-delete-char-untabify (min python-indent-offset
5073 (^
'(- (1+ (current-indentation))))))
5075 (if (null eldoc-documentation-function
)
5077 (set (make-local-variable 'eldoc-documentation-function
)
5078 #'python-eldoc-function
)
5079 (add-function :before-until
(local 'eldoc-documentation-function
)
5080 #'python-eldoc-function
))
5083 'hs-special-modes-alist
5085 "\\s-*\\(?:def\\|class\\)\\>"
5086 ;; Use the empty string as end regexp so it doesn't default to
5087 ;; "\\s)". This way parens at end of defun are properly hidden.
5090 python-hideshow-forward-sexp-function
5093 (set (make-local-variable 'outline-regexp
)
5094 (python-rx (* space
) block-start
))
5095 (set (make-local-variable 'outline-heading-end-regexp
) ":[^\n]*\n")
5096 (set (make-local-variable 'outline-level
)
5098 "`outline-level' function for Python mode."
5099 (1+ (/ (current-indentation) python-indent-offset
))))
5101 (python-skeleton-add-menu-items)
5103 (make-local-variable 'python-shell-internal-buffer
)
5105 (when python-indent-guess-indent-offset
5106 (python-indent-guess-indent-offset)))
5113 ;; indent-tabs-mode: nil
5116 ;;; python.el ends here