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 <fabian@anue.biz>
6 ;; URL: https://github.com/fgallina/python.el
8 ;; Maintainer: emacs-devel@gnu.org
10 ;; Keywords: languages
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published
16 ;; by the Free Software Foundation, either version 3 of the License,
17 ;; or (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful, but
20 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 ;; General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
29 ;; Major mode for editing Python files with some fontification and
30 ;; indentation bits extracted from original Dave Love's python.el
31 ;; found in GNU/Emacs.
33 ;; Implements Syntax highlighting, Indentation, Movement, Shell
34 ;; interaction, Shell completion, Shell virtualenv support, Shell
35 ;; package support, Shell syntax highlighting, Pdb tracking, Symbol
36 ;; completion, Skeletons, FFAP, Code Check, Eldoc, Imenu.
38 ;; Syntax highlighting: Fontification of code is provided and supports
39 ;; python's triple quoted strings properly.
41 ;; Indentation: Automatic indentation with indentation cycling is
42 ;; provided, it allows you to navigate different available levels of
43 ;; indentation by hitting <tab> several times. Also electric-indent-mode
44 ;; is supported such that when inserting a colon the current line is
45 ;; dedented automatically if needed.
47 ;; Movement: `beginning-of-defun' and `end-of-defun' functions are
48 ;; properly implemented. There are also specialized
49 ;; `forward-sentence' and `backward-sentence' replacements called
50 ;; `python-nav-forward-block', `python-nav-backward-block'
51 ;; respectively which navigate between beginning of blocks of code.
52 ;; Extra functions `python-nav-forward-statement',
53 ;; `python-nav-backward-statement',
54 ;; `python-nav-beginning-of-statement', `python-nav-end-of-statement',
55 ;; `python-nav-beginning-of-block', `python-nav-end-of-block' and
56 ;; `python-nav-if-name-main' are included but no bound to any key. At
57 ;; last but not least the specialized `python-nav-forward-sexp' allows
58 ;; easy navigation between code blocks. If you prefer `cc-mode'-like
59 ;; `forward-sexp' movement, setting `forward-sexp-function' to nil is
60 ;; enough, You can do that using the `python-mode-hook':
62 ;; (add-hook 'python-mode-hook
63 ;; (lambda () (setq forward-sexp-function nil)))
65 ;; Shell interaction: is provided and allows opening Python shells
66 ;; inside Emacs and executing any block of code of your current buffer
67 ;; in that inferior Python process.
69 ;; Besides that only the standard CPython (2.x and 3.x) shell and
70 ;; IPython are officially supported out of the box, the interaction
71 ;; should support any other readline based Python shells as well
72 ;; (e.g. Jython and PyPy have been reported to work). You can change
73 ;; your default interpreter and commandline arguments by setting the
74 ;; `python-shell-interpreter' and `python-shell-interpreter-args'
75 ;; variables. This example enables IPython globally:
77 ;; (setq python-shell-interpreter "ipython"
78 ;; python-shell-interpreter-args "-i")
80 ;; Using the "console" subcommand to start IPython in server-client
81 ;; mode is known to fail intermittently due a bug on IPython itself
82 ;; (see URL `http://debbugs.gnu.org/cgi/bugreport.cgi?bug=18052#27').
83 ;; There seems to be a race condition in the IPython server (A.K.A
84 ;; kernel) when code is sent while it is still initializing, sometimes
85 ;; causing the shell to get stalled. With that said, if an IPython
86 ;; kernel is already running, "console --existing" seems to work fine.
88 ;; Running IPython on Windows needs more tweaking. The way you should
89 ;; set `python-shell-interpreter' and `python-shell-interpreter-args'
90 ;; is as follows (of course you need to modify the paths according to
93 ;; (setq python-shell-interpreter "C:\\Python27\\python.exe"
94 ;; python-shell-interpreter-args
95 ;; "-i C:\\Python27\\Scripts\\ipython-script.py")
97 ;; Missing or delayed output used to happen due to differences between
98 ;; Operating Systems' pipe buffering (e.g. CPython 3.3.4 in Windows 7.
99 ;; See URL `http://debbugs.gnu.org/cgi/bugreport.cgi?bug=17304'). To
100 ;; avoid this, the `python-shell-unbuffered' defaults to non-nil and
101 ;; controls whether `python-shell-calculate-process-environment'
102 ;; should set the "PYTHONUNBUFFERED" environment variable on startup:
103 ;; See URL `https://docs.python.org/3/using/cmdline.html#cmdoption-u'.
105 ;; The interaction relies upon having prompts for input (e.g. ">>> "
106 ;; and "... " in standard Python shell) and output (e.g. "Out[1]: " in
107 ;; IPython) detected properly. Failing that Emacs may hang but, in
108 ;; the case that happens, you can recover with \\[keyboard-quit]. To
109 ;; avoid this issue, a two-step prompt autodetection mechanism is
110 ;; provided: the first step is manual and consists of a collection of
111 ;; regular expressions matching common prompts for Python shells
112 ;; stored in `python-shell-prompt-input-regexps' and
113 ;; `python-shell-prompt-output-regexps', and dir-local friendly vars
114 ;; `python-shell-prompt-regexp', `python-shell-prompt-block-regexp',
115 ;; `python-shell-prompt-output-regexp' which are appended to the
116 ;; former automatically when a shell spawns; the second step is
117 ;; automatic and depends on the `python-shell-prompt-detect' helper
118 ;; function. See its docstring for details on global variables that
119 ;; modify its behavior.
121 ;; Shell completion: hitting tab will try to complete the current
122 ;; word. The two built-in mechanisms depend on Python's readline
123 ;; module: the "native" completion is tried first and is activated
124 ;; when `python-shell-completion-native-enable' is non-nil, the
125 ;; current `python-shell-interpreter' is not a member of the
126 ;; `python-shell-completion-native-disabled-interpreters' variable and
127 ;; `python-shell-completion-native-setup' succeeds; the "fallback" or
128 ;; "legacy" mechanism works by executing Python code in the background
129 ;; and enables auto-completion for shells that do not support
130 ;; receiving escape sequences (with some limitations, i.e. completion
131 ;; in blocks does not work). The code executed for the "fallback"
132 ;; completion can be found in `python-shell-completion-setup-code' and
133 ;; `python-shell-completion-string-code' variables. Their default
134 ;; values enable completion for both CPython and IPython, and probably
135 ;; any readline based shell (it's known to work with PyPy). If your
136 ;; Python installation lacks readline (like CPython for Windows),
137 ;; installing pyreadline (URL `http://ipython.org/pyreadline.html')
138 ;; should suffice. To troubleshoot why you are not getting any
139 ;; completions, you can try the following in your Python shell:
141 ;; >>> import readline, rlcompleter
143 ;; If you see an error, then you need to either install pyreadline or
144 ;; setup custom code that avoids that dependency.
146 ;; Shell virtualenv support: The shell also contains support for
147 ;; virtualenvs and other special environment modifications thanks to
148 ;; `python-shell-process-environment' and `python-shell-exec-path'.
149 ;; These two variables allows you to modify execution paths and
150 ;; environment variables to make easy for you to setup virtualenv rules
151 ;; or behavior modifications when running shells. Here is an example
152 ;; of how to make shell processes to be run using the /path/to/env/
155 ;; (setq python-shell-process-environment
157 ;; (format "PATH=%s" (mapconcat
160 ;; (cons (getenv "PATH")
161 ;; '("/path/to/env/bin/")))
163 ;; "VIRTUAL_ENV=/path/to/env/"))
164 ;; (python-shell-exec-path . ("/path/to/env/bin/"))
166 ;; Since the above is cumbersome and can be programmatically
167 ;; calculated, the variable `python-shell-virtualenv-root' is
168 ;; provided. When this variable is set with the path of the
169 ;; virtualenv to use, `process-environment' and `exec-path' get proper
170 ;; values in order to run shells inside the specified virtualenv. So
171 ;; the following will achieve the same as the previous example:
173 ;; (setq python-shell-virtualenv-root "/path/to/env/")
175 ;; Also the `python-shell-extra-pythonpaths' variable have been
176 ;; introduced as simple way of adding paths to the PYTHONPATH without
177 ;; affecting existing values.
179 ;; Shell package support: you can enable a package in the current
180 ;; shell so that relative imports work properly using the
181 ;; `python-shell-package-enable' command.
183 ;; Shell syntax highlighting: when enabled current input in shell is
184 ;; highlighted. The variable `python-shell-font-lock-enable' controls
185 ;; activation of this feature globally when shells are started.
186 ;; Activation/deactivation can be also controlled on the fly via the
187 ;; `python-shell-font-lock-toggle' command.
189 ;; Pdb tracking: when you execute a block of code that contains some
190 ;; call to pdb (or ipdb) it will prompt the block of code and will
191 ;; follow the execution of pdb marking the current line with an arrow.
193 ;; Symbol completion: you can complete the symbol at point. It uses
194 ;; the shell completion in background so you should run
195 ;; `python-shell-send-buffer' from time to time to get better results.
197 ;; Skeletons: skeletons are provided for simple inserting of things like class,
198 ;; def, for, import, if, try, and while. These skeletons are
199 ;; integrated with abbrev. If you have `abbrev-mode' activated and
200 ;; `python-skeleton-autoinsert' is set to t, then whenever you type
201 ;; the name of any of those defined and hit SPC, they will be
202 ;; automatically expanded. As an alternative you can use the defined
203 ;; skeleton commands: `python-skeleton-<foo>'.
205 ;; FFAP: You can find the filename for a given module when using ffap
206 ;; out of the box. This feature needs an inferior python shell
209 ;; Code check: Check the current file for errors with `python-check'
210 ;; using the program defined in `python-check-command'.
212 ;; Eldoc: returns documentation for object at point by using the
213 ;; inferior python subprocess to inspect its documentation. As you
214 ;; might guessed you should run `python-shell-send-buffer' from time
215 ;; to time to get better results too.
217 ;; Imenu: There are two index building functions to be used as
218 ;; `imenu-create-index-function': `python-imenu-create-index' (the
219 ;; default one, builds the alist in form of a tree) and
220 ;; `python-imenu-create-flat-index'. See also
221 ;; `python-imenu-format-item-label-function',
222 ;; `python-imenu-format-parent-item-label-function',
223 ;; `python-imenu-format-parent-item-jump-label-function' variables for
224 ;; changing the way labels are formatted in the tree version.
226 ;; If you used python-mode.el you may miss auto-indentation when
227 ;; inserting newlines. To achieve the same behavior you have two
230 ;; 1) Enable the minor-mode `electric-indent-mode' (enabled by
231 ;; default) and use RET. If this mode is disabled use
232 ;; `newline-and-indent', bound to C-j.
234 ;; 2) Add the following hook in your .emacs:
236 ;; (add-hook 'python-mode-hook
238 ;; (define-key python-mode-map "\C-m" 'newline-and-indent)))
240 ;; I'd recommend the first one since you'll get the same behavior for
241 ;; all modes out-of-the-box.
245 ;; Add this to your .emacs:
247 ;; (add-to-list 'load-path "/folder/containing/file")
254 (require 'ansi-color
)
259 ;; Avoid compiler warnings
260 (defvar view-return-to-alist
)
261 (defvar compilation-error-regexp-alist
)
262 (defvar outline-heading-end-regexp
)
264 (autoload 'comint-mode
"comint")
265 (autoload 'help-function-arglist
"help-fns")
268 (add-to-list 'auto-mode-alist
(cons (purecopy "\\.py\\'") 'python-mode
))
270 (add-to-list 'interpreter-mode-alist
(cons (purecopy "python[0-9.]*") 'python-mode
))
273 "Python Language's flying circus support for Emacs."
276 :link
'(emacs-commentary-link "python"))
281 (defvar python-mode-map
282 (let ((map (make-sparse-keymap)))
284 (define-key map
[remap backward-sentence
] 'python-nav-backward-block
)
285 (define-key map
[remap forward-sentence
] 'python-nav-forward-block
)
286 (define-key map
[remap backward-up-list
] 'python-nav-backward-up-list
)
287 (define-key map
"\C-c\C-j" 'imenu
)
289 (define-key map
"\177" 'python-indent-dedent-line-backspace
)
290 (define-key map
(kbd "<backtab>") 'python-indent-dedent-line
)
291 (define-key map
"\C-c<" 'python-indent-shift-left
)
292 (define-key map
"\C-c>" 'python-indent-shift-right
)
294 (define-key map
"\C-c\C-tc" 'python-skeleton-class
)
295 (define-key map
"\C-c\C-td" 'python-skeleton-def
)
296 (define-key map
"\C-c\C-tf" 'python-skeleton-for
)
297 (define-key map
"\C-c\C-ti" 'python-skeleton-if
)
298 (define-key map
"\C-c\C-tm" 'python-skeleton-import
)
299 (define-key map
"\C-c\C-tt" 'python-skeleton-try
)
300 (define-key map
"\C-c\C-tw" 'python-skeleton-while
)
302 (define-key map
"\C-c\C-p" 'run-python
)
303 (define-key map
"\C-c\C-s" 'python-shell-send-string
)
304 (define-key map
"\C-c\C-r" 'python-shell-send-region
)
305 (define-key map
"\C-\M-x" 'python-shell-send-defun
)
306 (define-key map
"\C-c\C-c" 'python-shell-send-buffer
)
307 (define-key map
"\C-c\C-l" 'python-shell-send-file
)
308 (define-key map
"\C-c\C-z" 'python-shell-switch-to-shell
)
309 ;; Some util commands
310 (define-key map
"\C-c\C-v" 'python-check
)
311 (define-key map
"\C-c\C-f" 'python-eldoc-at-point
)
313 (substitute-key-definition 'complete-symbol
'completion-at-point
315 (easy-menu-define python-menu map
"Python Mode menu"
317 :help
"Python-specific Features"
318 ["Shift region left" python-indent-shift-left
:active mark-active
319 :help
"Shift region left by a single indentation step"]
320 ["Shift region right" python-indent-shift-right
:active mark-active
321 :help
"Shift region right by a single indentation step"]
323 ["Start of def/class" beginning-of-defun
324 :help
"Go to start of outermost definition around point"]
325 ["End of def/class" end-of-defun
326 :help
"Go to end of definition around point"]
327 ["Mark def/class" mark-defun
328 :help
"Mark outermost definition around point"]
329 ["Jump to def/class" imenu
330 :help
"Jump to a class or function definition"]
334 ["Start interpreter" run-python
335 :help
"Run inferior Python process in a separate buffer"]
336 ["Switch to shell" python-shell-switch-to-shell
337 :help
"Switch to running inferior Python process"]
338 ["Eval string" python-shell-send-string
339 :help
"Eval string in inferior Python session"]
340 ["Eval buffer" python-shell-send-buffer
341 :help
"Eval buffer in inferior Python session"]
342 ["Eval region" python-shell-send-region
343 :help
"Eval region in inferior Python session"]
344 ["Eval defun" python-shell-send-defun
345 :help
"Eval defun in inferior Python session"]
346 ["Eval file" python-shell-send-file
347 :help
"Eval file in inferior Python session"]
348 ["Debugger" pdb
:help
"Run pdb under GUD"]
350 ["Check file" python-check
351 :help
"Check file for errors"]
352 ["Help on symbol" python-eldoc-at-point
353 :help
"Get help on symbol at point"]
354 ["Complete symbol" completion-at-point
355 :help
"Complete symbol before point"]))
357 "Keymap for `python-mode'.")
360 ;;; Python specialized rx
363 (defconst python-rx-constituents
364 `((block-start .
,(rx symbol-start
365 (or "def" "class" "if" "elif" "else" "try"
366 "except" "finally" "for" "while" "with")
368 (dedenter .
,(rx symbol-start
369 (or "elif" "else" "except" "finally")
371 (block-ender .
,(rx symbol-start
373 "break" "continue" "pass" "raise" "return")
375 (decorator .
,(rx line-start
(* space
) ?
@ (any letter ?_
)
377 (defun .
,(rx symbol-start
(or "def" "class") symbol-end
))
378 (if-name-main .
,(rx line-start
"if" (+ space
) "__name__"
379 (+ space
) "==" (+ space
)
380 (any ?
' ?
\") "__main__" (any ?
' ?
\")
382 (symbol-name .
,(rx (any letter ?_
) (* (any word ?_
))))
383 (open-paren .
,(rx (or "{" "[" "(")))
384 (close-paren .
,(rx (or "}" "]" ")")))
385 (simple-operator .
,(rx (any ?
+ ?- ?
/ ?
& ?^ ?~ ?| ?
* ?
< ?
> ?
= ?%
)))
386 ;; FIXME: rx should support (not simple-operator).
387 (not-simple-operator .
,(rx
389 (any ?
+ ?- ?
/ ?
& ?^ ?~ ?| ?
* ?
< ?
> ?
= ?%
))))
390 ;; FIXME: Use regexp-opt.
391 (operator .
,(rx (or "+" "-" "/" "&" "^" "~" "|" "*" "<" ">"
392 "=" "%" "**" "//" "<<" ">>" "<=" "!="
393 "==" ">=" "is" "not")))
394 ;; FIXME: Use regexp-opt.
395 (assignment-operator .
,(rx (or "=" "+=" "-=" "*=" "/=" "//=" "%=" "**="
396 ">>=" "<<=" "&=" "^=" "|=")))
397 (string-delimiter .
,(rx (and
398 ;; Match even number of backslashes.
399 (or (not (any ?
\\ ?
\' ?
\")) point
400 ;; Quotes might be preceded by a escaped quote.
401 (and (or (not (any ?
\\)) point
) ?
\\
402 (* ?
\\ ?
\\) (any ?
\' ?
\")))
404 ;; Match single or triple quotes of any kind.
405 (group (or "\"" "\"\"\"" "'" "'''")))))
406 (coding-cookie .
,(rx line-start ?
# (* space
)
408 ;; # coding=<encoding name>
409 (: "coding" (or ?
: ?
=) (* space
) (group-n 1 (+ (or word ?-
))))
410 ;; # -*- coding: <encoding name> -*-
411 (: "-*-" (* space
) "coding:" (* space
)
412 (group-n 1 (+ (or word ?-
))) (* space
) "-*-")
413 ;; # vim: set fileencoding=<encoding name> :
414 (: "vim:" (* space
) "set" (+ space
)
415 "fileencoding" (* space
) ?
= (* space
)
416 (group-n 1 (+ (or word ?-
))) (* space
) ":")))))
417 "Additional Python specific sexps for `python-rx'")
419 (defmacro python-rx
(&rest regexps
)
420 "Python mode specialized rx macro.
421 This variant of `rx' supports common Python named REGEXPS."
422 (let ((rx-constituents (append python-rx-constituents rx-constituents
)))
423 (cond ((null regexps
)
426 (rx-to-string `(and ,@regexps
) t
))
428 (rx-to-string (car regexps
) t
))))))
431 ;;; Font-lock and syntax
434 (defun python-syntax--context-compiler-macro (form type
&optional syntax-ppss
)
437 `(let ((ppss (or ,syntax-ppss
(syntax-ppss))))
438 (and (nth 4 ppss
) (nth 8 ppss
))))
440 `(let ((ppss (or ,syntax-ppss
(syntax-ppss))))
441 (and (nth 3 ppss
) (nth 8 ppss
))))
443 `(nth 1 (or ,syntax-ppss
(syntax-ppss))))
446 (defun python-syntax-context (type &optional syntax-ppss
)
447 "Return non-nil if point is on TYPE using SYNTAX-PPSS.
448 TYPE can be `comment', `string' or `paren'. It returns the start
449 character address of the specified TYPE."
450 (declare (compiler-macro python-syntax--context-compiler-macro
))
451 (let ((ppss (or syntax-ppss
(syntax-ppss))))
453 (`comment
(and (nth 4 ppss
) (nth 8 ppss
)))
454 (`string
(and (nth 3 ppss
) (nth 8 ppss
)))
455 (`paren
(nth 1 ppss
))
458 (defun python-syntax-context-type (&optional syntax-ppss
)
459 "Return the context type using SYNTAX-PPSS.
460 The type returned can be `comment', `string' or `paren'."
461 (let ((ppss (or syntax-ppss
(syntax-ppss))))
463 ((nth 8 ppss
) (if (nth 4 ppss
) 'comment
'string
))
464 ((nth 1 ppss
) 'paren
))))
466 (defsubst python-syntax-comment-or-string-p
(&optional ppss
)
467 "Return non-nil if PPSS is inside 'comment or 'string."
468 (nth 8 (or ppss
(syntax-ppss))))
470 (defsubst python-syntax-closing-paren-p
()
471 "Return non-nil if char after point is a closing paren."
472 (= (syntax-class (syntax-after (point)))
473 (syntax-class (string-to-syntax ")"))))
475 (define-obsolete-function-alias
476 'python-info-ppss-context
#'python-syntax-context
"24.3")
478 (define-obsolete-function-alias
479 'python-info-ppss-context-type
#'python-syntax-context-type
"24.3")
481 (define-obsolete-function-alias
482 'python-info-ppss-comment-or-string-p
483 #'python-syntax-comment-or-string-p
"24.3")
485 (defun python-docstring-at-p (pos)
486 "Check to see if there is a docstring at POS."
489 (if (looking-at-p "'''\\|\"\"\"")
491 (python-nav-backward-statement)
492 (looking-at "\\`\\|class \\|def "))
495 (defun python-font-lock-syntactic-face-function (state)
497 (if (python-docstring-at-p (nth 8 state
))
499 font-lock-string-face
)
500 font-lock-comment-face
))
502 (defvar python-font-lock-keywords
506 "and" "del" "from" "not" "while" "as" "elif" "global" "or" "with"
507 "assert" "else" "if" "pass" "yield" "break" "except" "import" "class"
508 "in" "raise" "continue" "finally" "is" "return" "def" "for" "lambda"
513 ;; False, None, and True are listed as keywords on the Python 3
514 ;; documentation, but since they also qualify as constants they are
515 ;; fontified like that in order to keep font-lock consistent between
522 (,(rx symbol-start
"def" (1+ space
) (group (1+ (or word ?_
))))
523 (1 font-lock-function-name-face
))
525 (,(rx symbol-start
"class" (1+ space
) (group (1+ (or word ?_
))))
526 (1 font-lock-type-face
))
530 "Ellipsis" "False" "None" "NotImplemented" "True" "__debug__"
531 ;; copyright, license, credits, quit and exit are added by the site
532 ;; module and they are not intended to be used in programs
533 "copyright" "credits" "exit" "license" "quit")
534 symbol-end
) . font-lock-constant-face
)
536 (,(rx line-start
(* (any " \t")) (group "@" (1+ (or word ?_
))
537 (0+ "." (1+ (or word ?_
)))))
538 (1 font-lock-type-face
))
539 ;; Builtin Exceptions
542 "ArithmeticError" "AssertionError" "AttributeError" "BaseException"
543 "DeprecationWarning" "EOFError" "EnvironmentError" "Exception"
544 "FloatingPointError" "FutureWarning" "GeneratorExit" "IOError"
545 "ImportError" "ImportWarning" "IndexError" "KeyError"
546 "KeyboardInterrupt" "LookupError" "MemoryError" "NameError"
547 "NotImplementedError" "OSError" "OverflowError"
548 "PendingDeprecationWarning" "ReferenceError" "RuntimeError"
549 "RuntimeWarning" "StopIteration" "SyntaxError" "SyntaxWarning"
550 "SystemError" "SystemExit" "TypeError" "UnboundLocalError"
551 "UnicodeDecodeError" "UnicodeEncodeError" "UnicodeError"
552 "UnicodeTranslateError" "UnicodeWarning" "UserWarning" "VMSError"
553 "ValueError" "Warning" "WindowsError" "ZeroDivisionError"
557 "BufferError" "BytesWarning" "IndentationError" "ResourceWarning"
559 symbol-end
) . font-lock-type-face
)
563 "abs" "all" "any" "bin" "bool" "callable" "chr" "classmethod"
564 "compile" "complex" "delattr" "dict" "dir" "divmod" "enumerate"
565 "eval" "filter" "float" "format" "frozenset" "getattr" "globals"
566 "hasattr" "hash" "help" "hex" "id" "input" "int" "isinstance"
567 "issubclass" "iter" "len" "list" "locals" "map" "max" "memoryview"
568 "min" "next" "object" "oct" "open" "ord" "pow" "print" "property"
569 "range" "repr" "reversed" "round" "set" "setattr" "slice" "sorted"
570 "staticmethod" "str" "sum" "super" "tuple" "type" "vars" "zip"
573 "basestring" "cmp" "execfile" "file" "long" "raw_input" "reduce"
574 "reload" "unichr" "unicode" "xrange" "apply" "buffer" "coerce"
577 "ascii" "bytearray" "bytes" "exec"
579 "__all__" "__doc__" "__name__" "__package__")
580 symbol-end
) . font-lock-builtin-face
)
582 ;; support for a = b = c = 5
584 (let ((re (python-rx (group (+ (any word ?. ?_
)))
585 (? ?\
[ (+ (not (any ?\
]))) ?\
]) (* space
)
586 assignment-operator
))
588 (while (and (setq res
(re-search-forward re limit t
))
589 (or (python-syntax-context 'paren
)
590 (equal (char-after (point)) ?
=))))
592 (1 font-lock-variable-name-face nil nil
))
593 ;; support for a, b, c = (1, 2, 3)
595 (let ((re (python-rx (group (+ (any word ?. ?_
))) (* space
)
596 (* ?
, (* space
) (+ (any word ?. ?_
)) (* space
))
597 ?
, (* space
) (+ (any word ?. ?_
)) (* space
)
598 assignment-operator
))
600 (while (and (setq res
(re-search-forward re limit t
))
601 (goto-char (match-end 1))
602 (python-syntax-context 'paren
)))
604 (1 font-lock-variable-name-face nil nil
))))
606 (defconst python-syntax-propertize-function
607 (syntax-propertize-rules
608 ((python-rx string-delimiter
)
609 (0 (ignore (python-syntax-stringify))))))
611 (defsubst python-syntax-count-quotes
(quote-char &optional point limit
)
612 "Count number of quotes around point (max is 3).
613 QUOTE-CHAR is the quote char to count. Optional argument POINT is
614 the point where scan starts (defaults to current point), and LIMIT
615 is used to limit the scan."
618 (or (not limit
) (< (+ point i
) limit
))
619 (eq (char-after (+ point i
)) quote-char
))
623 (defun python-syntax-stringify ()
624 "Put `syntax-table' property correctly on single/triple quotes."
625 (let* ((num-quotes (length (match-string-no-properties 1)))
627 (backward-char num-quotes
)
629 (forward-char num-quotes
)))
630 (string-start (and (not (nth 4 ppss
)) (nth 8 ppss
)))
631 (quote-starting-pos (- (point) num-quotes
))
632 (quote-ending-pos (point))
635 (python-syntax-count-quotes
636 (char-before) string-start quote-starting-pos
))))
637 (cond ((and string-start
(= num-closing-quotes
0))
638 ;; This set of quotes doesn't match the string starting
642 ;; This set of quotes delimit the start of a string.
643 (put-text-property quote-starting-pos
(1+ quote-starting-pos
)
644 'syntax-table
(string-to-syntax "|")))
645 ((= num-quotes num-closing-quotes
)
646 ;; This set of quotes delimit the end of a string.
647 (put-text-property (1- quote-ending-pos
) quote-ending-pos
648 'syntax-table
(string-to-syntax "|")))
649 ((> num-quotes num-closing-quotes
)
650 ;; This may only happen whenever a triple quote is closing
651 ;; a single quoted string. Add string delimiter syntax to
653 (put-text-property quote-starting-pos quote-ending-pos
654 'syntax-table
(string-to-syntax "|"))))))
656 (defvar python-mode-syntax-table
657 (let ((table (make-syntax-table)))
658 ;; Give punctuation syntax to ASCII that normally has symbol
659 ;; syntax or has word syntax and isn't a letter.
660 (let ((symbol (string-to-syntax "_"))
661 (sst (standard-syntax-table)))
664 (if (equal symbol
(aref sst i
))
665 (modify-syntax-entry i
"." table
)))))
666 (modify-syntax-entry ?$
"." table
)
667 (modify-syntax-entry ?%
"." table
)
669 (modify-syntax-entry ?
# "<" table
)
670 (modify-syntax-entry ?
\n ">" table
)
671 (modify-syntax-entry ?
' "\"" table
)
672 (modify-syntax-entry ?
` "$" table
)
674 "Syntax table for Python files.")
676 (defvar python-dotty-syntax-table
677 (let ((table (make-syntax-table python-mode-syntax-table
)))
678 (modify-syntax-entry ?.
"w" table
)
679 (modify-syntax-entry ?_
"w" table
)
681 "Dotty syntax table for Python files.
682 It makes underscores and dots word constituent chars.")
687 (defcustom python-indent-offset
4
688 "Default indentation offset for Python."
693 (defcustom python-indent-guess-indent-offset t
694 "Non-nil tells Python mode to guess `python-indent-offset' value."
699 (defcustom python-indent-trigger-commands
700 '(indent-for-tab-command yas-expand yas
/expand
)
701 "Commands that might trigger a `python-indent-line' call."
702 :type
'(repeat symbol
)
705 (define-obsolete-variable-alias
706 'python-indent
'python-indent-offset
"24.3")
708 (define-obsolete-variable-alias
709 'python-guess-indent
'python-indent-guess-indent-offset
"24.3")
711 (defvar python-indent-current-level
0
712 "Deprecated var available for compatibility.")
714 (defvar python-indent-levels
'(0)
715 "Deprecated var available for compatibility.")
717 (make-obsolete-variable
718 'python-indent-current-level
719 "The indentation API changed to avoid global state.
720 The function `python-indent-calculate-levels' does not use it
721 anymore. If you were defadvising it and or depended on this
722 variable for indentation customizations, refactor your code to
723 work on `python-indent-calculate-indentation' instead."
726 (make-obsolete-variable
727 'python-indent-levels
728 "The indentation API changed to avoid global state.
729 The function `python-indent-calculate-levels' does not use it
730 anymore. If you were defadvising it and or depended on this
731 variable for indentation customizations, refactor your code to
732 work on `python-indent-calculate-indentation' instead."
735 (defun python-indent-guess-indent-offset ()
736 "Guess and set `python-indent-offset' for the current buffer."
741 (goto-char (point-min))
743 (while (and (not block-end
)
745 (python-rx line-start block-start
) nil t
))
747 (not (python-syntax-context-type))
749 (goto-char (line-end-position))
750 (python-util-forward-comment -
1)
751 (if (equal (char-before) ?
:)
754 (when (python-info-block-continuation-line-p)
755 (while (and (python-info-continuation-line-p)
758 (python-util-forward-comment -
1)
759 (when (equal (char-before) ?
:)
761 (setq block-end
(point-marker))))
764 (goto-char block-end
)
765 (python-util-forward-comment)
766 (current-indentation))))
767 (if (and indentation
(not (zerop indentation
)))
768 (set (make-local-variable 'python-indent-offset
) indentation
)
769 (message "Can't guess python-indent-offset, using defaults: %s"
770 python-indent-offset
)))))))
772 (defun python-indent-context ()
773 "Get information about the current indentation context.
774 Context is returned in a cons with the form (STATUS . START).
776 STATUS can be one of the following:
782 - Point is after a comment line.
783 - START is the position of the \"#\" character.
785 - Point is inside string.
786 - START is the position of the first quote that starts it.
788 - No possible indentation case matches.
789 - START is always zero.
792 - Fallback case when point is inside paren.
793 - START is the first non space char position *after* the open paren.
794 :inside-paren-at-closing-nested-paren
795 - Point is on a line that contains a nested paren closer.
796 - START is the position of the open paren it closes.
797 :inside-paren-at-closing-paren
798 - Point is on a line that contains a paren closer.
799 - START is the position of the open paren.
800 :inside-paren-newline-start
801 - Point is inside a paren with items starting in their own line.
802 - START is the position of the open paren.
803 :inside-paren-newline-start-from-block
804 - Point is inside a paren with items starting in their own line
806 - START is the position of the open paren.
809 - Fallback case when point is after backslash.
810 - START is the char after the position of the backslash.
811 :after-backslash-assignment-continuation
812 - Point is after a backslashed assignment.
813 - START is the char after the position of the backslash.
814 :after-backslash-block-continuation
815 - Point is after a backslashed block continuation.
816 - START is the char after the position of the backslash.
817 :after-backslash-dotted-continuation
818 - Point is after a backslashed dotted continuation. Previous
819 line must contain a dot to align with.
820 - START is the char after the position of the backslash.
821 :after-backslash-first-line
822 - First line following a backslashed continuation.
823 - START is the char after the position of the backslash.
826 - Point is after a line containing a block ender.
827 - START is the position where the ender starts.
829 - Point is after a line starting a block.
830 - START is the position where the block starts.
832 - Point is after a simple line.
833 - START is the position where the previous line starts.
834 :at-dedenter-block-start
835 - Point is on a line starting a dedenter block.
836 - START is the position where the dedenter block starts."
839 (let ((ppss (save-excursion
843 ;; Beginning of buffer.
844 ((= (line-number-at-pos) 1)
846 ;; Comment continuation (maybe).
850 (python-info-current-line-comment-p)
851 (python-info-current-line-empty-p))
853 (python-info-current-line-comment-p))
854 (cons :after-comment
(point)))))
856 ((let ((start (python-syntax-context 'string ppss
)))
858 (cons :inside-string start
))))
860 ((let* ((start (python-syntax-context 'paren ppss
))
867 (= (line-number-at-pos)
869 (python-util-forward-comment)
870 (line-number-at-pos))))))))
873 ;; Current line only holds the closing paren.
875 (skip-syntax-forward " ")
876 (when (and (python-syntax-closing-paren-p)
879 (not (python-syntax-context 'paren
))))
880 (cons :inside-paren-at-closing-paren start
))))
881 ;; Current line only holds a closing paren for nested.
883 (back-to-indentation)
884 (python-syntax-closing-paren-p))
885 (cons :inside-paren-at-closing-nested-paren start
))
886 ;; This line starts from a opening block in its own line.
892 (back-to-indentation)
893 (looking-at (python-rx block-start
))))
895 :inside-paren-newline-start-from-block start
))))
897 (cons :inside-paren-newline-start start
))
899 (t (cons :inside-paren
901 (goto-char (1+ start
))
902 (skip-syntax-forward "(" 1)
903 (skip-syntax-forward " ")
906 ((let ((start (when (not (python-syntax-comment-or-string-p ppss
))
907 (python-info-line-ends-backslash-p
908 (1- (line-number-at-pos))))))
911 ;; Continuation of dotted expression.
913 (back-to-indentation)
914 (when (eq (char-after) ?\.
)
915 ;; Move point back until it's not inside a paren.
919 (python-syntax-context 'paren
))))
920 (goto-char (line-end-position))
921 (while (and (search-backward
922 "." (line-beginning-position) t
)
923 (python-syntax-context-type)))
924 ;; Ensure previous statement has dot to align with.
925 (when (and (eq (char-after) ?\.
)
926 (not (python-syntax-context-type)))
927 (cons :after-backslash-dotted-continuation
(point))))))
928 ;; Continuation of block definition.
929 ((let ((block-continuation-start
930 (python-info-block-continuation-line-p)))
931 (when block-continuation-start
933 (goto-char block-continuation-start
)
935 (python-rx block-start
(* space
))
936 (line-end-position) t
)
937 (cons :after-backslash-block-continuation
(point))))))
938 ;; Continuation of assignment.
939 ((let ((assignment-continuation-start
940 (python-info-assignment-continuation-line-p)))
941 (when assignment-continuation-start
943 (goto-char assignment-continuation-start
)
944 (cons :after-backslash-assignment-continuation
(point))))))
945 ;; First line after backslash continuation start.
948 (when (or (= (line-number-at-pos) 1)
949 (not (python-info-beginning-of-backslash
950 (1- (line-number-at-pos)))))
951 (cons :after-backslash-first-line start
))))
953 (t (cons :after-backslash start
))))))
954 ;; After beginning of block.
955 ((let ((start (save-excursion
956 (back-to-indentation)
957 (python-util-forward-comment -
1)
958 (when (equal (char-before) ?
:)
959 (python-nav-beginning-of-block)))))
961 (cons :after-block-start start
))))
962 ;; At dedenter statement.
963 ((let ((start (python-info-dedenter-statement-p)))
965 (cons :at-dedenter-block-start start
))))
966 ;; After normal line.
967 ((let ((start (save-excursion
968 (back-to-indentation)
969 (skip-chars-backward " \t\n")
970 (python-nav-beginning-of-statement)
974 (python-util-forward-comment -
1)
975 (python-nav-beginning-of-statement)
976 (looking-at (python-rx block-ender
)))
977 (cons :after-block-end start
)
978 (cons :after-line start
)))))
979 ;; Default case: do not indent.
980 (t (cons :no-indent
0))))))
982 (defun python-indent--calculate-indentation ()
983 "Internal implementation of `python-indent-calculate-indentation'.
984 May return an integer for the maximum possible indentation at
985 current context or a list of integers. The latter case is only
986 happening for :at-dedenter-block-start context since the
987 possibilities can be narrowed to especific indentation points."
991 (pcase (python-indent-context)
992 (`(:no-indent .
,_
) 0)
997 :inside-paren-at-closing-paren
998 :inside-paren-at-closing-nested-paren
) .
,start
)
999 ;; Copy previous indentation.
1001 (current-indentation))
1002 (`(,(or :after-block-start
1003 :after-backslash-first-line
1004 :inside-paren-newline-start
) .
,start
)
1005 ;; Add one indentation level.
1007 (+ (current-indentation) python-indent-offset
))
1008 (`(,(or :inside-paren
1009 :after-backslash-block-continuation
1010 :after-backslash-assignment-continuation
1011 :after-backslash-dotted-continuation
) .
,start
)
1012 ;; Use the column given by the context.
1015 (`(:after-block-end .
,start
)
1016 ;; Subtract one indentation level.
1018 (- (current-indentation) python-indent-offset
))
1019 (`(:at-dedenter-block-start .
,_
)
1020 ;; List all possible indentation levels from opening blocks.
1021 (let ((opening-block-start-points
1022 (python-info-dedenter-opening-block-positions)))
1023 (if (not opening-block-start-points
)
1024 0 ; if not found default to first column
1025 (mapcar (lambda (pos)
1028 (current-indentation)))
1029 opening-block-start-points
))))
1030 (`(,(or :inside-paren-newline-start-from-block
) .
,start
)
1031 ;; Add two indentation levels to make the suite stand out.
1033 (+ (current-indentation) (* python-indent-offset
2)))))))
1035 (defun python-indent--calculate-levels (indentation)
1036 "Calculate levels list given INDENTATION.
1037 Argument INDENTATION can either be an integer or a list of
1038 integers. Levels are returned in ascending order, and in the
1039 case INDENTATION is a list, this order is enforced."
1040 (if (listp indentation
)
1041 (sort (copy-sequence indentation
) #'<)
1042 (let* ((remainder (% indentation python-indent-offset
))
1043 (steps (/ (- indentation remainder
) python-indent-offset
))
1044 (levels (mapcar (lambda (step)
1045 (* python-indent-offset step
))
1046 (number-sequence steps
0 -
1))))
1048 (if (not (zerop remainder
))
1049 (cons indentation levels
)
1052 (defun python-indent--previous-level (levels indentation
)
1053 "Return previous level from LEVELS relative to INDENTATION."
1054 (let* ((levels (sort (copy-sequence levels
) #'>))
1055 (default (car levels
)))
1057 (dolist (level levels
)
1058 (when (funcall #'< level indentation
)
1059 (throw 'return level
)))
1062 (defun python-indent-calculate-indentation (&optional previous
)
1063 "Calculate indentation.
1064 Get indentation of PREVIOUS level when argument is non-nil.
1065 Return the max level of the cycle when indentation reaches the
1067 (let* ((indentation (python-indent--calculate-indentation))
1068 (levels (python-indent--calculate-levels indentation
)))
1070 (python-indent--previous-level levels
(current-indentation))
1072 (apply #'max levels
)
1075 (defun python-indent-line (&optional previous
)
1076 "Internal implementation of `python-indent-line-function'.
1077 Use the PREVIOUS level when argument is non-nil, otherwise indent
1078 to the maxium available level. When indentation is the minimum
1079 possible and PREVIOUS is non-nil, cycle back to the maximum
1081 (let ((follow-indentation-p
1082 ;; Check if point is within indentation.
1083 (and (<= (line-beginning-position) (point))
1084 (>= (+ (line-beginning-position)
1085 (current-indentation))
1089 (python-indent-calculate-indentation previous
))
1090 (python-info-dedenter-opening-block-message))
1091 (when follow-indentation-p
1092 (back-to-indentation))))
1094 (defun python-indent-calculate-levels ()
1095 "Return possible indentation levels."
1096 (python-indent--calculate-levels
1097 (python-indent--calculate-indentation)))
1099 (defun python-indent-line-function ()
1100 "`indent-line-function' for Python mode.
1101 When the variable `last-command' is equal to one of the symbols
1102 inside `python-indent-trigger-commands' it cycles possible
1103 indentation levels from right to left."
1105 (and (memq this-command python-indent-trigger-commands
)
1106 (eq last-command this-command
))))
1108 (defun python-indent-dedent-line ()
1109 "De-indent current line."
1111 (when (and (not (bolp))
1112 (not (python-syntax-comment-or-string-p))
1113 (= (+ (line-beginning-position)
1114 (current-indentation))
1116 (python-indent-line t
)
1119 (defun python-indent-dedent-line-backspace (arg)
1120 "De-indent current line.
1121 Argument ARG is passed to `backward-delete-char-untabify' when
1122 point is not in between the indentation."
1124 (unless (python-indent-dedent-line)
1125 (backward-delete-char-untabify arg
)))
1127 (put 'python-indent-dedent-line-backspace
'delete-selection
'supersede
)
1129 (defun python-indent-region (start end
)
1130 "Indent a Python region automagically.
1132 Called from a program, START and END specify the region to indent."
1133 (let ((deactivate-mark nil
))
1136 (setq end
(point-marker))
1138 (or (bolp) (forward-line 1))
1139 (while (< (point) end
)
1140 (or (and (bolp) (eolp))
1142 ;; Skip if previous line is empty or a comment.
1144 (let ((line-is-comment-p
1145 (python-info-current-line-comment-p)))
1148 (or (and (python-info-current-line-comment-p)
1149 ;; Unless this line is a comment too.
1150 (not line-is-comment-p
))
1151 (python-info-current-line-empty-p)))))
1152 ;; Don't mess with strings, unless it's the
1153 ;; enclosing set of quotes.
1154 (or (not (python-syntax-context 'string
))
1158 (current-indentation)
1159 (python-syntax-count-quotes (char-after) (point))))
1160 (string-to-syntax "|")))
1161 ;; Skip if current line is a block start, a
1162 ;; dedenter or block ender.
1164 (back-to-indentation)
1167 (or block-start dedenter block-ender
))))))
1168 (python-indent-line)))
1170 (move-marker end nil
))))
1172 (defun python-indent-shift-left (start end
&optional count
)
1173 "Shift lines contained in region START END by COUNT columns to the left.
1174 COUNT defaults to `python-indent-offset'. If region isn't
1175 active, the current line is shifted. The shifted region includes
1176 the lines in which START and END lie. An error is signaled if
1177 any lines in the region are indented less than COUNT columns."
1180 (list (region-beginning) (region-end) current-prefix-arg
)
1181 (list (line-beginning-position) (line-end-position) current-prefix-arg
)))
1183 (setq count
(prefix-numeric-value count
))
1184 (setq count python-indent-offset
))
1186 (let ((deactivate-mark nil
))
1189 (while (< (point) end
)
1190 (if (and (< (current-indentation) count
)
1191 (not (looking-at "[ \t]*$")))
1192 (user-error "Can't shift all lines enough"))
1194 (indent-rigidly start end
(- count
))))))
1196 (defun python-indent-shift-right (start end
&optional count
)
1197 "Shift lines contained in region START END by COUNT columns to the right.
1198 COUNT defaults to `python-indent-offset'. If region isn't
1199 active, the current line is shifted. The shifted region includes
1200 the lines in which START and END lie."
1203 (list (region-beginning) (region-end) current-prefix-arg
)
1204 (list (line-beginning-position) (line-end-position) current-prefix-arg
)))
1205 (let ((deactivate-mark nil
))
1206 (setq count
(if count
(prefix-numeric-value count
)
1207 python-indent-offset
))
1208 (indent-rigidly start end count
)))
1210 (defun python-indent-post-self-insert-function ()
1211 "Adjust indentation after insertion of some characters.
1212 This function is intended to be added to `post-self-insert-hook.'
1213 If a line renders a paren alone, after adding a char before it,
1214 the line will be re-indented automatically if needed."
1215 (when (and electric-indent-mode
1216 (eq (char-before) last-command-event
))
1218 ;; Electric indent inside parens
1221 (let ((paren-start (python-syntax-context 'paren
)))
1222 ;; Check that point is inside parens.
1225 ;; Filter the case where input is happening in the same
1226 ;; line where the open paren is.
1227 (= (line-number-at-pos)
1228 (line-number-at-pos paren-start
)))))
1229 ;; When content has been added before the closing paren or a
1230 ;; comma has been inserted, it's ok to do the trick.
1232 (memq (char-after) '(?\
) ?\
] ?\
}))
1233 (eq (char-before) ?
,)))
1235 (goto-char (line-beginning-position))
1236 (let ((indentation (python-indent-calculate-indentation)))
1237 (when (and (numberp indentation
) (< (current-indentation) indentation
))
1238 (indent-line-to indentation
)))))
1240 ((and (eq ?
: last-command-event
)
1241 (memq ?
: electric-indent-chars
)
1242 (not current-prefix-arg
)
1243 ;; Trigger electric colon only at end of line
1245 ;; Avoid re-indenting on extra colon
1246 (not (equal ?
: (char-before (1- (point)))))
1247 (not (python-syntax-comment-or-string-p)))
1248 ;; Just re-indent dedenters
1249 (let ((dedenter-pos (python-info-dedenter-statement-p))
1250 (current-pos (point)))
1253 (goto-char dedenter-pos
)
1254 (python-indent-line)
1255 (unless (= (line-number-at-pos dedenter-pos
)
1256 (line-number-at-pos current-pos
))
1257 ;; Reindent region if this is a multiline statement
1258 (python-indent-region dedenter-pos current-pos
)))))))))
1263 (defvar python-nav-beginning-of-defun-regexp
1264 (python-rx line-start
(* space
) defun
(+ space
) (group symbol-name
))
1265 "Regexp matching class or function definition.
1266 The name of the defun should be grouped so it can be retrieved
1267 via `match-string'.")
1269 (defun python-nav--beginning-of-defun (&optional arg
)
1270 "Internal implementation of `python-nav-beginning-of-defun'.
1271 With positive ARG search backwards, else search forwards."
1272 (when (or (null arg
) (= arg
0)) (setq arg
1))
1273 (let* ((re-search-fn (if (> arg
0)
1274 #'re-search-backward
1275 #'re-search-forward
))
1276 (line-beg-pos (line-beginning-position))
1277 (line-content-start (+ line-beg-pos
(current-indentation)))
1278 (pos (point-marker))
1283 (not (python-info-looking-at-beginning-of-defun))
1284 (python-nav-backward-block)))
1285 (or (and (python-info-looking-at-beginning-of-defun)
1286 (+ (current-indentation) python-indent-offset
))
1290 (when (and (< arg
0)
1291 (python-info-looking-at-beginning-of-defun))
1293 (while (and (funcall re-search-fn
1294 python-nav-beginning-of-defun-regexp nil t
)
1295 (or (python-syntax-context-type)
1296 ;; Handle nested defuns when moving
1297 ;; backwards by checking indentation.
1299 (not (= (current-indentation) 0))
1300 (>= (current-indentation) beg-indentation
)))))
1301 (and (python-info-looking-at-beginning-of-defun)
1302 (or (not (= (line-number-at-pos pos
)
1303 (line-number-at-pos)))
1304 (and (>= (point) line-beg-pos
)
1305 (<= (point) line-content-start
)
1306 (> pos line-content-start
)))))))
1308 (or (beginning-of-line 1) t
)
1309 (and (goto-char pos
) nil
))))
1311 (defun python-nav-beginning-of-defun (&optional arg
)
1312 "Move point to `beginning-of-defun'.
1313 With positive ARG search backwards else search forward.
1314 ARG nil or 0 defaults to 1. When searching backwards,
1315 nested defuns are handled with care depending on current
1316 point position. Return non-nil if point is moved to
1317 `beginning-of-defun'."
1318 (when (or (null arg
) (= arg
0)) (setq arg
1))
1320 (while (and (not (= arg
0))
1321 (let ((keep-searching-p
1322 (python-nav--beginning-of-defun arg)))
1323 (when (and keep-searching-p
(null found
))
1326 (setq arg
(if (> arg
0) (1- arg
) (1+ arg
))))
1329 (defun python-nav-end-of-defun ()
1330 "Move point to the end of def or class.
1331 Returns nil if point is not in a def or class."
1333 (let ((beg-defun-indent)
1335 (when (or (python-info-looking-at-beginning-of-defun)
1336 (python-nav-beginning-of-defun 1)
1337 (python-nav-beginning-of-defun -1))
1338 (setq beg-defun-indent
(current-indentation))
1340 (python-nav-end-of-statement)
1341 (python-util-forward-comment 1)
1342 (and (> (current-indentation) beg-defun-indent
)
1344 (python-util-forward-comment -
1)
1346 ;; Ensure point moves forward.
1347 (and (> beg-pos
(point)) (goto-char beg-pos
)))))
1349 (defun python-nav--syntactically (fn poscompfn
&optional contextfn
)
1350 "Move point using FN avoiding places with specific context.
1351 FN must take no arguments. POSCOMPFN is a two arguments function
1352 used to compare current and previous point after it is moved
1353 using FN, this is normally a less-than or greater-than
1354 comparison. Optional argument CONTEXTFN defaults to
1355 `python-syntax-context-type' and is used for checking current
1356 point context, it must return a non-nil value if this point must
1358 (let ((contextfn (or contextfn
'python-syntax-context-type
))
1359 (start-pos (point-marker))
1364 (and (funcall fn
) (point-marker)))
1365 (context (funcall contextfn
)))
1366 (cond ((and (not context
) newpos
1367 (or (and (not prev-pos
) newpos
)
1368 (and prev-pos newpos
1369 (funcall poscompfn newpos prev-pos
))))
1370 (throw 'found
(point-marker)))
1371 ((and newpos context
)
1372 (setq prev-pos
(point)))
1373 (t (when (not newpos
) (goto-char start-pos
))
1374 (throw 'found nil
))))))))
1376 (defun python-nav--forward-defun (arg)
1377 "Internal implementation of python-nav-{backward,forward}-defun.
1378 Uses ARG to define which function to call, and how many times
1381 (while (and (> arg
0)
1383 (python-nav--syntactically
1386 python-nav-beginning-of-defun-regexp nil t
))
1388 (setq arg
(1- arg
)))
1389 (while (and (< arg
0)
1391 (python-nav--syntactically
1394 python-nav-beginning-of-defun-regexp nil t
))
1396 (setq arg
(1+ arg
)))
1399 (defun python-nav-backward-defun (&optional arg
)
1400 "Navigate to closer defun backward ARG times.
1401 Unlikely `python-nav-beginning-of-defun' this doesn't care about
1402 nested definitions."
1404 (python-nav--forward-defun (- (or arg
1))))
1406 (defun python-nav-forward-defun (&optional arg
)
1407 "Navigate to closer defun forward ARG times.
1408 Unlikely `python-nav-beginning-of-defun' this doesn't care about
1409 nested definitions."
1411 (python-nav--forward-defun (or arg
1)))
1413 (defun python-nav-beginning-of-statement ()
1414 "Move to start of current statement."
1416 (back-to-indentation)
1417 (let* ((ppss (syntax-ppss))
1420 (python-syntax-context 'paren ppss
)
1421 (python-syntax-context 'string ppss
))))
1424 (goto-char context-point
)
1425 (python-nav-beginning-of-statement))
1428 (python-info-line-ends-backslash-p))
1430 (python-nav-beginning-of-statement))))
1433 (defun python-nav-end-of-statement (&optional noend
)
1434 "Move to end of current statement.
1435 Optional argument NOEND is internal and makes the logic to not
1436 jump to the end of line when moving forward searching for the end
1439 (let (string-start bs-pos
)
1440 (while (and (or noend
(goto-char (line-end-position)))
1442 (cond ((setq string-start
(python-syntax-context 'string
))
1443 (goto-char string-start
)
1444 (if (python-syntax-context 'paren
)
1445 ;; Ended up inside a paren, roll again.
1446 (python-nav-end-of-statement t
)
1447 ;; This is not inside a paren, move to the
1448 ;; end of this string.
1449 (goto-char (+ (point)
1450 (python-syntax-count-quotes
1451 (char-after (point)) (point))))
1452 (or (re-search-forward (rx (syntax string-delimiter
)) nil t
)
1453 (goto-char (point-max)))))
1454 ((python-syntax-context 'paren
)
1455 ;; The statement won't end before we've escaped
1456 ;; at least one level of parenthesis.
1458 (goto-char (scan-lists (point) 1 -
1))
1459 (scan-error (goto-char (nth 3 err
)))))
1460 ((setq bs-pos
(python-info-line-ends-backslash-p))
1462 (forward-line 1))))))
1465 (defun python-nav-backward-statement (&optional arg
)
1466 "Move backward to previous statement.
1467 With ARG, repeat. See `python-nav-forward-statement'."
1469 (or arg
(setq arg
1))
1470 (python-nav-forward-statement (- arg
)))
1472 (defun python-nav-forward-statement (&optional arg
)
1473 "Move forward to next statement.
1474 With ARG, repeat. With negative argument, move ARG times
1475 backward to previous statement."
1477 (or arg
(setq arg
1))
1479 (python-nav-end-of-statement)
1480 (python-util-forward-comment)
1481 (python-nav-beginning-of-statement)
1482 (setq arg
(1- arg
)))
1484 (python-nav-beginning-of-statement)
1485 (python-util-forward-comment -
1)
1486 (python-nav-beginning-of-statement)
1487 (setq arg
(1+ arg
))))
1489 (defun python-nav-beginning-of-block ()
1490 "Move to start of current block."
1492 (let ((starting-pos (point)))
1494 (python-nav-beginning-of-statement)
1495 (looking-at (python-rx block-start
)))
1497 ;; Go to first line beginning a statement
1498 (while (and (not (bobp))
1499 (or (and (python-nav-beginning-of-statement) nil
)
1500 (python-info-current-line-comment-p)
1501 (python-info-current-line-empty-p)))
1503 (let ((block-matching-indent
1504 (- (current-indentation) python-indent-offset
)))
1506 (and (python-nav-backward-block)
1507 (> (current-indentation) block-matching-indent
)))
1508 (if (and (looking-at (python-rx block-start
))
1509 (= (current-indentation) block-matching-indent
))
1511 (and (goto-char starting-pos
) nil
))))))
1513 (defun python-nav-end-of-block ()
1514 "Move to end of current block."
1516 (when (python-nav-beginning-of-block)
1517 (let ((block-indentation (current-indentation)))
1518 (python-nav-end-of-statement)
1519 (while (and (forward-line 1)
1521 (or (and (> (current-indentation) block-indentation
)
1522 (or (python-nav-end-of-statement) t
))
1523 (python-info-current-line-comment-p)
1524 (python-info-current-line-empty-p))))
1525 (python-util-forward-comment -
1)
1528 (defun python-nav-backward-block (&optional arg
)
1529 "Move backward to previous block of code.
1530 With ARG, repeat. See `python-nav-forward-block'."
1532 (or arg
(setq arg
1))
1533 (python-nav-forward-block (- arg
)))
1535 (defun python-nav-forward-block (&optional arg
)
1536 "Move forward to next block of code.
1537 With ARG, repeat. With negative argument, move ARG times
1538 backward to previous block."
1540 (or arg
(setq arg
1))
1541 (let ((block-start-regexp
1542 (python-rx line-start
(* whitespace
) block-start
))
1543 (starting-pos (point)))
1545 (python-nav-end-of-statement)
1547 (re-search-forward block-start-regexp nil t
)
1548 (python-syntax-context-type)))
1549 (setq arg
(1- arg
)))
1551 (python-nav-beginning-of-statement)
1553 (re-search-backward block-start-regexp nil t
)
1554 (python-syntax-context-type)))
1555 (setq arg
(1+ arg
)))
1556 (python-nav-beginning-of-statement)
1557 (if (not (looking-at (python-rx block-start
)))
1558 (and (goto-char starting-pos
) nil
)
1559 (and (not (= (point) starting-pos
)) (point-marker)))))
1561 (defun python-nav--lisp-forward-sexp (&optional arg
)
1562 "Standard version `forward-sexp'.
1563 It ignores completely the value of `forward-sexp-function' by
1564 setting it to nil before calling `forward-sexp'. With positive
1565 ARG move forward only one sexp, else move backwards."
1566 (let ((forward-sexp-function)
1567 (arg (if (or (not arg
) (> arg
0)) 1 -
1)))
1568 (forward-sexp arg
)))
1570 (defun python-nav--lisp-forward-sexp-safe (&optional arg
)
1571 "Safe version of standard `forward-sexp'.
1572 When at end of sexp (i.e. looking at a opening/closing paren)
1573 skips it instead of throwing an error. With positive ARG move
1574 forward only one sexp, else move backwards."
1575 (let* ((arg (if (or (not arg
) (> arg
0)) 1 -
1))
1577 (if (> arg
0) (python-rx close-paren
) (python-rx open-paren
)))
1579 (if (> arg
0) #'re-search-forward
#'re-search-backward
)))
1581 (python-nav--lisp-forward-sexp arg
)
1583 (while (and (funcall search-fn paren-regexp nil t
)
1584 (python-syntax-context 'paren
)))))))
1586 (defun python-nav--forward-sexp (&optional dir safe
)
1587 "Move to forward sexp.
1588 With positive optional argument DIR direction move forward, else
1589 backwards. When optional argument SAFE is non-nil do not throw
1590 errors when at end of sexp, skip it instead."
1591 (setq dir
(or dir
1))
1593 (let* ((forward-p (if (> dir
0)
1594 (and (setq dir
1) t
)
1595 (and (setq dir -
1) nil
)))
1596 (context-type (python-syntax-context-type)))
1598 ((memq context-type
'(string comment
))
1599 ;; Inside of a string, get out of it.
1600 (let ((forward-sexp-function))
1601 (forward-sexp dir
)))
1602 ((or (eq context-type
'paren
)
1603 (and forward-p
(looking-at (python-rx open-paren
)))
1604 (and (not forward-p
)
1605 (eq (syntax-class (syntax-after (1- (point))))
1606 (car (string-to-syntax ")")))))
1607 ;; Inside a paren or looking at it, lisp knows what to do.
1609 (python-nav--lisp-forward-sexp-safe dir
)
1610 (python-nav--lisp-forward-sexp dir
)))
1612 ;; This part handles the lispy feel of
1613 ;; `python-nav-forward-sexp'. Knowing everything about the
1614 ;; current context and the context of the next sexp tries to
1615 ;; follow the lisp sexp motion commands in a symmetric manner.
1618 ((python-info-beginning-of-block-p) 'block-start
)
1619 ((python-info-end-of-block-p) 'block-end
)
1620 ((python-info-beginning-of-statement-p) 'statement-start
)
1621 ((python-info-end-of-statement-p) 'statement-end
)))
1625 (python-nav--lisp-forward-sexp-safe dir
)
1626 (python-nav--lisp-forward-sexp dir
))
1630 (goto-char next-sexp-pos
)
1632 ((python-info-beginning-of-block-p) 'block-start
)
1633 ((python-info-end-of-block-p) 'block-end
)
1634 ((python-info-beginning-of-statement-p) 'statement-start
)
1635 ((python-info-end-of-statement-p) 'statement-end
)
1636 ((python-info-statement-starts-block-p) 'starts-block
)
1637 ((python-info-statement-ends-block-p) 'ends-block
)))))
1639 (cond ((and (not (eobp))
1640 (python-info-current-line-empty-p))
1641 (python-util-forward-comment dir
)
1642 (python-nav--forward-sexp dir
))
1643 ((eq context
'block-start
)
1644 (python-nav-end-of-block))
1645 ((eq context
'statement-start
)
1646 (python-nav-end-of-statement))
1647 ((and (memq context
'(statement-end block-end
))
1648 (eq next-sexp-context
'ends-block
))
1649 (goto-char next-sexp-pos
)
1650 (python-nav-end-of-block))
1651 ((and (memq context
'(statement-end block-end
))
1652 (eq next-sexp-context
'starts-block
))
1653 (goto-char next-sexp-pos
)
1654 (python-nav-end-of-block))
1655 ((memq context
'(statement-end block-end
))
1656 (goto-char next-sexp-pos
)
1657 (python-nav-end-of-statement))
1658 (t (goto-char next-sexp-pos
)))
1659 (cond ((and (not (bobp))
1660 (python-info-current-line-empty-p))
1661 (python-util-forward-comment dir
)
1662 (python-nav--forward-sexp dir
))
1663 ((eq context
'block-end
)
1664 (python-nav-beginning-of-block))
1665 ((eq context
'statement-end
)
1666 (python-nav-beginning-of-statement))
1667 ((and (memq context
'(statement-start block-start
))
1668 (eq next-sexp-context
'starts-block
))
1669 (goto-char next-sexp-pos
)
1670 (python-nav-beginning-of-block))
1671 ((and (memq context
'(statement-start block-start
))
1672 (eq next-sexp-context
'ends-block
))
1673 (goto-char next-sexp-pos
)
1674 (python-nav-beginning-of-block))
1675 ((memq context
'(statement-start block-start
))
1676 (goto-char next-sexp-pos
)
1677 (python-nav-beginning-of-statement))
1678 (t (goto-char next-sexp-pos
))))))))))
1680 (defun python-nav-forward-sexp (&optional arg
)
1681 "Move forward across expressions.
1682 With ARG, do it that many times. Negative arg -N means move
1685 (or arg
(setq arg
1))
1687 (python-nav--forward-sexp 1)
1688 (setq arg
(1- arg
)))
1690 (python-nav--forward-sexp -
1)
1691 (setq arg
(1+ arg
))))
1693 (defun python-nav-backward-sexp (&optional arg
)
1694 "Move backward across expressions.
1695 With ARG, do it that many times. Negative arg -N means move
1698 (or arg
(setq arg
1))
1699 (python-nav-forward-sexp (- arg
)))
1701 (defun python-nav-forward-sexp-safe (&optional arg
)
1702 "Move forward safely across expressions.
1703 With ARG, do it that many times. Negative arg -N means move
1706 (or arg
(setq arg
1))
1708 (python-nav--forward-sexp 1 t
)
1709 (setq arg
(1- arg
)))
1711 (python-nav--forward-sexp -
1 t
)
1712 (setq arg
(1+ arg
))))
1714 (defun python-nav-backward-sexp-safe (&optional arg
)
1715 "Move backward safely across expressions.
1716 With ARG, do it that many times. Negative arg -N means move
1719 (or arg
(setq arg
1))
1720 (python-nav-forward-sexp-safe (- arg
)))
1722 (defun python-nav--up-list (&optional dir
)
1723 "Internal implementation of `python-nav-up-list'.
1724 DIR is always 1 or -1 and comes sanitized from
1725 `python-nav-up-list' calls."
1726 (let ((context (python-syntax-context-type))
1727 (forward-p (> dir
0)))
1729 ((memq context
'(string comment
)))
1730 ((eq context
'paren
)
1731 (let ((forward-sexp-function))
1733 ((and forward-p
(python-info-end-of-block-p))
1734 (let ((parent-end-pos
1736 (let ((indentation (and
1737 (python-nav-beginning-of-block)
1738 (current-indentation))))
1739 (while (and indentation
1741 (>= (current-indentation) indentation
)
1742 (python-nav-backward-block)))
1743 (python-nav-end-of-block)))))
1744 (and (> (or parent-end-pos
(point)) (point))
1745 (goto-char parent-end-pos
))))
1746 (forward-p (python-nav-end-of-block))
1747 ((and (not forward-p
)
1748 (> (current-indentation) 0)
1749 (python-info-beginning-of-block-p))
1750 (let ((prev-block-pos
1752 (let ((indentation (current-indentation)))
1753 (while (and (python-nav-backward-block)
1754 (>= (current-indentation) indentation
))))
1756 (and (> (point) prev-block-pos
)
1757 (goto-char prev-block-pos
))))
1758 ((not forward-p
) (python-nav-beginning-of-block)))))
1760 (defun python-nav-up-list (&optional arg
)
1761 "Move forward out of one level of parentheses (or blocks).
1762 With ARG, do this that many times.
1763 A negative argument means move backward but still to a less deep spot.
1764 This command assumes point is not in a string or comment."
1766 (or arg
(setq arg
1))
1768 (python-nav--up-list 1)
1769 (setq arg
(1- arg
)))
1771 (python-nav--up-list -
1)
1772 (setq arg
(1+ arg
))))
1774 (defun python-nav-backward-up-list (&optional arg
)
1775 "Move backward out of one level of parentheses (or blocks).
1776 With ARG, do this that many times.
1777 A negative argument means move forward but still to a less deep spot.
1778 This command assumes point is not in a string or comment."
1780 (or arg
(setq arg
1))
1781 (python-nav-up-list (- arg
)))
1783 (defun python-nav-if-name-main ()
1784 "Move point at the beginning the __main__ block.
1785 When \"if __name__ == '__main__':\" is found returns its
1786 position, else returns nil."
1788 (let ((point (point))
1789 (found (catch 'found
1790 (goto-char (point-min))
1791 (while (re-search-forward
1792 (python-rx line-start
1794 "__name__" (+ space
)
1796 (group-n 1 (or ?
\" ?
\'))
1797 "__main__" (backref 1) (* space
) ":")
1799 (when (not (python-syntax-context-type))
1801 (throw 'found t
))))))
1804 (ignore (goto-char point
)))))
1807 ;;; Shell integration
1809 (defcustom python-shell-buffer-name
"Python"
1810 "Default buffer name for Python interpreter."
1815 (defcustom python-shell-interpreter
"python"
1816 "Default Python interpreter for shell."
1820 (defcustom python-shell-internal-buffer-name
"Python Internal"
1821 "Default buffer name for the Internal Python interpreter."
1826 (defcustom python-shell-interpreter-args
"-i"
1827 "Default arguments for the Python interpreter."
1831 (defcustom python-shell-interpreter-interactive-arg
"-i"
1832 "Interpreter argument to force it to run interactively."
1836 (defcustom python-shell-prompt-detect-enabled t
1837 "Non-nil enables autodetection of interpreter prompts."
1842 (defcustom python-shell-prompt-detect-failure-warning t
1843 "Non-nil enables warnings when detection of prompts fail."
1848 (defcustom python-shell-prompt-input-regexps
1849 '(">>> " "\\.\\.\\. " ; Python
1850 "In \\[[0-9]+\\]: " ; IPython
1851 " \\.\\.\\.: " ; IPython
1852 ;; Using ipdb outside IPython may fail to cleanup and leave static
1853 ;; IPython prompts activated, this adds some safeguard for that.
1854 "In : " "\\.\\.\\.: ")
1855 "List of regular expressions matching input prompts."
1856 :type
'(repeat string
)
1859 (defcustom python-shell-prompt-output-regexps
1861 "Out\\[[0-9]+\\]: " ; IPython
1862 "Out :") ; ipdb safeguard
1863 "List of regular expressions matching output prompts."
1864 :type
'(repeat string
)
1867 (defcustom python-shell-prompt-regexp
">>> "
1868 "Regular expression matching top level input prompt of Python shell.
1869 It should not contain a caret (^) at the beginning."
1872 (defcustom python-shell-prompt-block-regexp
"\\.\\.\\. "
1873 "Regular expression matching block input prompt of Python shell.
1874 It should not contain a caret (^) at the beginning."
1877 (defcustom python-shell-prompt-output-regexp
""
1878 "Regular expression matching output prompt of Python shell.
1879 It should not contain a caret (^) at the beginning."
1882 (defcustom python-shell-prompt-pdb-regexp
"[(<]*[Ii]?[Pp]db[>)]+ "
1883 "Regular expression matching pdb input prompt of Python shell.
1884 It should not contain a caret (^) at the beginning."
1887 (define-obsolete-variable-alias
1888 'python-shell-enable-font-lock
'python-shell-font-lock-enable
"25.1")
1890 (defcustom python-shell-font-lock-enable t
1891 "Should syntax highlighting be enabled in the Python shell buffer?
1892 Restart the Python shell after changing this variable for it to take effect."
1897 (defcustom python-shell-unbuffered t
1898 "Should shell output be unbuffered?.
1899 When non-nil, this may prevent delayed and missing output in the
1900 Python shell. See commentary for details."
1905 (defcustom python-shell-process-environment nil
1906 "List of environment variables for Python shell.
1907 This variable follows the same rules as `process-environment'
1908 since it merges with it before the process creation routines are
1909 called. When this variable is nil, the Python shell is run with
1910 the default `process-environment'."
1911 :type
'(repeat string
)
1915 (defcustom python-shell-extra-pythonpaths nil
1916 "List of extra pythonpaths for Python shell.
1917 The values of this variable are added to the existing value of
1918 PYTHONPATH in the `process-environment' variable."
1919 :type
'(repeat string
)
1923 (defcustom python-shell-exec-path nil
1924 "List of path to search for binaries.
1925 This variable follows the same rules as `exec-path' since it
1926 merges with it before the process creation routines are called.
1927 When this variable is nil, the Python shell is run with the
1928 default `exec-path'."
1929 :type
'(repeat string
)
1933 (defcustom python-shell-virtualenv-root nil
1934 "Path to virtualenv root.
1935 This variable, when set to a string, makes the values stored in
1936 `python-shell-process-environment' and `python-shell-exec-path'
1937 to be modified properly so shells are started with the specified
1939 :type
'(choice (const nil
) string
)
1943 (define-obsolete-variable-alias
1944 'python-shell-virtualenv-path
'python-shell-virtualenv-root
"25.1")
1946 (defcustom python-shell-setup-codes
'(python-shell-completion-setup-code
1947 python-ffap-setup-code
1948 python-eldoc-setup-code
)
1949 "List of code run by `python-shell-send-setup-codes'."
1950 :type
'(repeat symbol
)
1954 (defcustom python-shell-compilation-regexp-alist
1955 `((,(rx line-start
(1+ (any " \t")) "File \""
1956 (group (1+ (not (any "\"<")))) ; avoid `<stdin>' &c
1957 "\", line " (group (1+ digit
)))
1959 (,(rx " in file " (group (1+ not-newline
)) " on line "
1962 (,(rx line-start
"> " (group (1+ (not (any "(\"<"))))
1963 "(" (group (1+ digit
)) ")" (1+ (not (any "("))) "()")
1965 "`compilation-error-regexp-alist' for inferior Python."
1966 :type
'(alist string
)
1969 (defvar python-shell--prompt-calculated-input-regexp nil
1970 "Calculated input prompt regexp for inferior python shell.
1971 Do not set this variable directly, instead use
1972 `python-shell-prompt-set-calculated-regexps'.")
1974 (defvar python-shell--prompt-calculated-output-regexp nil
1975 "Calculated output prompt regexp for inferior python shell.
1976 Do not set this variable directly, instead use
1977 `python-shell-set-prompt-regexp'.")
1979 (defun python-shell-prompt-detect ()
1980 "Detect prompts for the current `python-shell-interpreter'.
1981 When prompts can be retrieved successfully from the
1982 `python-shell-interpreter' run with
1983 `python-shell-interpreter-interactive-arg', returns a list of
1984 three elements, where the first two are input prompts and the
1985 last one is an output prompt. When no prompts can be detected
1986 and `python-shell-prompt-detect-failure-warning' is non-nil,
1987 shows a warning with instructions to avoid hangs and returns nil.
1988 When `python-shell-prompt-detect-enabled' is nil avoids any
1989 detection and just returns nil."
1990 (when python-shell-prompt-detect-enabled
1991 (let* ((process-environment (python-shell-calculate-process-environment))
1992 (exec-path (python-shell-calculate-exec-path))
1995 "ps = [getattr(sys, 'ps%s' % i, '') for i in range(1,4)]\n"
1996 ;; JSON is built manually for compatibility
1997 "ps_json = '\\n[\"%s\", \"%s\", \"%s\"]\\n' % tuple(ps)\n"
2002 ;; TODO: improve error handling by using
2003 ;; `condition-case' and displaying the error message to
2004 ;; the user in the no-prompts warning.
2006 (let ((code-file (python-shell--save-temp-file code
)))
2007 ;; Use `process-file' as it is remote-host friendly.
2009 python-shell-interpreter
2013 python-shell-interpreter-interactive-arg
)
2015 (delete-file code-file
)))
2019 (dolist (line (split-string output
"\n" t
))
2021 ;; Check if current line is a valid JSON array
2022 (and (string= (substring line
0 2) "[\"")
2024 ;; Return prompts as a list, not vector
2025 (append (json-read-from-string line
) nil
)))))
2026 ;; The list must contain 3 strings, where the first
2027 ;; is the input prompt, the second is the block
2028 ;; prompt and the last one is the output prompt. The
2029 ;; input prompt is the only one that can't be empty.
2030 (when (and (= (length res
) 3)
2031 (cl-every #'stringp res
)
2032 (not (string= (car res
) "")))
2033 (throw 'prompts res
))))
2035 (when (and (not prompts
)
2036 python-shell-prompt-detect-failure-warning
)
2038 '(python python-shell-prompt-regexp
)
2041 "Python shell prompts cannot be detected.\n"
2042 "If your emacs session hangs when starting python shells\n"
2043 "recover with `keyboard-quit' and then try fixing the\n"
2044 "interactive flag for your interpreter by adjusting the\n"
2045 "`python-shell-interpreter-interactive-arg' or add regexps\n"
2046 "matching shell prompts in the directory-local friendly vars:\n"
2047 " + `python-shell-prompt-regexp'\n"
2048 " + `python-shell-prompt-block-regexp'\n"
2049 " + `python-shell-prompt-output-regexp'\n"
2050 "Or alternatively in:\n"
2051 " + `python-shell-prompt-input-regexps'\n"
2052 " + `python-shell-prompt-output-regexps'")))
2055 (defun python-shell-prompt-validate-regexps ()
2056 "Validate all user provided regexps for prompts.
2057 Signals `user-error' if any of these vars contain invalid
2058 regexps: `python-shell-prompt-regexp',
2059 `python-shell-prompt-block-regexp',
2060 `python-shell-prompt-pdb-regexp',
2061 `python-shell-prompt-output-regexp',
2062 `python-shell-prompt-input-regexps',
2063 `python-shell-prompt-output-regexps'."
2064 (dolist (symbol (list 'python-shell-prompt-input-regexps
2065 'python-shell-prompt-output-regexps
2066 'python-shell-prompt-regexp
2067 'python-shell-prompt-block-regexp
2068 'python-shell-prompt-pdb-regexp
2069 'python-shell-prompt-output-regexp
))
2070 (dolist (regexp (let ((regexps (symbol-value symbol
)))
2074 (when (not (python-util-valid-regexp-p regexp
))
2075 (user-error "Invalid regexp %s in `%s'"
2078 (defun python-shell-prompt-set-calculated-regexps ()
2079 "Detect and set input and output prompt regexps.
2080 Build and set the values for `python-shell-input-prompt-regexp'
2081 and `python-shell-output-prompt-regexp' using the values from
2082 `python-shell-prompt-regexp', `python-shell-prompt-block-regexp',
2083 `python-shell-prompt-pdb-regexp',
2084 `python-shell-prompt-output-regexp',
2085 `python-shell-prompt-input-regexps',
2086 `python-shell-prompt-output-regexps' and detected prompts from
2087 `python-shell-prompt-detect'."
2088 (when (not (and python-shell--prompt-calculated-input-regexp
2089 python-shell--prompt-calculated-output-regexp
))
2090 (let* ((detected-prompts (python-shell-prompt-detect))
2092 (output-prompts nil
)
2096 (mapconcat #'identity
2099 (let ((length-a (length a
))
2100 (length-b (length b
)))
2101 (if (= length-a length-b
)
2103 (> (length a
) (length b
))))))
2106 ;; Validate ALL regexps
2107 (python-shell-prompt-validate-regexps)
2108 ;; Collect all user defined input prompts
2109 (dolist (prompt (append python-shell-prompt-input-regexps
2110 (list python-shell-prompt-regexp
2111 python-shell-prompt-block-regexp
2112 python-shell-prompt-pdb-regexp
)))
2113 (cl-pushnew prompt input-prompts
:test
#'string
=))
2114 ;; Collect all user defined output prompts
2115 (dolist (prompt (cons python-shell-prompt-output-regexp
2116 python-shell-prompt-output-regexps
))
2117 (cl-pushnew prompt output-prompts
:test
#'string
=))
2118 ;; Collect detected prompts if any
2119 (when detected-prompts
2120 (dolist (prompt (butlast detected-prompts
))
2121 (setq prompt
(regexp-quote prompt
))
2122 (cl-pushnew prompt input-prompts
:test
#'string
=))
2123 (cl-pushnew (regexp-quote
2124 (car (last detected-prompts
)))
2125 output-prompts
:test
#'string
=))
2126 ;; Set input and output prompt regexps from collected prompts
2127 (setq python-shell--prompt-calculated-input-regexp
2128 (funcall build-regexp input-prompts
)
2129 python-shell--prompt-calculated-output-regexp
2130 (funcall build-regexp output-prompts
)))))
2132 (defun python-shell-get-process-name (dedicated)
2133 "Calculate the appropriate process name for inferior Python process.
2134 If DEDICATED is t returns a string with the form
2135 `python-shell-buffer-name'[`buffer-name'] else returns the value
2136 of `python-shell-buffer-name'."
2138 (format "%s[%s]" python-shell-buffer-name
(buffer-name))
2139 python-shell-buffer-name
))
2141 (defun python-shell-internal-get-process-name ()
2142 "Calculate the appropriate process name for Internal Python process.
2143 The name is calculated from `python-shell-global-buffer-name' and
2145 (format "%s[%s]" python-shell-internal-buffer-name
(buffer-name)))
2147 (defun python-shell-calculate-command ()
2148 "Calculate the string used to execute the inferior Python process."
2149 (let ((exec-path (python-shell-calculate-exec-path)))
2150 ;; `exec-path' gets tweaked so that virtualenv's specific
2151 ;; `python-shell-interpreter' absolute path can be found by
2152 ;; `executable-find'.
2154 ;; FIXME: Why executable-find?
2155 (shell-quote-argument
2156 (executable-find python-shell-interpreter
))
2157 python-shell-interpreter-args
)))
2159 (define-obsolete-function-alias
2160 'python-shell-parse-command
2161 #'python-shell-calculate-command
"25.1")
2163 (defun python-shell-calculate-pythonpath ()
2164 "Calculate the PYTHONPATH using `python-shell-extra-pythonpaths'."
2165 (let ((pythonpath (getenv "PYTHONPATH"))
2166 (extra (mapconcat 'identity
2167 python-shell-extra-pythonpaths
2170 (concat extra path-separator pythonpath
)
2173 (defun python-shell-calculate-process-environment ()
2174 "Calculate process environment given `python-shell-virtualenv-root'."
2175 (let ((process-environment (append
2176 python-shell-process-environment
2177 process-environment nil
))
2178 (virtualenv (if python-shell-virtualenv-root
2179 (directory-file-name python-shell-virtualenv-root
)
2181 (when python-shell-unbuffered
2182 (setenv "PYTHONUNBUFFERED" "1"))
2183 (when python-shell-extra-pythonpaths
2184 (setenv "PYTHONPATH" (python-shell-calculate-pythonpath)))
2185 (if (not virtualenv
)
2187 (setenv "PYTHONHOME" nil
)
2188 (setenv "PATH" (format "%s/bin%s%s"
2189 virtualenv path-separator
2190 (or (getenv "PATH") "")))
2191 (setenv "VIRTUAL_ENV" virtualenv
))
2192 process-environment
))
2194 (defun python-shell-calculate-exec-path ()
2195 "Calculate exec path given `python-shell-virtualenv-root'."
2197 ;; Use nil as the tail so that the list is a full copy,
2198 ;; this is a paranoid safeguard for side-effects.
2199 python-shell-exec-path exec-path nil
)))
2200 (if (not python-shell-virtualenv-root
)
2202 (cons (expand-file-name "bin" python-shell-virtualenv-root
)
2205 (defvar python-shell--package-depth
10)
2207 (defun python-shell-package-enable (directory package
)
2208 "Add DIRECTORY parent to $PYTHONPATH and enable PACKAGE."
2210 (let* ((dir (expand-file-name
2211 (read-directory-name
2213 (file-name-directory
2214 (or (buffer-file-name) default-directory
)))))
2215 (name (completing-read
2217 (python-util-list-packages
2218 dir python-shell--package-depth
))))
2220 (python-shell-send-string
2223 "import os.path;import sys;"
2224 "sys.path.append(os.path.dirname(os.path.dirname('''%s''')));"
2225 "__package__ = '''%s''';"
2227 directory package package
)
2228 (python-shell-get-process)))
2230 (defun python-shell-accept-process-output (process &optional timeout regexp
)
2231 "Accept PROCESS output with TIMEOUT until REGEXP is found.
2232 Optional argument TIMEOUT is the timeout argument to
2233 `accept-process-output' calls. Optional argument REGEXP
2234 overrides the regexp to match the end of output, defaults to
2235 `comint-prompt-regexp.'. Returns non-nil when output was
2238 This utility is useful in situations where the output may be
2239 received in chunks, since `accept-process-output' gives no
2240 guarantees they will be grabbed in a single call. An example use
2241 case for this would be the CPython shell start-up, where the
2242 banner and the initial prompt are received separately."
2243 (let ((regexp (or regexp comint-prompt-regexp
)))
2246 (when (not (accept-process-output process timeout
))
2248 (when (looking-back regexp
)
2249 (throw 'found t
))))))
2251 (defun python-shell-comint-end-of-output-p (output)
2252 "Return non-nil if OUTPUT is ends with input prompt."
2254 ;; XXX: It seems on OSX an extra carriage return is attached
2255 ;; at the end of output, this handles that too.
2258 ;; Remove initial caret from calculated regexp
2259 (replace-regexp-in-string
2260 (rx string-start ?^
) ""
2261 python-shell--prompt-calculated-input-regexp
)
2265 (define-obsolete-function-alias
2266 'python-comint-output-filter-function
2267 'ansi-color-filter-apply
2270 (defun python-comint-postoutput-scroll-to-bottom (output)
2271 "Faster version of `comint-postoutput-scroll-to-bottom'.
2272 Avoids `recenter' calls until OUTPUT is completely sent."
2273 (when (and (not (string= "" output
))
2274 (python-shell-comint-end-of-output-p
2275 (ansi-color-filter-apply output
)))
2276 (comint-postoutput-scroll-to-bottom output
))
2279 (defvar python-shell--parent-buffer nil
)
2281 (defmacro python-shell-with-shell-buffer
(&rest body
)
2282 "Execute the forms in BODY with the shell buffer temporarily current.
2283 Signals an error if no shell buffer is available for current buffer."
2284 (declare (indent 0) (debug t
))
2285 (let ((shell-process (make-symbol "shell-process")))
2286 `(let ((,shell-process
(python-shell-get-process-or-error)))
2287 (with-current-buffer (process-buffer ,shell-process
)
2290 (defvar python-shell--font-lock-buffer nil
)
2292 (defun python-shell-font-lock-get-or-create-buffer ()
2293 "Get or create a font-lock buffer for current inferior process."
2294 (python-shell-with-shell-buffer
2295 (if python-shell--font-lock-buffer
2296 python-shell--font-lock-buffer
2298 (process-name (get-buffer-process (current-buffer)))))
2299 (generate-new-buffer
2300 (format " *%s-font-lock*" process-name
))))))
2302 (defun python-shell-font-lock-kill-buffer ()
2303 "Kill the font-lock buffer safely."
2304 (when (and python-shell--font-lock-buffer
2305 (buffer-live-p python-shell--font-lock-buffer
))
2306 (kill-buffer python-shell--font-lock-buffer
)
2307 (when (derived-mode-p 'inferior-python-mode
)
2308 (setq python-shell--font-lock-buffer nil
))))
2310 (defmacro python-shell-font-lock-with-font-lock-buffer
(&rest body
)
2311 "Execute the forms in BODY in the font-lock buffer.
2312 The value returned is the value of the last form in BODY. See
2313 also `with-current-buffer'."
2314 (declare (indent 0) (debug t
))
2315 `(python-shell-with-shell-buffer
2316 (save-current-buffer
2317 (when (not (and python-shell--font-lock-buffer
2318 (get-buffer python-shell--font-lock-buffer
)))
2319 (setq python-shell--font-lock-buffer
2320 (python-shell-font-lock-get-or-create-buffer)))
2321 (set-buffer python-shell--font-lock-buffer
)
2322 (when (not font-lock-mode
)
2324 (set (make-local-variable 'delay-mode-hooks
) t
)
2325 (let ((python-indent-guess-indent-offset nil
))
2326 (when (not (derived-mode-p 'python-mode
))
2330 (defun python-shell-font-lock-cleanup-buffer ()
2331 "Cleanup the font-lock buffer.
2332 Provided as a command because this might be handy if something
2333 goes wrong and syntax highlighting in the shell gets messed up."
2335 (python-shell-with-shell-buffer
2336 (python-shell-font-lock-with-font-lock-buffer
2339 (defun python-shell-font-lock-comint-output-filter-function (output)
2340 "Clean up the font-lock buffer after any OUTPUT."
2341 (if (and (not (string= "" output
))
2342 ;; Is end of output and is not just a prompt.
2344 (python-shell-comint-end-of-output-p
2345 (ansi-color-filter-apply output
))
2347 ;; If output is other than an input prompt then "real" output has
2348 ;; been received and the font-lock buffer must be cleaned up.
2349 (python-shell-font-lock-cleanup-buffer)
2350 ;; Otherwise just add a newline.
2351 (python-shell-font-lock-with-font-lock-buffer
2352 (goto-char (point-max))
2356 (defun python-shell-font-lock-post-command-hook ()
2357 "Fontifies current line in shell buffer."
2358 (let ((prompt-end (cdr (python-util-comint-last-prompt))))
2359 (when (and prompt-end
(> (point) prompt-end
)
2360 (process-live-p (get-buffer-process (current-buffer))))
2361 (let* ((input (buffer-substring-no-properties
2362 prompt-end
(point-max)))
2363 (start-pos prompt-end
)
2364 (buffer-undo-list t
)
2365 (font-lock-buffer-pos nil
)
2367 (python-shell-font-lock-with-font-lock-buffer
2368 (delete-region (line-beginning-position)
2370 (setq font-lock-buffer-pos
(point))
2372 ;; Ensure buffer is fontified, keeping it
2373 ;; compatible with Emacs < 24.4.
2374 (if (fboundp 'font-lock-ensure
)
2375 (funcall 'font-lock-ensure
)
2376 (font-lock-default-fontify-buffer))
2377 (buffer-substring font-lock-buffer-pos
2379 (replacement-length (length replacement
))
2381 ;; Inject text properties to get input fontified.
2382 (while (not (= i replacement-length
))
2383 (let* ((plist (text-properties-at i replacement
))
2384 (next-change (or (next-property-change i replacement
)
2385 replacement-length
))
2386 (plist (let ((face (plist-get plist
'face
)))
2389 ;; Replace FACE text properties with
2390 ;; FONT-LOCK-FACE so input is fontified.
2391 (plist-put plist
'face nil
)
2392 (plist-put plist
'font-lock-face face
)))))
2393 (set-text-properties
2394 (+ start-pos i
) (+ start-pos next-change
) plist
)
2395 (setq i next-change
)))))))
2397 (defun python-shell-font-lock-turn-on (&optional msg
)
2398 "Turn on shell font-lock.
2399 With argument MSG show activation message."
2401 (python-shell-with-shell-buffer
2402 (python-shell-font-lock-kill-buffer)
2403 (set (make-local-variable 'python-shell--font-lock-buffer
) nil
)
2404 (add-hook 'post-command-hook
2405 #'python-shell-font-lock-post-command-hook nil
'local
)
2406 (add-hook 'kill-buffer-hook
2407 #'python-shell-font-lock-kill-buffer nil
'local
)
2408 (add-hook 'comint-output-filter-functions
2409 #'python-shell-font-lock-comint-output-filter-function
2412 (message "Shell font-lock is enabled"))))
2414 (defun python-shell-font-lock-turn-off (&optional msg
)
2415 "Turn off shell font-lock.
2416 With argument MSG show deactivation message."
2418 (python-shell-with-shell-buffer
2419 (python-shell-font-lock-kill-buffer)
2420 (when (python-util-comint-last-prompt)
2421 ;; Cleanup current fontification
2422 (remove-text-properties
2423 (cdr (python-util-comint-last-prompt))
2425 '(face nil font-lock-face nil
)))
2426 (set (make-local-variable 'python-shell--font-lock-buffer
) nil
)
2427 (remove-hook 'post-command-hook
2428 #'python-shell-font-lock-post-command-hook
'local
)
2429 (remove-hook 'kill-buffer-hook
2430 #'python-shell-font-lock-kill-buffer
'local
)
2431 (remove-hook 'comint-output-filter-functions
2432 #'python-shell-font-lock-comint-output-filter-function
2435 (message "Shell font-lock is disabled"))))
2437 (defun python-shell-font-lock-toggle (&optional msg
)
2438 "Toggle font-lock for shell.
2439 With argument MSG show activation/deactivation message."
2441 (python-shell-with-shell-buffer
2442 (set (make-local-variable 'python-shell-font-lock-enable
)
2443 (not python-shell-font-lock-enable
))
2444 (if python-shell-font-lock-enable
2445 (python-shell-font-lock-turn-on msg
)
2446 (python-shell-font-lock-turn-off msg
))
2447 python-shell-font-lock-enable
))
2449 (define-derived-mode inferior-python-mode comint-mode
"Inferior Python"
2450 "Major mode for Python inferior process.
2451 Runs a Python interpreter as a subprocess of Emacs, with Python
2452 I/O through an Emacs buffer. Variables `python-shell-interpreter'
2453 and `python-shell-interpreter-args' control which Python
2454 interpreter is run. Variables
2455 `python-shell-prompt-regexp',
2456 `python-shell-prompt-output-regexp',
2457 `python-shell-prompt-block-regexp',
2458 `python-shell-font-lock-enable',
2459 `python-shell-completion-setup-code',
2460 `python-shell-completion-string-code',
2461 `python-eldoc-setup-code', `python-eldoc-string-code',
2462 `python-ffap-setup-code' and `python-ffap-string-code' can
2463 customize this mode for different Python interpreters.
2465 This mode resets `comint-output-filter-functions' locally, so you
2466 may want to re-add custom functions to it using the
2467 `inferior-python-mode-hook'.
2469 You can also add additional setup code to be run at
2470 initialization of the interpreter via `python-shell-setup-codes'
2473 \(Type \\[describe-mode] in the process buffer for a list of commands.)"
2474 (let ((interpreter python-shell-interpreter
)
2475 (args python-shell-interpreter-args
))
2476 (when python-shell--parent-buffer
2477 (python-util-clone-local-variables python-shell--parent-buffer
))
2478 ;; Users can override default values for these vars when calling
2479 ;; `run-python'. This ensures new values let-bound in
2480 ;; `python-shell-make-comint' are locally set.
2481 (set (make-local-variable 'python-shell-interpreter
) interpreter
)
2482 (set (make-local-variable 'python-shell-interpreter-args
) args
))
2483 (set (make-local-variable 'python-shell--prompt-calculated-input-regexp
) nil
)
2484 (set (make-local-variable 'python-shell--prompt-calculated-output-regexp
) nil
)
2485 (python-shell-prompt-set-calculated-regexps)
2486 (setq comint-prompt-regexp python-shell--prompt-calculated-input-regexp
)
2487 (set (make-local-variable 'comint-prompt-read-only
) t
)
2488 (setq mode-line-process
'(":%s"))
2489 (set (make-local-variable 'comint-output-filter-functions
)
2490 '(ansi-color-process-output
2491 python-pdbtrack-comint-output-filter-function
2492 python-comint-postoutput-scroll-to-bottom
))
2493 (set (make-local-variable 'compilation-error-regexp-alist
)
2494 python-shell-compilation-regexp-alist
)
2495 (add-hook 'completion-at-point-functions
2496 #'python-shell-completion-at-point nil
'local
)
2497 (define-key inferior-python-mode-map
"\t"
2498 'python-shell-completion-complete-or-indent
)
2499 (make-local-variable 'python-pdbtrack-buffers-to-kill
)
2500 (make-local-variable 'python-pdbtrack-tracked-buffer
)
2501 (make-local-variable 'python-shell-internal-last-output
)
2502 (when python-shell-font-lock-enable
2503 (python-shell-font-lock-turn-on))
2504 (compilation-shell-minor-mode 1)
2505 (python-shell-accept-process-output
2506 (get-buffer-process (current-buffer))))
2508 (defun python-shell-make-comint (cmd proc-name
&optional show internal
)
2509 "Create a Python shell comint buffer.
2510 CMD is the Python command to be executed and PROC-NAME is the
2511 process name the comint buffer will get. After the comint buffer
2512 is created the `inferior-python-mode' is activated. When
2513 optional argument SHOW is non-nil the buffer is shown. When
2514 optional argument INTERNAL is non-nil this process is run on a
2515 buffer with a name that starts with a space, following the Emacs
2516 convention for temporary/internal buffers, and also makes sure
2517 the user is not queried for confirmation when the process is
2520 (let* ((proc-buffer-name
2521 (format (if (not internal
) "*%s*" " *%s*") proc-name
))
2522 (process-environment (python-shell-calculate-process-environment))
2523 (exec-path (python-shell-calculate-exec-path)))
2524 (when (not (comint-check-proc proc-buffer-name
))
2525 (let* ((cmdlist (split-string-and-unquote cmd
))
2526 (interpreter (car cmdlist
))
2527 (args (cdr cmdlist
))
2528 (buffer (apply #'make-comint-in-buffer proc-name proc-buffer-name
2529 interpreter nil args
))
2530 (python-shell--parent-buffer (current-buffer))
2531 (process (get-buffer-process buffer
))
2532 ;; As the user may have overridden default values for
2533 ;; these vars on `run-python', let-binding them allows
2534 ;; to have the new right values in all setup code
2535 ;; that's is done in `inferior-python-mode', which is
2536 ;; important, especially for prompt detection.
2537 (python-shell-interpreter interpreter
)
2538 (python-shell-interpreter-args
2539 (mapconcat #'identity args
" ")))
2540 (with-current-buffer buffer
2541 (inferior-python-mode))
2542 (when show
(display-buffer buffer
))
2543 (and internal
(set-process-query-on-exit-flag process nil
))))
2547 (defun run-python (&optional cmd dedicated show
)
2548 "Run an inferior Python process.
2550 Argument CMD defaults to `python-shell-calculate-command' return
2551 value. When called interactively with `prefix-arg', it allows
2552 the user to edit such value and choose whether the interpreter
2553 should be DEDICATED for the current buffer. When numeric prefix
2554 arg is other than 0 or 4 do not SHOW.
2556 For a given buffer and same values of DEDICATED, if a process is
2557 already running for it, it will do nothing. This means that if
2558 the current buffer is using a global process, the user is still
2559 able to switch it to use a dedicated one.
2561 Runs the hook `inferior-python-mode-hook' after
2562 `comint-mode-hook' is run. (Type \\[describe-mode] in the
2563 process buffer for a list of commands.)"
2565 (if current-prefix-arg
2567 (read-shell-command "Run Python: " (python-shell-calculate-command))
2568 (y-or-n-p "Make dedicated process? ")
2569 (= (prefix-numeric-value current-prefix-arg
) 4))
2570 (list (python-shell-calculate-command) nil t
)))
2572 (python-shell-make-comint
2573 (or cmd
(python-shell-calculate-command))
2574 (python-shell-get-process-name dedicated
) show
)))
2576 (defun run-python-internal ()
2577 "Run an inferior Internal Python process.
2578 Input and output via buffer named after
2579 `python-shell-internal-buffer-name' and what
2580 `python-shell-internal-get-process-name' returns.
2582 This new kind of shell is intended to be used for generic
2583 communication related to defined configurations; the main
2584 difference with global or dedicated shells is that these ones are
2585 attached to a configuration, not a buffer. This means that can
2586 be used for example to retrieve the sys.path and other stuff,
2587 without messing with user shells. Note that
2588 `python-shell-font-lock-enable' and `inferior-python-mode-hook'
2589 are set to nil for these shells, so setup codes are not sent at
2591 (let ((python-shell-font-lock-enable nil
)
2592 (inferior-python-mode-hook nil
))
2594 (python-shell-make-comint
2595 (python-shell-calculate-command)
2596 (python-shell-internal-get-process-name) nil t
))))
2598 (defun python-shell-get-buffer ()
2599 "Return inferior Python buffer for current buffer.
2600 If current buffer is in `inferior-python-mode', return it."
2601 (if (derived-mode-p 'inferior-python-mode
)
2603 (let* ((dedicated-proc-name (python-shell-get-process-name t
))
2604 (dedicated-proc-buffer-name (format "*%s*" dedicated-proc-name
))
2605 (global-proc-name (python-shell-get-process-name nil
))
2606 (global-proc-buffer-name (format "*%s*" global-proc-name
))
2607 (dedicated-running (comint-check-proc dedicated-proc-buffer-name
))
2608 (global-running (comint-check-proc global-proc-buffer-name
)))
2609 ;; Always prefer dedicated
2610 (or (and dedicated-running dedicated-proc-buffer-name
)
2611 (and global-running global-proc-buffer-name
)))))
2613 (defun python-shell-get-process ()
2614 "Return inferior Python process for current buffer."
2615 (get-buffer-process (python-shell-get-buffer)))
2617 (defun python-shell-get-process-or-error (&optional interactivep
)
2618 "Return inferior Python process for current buffer or signal error.
2619 When argument INTERACTIVEP is non-nil, use `user-error' instead
2620 of `error' with a user-friendly message."
2621 (or (python-shell-get-process)
2624 "Start a Python process first with `M-x run-python' or `%s'."
2628 #'run-python overriding-local-map t
)))
2630 "No inferior Python process running."))))
2632 (defun python-shell-get-or-create-process (&optional cmd dedicated show
)
2633 "Get or create an inferior Python process for current buffer and return it.
2634 Arguments CMD, DEDICATED and SHOW are those of `run-python' and
2635 are used to start the shell. If those arguments are not
2636 provided, `run-python' is called interactively and the user will
2637 be asked for their values."
2638 (let ((shell-process (python-shell-get-process)))
2639 (when (not shell-process
)
2641 ;; XXX: Refactor code such that calling `run-python'
2642 ;; interactively is not needed anymore.
2643 (call-interactively 'run-python
)
2644 (run-python cmd dedicated show
)))
2645 (or shell-process
(python-shell-get-process))))
2648 #'python-shell-get-or-create-process
2649 "Instead call `python-shell-get-process' and create one if returns nil."
2652 (defvar python-shell-internal-buffer nil
2653 "Current internal shell buffer for the current buffer.
2654 This is really not necessary at all for the code to work but it's
2655 there for compatibility with CEDET.")
2657 (defvar python-shell-internal-last-output nil
2658 "Last output captured by the internal shell.
2659 This is really not necessary at all for the code to work but it's
2660 there for compatibility with CEDET.")
2662 (defun python-shell-internal-get-or-create-process ()
2663 "Get or create an inferior Internal Python process."
2664 (let ((proc-name (python-shell-internal-get-process-name)))
2665 (if (process-live-p proc-name
)
2666 (get-process proc-name
)
2667 (run-python-internal))))
2669 (define-obsolete-function-alias
2670 'python-proc
'python-shell-internal-get-or-create-process
"24.3")
2672 (define-obsolete-variable-alias
2673 'python-buffer
'python-shell-internal-buffer
"24.3")
2675 (define-obsolete-variable-alias
2676 'python-preoutput-result
'python-shell-internal-last-output
"24.3")
2678 (defun python-shell--save-temp-file (string)
2679 (let* ((temporary-file-directory
2680 (if (file-remote-p default-directory
)
2681 (concat (file-remote-p default-directory
) "/tmp")
2682 temporary-file-directory
))
2683 (temp-file-name (make-temp-file "py"))
2684 (coding-system-for-write (python-info-encoding)))
2685 (with-temp-file temp-file-name
2687 (delete-trailing-whitespace))
2690 (defun python-shell-send-string (string &optional process msg
)
2691 "Send STRING to inferior Python PROCESS.
2692 When optional argument MSG is non-nil, forces display of a
2693 user-friendly message if there's no process running; defaults to
2694 t when called interactively."
2696 (list (read-string "Python command: ") nil t
))
2697 (let ((process (or process
(python-shell-get-process-or-error msg
))))
2698 (if (string-match ".\n+." string
) ;Multiline.
2699 (let* ((temp-file-name (python-shell--save-temp-file string
))
2700 (file-name (or (buffer-file-name) temp-file-name
)))
2701 (python-shell-send-file file-name process temp-file-name t
))
2702 (comint-send-string process string
)
2703 (when (or (not (string-match "\n\\'" string
))
2704 (string-match "\n[ \t].*\n?\\'" string
))
2705 (comint-send-string process
"\n")))))
2707 (defvar python-shell-output-filter-in-progress nil
)
2708 (defvar python-shell-output-filter-buffer nil
)
2710 (defun python-shell-output-filter (string)
2711 "Filter used in `python-shell-send-string-no-output' to grab output.
2712 STRING is the output received to this point from the process.
2713 This filter saves received output from the process in
2714 `python-shell-output-filter-buffer' and stops receiving it after
2715 detecting a prompt at the end of the buffer."
2717 string
(ansi-color-filter-apply string
)
2718 python-shell-output-filter-buffer
2719 (concat python-shell-output-filter-buffer string
))
2720 (when (python-shell-comint-end-of-output-p
2721 python-shell-output-filter-buffer
)
2722 ;; Output ends when `python-shell-output-filter-buffer' contains
2723 ;; the prompt attached at the end of it.
2724 (setq python-shell-output-filter-in-progress nil
2725 python-shell-output-filter-buffer
2726 (substring python-shell-output-filter-buffer
2727 0 (match-beginning 0)))
2729 python-shell--prompt-calculated-output-regexp
2730 python-shell-output-filter-buffer
)
2731 ;; Some shells, like IPython might append a prompt before the
2732 ;; output, clean that.
2733 (setq python-shell-output-filter-buffer
2734 (substring python-shell-output-filter-buffer
(match-end 0)))))
2737 (defun python-shell-send-string-no-output (string &optional process
)
2738 "Send STRING to PROCESS and inhibit output.
2740 (let ((process (or process
(python-shell-get-process-or-error)))
2741 (comint-preoutput-filter-functions
2742 '(python-shell-output-filter))
2743 (python-shell-output-filter-in-progress t
)
2747 (python-shell-send-string string process
)
2748 (while python-shell-output-filter-in-progress
2749 ;; `python-shell-output-filter' takes care of setting
2750 ;; `python-shell-output-filter-in-progress' to NIL after it
2751 ;; detects end of output.
2752 (accept-process-output process
))
2754 python-shell-output-filter-buffer
2755 (setq python-shell-output-filter-buffer nil
)))
2756 (with-current-buffer (process-buffer process
)
2757 (comint-interrupt-subjob)))))
2759 (defun python-shell-internal-send-string (string)
2760 "Send STRING to the Internal Python interpreter.
2761 Returns the output. See `python-shell-send-string-no-output'."
2762 ;; XXX Remove `python-shell-internal-last-output' once CEDET is
2763 ;; updated to support this new mode.
2764 (setq python-shell-internal-last-output
2765 (python-shell-send-string-no-output
2766 ;; Makes this function compatible with the old
2767 ;; python-send-receive. (At least for CEDET).
2768 (replace-regexp-in-string "_emacs_out +" "" string
)
2769 (python-shell-internal-get-or-create-process))))
2771 (define-obsolete-function-alias
2772 'python-send-receive
'python-shell-internal-send-string
"24.3")
2774 (define-obsolete-function-alias
2775 'python-send-string
'python-shell-internal-send-string
"24.3")
2777 (defun python-shell-buffer-substring (start end
&optional nomain
)
2778 "Send buffer substring from START to END formatted for shell.
2779 This is a wrapper over `buffer-substring' that takes care of
2780 different transformations for the code sent to be evaluated in
2782 1. When optional argument NOMAIN is non-nil everything under an
2783 \"if __name__ == '__main__'\" block will be removed.
2784 2. When a subregion of the buffer is sent, it takes care of
2785 appending extra empty lines so tracebacks are correct.
2786 3. When the region sent is a substring of the current buffer, a
2787 coding cookie is added.
2788 4. Wraps indented regions under an \"if True:\" block so the
2789 interpreter evaluates them correctly."
2790 (let* ((substring (buffer-substring-no-properties start end
))
2791 (starts-at-point-min-p (save-restriction
2793 (= (point-min) start
)))
2794 (encoding (python-info-encoding))
2795 (fillstr (when (not starts-at-point-min-p
)
2797 (format "# -*- coding: %s -*-\n" encoding
)
2799 ;; Subtract 2 because of the coding cookie.
2800 (- (line-number-at-pos start
) 2) ?
\n))))
2801 (toplevel-block-p (save-excursion
2803 (or (zerop (line-number-at-pos start
))
2805 (python-util-forward-comment 1)
2806 (zerop (current-indentation)))))))
2809 (if fillstr
(insert fillstr
))
2811 (goto-char (point-min))
2812 (when (not toplevel-block-p
)
2814 (delete-region (point) (line-end-position)))
2816 (let* ((if-name-main-start-end
2819 (when (python-nav-if-name-main)
2821 (progn (python-nav-forward-sexp-safe)
2822 ;; Include ending newline
2825 ;; Oh destructuring bind, how I miss you.
2826 (if-name-main-start (car if-name-main-start-end
))
2827 (if-name-main-end (cdr if-name-main-start-end
))
2828 (fillstr (make-string
2829 (- (line-number-at-pos if-name-main-end
)
2830 (line-number-at-pos if-name-main-start
)) ?
\n)))
2831 (when if-name-main-start-end
2832 (goto-char if-name-main-start
)
2833 (delete-region if-name-main-start if-name-main-end
)
2835 ;; Ensure there's only one coding cookie in the generated string.
2836 (goto-char (point-min))
2837 (when (looking-at-p (python-rx coding-cookie
))
2839 (when (looking-at-p (python-rx coding-cookie
))
2841 (line-beginning-position) (line-end-position))))
2842 (buffer-substring-no-properties (point-min) (point-max)))))
2844 (defun python-shell-send-region (start end
&optional send-main msg
)
2845 "Send the region delimited by START and END to inferior Python process.
2846 When optional argument SEND-MAIN is non-nil, allow execution of
2847 code inside blocks delimited by \"if __name__== '__main__':\".
2848 When called interactively SEND-MAIN defaults to nil, unless it's
2849 called with prefix argument. When optional argument MSG is
2850 non-nil, forces display of a user-friendly message if there's no
2851 process running; defaults to t when called interactively."
2853 (list (region-beginning) (region-end) current-prefix-arg t
))
2854 (let* ((string (python-shell-buffer-substring start end
(not send-main
)))
2855 (process (python-shell-get-process-or-error msg
))
2856 (original-string (buffer-substring-no-properties start end
))
2857 (_ (string-match "\\`\n*\\(.*\\)" original-string
)))
2858 (message "Sent: %s..." (match-string 1 original-string
))
2859 (python-shell-send-string string process
)))
2861 (defun python-shell-send-buffer (&optional send-main msg
)
2862 "Send the entire buffer to inferior Python process.
2863 When optional argument SEND-MAIN is non-nil, allow execution of
2864 code inside blocks delimited by \"if __name__== '__main__':\".
2865 When called interactively SEND-MAIN defaults to nil, unless it's
2866 called with prefix argument. When optional argument MSG is
2867 non-nil, forces display of a user-friendly message if there's no
2868 process running; defaults to t when called interactively."
2869 (interactive (list current-prefix-arg t
))
2872 (python-shell-send-region (point-min) (point-max) send-main msg
)))
2874 (defun python-shell-send-defun (&optional arg msg
)
2875 "Send the current defun to inferior Python process.
2876 When argument ARG is non-nil do not include decorators. When
2877 optional argument MSG is non-nil, forces display of a
2878 user-friendly message if there's no process running; defaults to
2879 t when called interactively."
2880 (interactive (list current-prefix-arg t
))
2882 (python-shell-send-region
2885 (while (and (or (python-nav-beginning-of-defun)
2886 (beginning-of-line 1))
2887 (> (current-indentation) 0)))
2889 (while (and (forward-line -
1)
2890 (looking-at (python-rx decorator
))))
2894 (or (python-nav-end-of-defun)
2900 (defun python-shell-send-file (file-name &optional process temp-file-name
2902 "Send FILE-NAME to inferior Python PROCESS.
2903 If TEMP-FILE-NAME is passed then that file is used for processing
2904 instead, while internally the shell will continue to use
2905 FILE-NAME. If TEMP-FILE-NAME and DELETE are non-nil, then
2906 TEMP-FILE-NAME is deleted after evaluation is performed. When
2907 optional argument MSG is non-nil, forces display of a
2908 user-friendly message if there's no process running; defaults to
2909 t when called interactively."
2912 (read-file-name "File to send: ") ; file-name
2914 nil
; temp-file-name
2917 (let* ((process (or process
(python-shell-get-process-or-error msg
)))
2918 (encoding (with-temp-buffer
2919 (insert-file-contents
2920 (or temp-file-name file-name
))
2921 (python-info-encoding)))
2922 (file-name (expand-file-name
2923 (or (file-remote-p file-name
'localname
)
2925 (temp-file-name (when temp-file-name
2927 (or (file-remote-p temp-file-name
'localname
)
2929 (python-shell-send-string
2932 "import codecs, os;"
2933 "__pyfile = codecs.open('''%s''', encoding='''%s''');"
2934 "__code = __pyfile.read().encode('''%s''');"
2936 (when (and delete temp-file-name
)
2937 (format "os.remove('''%s''');" temp-file-name
))
2938 "exec(compile(__code, '''%s''', 'exec'));")
2939 (or temp-file-name file-name
) encoding encoding file-name
)
2942 (defun python-shell-switch-to-shell (&optional msg
)
2943 "Switch to inferior Python process buffer.
2944 When optional argument MSG is non-nil, forces display of a
2945 user-friendly message if there's no process running; defaults to
2946 t when called interactively."
2949 (process-buffer (python-shell-get-process-or-error msg
)) nil t
))
2951 (defun python-shell-send-setup-code ()
2952 "Send all setup code for shell.
2953 This function takes the list of setup code to send from the
2954 `python-shell-setup-codes' list."
2955 (let ((process (python-shell-get-process))
2959 (cond ((stringp elt
) elt
)
2960 ((symbolp elt
) (symbol-value elt
))
2962 python-shell-setup-codes
2964 "\n\nprint ('python.el: sent setup code')")))
2965 (python-shell-send-string code process
)
2966 (python-shell-accept-process-output process
)))
2968 (add-hook 'inferior-python-mode-hook
2969 #'python-shell-send-setup-code
)
2972 ;;; Shell completion
2974 (defcustom python-shell-completion-setup-code
2979 import builtins as __builtin__
2981 import readline, rlcompleter
2983 def __PYTHON_EL_get_completions(text):
2986 def __PYTHON_EL_get_completions(text):
2987 builtins = dir(__builtin__)
2990 splits = text.split()
2991 is_module = splits and splits[0] in ('from', 'import')
2992 is_ipython = ('__IPYTHON__' in builtins or
2993 '__IPYTHON__active' in builtins)
2995 from IPython.core.completerlib import module_completion
2996 completions = module_completion(text.strip())
2997 elif is_ipython and '__IP' in builtins:
2998 completions = __IP.complete(text)
2999 elif is_ipython and 'get_ipython' in builtins:
3000 completions = get_ipython().Completer.all_completions(text)
3004 res = readline.get_completer()(text, i)
3008 completions.append(res)
3012 "Code used to setup completion in inferior Python processes."
3016 (defcustom python-shell-completion-string-code
3017 "';'.join(__PYTHON_EL_get_completions('''%s'''))\n"
3018 "Python code used to get a string of completions separated by semicolons.
3019 The string passed to the function is the current python name or
3020 the full statement in the case of imports."
3024 (define-obsolete-variable-alias
3025 'python-shell-completion-module-string-code
3026 'python-shell-completion-string-code
3028 "Completion string code must also autocomplete modules.")
3030 (define-obsolete-variable-alias
3031 'python-shell-completion-pdb-string-code
3032 'python-shell-completion-string-code
3034 "Completion string code must work for (i)pdb.")
3036 (defcustom python-shell-completion-native-disabled-interpreters
3037 ;; PyPy's readline cannot handle some escape sequences yet.
3039 "List of disabled interpreters.
3040 When a match is found, native completion is disabled."
3041 :type
'(repeat string
))
3043 (defcustom python-shell-completion-native-enable t
3044 "Enable readline based native completion."
3047 (defcustom python-shell-completion-native-output-timeout
0.01
3048 "Time in seconds to wait for completion output before giving up."
3051 (defvar python-shell-completion-native-redirect-buffer
3052 " *Python completions redirect*"
3053 "Buffer to be used to redirect output of readline commands.")
3055 (defun python-shell-completion-native-interpreter-disabled-p ()
3056 "Return non-nil if interpreter has native completion disabled."
3057 (when python-shell-completion-native-disabled-interpreters
3059 (regexp-opt python-shell-completion-native-disabled-interpreters
)
3060 (file-name-nondirectory python-shell-interpreter
))))
3062 (defun python-shell-completion-native-try ()
3063 "Return non-nil if can trigger native completion."
3064 (let ((python-shell-completion-native-enable t
))
3065 (python-shell-completion-native-get-completions
3066 (get-buffer-process (current-buffer))
3069 (defun python-shell-completion-native-setup ()
3070 "Try to setup native completion, return non-nil on success."
3071 (let ((process (python-shell-get-process)))
3072 (python-shell-send-string
3078 " import readline, rlcompleter"
3079 ;; Remove parens on callables as it breaks completion on
3080 ;; arguments (e.g. str(Ari<tab>)).
3081 " class Completer(rlcompleter.Completer):"
3082 " def _callable_postfix(self, val, word):"
3084 " readline.set_completer(Completer().complete)"
3085 " if readline.__doc__ and 'libedit' in readline.__doc__:"
3086 " readline.parse_and_bind('bind ^I rl_complete')"
3088 " readline.parse_and_bind('tab: complete')"
3089 " print ('python.el: readline is available')"
3091 " print ('python.el: readline not available')")
3094 (python-shell-accept-process-output process
)
3095 (when (save-excursion
3097 (regexp-quote "python.el: readline is available") nil t
1))
3098 (python-shell-completion-native-try))))
3100 (defun python-shell-completion-native-turn-off (&optional msg
)
3101 "Turn off shell native completions.
3102 With argument MSG show deactivation message."
3104 (python-shell-with-shell-buffer
3105 (set (make-local-variable 'python-shell-completion-native-enable
) nil
)
3107 (message "Shell native completion is disabled, using fallback"))))
3109 (defun python-shell-completion-native-turn-on (&optional msg
)
3110 "Turn on shell native completions.
3111 With argument MSG show deactivation message."
3113 (python-shell-with-shell-buffer
3114 (set (make-local-variable 'python-shell-completion-native-enable
) t
)
3115 (python-shell-completion-native-turn-on-maybe msg
)))
3117 (defun python-shell-completion-native-turn-on-maybe (&optional msg
)
3118 "Turn on native completions if enabled and available.
3119 With argument MSG show activation/deactivation message."
3121 (python-shell-with-shell-buffer
3122 (when python-shell-completion-native-enable
3124 ((python-shell-completion-native-interpreter-disabled-p)
3125 (python-shell-completion-native-turn-off msg
))
3126 ((python-shell-completion-native-setup)
3128 (message "Shell native completion is enabled.")))
3130 '(python python-shell-completion-native-turn-on-maybe
)
3133 "Your `python-shell-interpreter' doesn't seem to "
3134 "support readline, yet `python-shell-completion-native' "
3135 (format "was `t' and %S is not part of the "
3136 (file-name-nondirectory python-shell-interpreter
))
3137 "`python-shell-completion-native-disabled-interpreters' "
3138 "list. Native completions have been disabled locally. "))
3139 (python-shell-completion-native-turn-off msg
))))))
3141 (defun python-shell-completion-native-turn-on-maybe-with-msg ()
3142 "Like `python-shell-completion-native-turn-on-maybe' but force messages."
3143 (python-shell-completion-native-turn-on-maybe t
))
3145 (add-hook 'inferior-python-mode-hook
3146 #'python-shell-completion-native-turn-on-maybe-with-msg
)
3148 (defun python-shell-completion-native-toggle (&optional msg
)
3149 "Toggle shell native completion.
3150 With argument MSG show activation/deactivation message."
3152 (python-shell-with-shell-buffer
3153 (if python-shell-completion-native-enable
3154 (python-shell-completion-native-turn-off msg
)
3155 (python-shell-completion-native-turn-on msg
))
3156 python-shell-completion-native-enable
))
3158 (defun python-shell-completion-native-get-completions (process import input
)
3159 "Get completions using native readline for PROCESS.
3160 When IMPORT is non-nil takes precedence over INPUT for
3162 (with-current-buffer (process-buffer process
)
3163 (when (and python-shell-completion-native-enable
3164 (python-util-comint-last-prompt)
3165 (>= (point) (cdr (python-util-comint-last-prompt))))
3166 (let* ((input (or import input
))
3167 (original-filter-fn (process-filter process
))
3168 (redirect-buffer (get-buffer-create
3169 python-shell-completion-native-redirect-buffer
))
3170 (separators (python-rx
3171 (or whitespace open-paren close-paren
)))
3173 (new-input (concat input trigger
))
3176 (+ (- (point-max) (comint-bol)) (length new-input
))))
3177 (delete-line-command (make-string input-length ?
\b))
3178 (input-to-send (concat new-input delete-line-command
)))
3179 ;; Ensure restoring the process filter, even if the user quits
3180 ;; or there's some other error.
3182 (with-current-buffer redirect-buffer
3183 ;; Cleanup the redirect buffer
3184 (delete-region (point-min) (point-max))
3185 ;; Mimic `comint-redirect-send-command', unfortunately it
3186 ;; can't be used here because it expects a newline in the
3187 ;; command and that's exactly what we are trying to avoid.
3188 (let ((comint-redirect-echo-input nil
)
3189 (comint-redirect-verbose nil
)
3190 (comint-redirect-perform-sanity-check nil
)
3191 (comint-redirect-insert-matching-regexp nil
)
3192 ;; Feed it some regex that will never match.
3193 (comint-redirect-finished-regexp "^\\'$")
3194 (comint-redirect-output-buffer redirect-buffer
))
3195 ;; Compatibility with Emacs 24.x. Comint changed and
3196 ;; now `comint-redirect-filter' gets 3 args. This
3197 ;; checks which version of `comint-redirect-filter' is
3198 ;; in use based on its args and uses `apply-partially'
3199 ;; to make it up for the 3 args case.
3201 (help-function-arglist 'comint-redirect-filter
)) 3)
3203 process
(apply-partially
3204 #'comint-redirect-filter original-filter-fn
))
3205 (set-process-filter process
#'comint-redirect-filter
))
3206 (process-send-string process input-to-send
)
3207 (accept-process-output
3209 python-shell-completion-native-output-timeout
)
3210 ;; XXX: can't use `python-shell-accept-process-output'
3211 ;; here because there are no guarantees on how output
3212 ;; ends. The workaround here is to call
3213 ;; `accept-process-output' until we don't find anything
3215 (while (accept-process-output
3217 python-shell-completion-native-output-timeout
))
3218 (cl-remove-duplicates
3220 (buffer-substring-no-properties
3221 (point-min) (point-max))
3223 (set-process-filter process original-filter-fn
))))))
3225 (defun python-shell-completion-get-completions (process import input
)
3226 "Do completion at point using PROCESS for IMPORT or INPUT.
3227 When IMPORT is non-nil takes precedence over INPUT for
3229 (with-current-buffer (process-buffer process
)
3231 (let ((prompt-boundaries (python-util-comint-last-prompt)))
3232 (buffer-substring-no-properties
3233 (car prompt-boundaries
) (cdr prompt-boundaries
))))
3235 ;; Check whether a prompt matches a pdb string, an import
3236 ;; statement or just the standard prompt and use the
3237 ;; correct python-shell-completion-*-code string
3238 (cond ((and (string-match
3239 (concat "^" python-shell-prompt-pdb-regexp
) prompt
))
3240 ;; Since there are no guarantees the user will remain
3241 ;; in the same context where completion code was sent
3242 ;; (e.g. user steps into a function), safeguard
3243 ;; resending completion setup continuously.
3244 (concat python-shell-completion-setup-code
3245 "\nprint (" python-shell-completion-string-code
")"))
3247 python-shell--prompt-calculated-input-regexp prompt
)
3248 python-shell-completion-string-code
)
3250 (subject (or import input
)))
3251 (and completion-code
3252 (> (length input
) 0)
3254 (python-util-strip-string
3255 (python-shell-send-string-no-output
3256 (format completion-code subject
) process
))))
3257 (and (> (length completions
) 2)
3258 (split-string completions
3259 "^'\\|^\"\\|;\\|'$\\|\"$" t
)))))))
3261 (defun python-shell-completion-at-point (&optional process
)
3262 "Function for `completion-at-point-functions' in `inferior-python-mode'.
3263 Optional argument PROCESS forces completions to be retrieved
3264 using that one instead of current buffer's process."
3265 (setq process
(or process
(get-buffer-process (current-buffer))))
3266 (let* ((line-start (if (derived-mode-p 'inferior-python-mode
)
3267 ;; Working on a shell buffer: use prompt end.
3268 (cdr (python-util-comint-last-prompt))
3269 (line-beginning-position)))
3271 (when (string-match-p
3272 (rx (* space
) word-start
(or "from" "import") word-end space
)
3273 (buffer-substring-no-properties line-start
(point)))
3274 (buffer-substring-no-properties line-start
(point))))
3277 (if (not (re-search-backward
3279 (or whitespace open-paren close-paren string-delimiter
))
3283 (forward-char (length (match-string-no-properties 0)))
3287 (if python-shell-completion-native-enable
3288 #'python-shell-completion-native-get-completions
3289 #'python-shell-completion-get-completions
)))
3291 (completion-table-dynamic
3294 process import-statement
)))))
3296 (define-obsolete-function-alias
3297 'python-shell-completion-complete-at-point
3298 'python-shell-completion-at-point
3301 (defun python-shell-completion-complete-or-indent ()
3302 "Complete or indent depending on the context.
3303 If content before pointer is all whitespace, indent.
3304 If not try to complete."
3306 (if (string-match "^[[:space:]]*$"
3307 (buffer-substring (comint-line-beginning-position)
3309 (indent-for-tab-command)
3310 (completion-at-point)))
3313 ;;; PDB Track integration
3315 (defcustom python-pdbtrack-activate t
3316 "Non-nil makes Python shell enable pdbtracking."
3321 (defcustom python-pdbtrack-stacktrace-info-regexp
3322 "> \\([^\"(<]+\\)(\\([0-9]+\\))\\([?a-zA-Z0-9_<>]+\\)()"
3323 "Regular expression matching stacktrace information.
3324 Used to extract the current line and module being inspected."
3329 (defvar python-pdbtrack-tracked-buffer nil
3330 "Variable containing the value of the current tracked buffer.
3331 Never set this variable directly, use
3332 `python-pdbtrack-set-tracked-buffer' instead.")
3334 (defvar python-pdbtrack-buffers-to-kill nil
3335 "List of buffers to be deleted after tracking finishes.")
3337 (defun python-pdbtrack-set-tracked-buffer (file-name)
3338 "Set the buffer for FILE-NAME as the tracked buffer.
3339 Internally it uses the `python-pdbtrack-tracked-buffer' variable.
3340 Returns the tracked buffer."
3341 (let ((file-buffer (get-file-buffer
3342 (concat (file-remote-p default-directory
)
3345 (setq python-pdbtrack-tracked-buffer file-buffer
)
3346 (setq file-buffer
(find-file-noselect file-name
))
3347 (when (not (member file-buffer python-pdbtrack-buffers-to-kill
))
3348 (add-to-list 'python-pdbtrack-buffers-to-kill file-buffer
)))
3351 (defun python-pdbtrack-comint-output-filter-function (output)
3352 "Move overlay arrow to current pdb line in tracked buffer.
3353 Argument OUTPUT is a string with the output from the comint process."
3354 (when (and python-pdbtrack-activate
(not (string= output
"")))
3355 (let* ((full-output (ansi-color-filter-apply
3356 (buffer-substring comint-last-input-end
(point-max))))
3360 (insert full-output
)
3361 ;; When the debugger encounters a pdb.set_trace()
3362 ;; command, it prints a single stack frame. Sometimes
3363 ;; it prints a bit of extra information about the
3364 ;; arguments of the present function. When ipdb
3365 ;; encounters an exception, it prints the _entire_ stack
3366 ;; trace. To handle all of these cases, we want to find
3367 ;; the _last_ stack frame printed in the most recent
3368 ;; batch of output, then jump to the corresponding
3369 ;; file/line number.
3370 (goto-char (point-max))
3371 (when (re-search-backward python-pdbtrack-stacktrace-info-regexp nil t
)
3372 (setq line-number
(string-to-number
3373 (match-string-no-properties 2)))
3374 (match-string-no-properties 1)))))
3375 (if (and file-name line-number
)
3376 (let* ((tracked-buffer
3377 (python-pdbtrack-set-tracked-buffer file-name
))
3378 (shell-buffer (current-buffer))
3379 (tracked-buffer-window (get-buffer-window tracked-buffer
))
3380 (tracked-buffer-line-pos))
3381 (with-current-buffer tracked-buffer
3382 (set (make-local-variable 'overlay-arrow-string
) "=>")
3383 (set (make-local-variable 'overlay-arrow-position
) (make-marker))
3384 (setq tracked-buffer-line-pos
(progn
3385 (goto-char (point-min))
3386 (forward-line (1- line-number
))
3388 (when tracked-buffer-window
3390 tracked-buffer-window tracked-buffer-line-pos
))
3391 (set-marker overlay-arrow-position tracked-buffer-line-pos
))
3392 (pop-to-buffer tracked-buffer
)
3393 (switch-to-buffer-other-window shell-buffer
))
3394 (when python-pdbtrack-tracked-buffer
3395 (with-current-buffer python-pdbtrack-tracked-buffer
3396 (set-marker overlay-arrow-position nil
))
3397 (mapc #'(lambda (buffer)
3398 (ignore-errors (kill-buffer buffer
)))
3399 python-pdbtrack-buffers-to-kill
)
3400 (setq python-pdbtrack-tracked-buffer nil
3401 python-pdbtrack-buffers-to-kill nil
)))))
3405 ;;; Symbol completion
3407 (defun python-completion-at-point ()
3408 "Function for `completion-at-point-functions' in `python-mode'.
3409 For this to work as best as possible you should call
3410 `python-shell-send-buffer' from time to time so context in
3411 inferior Python process is updated properly."
3412 (let ((process (python-shell-get-process)))
3414 (python-shell-completion-at-point process
))))
3416 (define-obsolete-function-alias
3417 'python-completion-complete-at-point
3418 'python-completion-at-point
3424 (defcustom python-fill-comment-function
'python-fill-comment
3425 "Function to fill comments.
3426 This is the function used by `python-fill-paragraph' to
3431 (defcustom python-fill-string-function
'python-fill-string
3432 "Function to fill strings.
3433 This is the function used by `python-fill-paragraph' to
3438 (defcustom python-fill-decorator-function
'python-fill-decorator
3439 "Function to fill decorators.
3440 This is the function used by `python-fill-paragraph' to
3445 (defcustom python-fill-paren-function
'python-fill-paren
3446 "Function to fill parens.
3447 This is the function used by `python-fill-paragraph' to
3452 (defcustom python-fill-docstring-style
'pep-257
3453 "Style used to fill docstrings.
3454 This affects `python-fill-string' behavior with regards to
3455 triple quotes positioning.
3457 Possible values are `django', `onetwo', `pep-257', `pep-257-nn',
3458 `symmetric', and nil. A value of nil won't care about quotes
3459 position and will treat docstrings a normal string, any other
3460 value may result in one of the following docstring styles:
3465 Process foo, return bar.
3469 Process foo, return bar.
3471 If processing fails throw ProcessingError.
3476 \"\"\"Process foo, return bar.\"\"\"
3479 Process foo, return bar.
3481 If processing fails throw ProcessingError.
3487 \"\"\"Process foo, return bar.\"\"\"
3489 \"\"\"Process foo, return bar.
3491 If processing fails throw ProcessingError.
3497 \"\"\"Process foo, return bar.\"\"\"
3499 \"\"\"Process foo, return bar.
3501 If processing fails throw ProcessingError.
3506 \"\"\"Process foo, return bar.\"\"\"
3509 Process foo, return bar.
3511 If processing fails throw ProcessingError.
3514 (const :tag
"Don't format docstrings" nil
)
3515 (const :tag
"Django's coding standards style." django
)
3516 (const :tag
"One newline and start and Two at end style." onetwo
)
3517 (const :tag
"PEP-257 with 2 newlines at end of string." pep-257
)
3518 (const :tag
"PEP-257 with 1 newline at end of string." pep-257-nn
)
3519 (const :tag
"Symmetric style." symmetric
))
3522 (memq val
'(django onetwo pep-257 pep-257-nn symmetric nil
))))
3524 (defun python-fill-paragraph (&optional justify
)
3525 "`fill-paragraph-function' handling multi-line strings and possibly comments.
3526 If any of the current line is in or at the end of a multi-line string,
3527 fill the string or the paragraph of it that point is in, preserving
3528 the string's indentation.
3529 Optional argument JUSTIFY defines if the paragraph should be justified."
3534 ((python-syntax-context 'comment
)
3535 (funcall python-fill-comment-function justify
))
3536 ;; Strings/Docstrings
3537 ((save-excursion (or (python-syntax-context 'string
)
3538 (equal (string-to-syntax "|")
3539 (syntax-after (point)))))
3540 (funcall python-fill-string-function justify
))
3542 ((equal (char-after (save-excursion
3543 (python-nav-beginning-of-statement))) ?
@)
3544 (funcall python-fill-decorator-function justify
))
3546 ((or (python-syntax-context 'paren
)
3547 (looking-at (python-rx open-paren
))
3549 (skip-syntax-forward "^(" (line-end-position))
3550 (looking-at (python-rx open-paren
))))
3551 (funcall python-fill-paren-function justify
))
3554 (defun python-fill-comment (&optional justify
)
3555 "Comment fill function for `python-fill-paragraph'.
3556 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
3557 (fill-comment-paragraph justify
))
3559 (defun python-fill-string (&optional justify
)
3560 "String fill function for `python-fill-paragraph'.
3561 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
3562 (let* ((str-start-pos
3565 (or (python-syntax-context 'string
)
3566 (and (equal (string-to-syntax "|")
3567 (syntax-after (point)))
3569 (num-quotes (python-syntax-count-quotes
3570 (char-after str-start-pos
) str-start-pos
))
3573 (goto-char (+ str-start-pos num-quotes
))
3574 (or (re-search-forward (rx (syntax string-delimiter
)) nil t
)
3575 (goto-char (point-max)))
3578 ;; Docstring styles may vary for oneliners and multi-liners.
3579 (> (count-matches "\n" str-start-pos str-end-pos
) 0))
3581 (pcase python-fill-docstring-style
3582 ;; delimiters-style is a cons cell with the form
3583 ;; (START-NEWLINES . END-NEWLINES). When any of the sexps
3584 ;; is NIL means to not add any newlines for start or end
3585 ;; of docstring. See `python-fill-docstring-style' for a
3586 ;; graphic idea of each style.
3587 (`django
(cons 1 1))
3588 (`onetwo
(and multi-line-p
(cons 1 2)))
3589 (`pep-257
(and multi-line-p
(cons nil
2)))
3590 (`pep-257-nn
(and multi-line-p
(cons nil
1)))
3591 (`symmetric
(and multi-line-p
(cons 1 1)))))
3592 (docstring-p (save-excursion
3593 ;; Consider docstrings those strings which
3594 ;; start on a line by themselves.
3595 (python-nav-beginning-of-statement)
3596 (and (= (point) str-start-pos
))))
3597 (fill-paragraph-function))
3599 (narrow-to-region str-start-pos str-end-pos
)
3600 (fill-paragraph justify
))
3602 (when (and docstring-p python-fill-docstring-style
)
3603 ;; Add the number of newlines indicated by the selected style
3604 ;; at the start of the docstring.
3605 (goto-char (+ str-start-pos num-quotes
))
3606 (delete-region (point) (progn
3607 (skip-syntax-forward "> ")
3609 (and (car delimiters-style
)
3610 (or (newline (car delimiters-style
)) t
)
3611 ;; Indent only if a newline is added.
3612 (indent-according-to-mode))
3613 ;; Add the number of newlines indicated by the selected style
3614 ;; at the end of the docstring.
3615 (goto-char (if (not (= str-end-pos
(point-max)))
3616 (- str-end-pos num-quotes
)
3618 (delete-region (point) (progn
3619 (skip-syntax-backward "> ")
3621 (and (cdr delimiters-style
)
3622 ;; Add newlines only if string ends.
3623 (not (= str-end-pos
(point-max)))
3624 (or (newline (cdr delimiters-style
)) t
)
3625 ;; Again indent only if a newline is added.
3626 (indent-according-to-mode))))) t
)
3628 (defun python-fill-decorator (&optional _justify
)
3629 "Decorator fill function for `python-fill-paragraph'.
3630 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
3633 (defun python-fill-paren (&optional justify
)
3634 "Paren fill function for `python-fill-paragraph'.
3635 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
3637 (narrow-to-region (progn
3638 (while (python-syntax-context 'paren
)
3639 (goto-char (1- (point))))
3640 (line-beginning-position))
3642 (when (not (python-syntax-context 'paren
))
3644 (when (not (python-syntax-context 'paren
))
3645 (skip-syntax-backward "^)")))
3646 (while (and (python-syntax-context 'paren
)
3648 (goto-char (1+ (point))))
3650 (let ((paragraph-start "\f\\|[ \t]*$")
3651 (paragraph-separate ",")
3652 (fill-paragraph-function))
3653 (goto-char (point-min))
3654 (fill-paragraph justify
))
3657 (python-indent-line)
3658 (goto-char (line-end-position))))
3664 (defcustom python-skeleton-autoinsert nil
3665 "Non-nil means template skeletons will be automagically inserted.
3666 This happens when pressing \"if<SPACE>\", for example, to prompt for
3672 (define-obsolete-variable-alias
3673 'python-use-skeletons
'python-skeleton-autoinsert
"24.3")
3675 (defvar python-skeleton-available
'()
3676 "Internal list of available skeletons.")
3678 (define-abbrev-table 'python-mode-skeleton-abbrev-table
()
3679 "Abbrev table for Python mode skeletons."
3681 ;; Allow / inside abbrevs.
3682 :regexp
"\\(?:^\\|[^/]\\)\\<\\([[:word:]/]+\\)\\W*"
3683 ;; Only expand in code.
3684 :enable-function
(lambda ()
3686 (not (python-syntax-comment-or-string-p))
3687 python-skeleton-autoinsert
)))
3689 (defmacro python-skeleton-define
(name doc
&rest skel
)
3690 "Define a `python-mode' skeleton using NAME DOC and SKEL.
3691 The skeleton will be bound to python-skeleton-NAME and will
3692 be added to `python-mode-skeleton-abbrev-table'."
3693 (declare (indent 2))
3694 (let* ((name (symbol-name name
))
3695 (function-name (intern (concat "python-skeleton-" name
))))
3697 (define-abbrev python-mode-skeleton-abbrev-table
3698 ,name
"" ',function-name
:system t
)
3699 (setq python-skeleton-available
3700 (cons ',function-name python-skeleton-available
))
3701 (define-skeleton ,function-name
3703 (format "Insert %s statement." name
))
3706 (define-abbrev-table 'python-mode-abbrev-table
()
3707 "Abbrev table for Python mode."
3708 :parents
(list python-mode-skeleton-abbrev-table
))
3710 (defmacro python-define-auxiliary-skeleton
(name doc
&optional
&rest skel
)
3711 "Define a `python-mode' auxiliary skeleton using NAME DOC and SKEL.
3712 The skeleton will be bound to python-skeleton-NAME."
3713 (declare (indent 2))
3714 (let* ((name (symbol-name name
))
3715 (function-name (intern (concat "python-skeleton--" name
)))
3717 "Add '%s' clause? " name
)))
3720 `(< ,(format "%s:" name
) \n \n
3722 `(define-skeleton ,function-name
3724 (format "Auxiliary skeleton for %s statement." name
))
3726 (unless (y-or-n-p ,msg
)
3730 (python-define-auxiliary-skeleton else nil
)
3732 (python-define-auxiliary-skeleton except nil
)
3734 (python-define-auxiliary-skeleton finally nil
)
3736 (python-skeleton-define if nil
3740 ("other condition, %s: "
3744 '(python-skeleton--else) | ^
)
3746 (python-skeleton-define while nil
3750 '(python-skeleton--else) | ^
)
3752 (python-skeleton-define for nil
3756 '(python-skeleton--else) | ^
)
3758 (python-skeleton-define import nil
3759 "Import from module: "
3760 "from " str
& " " | -
5
3762 ("Identifier: " str
", ") -
2 \n _
)
3764 (python-skeleton-define try nil
3770 "except " str
":" \n
3773 '(python-skeleton--except)
3774 '(python-skeleton--else)
3775 '(python-skeleton--finally) | ^
)
3777 (python-skeleton-define def nil
3779 "def " str
"(" ("Parameter, %s: "
3780 (unless (equal ?\
( (char-before)) ", ")
3782 "\"\"\"" -
"\"\"\"" \n
3785 (python-skeleton-define class nil
3787 "class " str
"(" ("Inheritance, %s: "
3788 (unless (equal ?\
( (char-before)) ", ")
3792 "\"\"\"" -
"\"\"\"" \n
3795 (defun python-skeleton-add-menu-items ()
3796 "Add menu items to Python->Skeletons menu."
3797 (let ((skeletons (sort python-skeleton-available
'string
<)))
3798 (dolist (skeleton skeletons
)
3800 nil
'("Python" "Skeletons")
3802 "Insert %s" (nth 2 (split-string (symbol-name skeleton
) "-")))
3807 (defcustom python-ffap-setup-code
3808 "def __FFAP_get_module_path(module):
3811 path = __import__(module).__file__
3812 if path[-4:] == '.pyc' and os.path.exists(path[0:-1]):
3817 "Python code to get a module path."
3821 (defcustom python-ffap-string-code
3822 "__FFAP_get_module_path('''%s''')\n"
3823 "Python code used to get a string with the path of a module."
3827 (defun python-ffap-module-path (module)
3828 "Function for `ffap-alist' to return path for MODULE."
3830 (and (derived-mode-p 'inferior-python-mode
)
3831 (get-buffer-process (current-buffer)))
3832 (python-shell-get-process))))
3836 (python-shell-send-string-no-output
3837 (format python-ffap-string-code module
) process
)))
3839 (substring-no-properties module-file
1 -
1))))))
3843 (eval-after-load "ffap"
3845 (push '(python-mode . python-ffap-module-path
) ffap-alist
)
3846 (push '(inferior-python-mode . python-ffap-module-path
) ffap-alist
)))
3851 (defcustom python-check-command
3852 (or (executable-find "pyflakes")
3853 (executable-find "epylint")
3854 "install pyflakes, pylint or something else")
3855 "Command used to check a Python file."
3859 (defcustom python-check-buffer-name
3860 "*Python check: %s*"
3861 "Buffer name used for check commands."
3865 (defvar python-check-custom-command nil
3867 ;; XXX: Avoid `defvar-local' for compat with Emacs<24.3
3868 (make-variable-buffer-local 'python-check-custom-command
)
3870 (defun python-check (command)
3871 "Check a Python file (default current buffer's file).
3872 Runs COMMAND, a shell command, as if by `compile'.
3873 See `python-check-command' for the default."
3875 (list (read-string "Check command: "
3876 (or python-check-custom-command
3877 (concat python-check-command
" "
3878 (shell-quote-argument
3880 (let ((name (buffer-file-name)))
3882 (file-name-nondirectory name
)))
3884 (setq python-check-custom-command command
)
3885 (save-some-buffers (not compilation-ask-about-save
) nil
)
3886 (let ((process-environment (python-shell-calculate-process-environment))
3887 (exec-path (python-shell-calculate-exec-path)))
3888 (compilation-start command nil
3890 (format python-check-buffer-name command
)))))
3895 (defcustom python-eldoc-setup-code
3896 "def __PYDOC_get_help(obj):
3900 str_type = basestring
3903 if isinstance(obj, str_type):
3904 obj = eval(obj, globals())
3905 doc = inspect.getdoc(obj)
3906 if not doc and callable(obj):
3908 if inspect.isclass(obj) and hasattr(obj, '__init__'):
3909 target = obj.__init__
3915 args = inspect.formatargspec(
3916 *inspect.getargspec(target)
3919 doc = '{objtype} {name}{args}'.format(
3920 objtype=objtype, name=name, args=args
3923 doc = doc.splitlines()[0]
3927 "Python code to setup documentation retrieval."
3931 (defcustom python-eldoc-string-code
3932 "__PYDOC_get_help('''%s''')\n"
3933 "Python code used to get a string with the documentation of an object."
3937 (defun python-eldoc--get-symbol-at-point ()
3938 "Get the current symbol for eldoc.
3939 Returns the current symbol handling point within arguments."
3941 (let ((start (python-syntax-context 'paren
)))
3946 (memq (char-syntax (char-after)) '(?\ ?-
)))
3947 ;; Try to adjust to closest symbol if not in one.
3948 (python-util-forward-comment -
1)))
3949 (python-info-current-symbol t
)))
3951 (defun python-eldoc--get-doc-at-point (&optional force-input force-process
)
3952 "Internal implementation to get documentation at point.
3953 If not FORCE-INPUT is passed then what `python-eldoc--get-symbol-at-point'
3954 returns will be used. If not FORCE-PROCESS is passed what
3955 `python-shell-get-process' returns is used."
3956 (let ((process (or force-process
(python-shell-get-process))))
3958 (let ((input (or force-input
3959 (python-eldoc--get-symbol-at-point))))
3961 ;; Prevent resizing the echo area when iPython is
3962 ;; enabled. Bug#18794.
3963 (python-util-strip-string
3964 (python-shell-send-string-no-output
3965 (format python-eldoc-string-code input
)
3968 (defun python-eldoc-function ()
3969 "`eldoc-documentation-function' for Python.
3970 For this to work as best as possible you should call
3971 `python-shell-send-buffer' from time to time so context in
3972 inferior Python process is updated properly."
3973 (python-eldoc--get-doc-at-point))
3975 (defun python-eldoc-at-point (symbol)
3976 "Get help on SYMBOL using `help'.
3977 Interactively, prompt for symbol."
3979 (let ((symbol (python-eldoc--get-symbol-at-point))
3980 (enable-recursive-minibuffers t
))
3981 (list (read-string (if symbol
3982 (format "Describe symbol (default %s): " symbol
)
3983 "Describe symbol: ")
3985 (message (python-eldoc--get-doc-at-point symbol
)))
3990 (defun python-hideshow-forward-sexp-function (arg)
3991 "Python specific `forward-sexp' function for `hs-minor-mode'.
3992 Argument ARG is ignored."
3993 arg
; Shut up, byte compiler.
3994 (python-nav-end-of-defun)
3995 (unless (python-info-current-line-empty-p)
4001 (defvar python-imenu-format-item-label-function
4002 'python-imenu-format-item-label
4003 "Imenu function used to format an item label.
4004 It must be a function with two arguments: TYPE and NAME.")
4006 (defvar python-imenu-format-parent-item-label-function
4007 'python-imenu-format-parent-item-label
4008 "Imenu function used to format a parent item label.
4009 It must be a function with two arguments: TYPE and NAME.")
4011 (defvar python-imenu-format-parent-item-jump-label-function
4012 'python-imenu-format-parent-item-jump-label
4013 "Imenu function used to format a parent jump item label.
4014 It must be a function with two arguments: TYPE and NAME.")
4016 (defun python-imenu-format-item-label (type name
)
4017 "Return Imenu label for single node using TYPE and NAME."
4018 (format "%s (%s)" name type
))
4020 (defun python-imenu-format-parent-item-label (type name
)
4021 "Return Imenu label for parent node using TYPE and NAME."
4022 (format "%s..." (python-imenu-format-item-label type name
)))
4024 (defun python-imenu-format-parent-item-jump-label (type _name
)
4025 "Return Imenu label for parent node jump using TYPE and NAME."
4026 (if (string= type
"class")
4027 "*class definition*"
4028 "*function definition*"))
4030 (defun python-imenu--put-parent (type name pos tree
)
4031 "Add the parent with TYPE, NAME and POS to TREE."
4033 (funcall python-imenu-format-item-label-function type name
))
4035 (funcall python-imenu-format-parent-item-jump-label-function type name
)))
4038 (cons label
(cons (cons jump-label pos
) tree
)))))
4040 (defun python-imenu--build-tree (&optional min-indent prev-indent tree
)
4041 "Recursively build the tree of nested definitions of a node.
4042 Arguments MIN-INDENT, PREV-INDENT and TREE are internal and should
4043 not be passed explicitly unless you know what you are doing."
4044 (setq min-indent
(or min-indent
0)
4045 prev-indent
(or prev-indent python-indent-offset
))
4046 (let* ((pos (python-nav-backward-defun))
4048 (name (when (and pos
(looking-at python-nav-beginning-of-defun-regexp
))
4049 (let ((split (split-string (match-string-no-properties 0))))
4050 (setq type
(car split
))
4053 (funcall python-imenu-format-item-label-function type name
)))
4054 (indent (current-indentation))
4055 (children-indent-limit (+ python-indent-offset min-indent
)))
4057 ;; Nothing found, probably near to bobp.
4059 ((<= indent min-indent
)
4060 ;; The current indentation points that this is a parent
4061 ;; node, add it to the tree and stop recursing.
4062 (python-imenu--put-parent type name pos tree
))
4064 (python-imenu--build-tree
4067 (if (<= indent children-indent-limit
)
4068 ;; This lies within the children indent offset range,
4069 ;; so it's a normal child of its parent (i.e., not
4070 ;; a child of a child).
4071 (cons (cons label pos
) tree
)
4072 ;; Oh no, a child of a child?! Fear not, we
4073 ;; know how to roll. We recursively parse these by
4074 ;; swapping prev-indent and min-indent plus adding this
4075 ;; newly found item to a fresh subtree. This works, I
4078 (python-imenu--build-tree
4079 prev-indent indent
(list (cons label pos
)))
4082 (defun python-imenu-create-index ()
4083 "Return tree Imenu alist for the current Python buffer.
4084 Change `python-imenu-format-item-label-function',
4085 `python-imenu-format-parent-item-label-function',
4086 `python-imenu-format-parent-item-jump-label-function' to
4087 customize how labels are formatted."
4088 (goto-char (point-max))
4091 (while (setq tree
(python-imenu--build-tree))
4092 (setq index
(cons tree index
)))
4095 (defun python-imenu-create-flat-index (&optional alist prefix
)
4096 "Return flat outline of the current Python buffer for Imenu.
4097 Optional argument ALIST is the tree to be flattened; when nil
4098 `python-imenu-build-index' is used with
4099 `python-imenu-format-parent-item-jump-label-function'
4100 `python-imenu-format-parent-item-label-function'
4101 `python-imenu-format-item-label-function' set to
4102 (lambda (type name) name)
4103 Optional argument PREFIX is used in recursive calls and should
4104 not be passed explicitly.
4111 (\"decorator\" . 173)
4114 (\"wrapped_f\" . 393))))
4120 (\"decorator\" . 173)
4121 (\"decorator.wrap\" . 353)
4122 (\"decorator.wrapped_f\" . 393))"
4123 ;; Inspired by imenu--flatten-index-alist removed in revno 21853.
4128 (let ((name (if prefix
4129 (concat prefix
"." (car item
))
4132 (cond ((or (numberp pos
) (markerp pos
))
4133 (list (cons name pos
)))
4136 (cons name
(cdar pos
))
4137 (python-imenu-create-flat-index (cddr item
) name
))))))
4139 (let* ((fn (lambda (_type name
) name
))
4140 (python-imenu-format-item-label-function fn
)
4141 (python-imenu-format-parent-item-label-function fn
)
4142 (python-imenu-format-parent-item-jump-label-function fn
))
4143 (python-imenu-create-index))))))
4148 (defun python-info-current-defun (&optional include-type
)
4149 "Return name of surrounding function with Python compatible dotty syntax.
4150 Optional argument INCLUDE-TYPE indicates to include the type of the defun.
4151 This function can be used as the value of `add-log-current-defun-function'
4152 since it returns nil if point is not inside a defun."
4158 (starting-indentation (current-indentation))
4159 (starting-pos (point))
4164 (while (python-nav-beginning-of-defun 1)
4165 (when (save-match-data
4167 (or (not last-indent
)
4168 (< (current-indentation) last-indent
))
4172 ;; If this is the first run, we may add
4173 ;; the current defun at point.
4174 (setq first-run nil
)
4175 (goto-char starting-pos
)
4176 (python-nav-beginning-of-statement)
4177 (beginning-of-line 1)
4179 python-nav-beginning-of-defun-regexp
)))
4183 (+ (current-indentation)
4184 python-indent-offset
)))
4185 (if (< starting-indentation min-indent
)
4186 ;; If the starting indentation is not
4187 ;; within the min defun indent make the
4190 ;; Else go to the end of defun and add
4191 ;; up the current indentation to the
4193 (python-nav-end-of-defun)
4195 (if (>= (current-indentation) min-indent
)
4196 (1+ (current-indentation))
4198 (save-match-data (setq last-indent
(current-indentation)))
4199 (if (or (not include-type
) type
)
4200 (setq names
(cons (match-string-no-properties 1) names
))
4201 (let ((match (split-string (match-string-no-properties 0))))
4202 (setq type
(car match
))
4203 (setq names
(cons (cadr match
) names
)))))
4204 ;; Stop searching ASAP.
4205 (and (= (current-indentation) 0) (throw 'exit t
))))
4207 (concat (and type
(format "%s " type
))
4208 (mapconcat 'identity names
".")))))))
4210 (defun python-info-current-symbol (&optional replace-self
)
4211 "Return current symbol using dotty syntax.
4212 With optional argument REPLACE-SELF convert \"self\" to current
4215 (and (not (python-syntax-comment-or-string-p))
4216 (with-syntax-table python-dotty-syntax-table
4217 (let ((sym (symbol-at-point)))
4219 (substring-no-properties (symbol-name sym
))))))))
4221 (if (not replace-self
)
4223 (let ((current-defun (python-info-current-defun)))
4224 (if (not current-defun
)
4226 (replace-regexp-in-string
4227 (python-rx line-start word-start
"self" word-end ?.
)
4229 (mapconcat 'identity
4230 (butlast (split-string current-defun
"\\."))
4234 (defun python-info-statement-starts-block-p ()
4235 "Return non-nil if current statement opens a block."
4237 (python-nav-beginning-of-statement)
4238 (looking-at (python-rx block-start
))))
4240 (defun python-info-statement-ends-block-p ()
4241 "Return non-nil if point is at end of block."
4242 (let ((end-of-block-pos (save-excursion
4243 (python-nav-end-of-block)))
4244 (end-of-statement-pos (save-excursion
4245 (python-nav-end-of-statement))))
4246 (and end-of-block-pos end-of-statement-pos
4247 (= end-of-block-pos end-of-statement-pos
))))
4249 (defun python-info-beginning-of-statement-p ()
4250 "Return non-nil if point is at beginning of statement."
4251 (= (point) (save-excursion
4252 (python-nav-beginning-of-statement)
4255 (defun python-info-end-of-statement-p ()
4256 "Return non-nil if point is at end of statement."
4257 (= (point) (save-excursion
4258 (python-nav-end-of-statement)
4261 (defun python-info-beginning-of-block-p ()
4262 "Return non-nil if point is at beginning of block."
4263 (and (python-info-beginning-of-statement-p)
4264 (python-info-statement-starts-block-p)))
4266 (defun python-info-end-of-block-p ()
4267 "Return non-nil if point is at end of block."
4268 (and (python-info-end-of-statement-p)
4269 (python-info-statement-ends-block-p)))
4271 (define-obsolete-function-alias
4272 'python-info-closing-block
4273 'python-info-dedenter-opening-block-position
"24.4")
4275 (defun python-info-dedenter-opening-block-position ()
4276 "Return the point of the closest block the current line closes.
4277 Returns nil if point is not on a dedenter statement or no opening
4278 block can be detected. The latter case meaning current file is
4279 likely an invalid python file."
4280 (let ((positions (python-info-dedenter-opening-block-positions))
4281 (indentation (current-indentation))
4283 (while (and (not position
)
4286 (goto-char (car positions
))
4287 (if (<= (current-indentation) indentation
)
4288 (setq position
(car positions
))
4289 (setq positions
(cdr positions
)))))
4292 (defun python-info-dedenter-opening-block-positions ()
4293 "Return points of blocks the current line may close sorted by closer.
4294 Returns nil if point is not on a dedenter statement or no opening
4295 block can be detected. The latter case meaning current file is
4296 likely an invalid python file."
4298 (let ((dedenter-pos (python-info-dedenter-statement-p)))
4300 (goto-char dedenter-pos
)
4301 (let* ((pairs '(("elif" "elif" "if")
4302 ("else" "if" "elif" "except" "for" "while")
4303 ("except" "except" "try")
4304 ("finally" "else" "except" "try")))
4305 (dedenter (match-string-no-properties 0))
4306 (possible-opening-blocks (cdr (assoc-string dedenter pairs
)))
4307 (collected-indentations)
4310 (while (python-nav--syntactically
4312 (re-search-backward (python-rx block-start
) nil t
))
4314 (let ((indentation (current-indentation)))
4315 (when (and (not (memq indentation collected-indentations
))
4316 (or (not collected-indentations
)
4317 (< indentation
(apply #'min collected-indentations
))))
4318 (setq collected-indentations
4319 (cons indentation collected-indentations
))
4320 (when (member (match-string-no-properties 0)
4321 possible-opening-blocks
)
4322 (setq opening-blocks
(cons (point) opening-blocks
))))
4323 (when (zerop indentation
)
4324 (throw 'exit nil
)))))
4326 (nreverse opening-blocks
))))))
4328 (define-obsolete-function-alias
4329 'python-info-closing-block-message
4330 'python-info-dedenter-opening-block-message
"24.4")
4332 (defun python-info-dedenter-opening-block-message ()
4333 "Message the first line of the block the current statement closes."
4334 (let ((point (python-info-dedenter-opening-block-position)))
4338 (message "Closes %s" (save-excursion
4341 (point) (line-end-position))))))))
4343 (defun python-info-dedenter-statement-p ()
4344 "Return point if current statement is a dedenter.
4345 Sets `match-data' to the keyword that starts the dedenter
4348 (python-nav-beginning-of-statement)
4349 (when (and (not (python-syntax-context-type))
4350 (looking-at (python-rx dedenter
)))
4353 (defun python-info-line-ends-backslash-p (&optional line-number
)
4354 "Return non-nil if current line ends with backslash.
4355 With optional argument LINE-NUMBER, check that line instead."
4360 (python-util-goto-line line-number
))
4361 (while (and (not (eobp))
4362 (goto-char (line-end-position))
4363 (python-syntax-context 'paren
)
4364 (not (equal (char-before (point)) ?
\\)))
4366 (when (equal (char-before) ?
\\)
4369 (defun python-info-beginning-of-backslash (&optional line-number
)
4370 "Return the point where the backslashed line start.
4371 Optional argument LINE-NUMBER forces the line number to check against."
4376 (python-util-goto-line line-number
))
4377 (when (python-info-line-ends-backslash-p)
4378 (while (save-excursion
4379 (goto-char (line-beginning-position))
4380 (python-syntax-context 'paren
))
4382 (back-to-indentation)
4385 (defun python-info-continuation-line-p ()
4386 "Check if current line is continuation of another.
4387 When current line is continuation of another return the point
4388 where the continued line ends."
4392 (let* ((context-type (progn
4393 (back-to-indentation)
4394 (python-syntax-context-type)))
4395 (line-start (line-number-at-pos))
4396 (context-start (when context-type
4397 (python-syntax-context context-type
))))
4398 (cond ((equal context-type
'paren
)
4399 ;; Lines inside a paren are always a continuation line
4400 ;; (except the first one).
4401 (python-util-forward-comment -
1)
4403 ((member context-type
'(string comment
))
4404 ;; move forward an roll again
4405 (goto-char context-start
)
4406 (python-util-forward-comment)
4407 (python-info-continuation-line-p))
4409 ;; Not within a paren, string or comment, the only way
4410 ;; we are dealing with a continuation line is that
4411 ;; previous line contains a backslash, and this can
4412 ;; only be the previous line from current
4413 (back-to-indentation)
4414 (python-util-forward-comment -
1)
4415 (when (and (equal (1- line-start
) (line-number-at-pos))
4416 (python-info-line-ends-backslash-p))
4417 (point-marker))))))))
4419 (defun python-info-block-continuation-line-p ()
4420 "Return non-nil if current line is a continuation of a block."
4422 (when (python-info-continuation-line-p)
4424 (back-to-indentation)
4425 (when (looking-at (python-rx block-start
))
4428 (defun python-info-assignment-continuation-line-p ()
4429 "Check if current line is a continuation of an assignment.
4430 When current line is continuation of another with an assignment
4431 return the point of the first non-blank character after the
4434 (when (python-info-continuation-line-p)
4436 (back-to-indentation)
4437 (when (and (not (looking-at (python-rx block-start
)))
4438 (and (re-search-forward (python-rx not-simple-operator
4440 not-simple-operator
)
4441 (line-end-position) t
)
4442 (not (python-syntax-context-type))))
4443 (skip-syntax-forward "\s")
4446 (defun python-info-looking-at-beginning-of-defun (&optional syntax-ppss
)
4447 "Check if point is at `beginning-of-defun' using SYNTAX-PPSS."
4448 (and (not (python-syntax-context-type (or syntax-ppss
(syntax-ppss))))
4450 (beginning-of-line 1)
4451 (looking-at python-nav-beginning-of-defun-regexp
))))
4453 (defun python-info-current-line-comment-p ()
4454 "Return non-nil if current line is a comment line."
4456 (or (char-after (+ (line-beginning-position) (current-indentation))) ?_
)
4459 (defun python-info-current-line-empty-p ()
4460 "Return non-nil if current line is empty, ignoring whitespace."
4462 (beginning-of-line 1)
4464 (python-rx line-start
(* whitespace
)
4465 (group (* not-newline
))
4466 (* whitespace
) line-end
))
4467 (string-equal "" (match-string-no-properties 1))))
4469 (defun python-info-encoding-from-cookie ()
4470 "Detect current buffer's encoding from its coding cookie.
4471 Returns the encoding as a symbol."
4472 (let ((first-two-lines
4476 (goto-char (point-min))
4478 (buffer-substring-no-properties
4481 (when (string-match (python-rx coding-cookie
) first-two-lines
)
4482 (intern (match-string-no-properties 1 first-two-lines
)))))
4484 (defun python-info-encoding ()
4485 "Return encoding for file.
4486 Try `python-info-encoding-from-cookie', if none is found then
4488 ;; If no encoding is defined, then it's safe to use UTF-8: Python 2
4489 ;; uses ASCII as default while Python 3 uses UTF-8. This means that
4490 ;; in the worst case scenario python.el will make things work for
4491 ;; Python 2 files with unicode data and no encoding defined.
4492 (or (python-info-encoding-from-cookie)
4496 ;;; Utility functions
4498 (defun python-util-goto-line (line-number)
4499 "Move point to LINE-NUMBER."
4500 (goto-char (point-min))
4501 (forward-line (1- line-number
)))
4503 ;; Stolen from org-mode
4504 (defun python-util-clone-local-variables (from-buffer &optional regexp
)
4505 "Clone local variables from FROM-BUFFER.
4506 Optional argument REGEXP selects variables to clone and defaults
4510 (and (symbolp (car pair
))
4511 (string-match (or regexp
"^python-")
4512 (symbol-name (car pair
)))
4513 (set (make-local-variable (car pair
))
4515 (buffer-local-variables from-buffer
)))
4517 (defvar comint-last-prompt-overlay
) ; Shut up, byte compiler.
4519 (defun python-util-comint-last-prompt ()
4520 "Return comint last prompt overlay start and end.
4521 This is for compatibility with Emacs < 24.4."
4522 (cond ((bound-and-true-p comint-last-prompt-overlay
)
4523 (cons (overlay-start comint-last-prompt-overlay
)
4524 (overlay-end comint-last-prompt-overlay
)))
4525 ((bound-and-true-p comint-last-prompt
)
4529 (defun python-util-forward-comment (&optional direction
)
4530 "Python mode specific version of `forward-comment'.
4531 Optional argument DIRECTION defines the direction to move to."
4532 (let ((comment-start (python-syntax-context 'comment
))
4533 (factor (if (< (or direction
0) 0)
4537 (goto-char comment-start
))
4538 (forward-comment factor
)))
4540 (defun python-util-list-directories (directory &optional predicate max-depth
)
4541 "List DIRECTORY subdirs, filtered by PREDICATE and limited by MAX-DEPTH.
4542 Argument PREDICATE defaults to `identity' and must be a function
4543 that takes one argument (a full path) and returns non-nil for
4544 allowed files. When optional argument MAX-DEPTH is non-nil, stop
4545 searching when depth is reached, else don't limit."
4546 (let* ((dir (expand-file-name directory
))
4547 (dir-length (length dir
))
4548 (predicate (or predicate
#'identity
))
4549 (to-scan (list dir
))
4552 (let ((current-dir (car to-scan
)))
4553 (when (funcall predicate current-dir
)
4554 (setq tally
(cons current-dir tally
)))
4555 (setq to-scan
(append (cdr to-scan
)
4556 (python-util-list-files
4557 current-dir
#'file-directory-p
)
4559 (when (and max-depth
4561 (length (split-string
4562 (substring current-dir dir-length
)
4564 (setq to-scan nil
))))
4567 (defun python-util-list-files (dir &optional predicate
)
4568 "List files in DIR, filtering with PREDICATE.
4569 Argument PREDICATE defaults to `identity' and must be a function
4570 that takes one argument (a full path) and returns non-nil for
4572 (let ((dir-name (file-name-as-directory dir
)))
4574 (mapcar (lambda (file-name)
4575 (let ((full-file-name (expand-file-name file-name dir-name
)))
4577 (not (member file-name
'("." "..")))
4578 (funcall (or predicate
#'identity
) full-file-name
))
4579 (list full-file-name
))))
4580 (directory-files dir-name
)))))
4582 (defun python-util-list-packages (dir &optional max-depth
)
4583 "List packages in DIR, limited by MAX-DEPTH.
4584 When optional argument MAX-DEPTH is non-nil, stop searching when
4585 depth is reached, else don't limit."
4586 (let* ((dir (expand-file-name dir
))
4587 (parent-dir (file-name-directory
4588 (directory-file-name
4589 (file-name-directory
4590 (file-name-as-directory dir
)))))
4591 (subpath-length (length parent-dir
)))
4594 (replace-regexp-in-string
4595 (rx (or ?
\\ ?
/)) "." (substring file-name subpath-length
)))
4596 (python-util-list-directories
4597 (directory-file-name dir
)
4599 (file-exists-p (expand-file-name "__init__.py" dir
)))
4602 (defun python-util-popn (lst n
)
4603 "Return LST first N elements.
4604 N should be an integer, when negative its opposite is used.
4605 When N is bigger than the length of LST, the list is
4607 (let* ((n (min (abs n
)))
4613 (setq acc
(cons (car lst
) acc
)
4618 (defun python-util-strip-string (string)
4619 "Strip STRING whitespace and newlines from end and beginning."
4620 (replace-regexp-in-string
4621 (rx (or (: string-start
(* (any whitespace ?
\r ?
\n)))
4622 (: (* (any whitespace ?
\r ?
\n)) string-end
)))
4626 (defun python-util-valid-regexp-p (regexp)
4627 "Return non-nil if REGEXP is valid."
4628 (ignore-errors (string-match regexp
"") t
))
4631 (defun python-electric-pair-string-delimiter ()
4632 (when (and electric-pair-mode
4633 (memq last-command-event
'(?
\" ?
\'))
4635 (while (eq (char-before (- (point) count
)) last-command-event
)
4638 (eq (char-after) last-command-event
))
4639 (save-excursion (insert (make-string 2 last-command-event
)))))
4641 (defvar electric-indent-inhibit
)
4644 (define-derived-mode python-mode prog-mode
"Python"
4645 "Major mode for editing Python files.
4647 \\{python-mode-map}"
4648 (set (make-local-variable 'tab-width
) 8)
4649 (set (make-local-variable 'indent-tabs-mode
) nil
)
4651 (set (make-local-variable 'comment-start
) "# ")
4652 (set (make-local-variable 'comment-start-skip
) "#+\\s-*")
4654 (set (make-local-variable 'parse-sexp-lookup-properties
) t
)
4655 (set (make-local-variable 'parse-sexp-ignore-comments
) t
)
4657 (set (make-local-variable 'forward-sexp-function
)
4658 'python-nav-forward-sexp
)
4660 (set (make-local-variable 'font-lock-defaults
)
4661 '(python-font-lock-keywords
4663 (font-lock-syntactic-face-function
4664 . python-font-lock-syntactic-face-function
)))
4666 (set (make-local-variable 'syntax-propertize-function
)
4667 python-syntax-propertize-function
)
4669 (set (make-local-variable 'indent-line-function
)
4670 #'python-indent-line-function
)
4671 (set (make-local-variable 'indent-region-function
) #'python-indent-region
)
4672 ;; Because indentation is not redundant, we cannot safely reindent code.
4673 (set (make-local-variable 'electric-indent-inhibit
) t
)
4674 (set (make-local-variable 'electric-indent-chars
)
4675 (cons ?
: electric-indent-chars
))
4677 ;; Add """ ... """ pairing to electric-pair-mode.
4678 (add-hook 'post-self-insert-hook
4679 #'python-electric-pair-string-delimiter
'append t
)
4681 (set (make-local-variable 'paragraph-start
) "\\s-*$")
4682 (set (make-local-variable 'fill-paragraph-function
)
4683 #'python-fill-paragraph
)
4685 (set (make-local-variable 'beginning-of-defun-function
)
4686 #'python-nav-beginning-of-defun
)
4687 (set (make-local-variable 'end-of-defun-function
)
4688 #'python-nav-end-of-defun
)
4690 (add-hook 'completion-at-point-functions
4691 #'python-completion-at-point nil
'local
)
4693 (add-hook 'post-self-insert-hook
4694 #'python-indent-post-self-insert-function
'append
'local
)
4696 (set (make-local-variable 'imenu-create-index-function
)
4697 #'python-imenu-create-index
)
4699 (set (make-local-variable 'add-log-current-defun-function
)
4700 #'python-info-current-defun
)
4702 (add-hook 'which-func-functions
#'python-info-current-defun
nil t
)
4704 (set (make-local-variable 'skeleton-further-elements
)
4706 (< '(backward-delete-char-untabify (min python-indent-offset
4708 (^
'(- (1+ (current-indentation))))))
4710 (if (null eldoc-documentation-function
)
4712 (set (make-local-variable 'eldoc-documentation-function
)
4713 #'python-eldoc-function
)
4714 (add-function :before-until
(local 'eldoc-documentation-function
)
4715 #'python-eldoc-function
))
4718 'hs-special-modes-alist
4720 "\\s-*\\(?:def\\|class\\)\\>"
4721 ;; Use the empty string as end regexp so it doesn't default to
4722 ;; "\\s)". This way parens at end of defun are properly hidden.
4725 python-hideshow-forward-sexp-function
4728 (set (make-local-variable 'outline-regexp
)
4729 (python-rx (* space
) block-start
))
4730 (set (make-local-variable 'outline-heading-end-regexp
) ":[^\n]*\n")
4731 (set (make-local-variable 'outline-level
)
4733 "`outline-level' function for Python mode."
4734 (1+ (/ (current-indentation) python-indent-offset
))))
4736 (python-skeleton-add-menu-items)
4738 (make-local-variable 'python-shell-internal-buffer
)
4740 (when python-indent-guess-indent-offset
4741 (python-indent-guess-indent-offset)))
4748 ;; indent-tabs-mode: nil
4751 ;;; python.el ends here