1 ;;; python.el --- Python's flying circus support for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 2003-2014 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, Pdb
35 ;; tracking, Symbol completion, Skeletons, FFAP, Code Check, Eldoc,
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 ;; If you are experiencing missing or delayed output in your shells,
98 ;; that's likely caused by your Operating System's pipe buffering
99 ;; (e.g. this is known to happen running CPython 3.3.4 in Windows 7.
100 ;; See URL `http://debbugs.gnu.org/cgi/bugreport.cgi?bug=17304'). To
101 ;; fix this, using CPython's "-u" commandline argument or setting the
102 ;; "PYTHONUNBUFFERED" environment variable should help: See URL
103 ;; `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. Shell completion is implemented in such way that if you
123 ;; change the `python-shell-interpreter' it should be possible to
124 ;; integrate custom logic to calculate completions. To achieve this
125 ;; you just need to set `python-shell-completion-setup-code' and
126 ;; `python-shell-completion-string-code'. The default provided code,
127 ;; enables autocompletion for both CPython and IPython (and ideally
128 ;; any readline based Python shell). This code depends on the
129 ;; readline module, so if you are using some Operating System that
130 ;; bundles Python without it (like Windows), installing pyreadline
131 ;; from URL `http://ipython.scipy.org/moin/PyReadline/Intro' should
132 ;; suffice. To troubleshoot why you are not getting any completions
133 ;; you can try the following in your Python shell:
135 ;; >>> import readline, rlcompleter
137 ;; If you see an error, then you need to either install pyreadline or
138 ;; setup custom code that avoids that dependency.
140 ;; Shell virtualenv support: The shell also contains support for
141 ;; virtualenvs and other special environment modifications thanks to
142 ;; `python-shell-process-environment' and `python-shell-exec-path'.
143 ;; These two variables allows you to modify execution paths and
144 ;; environment variables to make easy for you to setup virtualenv rules
145 ;; or behavior modifications when running shells. Here is an example
146 ;; of how to make shell processes to be run using the /path/to/env/
149 ;; (setq python-shell-process-environment
151 ;; (format "PATH=%s" (mapconcat
154 ;; (cons (getenv "PATH")
155 ;; '("/path/to/env/bin/")))
157 ;; "VIRTUAL_ENV=/path/to/env/"))
158 ;; (python-shell-exec-path . ("/path/to/env/bin/"))
160 ;; Since the above is cumbersome and can be programmatically
161 ;; calculated, the variable `python-shell-virtualenv-path' is
162 ;; provided. When this variable is set with the path of the
163 ;; virtualenv to use, `process-environment' and `exec-path' get proper
164 ;; values in order to run shells inside the specified virtualenv. So
165 ;; the following will achieve the same as the previous example:
167 ;; (setq python-shell-virtualenv-path "/path/to/env/")
169 ;; Also the `python-shell-extra-pythonpaths' variable have been
170 ;; introduced as simple way of adding paths to the PYTHONPATH without
171 ;; affecting existing values.
173 ;; Pdb tracking: when you execute a block of code that contains some
174 ;; call to pdb (or ipdb) it will prompt the block of code and will
175 ;; follow the execution of pdb marking the current line with an arrow.
177 ;; Symbol completion: you can complete the symbol at point. It uses
178 ;; the shell completion in background so you should run
179 ;; `python-shell-send-buffer' from time to time to get better results.
181 ;; Skeletons: 6 skeletons are provided for simple inserting of class,
182 ;; def, for, if, try and while. These skeletons are integrated with
183 ;; abbrev. If you have `abbrev-mode' activated and
184 ;; `python-skeleton-autoinsert' is set to t, then whenever you type
185 ;; the name of any of those defined and hit SPC, they will be
186 ;; automatically expanded. As an alternative you can use the defined
187 ;; skeleton commands: `python-skeleton-class', `python-skeleton-def'
188 ;; `python-skeleton-for', `python-skeleton-if', `python-skeleton-try'
189 ;; and `python-skeleton-while'.
191 ;; FFAP: You can find the filename for a given module when using ffap
192 ;; out of the box. This feature needs an inferior python shell
195 ;; Code check: Check the current file for errors with `python-check'
196 ;; using the program defined in `python-check-command'.
198 ;; Eldoc: returns documentation for object at point by using the
199 ;; inferior python subprocess to inspect its documentation. As you
200 ;; might guessed you should run `python-shell-send-buffer' from time
201 ;; to time to get better results too.
203 ;; Imenu: There are two index building functions to be used as
204 ;; `imenu-create-index-function': `python-imenu-create-index' (the
205 ;; default one, builds the alist in form of a tree) and
206 ;; `python-imenu-create-flat-index'. See also
207 ;; `python-imenu-format-item-label-function',
208 ;; `python-imenu-format-parent-item-label-function',
209 ;; `python-imenu-format-parent-item-jump-label-function' variables for
210 ;; changing the way labels are formatted in the tree version.
212 ;; If you used python-mode.el you probably will miss auto-indentation
213 ;; when inserting newlines. To achieve the same behavior you have
216 ;; 1) Use GNU/Emacs' standard binding for `newline-and-indent': C-j.
218 ;; 2) Add the following hook in your .emacs:
220 ;; (add-hook 'python-mode-hook
222 ;; (define-key python-mode-map "\C-m" 'newline-and-indent)))
224 ;; I'd recommend the first one since you'll get the same behavior for
225 ;; all modes out-of-the-box.
229 ;; Add this to your .emacs:
231 ;; (add-to-list 'load-path "/folder/containing/file")
238 (require 'ansi-color
)
243 ;; Avoid compiler warnings
244 (defvar view-return-to-alist
)
245 (defvar compilation-error-regexp-alist
)
246 (defvar outline-heading-end-regexp
)
248 (autoload 'comint-mode
"comint")
251 (add-to-list 'auto-mode-alist
(cons (purecopy "\\.py\\'") 'python-mode
))
253 (add-to-list 'interpreter-mode-alist
(cons (purecopy "python[0-9.]*") 'python-mode
))
256 "Python Language's flying circus support for Emacs."
259 :link
'(emacs-commentary-link "python"))
264 (defvar python-mode-map
265 (let ((map (make-sparse-keymap)))
267 (define-key map
[remap backward-sentence
] 'python-nav-backward-block
)
268 (define-key map
[remap forward-sentence
] 'python-nav-forward-block
)
269 (define-key map
[remap backward-up-list
] 'python-nav-backward-up-list
)
270 (define-key map
"\C-c\C-j" 'imenu
)
272 (define-key map
"\177" 'python-indent-dedent-line-backspace
)
273 (define-key map
(kbd "<backtab>") 'python-indent-dedent-line
)
274 (define-key map
"\C-c<" 'python-indent-shift-left
)
275 (define-key map
"\C-c>" 'python-indent-shift-right
)
277 (define-key map
"\C-c\C-tc" 'python-skeleton-class
)
278 (define-key map
"\C-c\C-td" 'python-skeleton-def
)
279 (define-key map
"\C-c\C-tf" 'python-skeleton-for
)
280 (define-key map
"\C-c\C-ti" 'python-skeleton-if
)
281 (define-key map
"\C-c\C-tt" 'python-skeleton-try
)
282 (define-key map
"\C-c\C-tw" 'python-skeleton-while
)
284 (define-key map
"\C-c\C-p" 'run-python
)
285 (define-key map
"\C-c\C-s" 'python-shell-send-string
)
286 (define-key map
"\C-c\C-r" 'python-shell-send-region
)
287 (define-key map
"\C-\M-x" 'python-shell-send-defun
)
288 (define-key map
"\C-c\C-c" 'python-shell-send-buffer
)
289 (define-key map
"\C-c\C-l" 'python-shell-send-file
)
290 (define-key map
"\C-c\C-z" 'python-shell-switch-to-shell
)
291 ;; Some util commands
292 (define-key map
"\C-c\C-v" 'python-check
)
293 (define-key map
"\C-c\C-f" 'python-eldoc-at-point
)
295 (substitute-key-definition 'complete-symbol
'completion-at-point
297 (easy-menu-define python-menu map
"Python Mode menu"
299 :help
"Python-specific Features"
300 ["Shift region left" python-indent-shift-left
:active mark-active
301 :help
"Shift region left by a single indentation step"]
302 ["Shift region right" python-indent-shift-right
:active mark-active
303 :help
"Shift region right by a single indentation step"]
305 ["Start of def/class" beginning-of-defun
306 :help
"Go to start of outermost definition around point"]
307 ["End of def/class" end-of-defun
308 :help
"Go to end of definition around point"]
309 ["Mark def/class" mark-defun
310 :help
"Mark outermost definition around point"]
311 ["Jump to def/class" imenu
312 :help
"Jump to a class or function definition"]
316 ["Start interpreter" run-python
317 :help
"Run inferior Python process in a separate buffer"]
318 ["Switch to shell" python-shell-switch-to-shell
319 :help
"Switch to running inferior Python process"]
320 ["Eval string" python-shell-send-string
321 :help
"Eval string in inferior Python session"]
322 ["Eval buffer" python-shell-send-buffer
323 :help
"Eval buffer in inferior Python session"]
324 ["Eval region" python-shell-send-region
325 :help
"Eval region in inferior Python session"]
326 ["Eval defun" python-shell-send-defun
327 :help
"Eval defun in inferior Python session"]
328 ["Eval file" python-shell-send-file
329 :help
"Eval file in inferior Python session"]
330 ["Debugger" pdb
:help
"Run pdb under GUD"]
332 ["Check file" python-check
333 :help
"Check file for errors"]
334 ["Help on symbol" python-eldoc-at-point
335 :help
"Get help on symbol at point"]
336 ["Complete symbol" completion-at-point
337 :help
"Complete symbol before point"]))
339 "Keymap for `python-mode'.")
342 ;;; Python specialized rx
345 (defconst python-rx-constituents
346 `((block-start .
,(rx symbol-start
347 (or "def" "class" "if" "elif" "else" "try"
348 "except" "finally" "for" "while" "with")
350 (dedenter .
,(rx symbol-start
351 (or "elif" "else" "except" "finally")
353 (block-ender .
,(rx symbol-start
355 "break" "continue" "pass" "raise" "return")
357 (decorator .
,(rx line-start
(* space
) ?
@ (any letter ?_
)
359 (defun .
,(rx symbol-start
(or "def" "class") symbol-end
))
360 (if-name-main .
,(rx line-start
"if" (+ space
) "__name__"
361 (+ space
) "==" (+ space
)
362 (any ?
' ?
\") "__main__" (any ?
' ?
\")
364 (symbol-name .
,(rx (any letter ?_
) (* (any word ?_
))))
365 (open-paren .
,(rx (or "{" "[" "(")))
366 (close-paren .
,(rx (or "}" "]" ")")))
367 (simple-operator .
,(rx (any ?
+ ?- ?
/ ?
& ?^ ?~ ?| ?
* ?
< ?
> ?
= ?%
)))
368 ;; FIXME: rx should support (not simple-operator).
369 (not-simple-operator .
,(rx
371 (any ?
+ ?- ?
/ ?
& ?^ ?~ ?| ?
* ?
< ?
> ?
= ?%
))))
372 ;; FIXME: Use regexp-opt.
373 (operator .
,(rx (or "+" "-" "/" "&" "^" "~" "|" "*" "<" ">"
374 "=" "%" "**" "//" "<<" ">>" "<=" "!="
375 "==" ">=" "is" "not")))
376 ;; FIXME: Use regexp-opt.
377 (assignment-operator .
,(rx (or "=" "+=" "-=" "*=" "/=" "//=" "%=" "**="
378 ">>=" "<<=" "&=" "^=" "|=")))
379 (string-delimiter .
,(rx (and
380 ;; Match even number of backslashes.
381 (or (not (any ?
\\ ?
\' ?
\")) point
382 ;; Quotes might be preceded by a escaped quote.
383 (and (or (not (any ?
\\)) point
) ?
\\
384 (* ?
\\ ?
\\) (any ?
\' ?
\")))
386 ;; Match single or triple quotes of any kind.
387 (group (or "\"" "\"\"\"" "'" "'''"))))))
388 "Additional Python specific sexps for `python-rx'")
390 (defmacro python-rx
(&rest regexps
)
391 "Python mode specialized rx macro.
392 This variant of `rx' supports common Python named REGEXPS."
393 (let ((rx-constituents (append python-rx-constituents rx-constituents
)))
394 (cond ((null regexps
)
397 (rx-to-string `(and ,@regexps
) t
))
399 (rx-to-string (car regexps
) t
))))))
402 ;;; Font-lock and syntax
405 (defun python-syntax--context-compiler-macro (form type
&optional syntax-ppss
)
408 `(let ((ppss (or ,syntax-ppss
(syntax-ppss))))
409 (and (nth 4 ppss
) (nth 8 ppss
))))
411 `(let ((ppss (or ,syntax-ppss
(syntax-ppss))))
412 (and (nth 3 ppss
) (nth 8 ppss
))))
414 `(nth 1 (or ,syntax-ppss
(syntax-ppss))))
417 (defun python-syntax-context (type &optional syntax-ppss
)
418 "Return non-nil if point is on TYPE using SYNTAX-PPSS.
419 TYPE can be `comment', `string' or `paren'. It returns the start
420 character address of the specified TYPE."
421 (declare (compiler-macro python-syntax--context-compiler-macro
))
422 (let ((ppss (or syntax-ppss
(syntax-ppss))))
424 (`comment
(and (nth 4 ppss
) (nth 8 ppss
)))
425 (`string
(and (nth 3 ppss
) (nth 8 ppss
)))
426 (`paren
(nth 1 ppss
))
429 (defun python-syntax-context-type (&optional syntax-ppss
)
430 "Return the context type using SYNTAX-PPSS.
431 The type returned can be `comment', `string' or `paren'."
432 (let ((ppss (or syntax-ppss
(syntax-ppss))))
434 ((nth 8 ppss
) (if (nth 4 ppss
) 'comment
'string
))
435 ((nth 1 ppss
) 'paren
))))
437 (defsubst python-syntax-comment-or-string-p
()
438 "Return non-nil if point is inside 'comment or 'string."
439 (nth 8 (syntax-ppss)))
441 (define-obsolete-function-alias
442 'python-info-ppss-context
#'python-syntax-context
"24.3")
444 (define-obsolete-function-alias
445 'python-info-ppss-context-type
#'python-syntax-context-type
"24.3")
447 (define-obsolete-function-alias
448 'python-info-ppss-comment-or-string-p
449 #'python-syntax-comment-or-string-p
"24.3")
451 (defvar python-font-lock-keywords
455 "and" "del" "from" "not" "while" "as" "elif" "global" "or" "with"
456 "assert" "else" "if" "pass" "yield" "break" "except" "import" "class"
457 "in" "raise" "continue" "finally" "is" "return" "def" "for" "lambda"
462 ;; False, None, and True are listed as keywords on the Python 3
463 ;; documentation, but since they also qualify as constants they are
464 ;; fontified like that in order to keep font-lock consistent between
471 (,(rx symbol-start
"def" (1+ space
) (group (1+ (or word ?_
))))
472 (1 font-lock-function-name-face
))
474 (,(rx symbol-start
"class" (1+ space
) (group (1+ (or word ?_
))))
475 (1 font-lock-type-face
))
479 "Ellipsis" "False" "None" "NotImplemented" "True" "__debug__"
480 ;; copyright, license, credits, quit and exit are added by the site
481 ;; module and they are not intended to be used in programs
482 "copyright" "credits" "exit" "license" "quit")
483 symbol-end
) . font-lock-constant-face
)
485 (,(rx line-start
(* (any " \t")) (group "@" (1+ (or word ?_
))
486 (0+ "." (1+ (or word ?_
)))))
487 (1 font-lock-type-face
))
488 ;; Builtin Exceptions
491 "ArithmeticError" "AssertionError" "AttributeError" "BaseException"
492 "DeprecationWarning" "EOFError" "EnvironmentError" "Exception"
493 "FloatingPointError" "FutureWarning" "GeneratorExit" "IOError"
494 "ImportError" "ImportWarning" "IndexError" "KeyError"
495 "KeyboardInterrupt" "LookupError" "MemoryError" "NameError"
496 "NotImplementedError" "OSError" "OverflowError"
497 "PendingDeprecationWarning" "ReferenceError" "RuntimeError"
498 "RuntimeWarning" "StopIteration" "SyntaxError" "SyntaxWarning"
499 "SystemError" "SystemExit" "TypeError" "UnboundLocalError"
500 "UnicodeDecodeError" "UnicodeEncodeError" "UnicodeError"
501 "UnicodeTranslateError" "UnicodeWarning" "UserWarning" "VMSError"
502 "ValueError" "Warning" "WindowsError" "ZeroDivisionError"
506 "BufferError" "BytesWarning" "IndentationError" "ResourceWarning"
508 symbol-end
) . font-lock-type-face
)
512 "abs" "all" "any" "bin" "bool" "callable" "chr" "classmethod"
513 "compile" "complex" "delattr" "dict" "dir" "divmod" "enumerate"
514 "eval" "filter" "float" "format" "frozenset" "getattr" "globals"
515 "hasattr" "hash" "help" "hex" "id" "input" "int" "isinstance"
516 "issubclass" "iter" "len" "list" "locals" "map" "max" "memoryview"
517 "min" "next" "object" "oct" "open" "ord" "pow" "print" "property"
518 "range" "repr" "reversed" "round" "set" "setattr" "slice" "sorted"
519 "staticmethod" "str" "sum" "super" "tuple" "type" "vars" "zip"
522 "basestring" "cmp" "execfile" "file" "long" "raw_input" "reduce"
523 "reload" "unichr" "unicode" "xrange" "apply" "buffer" "coerce"
526 "ascii" "bytearray" "bytes" "exec"
528 "__all__" "__doc__" "__name__" "__package__")
529 symbol-end
) . font-lock-builtin-face
)
531 ;; support for a = b = c = 5
533 (let ((re (python-rx (group (+ (any word ?. ?_
)))
534 (? ?\
[ (+ (not (any ?\
]))) ?\
]) (* space
)
535 assignment-operator
))
537 (while (and (setq res
(re-search-forward re limit t
))
538 (or (python-syntax-context 'paren
)
539 (equal (char-after (point-marker)) ?
=))))
541 (1 font-lock-variable-name-face nil nil
))
542 ;; support for a, b, c = (1, 2, 3)
544 (let ((re (python-rx (group (+ (any word ?. ?_
))) (* space
)
545 (* ?
, (* space
) (+ (any word ?. ?_
)) (* space
))
546 ?
, (* space
) (+ (any word ?. ?_
)) (* space
)
547 assignment-operator
))
549 (while (and (setq res
(re-search-forward re limit t
))
550 (goto-char (match-end 1))
551 (python-syntax-context 'paren
)))
553 (1 font-lock-variable-name-face nil nil
))))
555 (defconst python-syntax-propertize-function
556 (syntax-propertize-rules
557 ((python-rx string-delimiter
)
558 (0 (ignore (python-syntax-stringify))))))
560 (defsubst python-syntax-count-quotes
(quote-char &optional point limit
)
561 "Count number of quotes around point (max is 3).
562 QUOTE-CHAR is the quote char to count. Optional argument POINT is
563 the point where scan starts (defaults to current point), and LIMIT
564 is used to limit the scan."
567 (or (not limit
) (< (+ point i
) limit
))
568 (eq (char-after (+ point i
)) quote-char
))
572 (defun python-syntax-stringify ()
573 "Put `syntax-table' property correctly on single/triple quotes."
574 (let* ((num-quotes (length (match-string-no-properties 1)))
576 (backward-char num-quotes
)
578 (forward-char num-quotes
)))
579 (string-start (and (not (nth 4 ppss
)) (nth 8 ppss
)))
580 (quote-starting-pos (- (point) num-quotes
))
581 (quote-ending-pos (point))
584 (python-syntax-count-quotes
585 (char-before) string-start quote-starting-pos
))))
586 (cond ((and string-start
(= num-closing-quotes
0))
587 ;; This set of quotes doesn't match the string starting
591 ;; This set of quotes delimit the start of a string.
592 (put-text-property quote-starting-pos
(1+ quote-starting-pos
)
593 'syntax-table
(string-to-syntax "|")))
594 ((= num-quotes num-closing-quotes
)
595 ;; This set of quotes delimit the end of a string.
596 (put-text-property (1- quote-ending-pos
) quote-ending-pos
597 'syntax-table
(string-to-syntax "|")))
598 ((> num-quotes num-closing-quotes
)
599 ;; This may only happen whenever a triple quote is closing
600 ;; a single quoted string. Add string delimiter syntax to
602 (put-text-property quote-starting-pos quote-ending-pos
603 'syntax-table
(string-to-syntax "|"))))))
605 (defvar python-mode-syntax-table
606 (let ((table (make-syntax-table)))
607 ;; Give punctuation syntax to ASCII that normally has symbol
608 ;; syntax or has word syntax and isn't a letter.
609 (let ((symbol (string-to-syntax "_"))
610 (sst (standard-syntax-table)))
613 (if (equal symbol
(aref sst i
))
614 (modify-syntax-entry i
"." table
)))))
615 (modify-syntax-entry ?$
"." table
)
616 (modify-syntax-entry ?%
"." table
)
618 (modify-syntax-entry ?
# "<" table
)
619 (modify-syntax-entry ?
\n ">" table
)
620 (modify-syntax-entry ?
' "\"" table
)
621 (modify-syntax-entry ?
` "$" table
)
623 "Syntax table for Python files.")
625 (defvar python-dotty-syntax-table
626 (let ((table (make-syntax-table python-mode-syntax-table
)))
627 (modify-syntax-entry ?.
"w" table
)
628 (modify-syntax-entry ?_
"w" table
)
630 "Dotty syntax table for Python files.
631 It makes underscores and dots word constituent chars.")
636 (defcustom python-indent-offset
4
637 "Default indentation offset for Python."
642 (defcustom python-indent-guess-indent-offset t
643 "Non-nil tells Python mode to guess `python-indent-offset' value."
648 (defcustom python-indent-trigger-commands
649 '(indent-for-tab-command yas-expand yas
/expand
)
650 "Commands that might trigger a `python-indent-line' call."
651 :type
'(repeat symbol
)
654 (define-obsolete-variable-alias
655 'python-indent
'python-indent-offset
"24.3")
657 (define-obsolete-variable-alias
658 'python-guess-indent
'python-indent-guess-indent-offset
"24.3")
660 (defvar python-indent-current-level
0
661 "Current indentation level `python-indent-line-function' is using.")
663 (defvar python-indent-levels
'(0)
664 "Levels of indentation available for `python-indent-line-function'.")
666 (defun python-indent-guess-indent-offset ()
667 "Guess and set `python-indent-offset' for the current buffer."
672 (goto-char (point-min))
674 (while (and (not block-end
)
676 (python-rx line-start block-start
) nil t
))
678 (not (python-syntax-context-type))
680 (goto-char (line-end-position))
681 (python-util-forward-comment -
1)
682 (if (equal (char-before) ?
:)
685 (when (python-info-block-continuation-line-p)
686 (while (and (python-info-continuation-line-p)
689 (python-util-forward-comment -
1)
690 (when (equal (char-before) ?
:)
692 (setq block-end
(point-marker))))
695 (goto-char block-end
)
696 (python-util-forward-comment)
697 (current-indentation))))
698 (if (and indentation
(not (zerop indentation
)))
699 (set (make-local-variable 'python-indent-offset
) indentation
)
700 (message "Can't guess python-indent-offset, using defaults: %s"
701 python-indent-offset
)))))))
703 (defun python-indent-context ()
704 "Get information on indentation context.
705 Context information is returned with a cons with the form:
708 Where status can be any of the following symbols:
710 * after-comment: When current line might continue a comment block
711 * inside-paren: If point in between (), {} or []
712 * inside-string: If point is inside a string
713 * after-backslash: Previous line ends in a backslash
714 * after-beginning-of-block: Point is after beginning of block
715 * after-line: Point is after normal line
716 * dedenter-statement: Point is on a dedenter statement.
717 * no-indent: Point is at beginning of buffer or other special case
718 START is the buffer position where the sexp starts."
721 (let ((ppss (save-excursion (beginning-of-line) (syntax-ppss)))
725 ;; Beginning of buffer
727 (goto-char (line-beginning-position))
730 ;; Comment continuation
734 (python-info-current-line-comment-p)
735 (python-info-current-line-empty-p))
738 (python-info-current-line-comment-p)))
742 ((setq start
(python-syntax-context 'string ppss
))
745 ((setq start
(python-syntax-context 'paren ppss
))
748 ((setq start
(when (not (or (python-syntax-context 'string ppss
)
749 (python-syntax-context 'comment ppss
)))
750 (let ((line-beg-pos (line-number-at-pos)))
751 (python-info-line-ends-backslash-p
752 (1- line-beg-pos
)))))
754 ;; After beginning of block
755 ((setq start
(save-excursion
757 (back-to-indentation)
758 (python-util-forward-comment -
1)
759 (equal (char-before) ?
:))
760 ;; Move to the first block start that's not in within
761 ;; a string, comment or paren and that's not a
762 ;; continuation line.
763 (while (and (re-search-backward
764 (python-rx block-start
) nil t
)
766 (python-syntax-context-type)
767 (python-info-continuation-line-p))))
768 (when (looking-at (python-rx block-start
))
770 'after-beginning-of-block
)
771 ((when (setq start
(python-info-dedenter-statement-p))
772 'dedenter-statement
))
774 ((setq start
(save-excursion
775 (back-to-indentation)
776 (skip-chars-backward (rx (or whitespace ?
\n)))
777 (python-nav-beginning-of-statement)
784 (defun python-indent-calculate-indentation ()
785 "Calculate correct indentation offset for the current line."
786 (let* ((indentation-context (python-indent-context))
787 (context-status (car indentation-context
))
788 (context-start (cdr indentation-context
)))
792 (pcase context-status
795 (goto-char context-start
)
796 (current-indentation))
797 ;; When point is after beginning of block just add one level
798 ;; of indentation relative to the context-start
799 (`after-beginning-of-block
800 (goto-char context-start
)
801 (+ (current-indentation) python-indent-offset
))
802 ;; When after a simple line just use previous line
805 (let* ((pair (save-excursion
806 (goto-char context-start
)
808 (current-indentation)
809 (python-info-beginning-of-block-p))))
810 (context-indentation (car pair
))
811 ;; TODO: Separate block enders into its own case.
814 (python-util-forward-comment -
1)
815 (python-nav-beginning-of-statement)
816 (looking-at (python-rx block-ender
)))
819 (- context-indentation adjustment
)))
820 ;; When point is on a dedenter statement, search for the
821 ;; opening block that corresponds to it and use its
822 ;; indentation. If no opening block is found just remove
823 ;; indentation as this is an invalid python file.
825 (let ((block-start-point
826 (python-info-dedenter-opening-block-position)))
828 (if (not block-start-point
)
830 (goto-char block-start-point
)
831 (current-indentation)))))
832 ;; When inside of a string, do nothing. just use the current
833 ;; indentation. XXX: perhaps it would be a good idea to
834 ;; invoke standard text indentation here
836 (goto-char context-start
)
837 (current-indentation))
838 ;; After backslash we have several possibilities.
841 ;; Check if current line is a dot continuation. For this
842 ;; the current line must start with a dot and previous
843 ;; line must contain a dot too.
845 (back-to-indentation)
846 (when (looking-at "\\.")
847 ;; If after moving one line back point is inside a paren it
848 ;; needs to move back until it's not anymore
852 (python-syntax-context 'paren
))))
853 (goto-char (line-end-position))
854 (while (and (re-search-backward
855 "\\." (line-beginning-position) t
)
856 (python-syntax-context-type)))
857 (if (and (looking-at "\\.")
858 (not (python-syntax-context-type)))
859 ;; The indentation is the same column of the
860 ;; first matching dot that's not inside a
861 ;; comment, a string or a paren
863 ;; No dot found on previous line, just add another
864 ;; indentation level.
865 (+ (current-indentation) python-indent-offset
)))))
866 ;; Check if prev line is a block continuation
867 ((let ((block-continuation-start
868 (python-info-block-continuation-line-p)))
869 (when block-continuation-start
870 ;; If block-continuation-start is set jump to that
871 ;; marker and use first column after the block start
872 ;; as indentation value.
873 (goto-char block-continuation-start
)
875 (python-rx block-start
(* space
))
876 (line-end-position) t
)
878 ;; Check if current line is an assignment continuation
879 ((let ((assignment-continuation-start
880 (python-info-assignment-continuation-line-p)))
881 (when assignment-continuation-start
882 ;; If assignment-continuation is set jump to that
883 ;; marker and use first column after the assignment
884 ;; operator as indentation value.
885 (goto-char assignment-continuation-start
)
889 (goto-char (python-info-beginning-of-backslash))
894 (or (python-info-beginning-of-backslash) (point)))
895 (python-info-line-ends-backslash-p)))
896 ;; The two previous lines ended in a backslash so we must
897 ;; respect previous line indentation.
898 (current-indentation)
899 ;; What happens here is that we are dealing with the second
900 ;; line of a backslash continuation, in that case we just going
901 ;; to add one indentation level.
902 (+ (current-indentation) python-indent-offset
)))))
903 ;; When inside a paren there's a need to handle nesting
907 ;; If current line closes the outermost open paren use the
908 ;; current indentation of the context-start line.
910 (skip-syntax-forward "\s" (line-end-position))
911 (when (and (looking-at (regexp-opt '(")" "]" "}")))
914 (not (python-syntax-context 'paren
))))
915 (goto-char context-start
)
916 (current-indentation))))
917 ;; If open paren is contained on a line by itself add another
918 ;; indentation level, else look for the first word after the
919 ;; opening paren and use it's column position as indentation
921 ((let* ((content-starts-in-newline)
924 (if (setq content-starts-in-newline
926 (goto-char context-start
)
930 (line-beginning-position)
932 (python-util-forward-comment))
934 (+ (current-indentation) python-indent-offset
)
938 ;; If current line closes a nested open paren de-indent one
941 (back-to-indentation)
942 (looking-at (regexp-opt '(")" "]" "}"))))
943 (- indent python-indent-offset
))
944 ;; If the line of the opening paren that wraps the current
945 ;; line starts a block add another level of indentation to
946 ;; follow new pep8 recommendation. See: http://ur1.ca/5rojx
948 (when (and content-starts-in-newline
950 (goto-char context-start
)
951 (back-to-indentation)
952 (looking-at (python-rx block-start
))))
953 (+ indent python-indent-offset
))))
956 (defun python-indent-calculate-levels ()
957 "Calculate `python-indent-levels' and reset `python-indent-current-level'."
958 (if (not (python-info-dedenter-statement-p))
959 (let* ((indentation (python-indent-calculate-indentation))
960 (remainder (% indentation python-indent-offset
))
961 (steps (/ (- indentation remainder
) python-indent-offset
)))
962 (setq python-indent-levels
(list 0))
963 (dotimes (step steps
)
964 (push (* python-indent-offset
(1+ step
)) python-indent-levels
))
965 (when (not (eq 0 remainder
))
966 (push (+ (* python-indent-offset steps
) remainder
) python-indent-levels
)))
967 (setq python-indent-levels
969 (mapcar (lambda (pos)
972 (current-indentation)))
973 (python-info-dedenter-opening-block-positions))
975 (setq python-indent-current-level
(1- (length python-indent-levels
))
976 python-indent-levels
(nreverse python-indent-levels
)))
978 (defun python-indent-toggle-levels ()
979 "Toggle `python-indent-current-level' over `python-indent-levels'."
980 (setq python-indent-current-level
(1- python-indent-current-level
))
981 (when (< python-indent-current-level
0)
982 (setq python-indent-current-level
(1- (length python-indent-levels
)))))
984 (defun python-indent-line (&optional force-toggle
)
985 "Internal implementation of `python-indent-line-function'.
986 Uses the offset calculated in
987 `python-indent-calculate-indentation' and available levels
988 indicated by the variable `python-indent-levels' to set the
991 When the variable `last-command' is equal to one of the symbols
992 inside `python-indent-trigger-commands' or FORCE-TOGGLE is
993 non-nil it cycles levels indicated in the variable
994 `python-indent-levels' by setting the current level in the
995 variable `python-indent-current-level'.
997 When the variable `last-command' is not equal to one of the
998 symbols inside `python-indent-trigger-commands' and FORCE-TOGGLE
999 is nil it calculates possible indentation levels and saves them
1000 in the variable `python-indent-levels'. Afterwards it sets the
1001 variable `python-indent-current-level' correctly so offset is
1003 (nth python-indent-current-level python-indent-levels)"
1005 (and (or (and (memq this-command python-indent-trigger-commands
)
1006 (eq last-command this-command
))
1008 (not (equal python-indent-levels
'(0)))
1009 (or (python-indent-toggle-levels) t
))
1010 (python-indent-calculate-levels))
1011 (let* ((starting-pos (point-marker))
1012 (indent-ending-position
1013 (+ (line-beginning-position) (current-indentation)))
1014 (follow-indentation-p
1016 (and (<= (line-beginning-position) starting-pos
)
1017 (>= indent-ending-position starting-pos
))))
1018 (next-indent (nth python-indent-current-level python-indent-levels
)))
1019 (unless (= next-indent
(current-indentation))
1021 (delete-horizontal-space)
1022 (indent-to next-indent
)
1023 (goto-char starting-pos
))
1024 (and follow-indentation-p
(back-to-indentation)))
1025 (python-info-dedenter-opening-block-message))
1027 (defun python-indent-line-function ()
1028 "`indent-line-function' for Python mode.
1029 See `python-indent-line' for details."
1030 (python-indent-line))
1032 (defun python-indent-dedent-line ()
1033 "De-indent current line."
1035 (when (and (not (python-syntax-comment-or-string-p))
1036 (<= (point-marker) (save-excursion
1037 (back-to-indentation)
1039 (> (current-column) 0))
1040 (python-indent-line t
)
1043 (defun python-indent-dedent-line-backspace (arg)
1044 "De-indent current line.
1045 Argument ARG is passed to `backward-delete-char-untabify' when
1046 point is not in between the indentation."
1048 (when (not (python-indent-dedent-line))
1049 (backward-delete-char-untabify arg
)))
1050 (put 'python-indent-dedent-line-backspace
'delete-selection
'supersede
)
1052 (defun python-indent-region (start end
)
1053 "Indent a Python region automagically.
1055 Called from a program, START and END specify the region to indent."
1056 (let ((deactivate-mark nil
))
1059 (setq end
(point-marker))
1061 (or (bolp) (forward-line 1))
1062 (while (< (point) end
)
1063 (or (and (bolp) (eolp))
1066 (back-to-indentation)
1067 (setq word
(current-word))
1070 ;; Don't mess with strings, unless it's the
1071 ;; enclosing set of quotes.
1072 (or (not (python-syntax-context 'string
))
1076 (current-indentation)
1077 (python-syntax-count-quotes (char-after) (point))))
1078 (string-to-syntax "|"))))
1080 (delete-horizontal-space)
1081 (indent-to (python-indent-calculate-indentation)))))
1083 (move-marker end nil
))))
1085 (defun python-indent-shift-left (start end
&optional count
)
1086 "Shift lines contained in region START END by COUNT columns to the left.
1087 COUNT defaults to `python-indent-offset'. If region isn't
1088 active, the current line is shifted. The shifted region includes
1089 the lines in which START and END lie. An error is signaled if
1090 any lines in the region are indented less than COUNT columns."
1093 (list (region-beginning) (region-end) current-prefix-arg
)
1094 (list (line-beginning-position) (line-end-position) current-prefix-arg
)))
1096 (setq count
(prefix-numeric-value count
))
1097 (setq count python-indent-offset
))
1099 (let ((deactivate-mark nil
))
1102 (while (< (point) end
)
1103 (if (and (< (current-indentation) count
)
1104 (not (looking-at "[ \t]*$")))
1105 (error "Can't shift all lines enough"))
1107 (indent-rigidly start end
(- count
))))))
1109 (add-to-list 'debug-ignored-errors
"^Can't shift all lines enough")
1111 (defun python-indent-shift-right (start end
&optional count
)
1112 "Shift lines contained in region START END by COUNT columns to the right.
1113 COUNT defaults to `python-indent-offset'. If region isn't
1114 active, the current line is shifted. The shifted region includes
1115 the lines in which START and END lie."
1118 (list (region-beginning) (region-end) current-prefix-arg
)
1119 (list (line-beginning-position) (line-end-position) current-prefix-arg
)))
1120 (let ((deactivate-mark nil
))
1121 (setq count
(if count
(prefix-numeric-value count
)
1122 python-indent-offset
))
1123 (indent-rigidly start end count
)))
1125 (defun python-indent-post-self-insert-function ()
1126 "Adjust indentation after insertion of some characters.
1127 This function is intended to be added to `post-self-insert-hook.'
1128 If a line renders a paren alone, after adding a char before it,
1129 the line will be re-indented automatically if needed."
1130 (when (and electric-indent-mode
1131 (eq (char-before) last-command-event
))
1133 ;; Electric indent inside parens
1136 (let ((paren-start (python-syntax-context 'paren
)))
1137 ;; Check that point is inside parens.
1140 ;; Filter the case where input is happening in the same
1141 ;; line where the open paren is.
1142 (= (line-number-at-pos)
1143 (line-number-at-pos paren-start
)))))
1144 ;; When content has been added before the closing paren or a
1145 ;; comma has been inserted, it's ok to do the trick.
1147 (memq (char-after) '(?\
) ?\
] ?\
}))
1148 (eq (char-before) ?
,)))
1150 (goto-char (line-beginning-position))
1151 (let ((indentation (python-indent-calculate-indentation)))
1152 (when (< (current-indentation) indentation
)
1153 (indent-line-to indentation
)))))
1155 ((and (eq ?
: last-command-event
)
1156 (memq ?
: electric-indent-chars
)
1157 (not current-prefix-arg
)
1158 ;; Trigger electric colon only at end of line
1160 ;; Avoid re-indenting on extra colon
1161 (not (equal ?
: (char-before (1- (point)))))
1162 (not (python-syntax-comment-or-string-p))
1163 ;; Never re-indent at beginning of defun
1164 (not (save-excursion
1165 (python-nav-beginning-of-statement)
1166 (python-info-looking-at-beginning-of-defun))))
1167 (python-indent-line)))))
1172 (defvar python-nav-beginning-of-defun-regexp
1173 (python-rx line-start
(* space
) defun
(+ space
) (group symbol-name
))
1174 "Regexp matching class or function definition.
1175 The name of the defun should be grouped so it can be retrieved
1176 via `match-string'.")
1178 (defun python-nav--beginning-of-defun (&optional arg
)
1179 "Internal implementation of `python-nav-beginning-of-defun'.
1180 With positive ARG search backwards, else search forwards."
1181 (when (or (null arg
) (= arg
0)) (setq arg
1))
1182 (let* ((re-search-fn (if (> arg
0)
1183 #'re-search-backward
1184 #'re-search-forward
))
1185 (line-beg-pos (line-beginning-position))
1186 (line-content-start (+ line-beg-pos
(current-indentation)))
1187 (pos (point-marker))
1192 (not (python-info-looking-at-beginning-of-defun))
1193 (python-nav-backward-block)))
1194 (or (and (python-info-looking-at-beginning-of-defun)
1195 (+ (current-indentation) python-indent-offset
))
1199 (when (and (< arg
0)
1200 (python-info-looking-at-beginning-of-defun))
1202 (while (and (funcall re-search-fn
1203 python-nav-beginning-of-defun-regexp nil t
)
1204 (or (python-syntax-context-type)
1205 ;; Handle nested defuns when moving
1206 ;; backwards by checking indentation.
1208 (not (= (current-indentation) 0))
1209 (>= (current-indentation) beg-indentation
)))))
1210 (and (python-info-looking-at-beginning-of-defun)
1211 (or (not (= (line-number-at-pos pos
)
1212 (line-number-at-pos)))
1213 (and (>= (point) line-beg-pos
)
1214 (<= (point) line-content-start
)
1215 (> pos line-content-start
)))))))
1217 (or (beginning-of-line 1) t
)
1218 (and (goto-char pos
) nil
))))
1220 (defun python-nav-beginning-of-defun (&optional arg
)
1221 "Move point to `beginning-of-defun'.
1222 With positive ARG search backwards else search forward.
1223 ARG nil or 0 defaults to 1. When searching backwards,
1224 nested defuns are handled with care depending on current
1225 point position. Return non-nil if point is moved to
1226 `beginning-of-defun'."
1227 (when (or (null arg
) (= arg
0)) (setq arg
1))
1229 (while (and (not (= arg
0))
1230 (let ((keep-searching-p
1231 (python-nav--beginning-of-defun arg)))
1232 (when (and keep-searching-p
(null found
))
1235 (setq arg
(if (> arg
0) (1- arg
) (1+ arg
))))
1238 (defun python-nav-end-of-defun ()
1239 "Move point to the end of def or class.
1240 Returns nil if point is not in a def or class."
1242 (let ((beg-defun-indent)
1244 (when (or (python-info-looking-at-beginning-of-defun)
1245 (python-nav-beginning-of-defun 1)
1246 (python-nav-beginning-of-defun -1))
1247 (setq beg-defun-indent
(current-indentation))
1249 (python-nav-end-of-statement)
1250 (python-util-forward-comment 1)
1251 (and (> (current-indentation) beg-defun-indent
)
1253 (python-util-forward-comment -
1)
1255 ;; Ensure point moves forward.
1256 (and (> beg-pos
(point)) (goto-char beg-pos
)))))
1258 (defun python-nav--syntactically (fn poscompfn
&optional contextfn
)
1259 "Move point using FN avoiding places with specific context.
1260 FN must take no arguments. POSCOMPFN is a two arguments function
1261 used to compare current and previous point after it is moved
1262 using FN, this is normally a less-than or greater-than
1263 comparison. Optional argument CONTEXTFN defaults to
1264 `python-syntax-context-type' and is used for checking current
1265 point context, it must return a non-nil value if this point must
1267 (let ((contextfn (or contextfn
'python-syntax-context-type
))
1268 (start-pos (point-marker))
1273 (and (funcall fn
) (point-marker)))
1274 (context (funcall contextfn
)))
1275 (cond ((and (not context
) newpos
1276 (or (and (not prev-pos
) newpos
)
1277 (and prev-pos newpos
1278 (funcall poscompfn newpos prev-pos
))))
1279 (throw 'found
(point-marker)))
1280 ((and newpos context
)
1281 (setq prev-pos
(point)))
1282 (t (when (not newpos
) (goto-char start-pos
))
1283 (throw 'found nil
))))))))
1285 (defun python-nav--forward-defun (arg)
1286 "Internal implementation of python-nav-{backward,forward}-defun.
1287 Uses ARG to define which function to call, and how many times
1290 (while (and (> arg
0)
1292 (python-nav--syntactically
1295 python-nav-beginning-of-defun-regexp nil t
))
1297 (setq arg
(1- arg
)))
1298 (while (and (< arg
0)
1300 (python-nav--syntactically
1303 python-nav-beginning-of-defun-regexp nil t
))
1305 (setq arg
(1+ arg
)))
1308 (defun python-nav-backward-defun (&optional arg
)
1309 "Navigate to closer defun backward ARG times.
1310 Unlikely `python-nav-beginning-of-defun' this doesn't care about
1311 nested definitions."
1313 (python-nav--forward-defun (- (or arg
1))))
1315 (defun python-nav-forward-defun (&optional arg
)
1316 "Navigate to closer defun forward ARG times.
1317 Unlikely `python-nav-beginning-of-defun' this doesn't care about
1318 nested definitions."
1320 (python-nav--forward-defun (or arg
1)))
1322 (defun python-nav-beginning-of-statement ()
1323 "Move to start of current statement."
1325 (back-to-indentation)
1326 (let* ((ppss (syntax-ppss))
1329 (python-syntax-context 'paren ppss
)
1330 (python-syntax-context 'string ppss
))))
1333 (goto-char context-point
)
1334 (python-nav-beginning-of-statement))
1337 (python-info-line-ends-backslash-p))
1339 (python-nav-beginning-of-statement))))
1342 (defun python-nav-end-of-statement (&optional noend
)
1343 "Move to end of current statement.
1344 Optional argument NOEND is internal and makes the logic to not
1345 jump to the end of line when moving forward searching for the end
1348 (let (string-start bs-pos
)
1349 (while (and (or noend
(goto-char (line-end-position)))
1351 (cond ((setq string-start
(python-syntax-context 'string
))
1352 (goto-char string-start
)
1353 (if (python-syntax-context 'paren
)
1354 ;; Ended up inside a paren, roll again.
1355 (python-nav-end-of-statement t
)
1356 ;; This is not inside a paren, move to the
1357 ;; end of this string.
1358 (goto-char (+ (point)
1359 (python-syntax-count-quotes
1360 (char-after (point)) (point))))
1361 (or (re-search-forward (rx (syntax string-delimiter
)) nil t
)
1362 (goto-char (point-max)))))
1363 ((python-syntax-context 'paren
)
1364 ;; The statement won't end before we've escaped
1365 ;; at least one level of parenthesis.
1367 (goto-char (scan-lists (point) 1 -
1))
1368 (scan-error (goto-char (nth 3 err
)))))
1369 ((setq bs-pos
(python-info-line-ends-backslash-p))
1371 (forward-line 1))))))
1374 (defun python-nav-backward-statement (&optional arg
)
1375 "Move backward to previous statement.
1376 With ARG, repeat. See `python-nav-forward-statement'."
1378 (or arg
(setq arg
1))
1379 (python-nav-forward-statement (- arg
)))
1381 (defun python-nav-forward-statement (&optional arg
)
1382 "Move forward to next statement.
1383 With ARG, repeat. With negative argument, move ARG times
1384 backward to previous statement."
1386 (or arg
(setq arg
1))
1388 (python-nav-end-of-statement)
1389 (python-util-forward-comment)
1390 (python-nav-beginning-of-statement)
1391 (setq arg
(1- arg
)))
1393 (python-nav-beginning-of-statement)
1394 (python-util-forward-comment -
1)
1395 (python-nav-beginning-of-statement)
1396 (setq arg
(1+ arg
))))
1398 (defun python-nav-beginning-of-block ()
1399 "Move to start of current block."
1401 (let ((starting-pos (point)))
1403 (python-nav-beginning-of-statement)
1404 (looking-at (python-rx block-start
)))
1406 ;; Go to first line beginning a statement
1407 (while (and (not (bobp))
1408 (or (and (python-nav-beginning-of-statement) nil
)
1409 (python-info-current-line-comment-p)
1410 (python-info-current-line-empty-p)))
1412 (let ((block-matching-indent
1413 (- (current-indentation) python-indent-offset
)))
1415 (and (python-nav-backward-block)
1416 (> (current-indentation) block-matching-indent
)))
1417 (if (and (looking-at (python-rx block-start
))
1418 (= (current-indentation) block-matching-indent
))
1420 (and (goto-char starting-pos
) nil
))))))
1422 (defun python-nav-end-of-block ()
1423 "Move to end of current block."
1425 (when (python-nav-beginning-of-block)
1426 (let ((block-indentation (current-indentation)))
1427 (python-nav-end-of-statement)
1428 (while (and (forward-line 1)
1430 (or (and (> (current-indentation) block-indentation
)
1431 (or (python-nav-end-of-statement) t
))
1432 (python-info-current-line-comment-p)
1433 (python-info-current-line-empty-p))))
1434 (python-util-forward-comment -
1)
1437 (defun python-nav-backward-block (&optional arg
)
1438 "Move backward to previous block of code.
1439 With ARG, repeat. See `python-nav-forward-block'."
1441 (or arg
(setq arg
1))
1442 (python-nav-forward-block (- arg
)))
1444 (defun python-nav-forward-block (&optional arg
)
1445 "Move forward to next block of code.
1446 With ARG, repeat. With negative argument, move ARG times
1447 backward to previous block."
1449 (or arg
(setq arg
1))
1450 (let ((block-start-regexp
1451 (python-rx line-start
(* whitespace
) block-start
))
1452 (starting-pos (point)))
1454 (python-nav-end-of-statement)
1456 (re-search-forward block-start-regexp nil t
)
1457 (python-syntax-context-type)))
1458 (setq arg
(1- arg
)))
1460 (python-nav-beginning-of-statement)
1462 (re-search-backward block-start-regexp nil t
)
1463 (python-syntax-context-type)))
1464 (setq arg
(1+ arg
)))
1465 (python-nav-beginning-of-statement)
1466 (if (not (looking-at (python-rx block-start
)))
1467 (and (goto-char starting-pos
) nil
)
1468 (and (not (= (point) starting-pos
)) (point-marker)))))
1470 (defun python-nav--lisp-forward-sexp (&optional arg
)
1471 "Standard version `forward-sexp'.
1472 It ignores completely the value of `forward-sexp-function' by
1473 setting it to nil before calling `forward-sexp'. With positive
1474 ARG move forward only one sexp, else move backwards."
1475 (let ((forward-sexp-function)
1476 (arg (if (or (not arg
) (> arg
0)) 1 -
1)))
1477 (forward-sexp arg
)))
1479 (defun python-nav--lisp-forward-sexp-safe (&optional arg
)
1480 "Safe version of standard `forward-sexp'.
1481 When at end of sexp (i.e. looking at a opening/closing paren)
1482 skips it instead of throwing an error. With positive ARG move
1483 forward only one sexp, else move backwards."
1484 (let* ((arg (if (or (not arg
) (> arg
0)) 1 -
1))
1486 (if (> arg
0) (python-rx close-paren
) (python-rx open-paren
)))
1488 (if (> arg
0) #'re-search-forward
#'re-search-backward
)))
1490 (python-nav--lisp-forward-sexp arg
)
1492 (while (and (funcall search-fn paren-regexp nil t
)
1493 (python-syntax-context 'paren
)))))))
1495 (defun python-nav--forward-sexp (&optional dir safe
)
1496 "Move to forward sexp.
1497 With positive optional argument DIR direction move forward, else
1498 backwards. When optional argument SAFE is non-nil do not throw
1499 errors when at end of sexp, skip it instead."
1500 (setq dir
(or dir
1))
1502 (let* ((forward-p (if (> dir
0)
1503 (and (setq dir
1) t
)
1504 (and (setq dir -
1) nil
)))
1505 (context-type (python-syntax-context-type)))
1507 ((memq context-type
'(string comment
))
1508 ;; Inside of a string, get out of it.
1509 (let ((forward-sexp-function))
1510 (forward-sexp dir
)))
1511 ((or (eq context-type
'paren
)
1512 (and forward-p
(looking-at (python-rx open-paren
)))
1513 (and (not forward-p
)
1514 (eq (syntax-class (syntax-after (1- (point))))
1515 (car (string-to-syntax ")")))))
1516 ;; Inside a paren or looking at it, lisp knows what to do.
1518 (python-nav--lisp-forward-sexp-safe dir
)
1519 (python-nav--lisp-forward-sexp dir
)))
1521 ;; This part handles the lispy feel of
1522 ;; `python-nav-forward-sexp'. Knowing everything about the
1523 ;; current context and the context of the next sexp tries to
1524 ;; follow the lisp sexp motion commands in a symmetric manner.
1527 ((python-info-beginning-of-block-p) 'block-start
)
1528 ((python-info-end-of-block-p) 'block-end
)
1529 ((python-info-beginning-of-statement-p) 'statement-start
)
1530 ((python-info-end-of-statement-p) 'statement-end
)))
1534 (python-nav--lisp-forward-sexp-safe dir
)
1535 (python-nav--lisp-forward-sexp dir
))
1539 (goto-char next-sexp-pos
)
1541 ((python-info-beginning-of-block-p) 'block-start
)
1542 ((python-info-end-of-block-p) 'block-end
)
1543 ((python-info-beginning-of-statement-p) 'statement-start
)
1544 ((python-info-end-of-statement-p) 'statement-end
)
1545 ((python-info-statement-starts-block-p) 'starts-block
)
1546 ((python-info-statement-ends-block-p) 'ends-block
)))))
1548 (cond ((and (not (eobp))
1549 (python-info-current-line-empty-p))
1550 (python-util-forward-comment dir
)
1551 (python-nav--forward-sexp dir
))
1552 ((eq context
'block-start
)
1553 (python-nav-end-of-block))
1554 ((eq context
'statement-start
)
1555 (python-nav-end-of-statement))
1556 ((and (memq context
'(statement-end block-end
))
1557 (eq next-sexp-context
'ends-block
))
1558 (goto-char next-sexp-pos
)
1559 (python-nav-end-of-block))
1560 ((and (memq context
'(statement-end block-end
))
1561 (eq next-sexp-context
'starts-block
))
1562 (goto-char next-sexp-pos
)
1563 (python-nav-end-of-block))
1564 ((memq context
'(statement-end block-end
))
1565 (goto-char next-sexp-pos
)
1566 (python-nav-end-of-statement))
1567 (t (goto-char next-sexp-pos
)))
1568 (cond ((and (not (bobp))
1569 (python-info-current-line-empty-p))
1570 (python-util-forward-comment dir
)
1571 (python-nav--forward-sexp dir
))
1572 ((eq context
'block-end
)
1573 (python-nav-beginning-of-block))
1574 ((eq context
'statement-end
)
1575 (python-nav-beginning-of-statement))
1576 ((and (memq context
'(statement-start block-start
))
1577 (eq next-sexp-context
'starts-block
))
1578 (goto-char next-sexp-pos
)
1579 (python-nav-beginning-of-block))
1580 ((and (memq context
'(statement-start block-start
))
1581 (eq next-sexp-context
'ends-block
))
1582 (goto-char next-sexp-pos
)
1583 (python-nav-beginning-of-block))
1584 ((memq context
'(statement-start block-start
))
1585 (goto-char next-sexp-pos
)
1586 (python-nav-beginning-of-statement))
1587 (t (goto-char next-sexp-pos
))))))))))
1589 (defun python-nav-forward-sexp (&optional arg
)
1590 "Move forward across expressions.
1591 With ARG, do it that many times. Negative arg -N means move
1594 (or arg
(setq arg
1))
1596 (python-nav--forward-sexp 1)
1597 (setq arg
(1- arg
)))
1599 (python-nav--forward-sexp -
1)
1600 (setq arg
(1+ arg
))))
1602 (defun python-nav-backward-sexp (&optional arg
)
1603 "Move backward across expressions.
1604 With ARG, do it that many times. Negative arg -N means move
1607 (or arg
(setq arg
1))
1608 (python-nav-forward-sexp (- arg
)))
1610 (defun python-nav-forward-sexp-safe (&optional arg
)
1611 "Move forward safely across expressions.
1612 With ARG, do it that many times. Negative arg -N means move
1615 (or arg
(setq arg
1))
1617 (python-nav--forward-sexp 1 t
)
1618 (setq arg
(1- arg
)))
1620 (python-nav--forward-sexp -
1 t
)
1621 (setq arg
(1+ arg
))))
1623 (defun python-nav-backward-sexp-safe (&optional arg
)
1624 "Move backward safely across expressions.
1625 With ARG, do it that many times. Negative arg -N means move
1628 (or arg
(setq arg
1))
1629 (python-nav-forward-sexp-safe (- arg
)))
1631 (defun python-nav--up-list (&optional dir
)
1632 "Internal implementation of `python-nav-up-list'.
1633 DIR is always 1 or -1 and comes sanitized from
1634 `python-nav-up-list' calls."
1635 (let ((context (python-syntax-context-type))
1636 (forward-p (> dir
0)))
1638 ((memq context
'(string comment
)))
1639 ((eq context
'paren
)
1640 (let ((forward-sexp-function))
1642 ((and forward-p
(python-info-end-of-block-p))
1643 (let ((parent-end-pos
1645 (let ((indentation (and
1646 (python-nav-beginning-of-block)
1647 (current-indentation))))
1648 (while (and indentation
1650 (>= (current-indentation) indentation
)
1651 (python-nav-backward-block)))
1652 (python-nav-end-of-block)))))
1653 (and (> (or parent-end-pos
(point)) (point))
1654 (goto-char parent-end-pos
))))
1655 (forward-p (python-nav-end-of-block))
1656 ((and (not forward-p
)
1657 (> (current-indentation) 0)
1658 (python-info-beginning-of-block-p))
1659 (let ((prev-block-pos
1661 (let ((indentation (current-indentation)))
1662 (while (and (python-nav-backward-block)
1663 (>= (current-indentation) indentation
))))
1665 (and (> (point) prev-block-pos
)
1666 (goto-char prev-block-pos
))))
1667 ((not forward-p
) (python-nav-beginning-of-block)))))
1669 (defun python-nav-up-list (&optional arg
)
1670 "Move forward out of one level of parentheses (or blocks).
1671 With ARG, do this that many times.
1672 A negative argument means move backward but still to a less deep spot.
1673 This command assumes point is not in a string or comment."
1675 (or arg
(setq arg
1))
1677 (python-nav--up-list 1)
1678 (setq arg
(1- arg
)))
1680 (python-nav--up-list -
1)
1681 (setq arg
(1+ arg
))))
1683 (defun python-nav-backward-up-list (&optional arg
)
1684 "Move backward out of one level of parentheses (or blocks).
1685 With ARG, do this that many times.
1686 A negative argument means move forward but still to a less deep spot.
1687 This command assumes point is not in a string or comment."
1689 (or arg
(setq arg
1))
1690 (python-nav-up-list (- arg
)))
1692 (defun python-nav-if-name-main ()
1693 "Move point at the beginning the __main__ block.
1694 When \"if __name__ == '__main__':\" is found returns its
1695 position, else returns nil."
1697 (let ((point (point))
1698 (found (catch 'found
1699 (goto-char (point-min))
1700 (while (re-search-forward
1701 (python-rx line-start
1703 "__name__" (+ space
)
1705 (group-n 1 (or ?
\" ?
\'))
1706 "__main__" (backref 1) (* space
) ":")
1708 (when (not (python-syntax-context-type))
1710 (throw 'found t
))))))
1713 (ignore (goto-char point
)))))
1716 ;;; Shell integration
1718 (defcustom python-shell-buffer-name
"Python"
1719 "Default buffer name for Python interpreter."
1724 (defcustom python-shell-interpreter
"python"
1725 "Default Python interpreter for shell."
1729 (defcustom python-shell-internal-buffer-name
"Python Internal"
1730 "Default buffer name for the Internal Python interpreter."
1735 (defcustom python-shell-interpreter-args
"-i"
1736 "Default arguments for the Python interpreter."
1740 (defcustom python-shell-interpreter-interactive-arg
"-i"
1741 "Interpreter argument to force it to run interactively."
1745 (defcustom python-shell-prompt-detect-enabled t
1746 "Non-nil enables autodetection of interpreter prompts."
1751 (defcustom python-shell-prompt-detect-failure-warning t
1752 "Non-nil enables warnings when detection of prompts fail."
1757 (defcustom python-shell-prompt-input-regexps
1758 '(">>> " "\\.\\.\\. " ; Python
1759 "In \\[[0-9]+\\]: " ; IPython
1760 ;; Using ipdb outside IPython may fail to cleanup and leave static
1761 ;; IPython prompts activated, this adds some safeguard for that.
1762 "In : " "\\.\\.\\.: ")
1763 "List of regular expressions matching input prompts."
1764 :type
'(repeat string
)
1767 (defcustom python-shell-prompt-output-regexps
1769 "Out\\[[0-9]+\\]: " ; IPython
1770 "Out :") ; ipdb safeguard
1771 "List of regular expressions matching output prompts."
1772 :type
'(repeat string
)
1775 (defcustom python-shell-prompt-regexp
">>> "
1776 "Regular expression matching top level input prompt of Python shell.
1777 It should not contain a caret (^) at the beginning."
1780 (defcustom python-shell-prompt-block-regexp
"\\.\\.\\. "
1781 "Regular expression matching block input prompt of Python shell.
1782 It should not contain a caret (^) at the beginning."
1785 (defcustom python-shell-prompt-output-regexp
""
1786 "Regular expression matching output prompt of Python shell.
1787 It should not contain a caret (^) at the beginning."
1790 (defcustom python-shell-prompt-pdb-regexp
"[(<]*[Ii]?[Pp]db[>)]+ "
1791 "Regular expression matching pdb input prompt of Python shell.
1792 It should not contain a caret (^) at the beginning."
1795 (defcustom python-shell-enable-font-lock t
1796 "Should syntax highlighting be enabled in the Python shell buffer?
1797 Restart the Python shell after changing this variable for it to take effect."
1802 (defcustom python-shell-process-environment nil
1803 "List of environment variables for Python shell.
1804 This variable follows the same rules as `process-environment'
1805 since it merges with it before the process creation routines are
1806 called. When this variable is nil, the Python shell is run with
1807 the default `process-environment'."
1808 :type
'(repeat string
)
1812 (defcustom python-shell-extra-pythonpaths nil
1813 "List of extra pythonpaths for Python shell.
1814 The values of this variable are added to the existing value of
1815 PYTHONPATH in the `process-environment' variable."
1816 :type
'(repeat string
)
1820 (defcustom python-shell-exec-path nil
1821 "List of path to search for binaries.
1822 This variable follows the same rules as `exec-path' since it
1823 merges with it before the process creation routines are called.
1824 When this variable is nil, the Python shell is run with the
1825 default `exec-path'."
1826 :type
'(repeat string
)
1830 (defcustom python-shell-virtualenv-path nil
1831 "Path to virtualenv root.
1832 This variable, when set to a string, makes the values stored in
1833 `python-shell-process-environment' and `python-shell-exec-path'
1834 to be modified properly so shells are started with the specified
1836 :type
'(choice (const nil
) string
)
1840 (defcustom python-shell-setup-codes
'(python-shell-completion-setup-code
1841 python-ffap-setup-code
1842 python-eldoc-setup-code
)
1843 "List of code run by `python-shell-send-setup-codes'."
1844 :type
'(repeat symbol
)
1848 (defcustom python-shell-compilation-regexp-alist
1849 `((,(rx line-start
(1+ (any " \t")) "File \""
1850 (group (1+ (not (any "\"<")))) ; avoid `<stdin>' &c
1851 "\", line " (group (1+ digit
)))
1853 (,(rx " in file " (group (1+ not-newline
)) " on line "
1856 (,(rx line-start
"> " (group (1+ (not (any "(\"<"))))
1857 "(" (group (1+ digit
)) ")" (1+ (not (any "("))) "()")
1859 "`compilation-error-regexp-alist' for inferior Python."
1860 :type
'(alist string
)
1863 (defvar python-shell--prompt-calculated-input-regexp nil
1864 "Calculated input prompt regexp for inferior python shell.
1865 Do not set this variable directly, instead use
1866 `python-shell-prompt-set-calculated-regexps'.")
1868 (defvar python-shell--prompt-calculated-output-regexp nil
1869 "Calculated output prompt regexp for inferior python shell.
1870 Do not set this variable directly, instead use
1871 `python-shell-set-prompt-regexp'.")
1873 (defun python-shell-prompt-detect ()
1874 "Detect prompts for the current `python-shell-interpreter'.
1875 When prompts can be retrieved successfully from the
1876 `python-shell-interpreter' run with
1877 `python-shell-interpreter-interactive-arg', returns a list of
1878 three elements, where the first two are input prompts and the
1879 last one is an output prompt. When no prompts can be detected
1880 and `python-shell-prompt-detect-failure-warning' is non-nil,
1881 shows a warning with instructions to avoid hangs and returns nil.
1882 When `python-shell-prompt-detect-enabled' is nil avoids any
1883 detection and just returns nil."
1884 (when python-shell-prompt-detect-enabled
1885 (let* ((process-environment (python-shell-calculate-process-environment))
1886 (exec-path (python-shell-calculate-exec-path))
1889 "ps = [getattr(sys, 'ps%s' % i, '') for i in range(1,4)]\n"
1890 ;; JSON is built manually for compatibility
1891 "ps_json = '\\n[\"%s\", \"%s\", \"%s\"]\\n' % tuple(ps)\n"
1896 ;; TODO: improve error handling by using
1897 ;; `condition-case' and displaying the error message to
1898 ;; the user in the no-prompts warning.
1900 (let ((code-file (python-shell--save-temp-file code
)))
1901 ;; Use `process-file' as it is remote-host friendly.
1903 python-shell-interpreter
1907 python-shell-interpreter-interactive-arg
)
1909 (delete-file code-file
)))
1913 (dolist (line (split-string output
"\n" t
))
1915 ;; Check if current line is a valid JSON array
1916 (and (string= (substring line
0 2) "[\"")
1918 ;; Return prompts as a list, not vector
1919 (append (json-read-from-string line
) nil
)))))
1920 ;; The list must contain 3 strings, where the first
1921 ;; is the input prompt, the second is the block
1922 ;; prompt and the last one is the output prompt. The
1923 ;; input prompt is the only one that can't be empty.
1924 (when (and (= (length res
) 3)
1925 (cl-every #'stringp res
)
1926 (not (string= (car res
) "")))
1927 (throw 'prompts res
))))
1929 (when (and (not prompts
)
1930 python-shell-prompt-detect-failure-warning
)
1933 "Python shell prompts cannot be detected.\n"
1934 "If your emacs session hangs when starting python shells\n"
1935 "recover with `keyboard-quit' and then try fixing the\n"
1936 "interactive flag for your interpreter by adjusting the\n"
1937 "`python-shell-interpreter-interactive-arg' or add regexps\n"
1938 "matching shell prompts in the directory-local friendly vars:\n"
1939 " + `python-shell-prompt-regexp'\n"
1940 " + `python-shell-prompt-block-regexp'\n"
1941 " + `python-shell-prompt-output-regexp'\n"
1942 "Or alternatively in:\n"
1943 " + `python-shell-prompt-input-regexps'\n"
1944 " + `python-shell-prompt-output-regexps'")))
1947 (defun python-shell-prompt-validate-regexps ()
1948 "Validate all user provided regexps for prompts.
1949 Signals `user-error' if any of these vars contain invalid
1950 regexps: `python-shell-prompt-regexp',
1951 `python-shell-prompt-block-regexp',
1952 `python-shell-prompt-pdb-regexp',
1953 `python-shell-prompt-output-regexp',
1954 `python-shell-prompt-input-regexps',
1955 `python-shell-prompt-output-regexps'."
1956 (dolist (symbol (list 'python-shell-prompt-input-regexps
1957 'python-shell-prompt-output-regexps
1958 'python-shell-prompt-regexp
1959 'python-shell-prompt-block-regexp
1960 'python-shell-prompt-pdb-regexp
1961 'python-shell-prompt-output-regexp
))
1962 (dolist (regexp (let ((regexps (symbol-value symbol
)))
1966 (when (not (python-util-valid-regexp-p regexp
))
1967 (user-error "Invalid regexp %s in `%s'"
1970 (defun python-shell-prompt-set-calculated-regexps ()
1971 "Detect and set input and output prompt regexps.
1972 Build and set the values for `python-shell-input-prompt-regexp'
1973 and `python-shell-output-prompt-regexp' using the values from
1974 `python-shell-prompt-regexp', `python-shell-prompt-block-regexp',
1975 `python-shell-prompt-pdb-regexp',
1976 `python-shell-prompt-output-regexp',
1977 `python-shell-prompt-input-regexps',
1978 `python-shell-prompt-output-regexps' and detected prompts from
1979 `python-shell-prompt-detect'."
1980 (when (not (and python-shell--prompt-calculated-input-regexp
1981 python-shell--prompt-calculated-output-regexp
))
1982 (let* ((detected-prompts (python-shell-prompt-detect))
1984 (output-prompts nil
)
1988 (mapconcat #'identity
1991 (let ((length-a (length a
))
1992 (length-b (length b
)))
1993 (if (= length-a length-b
)
1995 (> (length a
) (length b
))))))
1998 ;; Validate ALL regexps
1999 (python-shell-prompt-validate-regexps)
2000 ;; Collect all user defined input prompts
2001 (dolist (prompt (append python-shell-prompt-input-regexps
2002 (list python-shell-prompt-regexp
2003 python-shell-prompt-block-regexp
2004 python-shell-prompt-pdb-regexp
)))
2005 (cl-pushnew prompt input-prompts
:test
#'string
=))
2006 ;; Collect all user defined output prompts
2007 (dolist (prompt (cons python-shell-prompt-output-regexp
2008 python-shell-prompt-output-regexps
))
2009 (cl-pushnew prompt output-prompts
:test
#'string
=))
2010 ;; Collect detected prompts if any
2011 (when detected-prompts
2012 (dolist (prompt (butlast detected-prompts
))
2013 (setq prompt
(regexp-quote prompt
))
2014 (cl-pushnew prompt input-prompts
:test
#'string
=))
2015 (cl-pushnew (regexp-quote
2016 (car (last detected-prompts
)))
2017 output-prompts
:test
#'string
=))
2018 ;; Set input and output prompt regexps from collected prompts
2019 (setq python-shell--prompt-calculated-input-regexp
2020 (funcall build-regexp input-prompts
)
2021 python-shell--prompt-calculated-output-regexp
2022 (funcall build-regexp output-prompts
)))))
2024 (defun python-shell-get-process-name (dedicated)
2025 "Calculate the appropriate process name for inferior Python process.
2026 If DEDICATED is t and the variable `buffer-file-name' is non-nil
2027 returns a string with the form
2028 `python-shell-buffer-name'[variable `buffer-file-name'] else
2029 returns the value of `python-shell-buffer-name'."
2033 (format "%s[%s]" python-shell-buffer-name buffer-file-name
)
2034 (format "%s" python-shell-buffer-name
))))
2037 (defun python-shell-internal-get-process-name ()
2038 "Calculate the appropriate process name for Internal Python process.
2039 The name is calculated from `python-shell-global-buffer-name' and
2040 a hash of all relevant global shell settings in order to ensure
2041 uniqueness for different types of configurations."
2043 python-shell-internal-buffer-name
2046 python-shell-interpreter
2047 python-shell-interpreter-args
2048 python-shell--prompt-calculated-input-regexp
2049 python-shell--prompt-calculated-output-regexp
2050 (mapconcat #'symbol-value python-shell-setup-codes
"")
2051 (mapconcat #'identity python-shell-process-environment
"")
2052 (mapconcat #'identity python-shell-extra-pythonpaths
"")
2053 (mapconcat #'identity python-shell-exec-path
"")
2054 (or python-shell-virtualenv-path
"")
2055 (mapconcat #'identity python-shell-exec-path
"")))))
2057 (defun python-shell-parse-command () ;FIXME: why name it "parse"?
2058 "Calculate the string used to execute the inferior Python process."
2059 ;; FIXME: process-environment doesn't seem to be used anywhere within
2061 (let ((process-environment (python-shell-calculate-process-environment))
2062 (exec-path (python-shell-calculate-exec-path)))
2064 ;; FIXME: Why executable-find?
2065 (executable-find python-shell-interpreter
)
2066 python-shell-interpreter-args
)))
2068 (defun python-shell-calculate-process-environment ()
2069 "Calculate process environment given `python-shell-virtualenv-path'."
2070 (let ((process-environment (append
2071 python-shell-process-environment
2072 process-environment nil
))
2073 (virtualenv (if python-shell-virtualenv-path
2074 (directory-file-name python-shell-virtualenv-path
)
2076 (when python-shell-extra-pythonpaths
2077 (setenv "PYTHONPATH"
2079 (mapconcat 'identity
2080 python-shell-extra-pythonpaths
2083 (or (getenv "PYTHONPATH") ""))))
2084 (if (not virtualenv
)
2086 (setenv "PYTHONHOME" nil
)
2087 (setenv "PATH" (format "%s/bin%s%s"
2088 virtualenv path-separator
2089 (or (getenv "PATH") "")))
2090 (setenv "VIRTUAL_ENV" virtualenv
))
2091 process-environment
))
2093 (defun python-shell-calculate-exec-path ()
2094 "Calculate exec path given `python-shell-virtualenv-path'."
2095 (let ((path (append python-shell-exec-path
2096 exec-path nil
))) ;FIXME: Why nil?
2097 (if (not python-shell-virtualenv-path
)
2099 (cons (expand-file-name "bin" python-shell-virtualenv-path
)
2102 (defun python-comint-output-filter-function (output)
2103 "Hook run after content is put into comint buffer.
2104 OUTPUT is a string with the contents of the buffer."
2105 (ansi-color-filter-apply output
))
2107 (defvar python-shell--parent-buffer nil
)
2109 (defvar python-shell-output-syntax-table
2110 (let ((table (make-syntax-table python-dotty-syntax-table
)))
2111 (modify-syntax-entry ?
\' "." table
)
2112 (modify-syntax-entry ?
\" "." table
)
2113 (modify-syntax-entry ?\
( "." table
)
2114 (modify-syntax-entry ?\
[ "." table
)
2115 (modify-syntax-entry ?\
{ "." table
)
2116 (modify-syntax-entry ?\
) "." table
)
2117 (modify-syntax-entry ?\
] "." table
)
2118 (modify-syntax-entry ?\
} "." table
)
2120 "Syntax table for shell output.
2121 It makes parens and quotes be treated as punctuation chars.")
2123 (define-derived-mode inferior-python-mode comint-mode
"Inferior Python"
2124 "Major mode for Python inferior process.
2125 Runs a Python interpreter as a subprocess of Emacs, with Python
2126 I/O through an Emacs buffer. Variables `python-shell-interpreter'
2127 and `python-shell-interpreter-args' control which Python
2128 interpreter is run. Variables
2129 `python-shell-prompt-regexp',
2130 `python-shell-prompt-output-regexp',
2131 `python-shell-prompt-block-regexp',
2132 `python-shell-enable-font-lock',
2133 `python-shell-completion-setup-code',
2134 `python-shell-completion-string-code',
2135 `python-eldoc-setup-code', `python-eldoc-string-code',
2136 `python-ffap-setup-code' and `python-ffap-string-code' can
2137 customize this mode for different Python interpreters.
2139 You can also add additional setup code to be run at
2140 initialization of the interpreter via `python-shell-setup-codes'
2143 \(Type \\[describe-mode] in the process buffer for a list of commands.)"
2144 (let ((interpreter python-shell-interpreter
)
2145 (args python-shell-interpreter-args
))
2146 (when python-shell--parent-buffer
2147 (python-util-clone-local-variables python-shell--parent-buffer
))
2148 ;; Users can override default values for these vars when calling
2149 ;; `run-python'. This ensures new values let-bound in
2150 ;; `python-shell-make-comint' are locally set.
2151 (set (make-local-variable 'python-shell-interpreter
) interpreter
)
2152 (set (make-local-variable 'python-shell-interpreter-args
) args
))
2153 (set (make-local-variable 'python-shell--prompt-calculated-input-regexp
) nil
)
2154 (set (make-local-variable 'python-shell--prompt-calculated-output-regexp
) nil
)
2155 (python-shell-prompt-set-calculated-regexps)
2156 (setq comint-prompt-regexp python-shell--prompt-calculated-input-regexp
)
2157 (setq mode-line-process
'(":%s"))
2158 (make-local-variable 'comint-output-filter-functions
)
2159 (add-hook 'comint-output-filter-functions
2160 'python-comint-output-filter-function
)
2161 (add-hook 'comint-output-filter-functions
2162 'python-pdbtrack-comint-output-filter-function
)
2163 (set (make-local-variable 'compilation-error-regexp-alist
)
2164 python-shell-compilation-regexp-alist
)
2165 (define-key inferior-python-mode-map
[remap complete-symbol
]
2166 'completion-at-point
)
2167 (add-hook 'completion-at-point-functions
2168 'python-shell-completion-complete-at-point nil
'local
)
2169 (add-to-list (make-local-variable 'comint-dynamic-complete-functions
)
2170 'python-shell-completion-complete-at-point
)
2171 (define-key inferior-python-mode-map
"\t"
2172 'python-shell-completion-complete-or-indent
)
2173 (make-local-variable 'python-pdbtrack-buffers-to-kill
)
2174 (make-local-variable 'python-pdbtrack-tracked-buffer
)
2175 (make-local-variable 'python-shell-internal-last-output
)
2176 (when python-shell-enable-font-lock
2177 (set-syntax-table python-mode-syntax-table
)
2178 (set (make-local-variable 'font-lock-defaults
)
2179 '(python-font-lock-keywords nil nil nil nil
))
2180 (set (make-local-variable 'syntax-propertize-function
)
2182 ;; XXX: Unfortunately eval is needed here to make use of the
2183 ;; dynamic value of `comint-prompt-regexp'.
2184 `(syntax-propertize-rules
2185 (,comint-prompt-regexp
2188 comint-last-input-start end
'syntax-table
2189 python-shell-output-syntax-table
)
2190 ;; XXX: This might look weird, but it is the easiest
2191 ;; way to ensure font lock gets cleaned up before the
2192 ;; current prompt, which is needed for unclosed
2193 ;; strings to not mess up with current input.
2194 (font-lock-unfontify-region comint-last-input-start end
))))
2195 (,(python-rx string-delimiter
)
2197 (and (not (eq (get-text-property start
'field
) 'output
))
2198 (python-syntax-stringify)))))))))
2199 (compilation-shell-minor-mode 1))
2201 (defun python-shell-make-comint (cmd proc-name
&optional pop internal
)
2202 "Create a Python shell comint buffer.
2203 CMD is the Python command to be executed and PROC-NAME is the
2204 process name the comint buffer will get. After the comint buffer
2205 is created the `inferior-python-mode' is activated. When
2206 optional argument POP is non-nil the buffer is shown. When
2207 optional argument INTERNAL is non-nil this process is run on a
2208 buffer with a name that starts with a space, following the Emacs
2209 convention for temporary/internal buffers, and also makes sure
2210 the user is not queried for confirmation when the process is
2213 (let* ((proc-buffer-name
2214 (format (if (not internal
) "*%s*" " *%s*") proc-name
))
2215 (process-environment (python-shell-calculate-process-environment))
2216 (exec-path (python-shell-calculate-exec-path)))
2217 (when (not (comint-check-proc proc-buffer-name
))
2218 (let* ((cmdlist (split-string-and-unquote cmd
))
2219 (interpreter (car cmdlist
))
2220 (args (cdr cmdlist
))
2221 (buffer (apply #'make-comint-in-buffer proc-name proc-buffer-name
2222 interpreter nil args
))
2223 (python-shell--parent-buffer (current-buffer))
2224 (process (get-buffer-process buffer
))
2225 ;; As the user may have overridden default values for
2226 ;; these vars on `run-python', let-binding them allows
2227 ;; to have the new right values in all setup code
2228 ;; that's is done in `inferior-python-mode', which is
2229 ;; important, especially for prompt detection.
2230 (python-shell-interpreter interpreter
)
2231 (python-shell-interpreter-args
2232 (mapconcat #'identity args
" ")))
2233 (with-current-buffer buffer
2234 (inferior-python-mode))
2235 (accept-process-output process
)
2236 (and pop
(pop-to-buffer buffer t
))
2237 (and internal
(set-process-query-on-exit-flag process nil
))))
2241 (defun run-python (cmd &optional dedicated show
)
2242 "Run an inferior Python process.
2243 Input and output via buffer named after
2244 `python-shell-buffer-name'. If there is a process already
2245 running in that buffer, just switch to it.
2247 With argument, allows you to define CMD so you can edit the
2248 command used to call the interpreter and define DEDICATED, so a
2249 dedicated process for the current buffer is open. When numeric
2250 prefix arg is other than 0 or 4 do not SHOW.
2252 Runs the hook `inferior-python-mode-hook' after
2253 `comint-mode-hook' is run. (Type \\[describe-mode] in the
2254 process buffer for a list of commands.)"
2256 (if current-prefix-arg
2258 (read-string "Run Python: " (python-shell-parse-command))
2259 (y-or-n-p "Make dedicated process? ")
2260 (= (prefix-numeric-value current-prefix-arg
) 4))
2261 (list (python-shell-parse-command) nil t
)))
2262 (python-shell-make-comint
2263 cmd
(python-shell-get-process-name dedicated
) show
)
2266 (defun run-python-internal ()
2267 "Run an inferior Internal Python process.
2268 Input and output via buffer named after
2269 `python-shell-internal-buffer-name' and what
2270 `python-shell-internal-get-process-name' returns.
2272 This new kind of shell is intended to be used for generic
2273 communication related to defined configurations; the main
2274 difference with global or dedicated shells is that these ones are
2275 attached to a configuration, not a buffer. This means that can
2276 be used for example to retrieve the sys.path and other stuff,
2277 without messing with user shells. Note that
2278 `python-shell-enable-font-lock' and `inferior-python-mode-hook'
2279 are set to nil for these shells, so setup codes are not sent at
2281 (let ((python-shell-enable-font-lock nil
)
2282 (inferior-python-mode-hook nil
))
2284 (python-shell-make-comint
2285 (python-shell-parse-command)
2286 (python-shell-internal-get-process-name) nil t
))))
2288 (defun python-shell-get-buffer ()
2289 "Return inferior Python buffer for current buffer."
2290 (let* ((dedicated-proc-name (python-shell-get-process-name t
))
2291 (dedicated-proc-buffer-name (format "*%s*" dedicated-proc-name
))
2292 (global-proc-name (python-shell-get-process-name nil
))
2293 (global-proc-buffer-name (format "*%s*" global-proc-name
))
2294 (dedicated-running (comint-check-proc dedicated-proc-buffer-name
))
2295 (global-running (comint-check-proc global-proc-buffer-name
)))
2296 ;; Always prefer dedicated
2297 (or (and dedicated-running dedicated-proc-buffer-name
)
2298 (and global-running global-proc-buffer-name
))))
2300 (defun python-shell-get-process ()
2301 "Return inferior Python process for current buffer."
2302 (get-buffer-process (python-shell-get-buffer)))
2304 (defun python-shell-get-or-create-process (&optional cmd dedicated show
)
2305 "Get or create an inferior Python process for current buffer and return it.
2306 Arguments CMD, DEDICATED and SHOW are those of `run-python' and
2307 are used to start the shell. If those arguments are not
2308 provided, `run-python' is called interactively and the user will
2309 be asked for their values."
2310 (let* ((dedicated-proc-name (python-shell-get-process-name t
))
2311 (dedicated-proc-buffer-name (format "*%s*" dedicated-proc-name
))
2312 (global-proc-name (python-shell-get-process-name nil
))
2313 (global-proc-buffer-name (format "*%s*" global-proc-name
))
2314 (dedicated-running (comint-check-proc dedicated-proc-buffer-name
))
2315 (global-running (comint-check-proc global-proc-buffer-name
))
2316 (current-prefix-arg 16))
2317 (when (and (not dedicated-running
) (not global-running
))
2319 ;; XXX: Refactor code such that calling `run-python'
2320 ;; interactively is not needed anymore.
2321 (call-interactively 'run-python
)
2322 (run-python cmd dedicated show
))
2323 (setq dedicated-running t
)
2324 (setq global-running t
)))
2325 ;; Always prefer dedicated
2326 (get-buffer-process (if dedicated-running
2327 dedicated-proc-buffer-name
2328 global-proc-buffer-name
))))
2330 (defvar python-shell-internal-buffer nil
2331 "Current internal shell buffer for the current buffer.
2332 This is really not necessary at all for the code to work but it's
2333 there for compatibility with CEDET.")
2335 (defvar python-shell-internal-last-output nil
2336 "Last output captured by the internal shell.
2337 This is really not necessary at all for the code to work but it's
2338 there for compatibility with CEDET.")
2340 (defun python-shell-internal-get-or-create-process ()
2341 "Get or create an inferior Internal Python process."
2342 (let* ((proc-name (python-shell-internal-get-process-name))
2343 (proc-buffer-name (format " *%s*" proc-name
)))
2344 (when (not (process-live-p proc-name
))
2345 (run-python-internal)
2346 (setq python-shell-internal-buffer proc-buffer-name
)
2347 ;; XXX: Why is this `sit-for' needed?
2348 ;; `python-shell-make-comint' calls `accept-process-output'
2349 ;; already but it is not helping to get proper output on
2350 ;; 'gnu/linux when the internal shell process is not running and
2351 ;; a call to `python-shell-internal-send-string' is issued.
2353 (get-buffer-process proc-buffer-name
)))
2355 (define-obsolete-function-alias
2356 'python-proc
'python-shell-internal-get-or-create-process
"24.3")
2358 (define-obsolete-variable-alias
2359 'python-buffer
'python-shell-internal-buffer
"24.3")
2361 (define-obsolete-variable-alias
2362 'python-preoutput-result
'python-shell-internal-last-output
"24.3")
2364 (defun python-shell--save-temp-file (string)
2365 (let* ((temporary-file-directory
2366 (if (file-remote-p default-directory
)
2367 (concat (file-remote-p default-directory
) "/tmp")
2368 temporary-file-directory
))
2369 (temp-file-name (make-temp-file "py"))
2370 (coding-system-for-write 'utf-8
))
2371 (with-temp-file temp-file-name
2372 (insert "# -*- coding: utf-8 -*-\n") ;Not needed for Python-3.
2374 (delete-trailing-whitespace))
2377 (defun python-shell-send-string (string &optional process
)
2378 "Send STRING to inferior Python PROCESS."
2379 (interactive "sPython command: ")
2380 (let ((process (or process
(python-shell-get-or-create-process))))
2381 (if (string-match ".\n+." string
) ;Multiline.
2382 (let* ((temp-file-name (python-shell--save-temp-file string
)))
2383 (python-shell-send-file temp-file-name process temp-file-name t
))
2384 (comint-send-string process string
)
2385 (when (or (not (string-match "\n\\'" string
))
2386 (string-match "\n[ \t].*\n?\\'" string
))
2387 (comint-send-string process
"\n")))))
2389 (defvar python-shell-output-filter-in-progress nil
)
2390 (defvar python-shell-output-filter-buffer nil
)
2392 (defun python-shell-output-filter (string)
2393 "Filter used in `python-shell-send-string-no-output' to grab output.
2394 STRING is the output received to this point from the process.
2395 This filter saves received output from the process in
2396 `python-shell-output-filter-buffer' and stops receiving it after
2397 detecting a prompt at the end of the buffer."
2399 string
(ansi-color-filter-apply string
)
2400 python-shell-output-filter-buffer
2401 (concat python-shell-output-filter-buffer string
))
2403 ;; XXX: It seems on OSX an extra carriage return is attached
2404 ;; at the end of output, this handles that too.
2407 ;; Remove initial caret from calculated regexp
2408 (replace-regexp-in-string
2409 (rx string-start ?^
) ""
2410 python-shell--prompt-calculated-input-regexp
)
2412 python-shell-output-filter-buffer
)
2413 ;; Output ends when `python-shell-output-filter-buffer' contains
2414 ;; the prompt attached at the end of it.
2415 (setq python-shell-output-filter-in-progress nil
2416 python-shell-output-filter-buffer
2417 (substring python-shell-output-filter-buffer
2418 0 (match-beginning 0)))
2420 python-shell--prompt-calculated-output-regexp
2421 python-shell-output-filter-buffer
)
2422 ;; Some shells, like IPython might append a prompt before the
2423 ;; output, clean that.
2424 (setq python-shell-output-filter-buffer
2425 (substring python-shell-output-filter-buffer
(match-end 0)))))
2428 (defun python-shell-send-string-no-output (string &optional process
)
2429 "Send STRING to PROCESS and inhibit output.
2431 (let ((process (or process
(python-shell-get-or-create-process)))
2432 (comint-preoutput-filter-functions
2433 '(python-shell-output-filter))
2434 (python-shell-output-filter-in-progress t
)
2438 (python-shell-send-string string process
)
2439 (while python-shell-output-filter-in-progress
2440 ;; `python-shell-output-filter' takes care of setting
2441 ;; `python-shell-output-filter-in-progress' to NIL after it
2442 ;; detects end of output.
2443 (accept-process-output process
))
2445 python-shell-output-filter-buffer
2446 (setq python-shell-output-filter-buffer nil
)))
2447 (with-current-buffer (process-buffer process
)
2448 (comint-interrupt-subjob)))))
2450 (defun python-shell-internal-send-string (string)
2451 "Send STRING to the Internal Python interpreter.
2452 Returns the output. See `python-shell-send-string-no-output'."
2453 ;; XXX Remove `python-shell-internal-last-output' once CEDET is
2454 ;; updated to support this new mode.
2455 (setq python-shell-internal-last-output
2456 (python-shell-send-string-no-output
2457 ;; Makes this function compatible with the old
2458 ;; python-send-receive. (At least for CEDET).
2459 (replace-regexp-in-string "_emacs_out +" "" string
)
2460 (python-shell-internal-get-or-create-process))))
2462 (define-obsolete-function-alias
2463 'python-send-receive
'python-shell-internal-send-string
"24.3")
2465 (define-obsolete-function-alias
2466 'python-send-string
'python-shell-internal-send-string
"24.3")
2468 (defvar python--use-fake-loc nil
2469 "If non-nil, use `compilation-fake-loc' to trace errors back to the buffer.
2470 If nil, regions of text are prepended by the corresponding number of empty
2471 lines and Python is told to output error messages referring to the whole
2474 (defun python-shell-buffer-substring (start end
&optional nomain
)
2475 "Send buffer substring from START to END formatted for shell.
2476 This is a wrapper over `buffer-substring' that takes care of
2477 different transformations for the code sent to be evaluated in
2479 1. When optional argument NOMAIN is non-nil everything under an
2480 \"if __name__ == '__main__'\" block will be removed.
2481 2. When a subregion of the buffer is sent, it takes care of
2482 appending extra empty lines so tracebacks are correct.
2483 3. Wraps indented regions under an \"if True:\" block so the
2484 interpreter evaluates them correctly."
2485 (let ((substring (buffer-substring-no-properties start end
))
2486 (fillstr (unless python--use-fake-loc
2487 (make-string (1- (line-number-at-pos start
)) ?
\n)))
2488 (toplevel-block-p (save-excursion
2490 (or (zerop (line-number-at-pos start
))
2492 (python-util-forward-comment 1)
2493 (zerop (current-indentation)))))))
2496 (if fillstr
(insert fillstr
))
2498 (goto-char (point-min))
2499 (unless python--use-fake-loc
2500 ;; python-shell--save-temp-file adds an extra coding line, which would
2501 ;; throw off the line-counts, so let's try to compensate here.
2502 (if (looking-at "[ \t]*[#\n]")
2503 (delete-region (point) (line-beginning-position 2))))
2504 (when (not toplevel-block-p
)
2506 (delete-region (point) (line-end-position)))
2508 (let* ((if-name-main-start-end
2511 (when (python-nav-if-name-main)
2513 (progn (python-nav-forward-sexp-safe)
2515 ;; Oh destructuring bind, how I miss you.
2516 (if-name-main-start (car if-name-main-start-end
))
2517 (if-name-main-end (cdr if-name-main-start-end
)))
2518 (when if-name-main-start-end
2519 (goto-char if-name-main-start
)
2520 (delete-region if-name-main-start if-name-main-end
)
2523 (- (line-number-at-pos if-name-main-end
)
2524 (line-number-at-pos if-name-main-start
)) ?
\n)))))
2525 (buffer-substring-no-properties (point-min) (point-max)))))
2527 (declare-function compilation-fake-loc
"compile"
2528 (marker file
&optional line col
))
2530 (defun python-shell-send-region (start end
&optional nomain
)
2531 "Send the region delimited by START and END to inferior Python process."
2533 (let* ((python--use-fake-loc
2534 (or python--use-fake-loc
(not buffer-file-name
)))
2535 (string (python-shell-buffer-substring start end nomain
))
2536 (process (python-shell-get-or-create-process))
2537 (_ (string-match "\\`\n*\\(.*\\)" string
)))
2538 (message "Sent: %s..." (match-string 1 string
))
2539 (let* ((temp-file-name (python-shell--save-temp-file string
))
2540 (file-name (or (buffer-file-name) temp-file-name
)))
2541 (python-shell-send-file file-name process temp-file-name t
)
2542 (unless python--use-fake-loc
2543 (with-current-buffer (process-buffer process
)
2544 (compilation-fake-loc (copy-marker start
) temp-file-name
2545 2)) ;; Not 1, because of the added coding line.
2548 (defun python-shell-send-buffer (&optional arg
)
2549 "Send the entire buffer to inferior Python process.
2550 With prefix ARG allow execution of code inside blocks delimited
2551 by \"if __name__== '__main__':\"."
2555 (python-shell-send-region (point-min) (point-max) (not arg
))))
2557 (defun python-shell-send-defun (arg)
2558 "Send the current defun to inferior Python process.
2559 When argument ARG is non-nil do not include decorators."
2562 (python-shell-send-region
2565 (while (and (or (python-nav-beginning-of-defun)
2566 (beginning-of-line 1))
2567 (> (current-indentation) 0)))
2569 (while (and (forward-line -
1)
2570 (looking-at (python-rx decorator
))))
2574 (or (python-nav-end-of-defun)
2578 (defun python-shell-send-file (file-name &optional process temp-file-name
2580 "Send FILE-NAME to inferior Python PROCESS.
2581 If TEMP-FILE-NAME is passed then that file is used for processing
2582 instead, while internally the shell will continue to use FILE-NAME.
2583 If DELETE is non-nil, delete the file afterwards."
2584 (interactive "fFile to send: ")
2585 (let* ((process (or process
(python-shell-get-or-create-process)))
2586 (temp-file-name (when temp-file-name
2588 (or (file-remote-p temp-file-name
'localname
)
2590 (file-name (or (when file-name
2592 (or (file-remote-p file-name
'localname
)
2595 (when (not file-name
)
2596 (error "If FILE-NAME is nil then TEMP-FILE-NAME must be non-nil"))
2597 (python-shell-send-string
2599 (concat "__pyfile = open('''%s''');"
2600 "exec(compile(__pyfile.read(), '''%s''', 'exec'));"
2601 "__pyfile.close()%s")
2602 (or temp-file-name file-name
) file-name
2603 (if delete
(format "; import os; os.remove('''%s''')"
2604 (or temp-file-name file-name
))
2608 (defun python-shell-switch-to-shell ()
2609 "Switch to inferior Python process buffer."
2611 (pop-to-buffer (process-buffer (python-shell-get-or-create-process)) t
))
2613 (defun python-shell-send-setup-code ()
2614 "Send all setup code for shell.
2615 This function takes the list of setup code to send from the
2616 `python-shell-setup-codes' list."
2617 (let ((process (get-buffer-process (current-buffer))))
2618 (dolist (code python-shell-setup-codes
)
2620 (message "Sent %s" code
)
2621 (python-shell-send-string
2622 (symbol-value code
) process
)))))
2624 (add-hook 'inferior-python-mode-hook
2625 #'python-shell-send-setup-code
)
2628 ;;; Shell completion
2630 (defcustom python-shell-completion-setup-code
2632 import readline, rlcompleter
2634 def __PYTHON_EL_get_completions(text):
2637 def __PYTHON_EL_get_completions(text):
2640 splits = text.split()
2641 is_module = splits and splits[0] in ('from', 'import')
2642 is_ipython = getattr(
2643 __builtins__, '__IPYTHON__',
2644 getattr(__builtins__, '__IPYTHON__active', False))
2646 from IPython.core.completerlib import module_completion
2647 completions = module_completion(text.strip())
2648 elif is_ipython and getattr(__builtins__, '__IP', None):
2649 completions = __IP.complete(text)
2650 elif is_ipython and getattr(__builtins__, 'get_ipython', None):
2651 completions = get_ipython().Completer.all_completions(text)
2655 res = readline.get_completer()(text, i)
2659 completions.append(res)
2663 "Code used to setup completion in inferior Python processes."
2667 (defcustom python-shell-completion-string-code
2668 "';'.join(__PYTHON_EL_get_completions('''%s'''))\n"
2669 "Python code used to get a string of completions separated by semicolons.
2670 The string passed to the function is the current python name or
2671 the full statement in the case of imports."
2675 (define-obsolete-variable-alias
2676 'python-shell-completion-module-string-code
2677 'python-shell-completion-string-code
2679 "Completion string code must also autocomplete modules.")
2681 (defcustom python-shell-completion-pdb-string-code
2682 "';'.join(globals().keys() + locals().keys())"
2683 "Python code used to get completions separated by semicolons for [i]pdb."
2687 (defun python-shell-completion-get-completions (process line input
)
2688 "Do completion at point for PROCESS.
2689 LINE is used to detect the context on how to complete given INPUT."
2690 (with-current-buffer (process-buffer process
)
2692 ;; Get last prompt of the inferior process buffer (this
2693 ;; intentionally avoids using `comint-last-prompt' because
2694 ;; of incompatibilities with Emacs 24.x).
2696 (buffer-substring-no-properties
2697 (line-beginning-position) ;End of prompt.
2699 (re-search-backward "^")
2700 (python-util-forward-comment) ;FIXME: Why?
2703 ;; Check whether a prompt matches a pdb string, an import
2704 ;; statement or just the standard prompt and use the
2705 ;; correct python-shell-completion-*-code string
2706 (cond ((and (> (length python-shell-completion-pdb-string-code
) 0)
2708 (concat "^" python-shell-prompt-pdb-regexp
) prompt
))
2709 python-shell-completion-pdb-string-code
)
2711 python-shell--prompt-calculated-input-regexp prompt
)
2712 python-shell-completion-string-code
)
2716 (python-rx (+ space
) (or "from" "import") space
)
2720 (and completion-code
2721 (> (length input
) 0)
2723 (python-util-strip-string
2724 (python-shell-send-string-no-output
2725 (format completion-code input
) process
))))
2726 (and (> (length completions
) 2)
2727 (split-string completions
2728 "^'\\|^\"\\|;\\|'$\\|\"$" t
)))))))
2730 (defun python-shell-completion-complete-at-point (&optional process
)
2731 "Perform completion at point in inferior Python.
2732 Optional argument PROCESS forces completions to be retrieved
2733 using that one instead of current buffer's process."
2734 (setq process
(or process
(get-buffer-process (current-buffer))))
2737 (with-syntax-table python-dotty-syntax-table
2738 (let* ((paren-depth (car (syntax-ppss)))
2739 (syntax-string "w_")
2740 (syntax-list (string-to-syntax syntax-string
)))
2741 ;; Stop scanning for the beginning of the completion
2742 ;; subject after the char before point matches a
2745 (car (syntax-after (1- (point)))) syntax-list
)
2746 (skip-syntax-backward syntax-string
)
2747 (when (or (equal (char-before) ?\
))
2748 (equal (char-before) ?
\"))
2751 ;; honor initial paren depth
2752 (> (car (syntax-ppss)) paren-depth
)
2753 (python-syntax-context 'string
))
2758 (completion-table-dynamic
2760 #'python-shell-completion-get-completions
2761 process
(buffer-substring-no-properties
2762 (line-beginning-position) end
))))))
2764 (defun python-shell-completion-complete-or-indent ()
2765 "Complete or indent depending on the context.
2766 If content before pointer is all whitespace, indent.
2767 If not try to complete."
2769 (if (string-match "^[[:space:]]*$"
2770 (buffer-substring (comint-line-beginning-position)
2772 (indent-for-tab-command)
2773 (completion-at-point)))
2776 ;;; PDB Track integration
2778 (defcustom python-pdbtrack-activate t
2779 "Non-nil makes Python shell enable pdbtracking."
2784 (defcustom python-pdbtrack-stacktrace-info-regexp
2785 "> \\([^\"(<]+\\)(\\([0-9]+\\))\\([?a-zA-Z0-9_<>]+\\)()"
2786 "Regular expression matching stacktrace information.
2787 Used to extract the current line and module being inspected."
2792 (defvar python-pdbtrack-tracked-buffer nil
2793 "Variable containing the value of the current tracked buffer.
2794 Never set this variable directly, use
2795 `python-pdbtrack-set-tracked-buffer' instead.")
2797 (defvar python-pdbtrack-buffers-to-kill nil
2798 "List of buffers to be deleted after tracking finishes.")
2800 (defun python-pdbtrack-set-tracked-buffer (file-name)
2801 "Set the buffer for FILE-NAME as the tracked buffer.
2802 Internally it uses the `python-pdbtrack-tracked-buffer' variable.
2803 Returns the tracked buffer."
2804 (let ((file-buffer (get-file-buffer
2805 (concat (file-remote-p default-directory
)
2808 (setq python-pdbtrack-tracked-buffer file-buffer
)
2809 (setq file-buffer
(find-file-noselect file-name
))
2810 (when (not (member file-buffer python-pdbtrack-buffers-to-kill
))
2811 (add-to-list 'python-pdbtrack-buffers-to-kill file-buffer
)))
2814 (defun python-pdbtrack-comint-output-filter-function (output)
2815 "Move overlay arrow to current pdb line in tracked buffer.
2816 Argument OUTPUT is a string with the output from the comint process."
2817 (when (and python-pdbtrack-activate
(not (string= output
"")))
2818 (let* ((full-output (ansi-color-filter-apply
2819 (buffer-substring comint-last-input-end
(point-max))))
2823 (insert full-output
)
2824 ;; When the debugger encounters a pdb.set_trace()
2825 ;; command, it prints a single stack frame. Sometimes
2826 ;; it prints a bit of extra information about the
2827 ;; arguments of the present function. When ipdb
2828 ;; encounters an exception, it prints the _entire_ stack
2829 ;; trace. To handle all of these cases, we want to find
2830 ;; the _last_ stack frame printed in the most recent
2831 ;; batch of output, then jump to the corresponding
2832 ;; file/line number.
2833 (goto-char (point-max))
2834 (when (re-search-backward python-pdbtrack-stacktrace-info-regexp nil t
)
2835 (setq line-number
(string-to-number
2836 (match-string-no-properties 2)))
2837 (match-string-no-properties 1)))))
2838 (if (and file-name line-number
)
2839 (let* ((tracked-buffer
2840 (python-pdbtrack-set-tracked-buffer file-name
))
2841 (shell-buffer (current-buffer))
2842 (tracked-buffer-window (get-buffer-window tracked-buffer
))
2843 (tracked-buffer-line-pos))
2844 (with-current-buffer tracked-buffer
2845 (set (make-local-variable 'overlay-arrow-string
) "=>")
2846 (set (make-local-variable 'overlay-arrow-position
) (make-marker))
2847 (setq tracked-buffer-line-pos
(progn
2848 (goto-char (point-min))
2849 (forward-line (1- line-number
))
2851 (when tracked-buffer-window
2853 tracked-buffer-window tracked-buffer-line-pos
))
2854 (set-marker overlay-arrow-position tracked-buffer-line-pos
))
2855 (pop-to-buffer tracked-buffer
)
2856 (switch-to-buffer-other-window shell-buffer
))
2857 (when python-pdbtrack-tracked-buffer
2858 (with-current-buffer python-pdbtrack-tracked-buffer
2859 (set-marker overlay-arrow-position nil
))
2860 (mapc #'(lambda (buffer)
2861 (ignore-errors (kill-buffer buffer
)))
2862 python-pdbtrack-buffers-to-kill
)
2863 (setq python-pdbtrack-tracked-buffer nil
2864 python-pdbtrack-buffers-to-kill nil
)))))
2868 ;;; Symbol completion
2870 (defun python-completion-complete-at-point ()
2871 "Complete current symbol at point.
2872 For this to work as best as possible you should call
2873 `python-shell-send-buffer' from time to time so context in
2874 inferior Python process is updated properly."
2875 (let ((process (python-shell-get-process)))
2877 (error "Completion needs an inferior Python process running")
2878 (python-shell-completion-complete-at-point process
))))
2880 (add-to-list 'debug-ignored-errors
2881 "^Completion needs an inferior Python process running.")
2886 (defcustom python-fill-comment-function
'python-fill-comment
2887 "Function to fill comments.
2888 This is the function used by `python-fill-paragraph' to
2893 (defcustom python-fill-string-function
'python-fill-string
2894 "Function to fill strings.
2895 This is the function used by `python-fill-paragraph' to
2900 (defcustom python-fill-decorator-function
'python-fill-decorator
2901 "Function to fill decorators.
2902 This is the function used by `python-fill-paragraph' to
2907 (defcustom python-fill-paren-function
'python-fill-paren
2908 "Function to fill parens.
2909 This is the function used by `python-fill-paragraph' to
2914 (defcustom python-fill-docstring-style
'pep-257
2915 "Style used to fill docstrings.
2916 This affects `python-fill-string' behavior with regards to
2917 triple quotes positioning.
2919 Possible values are `django', `onetwo', `pep-257', `pep-257-nn',
2920 `symmetric', and nil. A value of nil won't care about quotes
2921 position and will treat docstrings a normal string, any other
2922 value may result in one of the following docstring styles:
2927 Process foo, return bar.
2931 Process foo, return bar.
2933 If processing fails throw ProcessingError.
2938 \"\"\"Process foo, return bar.\"\"\"
2941 Process foo, return bar.
2943 If processing fails throw ProcessingError.
2949 \"\"\"Process foo, return bar.\"\"\"
2951 \"\"\"Process foo, return bar.
2953 If processing fails throw ProcessingError.
2959 \"\"\"Process foo, return bar.\"\"\"
2961 \"\"\"Process foo, return bar.
2963 If processing fails throw ProcessingError.
2968 \"\"\"Process foo, return bar.\"\"\"
2971 Process foo, return bar.
2973 If processing fails throw ProcessingError.
2976 (const :tag
"Don't format docstrings" nil
)
2977 (const :tag
"Django's coding standards style." django
)
2978 (const :tag
"One newline and start and Two at end style." onetwo
)
2979 (const :tag
"PEP-257 with 2 newlines at end of string." pep-257
)
2980 (const :tag
"PEP-257 with 1 newline at end of string." pep-257-nn
)
2981 (const :tag
"Symmetric style." symmetric
))
2984 (memq val
'(django onetwo pep-257 pep-257-nn symmetric nil
))))
2986 (defun python-fill-paragraph (&optional justify
)
2987 "`fill-paragraph-function' handling multi-line strings and possibly comments.
2988 If any of the current line is in or at the end of a multi-line string,
2989 fill the string or the paragraph of it that point is in, preserving
2990 the string's indentation.
2991 Optional argument JUSTIFY defines if the paragraph should be justified."
2996 ((python-syntax-context 'comment
)
2997 (funcall python-fill-comment-function justify
))
2998 ;; Strings/Docstrings
2999 ((save-excursion (or (python-syntax-context 'string
)
3000 (equal (string-to-syntax "|")
3001 (syntax-after (point)))))
3002 (funcall python-fill-string-function justify
))
3004 ((equal (char-after (save-excursion
3005 (python-nav-beginning-of-statement))) ?
@)
3006 (funcall python-fill-decorator-function justify
))
3008 ((or (python-syntax-context 'paren
)
3009 (looking-at (python-rx open-paren
))
3011 (skip-syntax-forward "^(" (line-end-position))
3012 (looking-at (python-rx open-paren
))))
3013 (funcall python-fill-paren-function justify
))
3016 (defun python-fill-comment (&optional justify
)
3017 "Comment fill function for `python-fill-paragraph'.
3018 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
3019 (fill-comment-paragraph justify
))
3021 (defun python-fill-string (&optional justify
)
3022 "String fill function for `python-fill-paragraph'.
3023 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
3024 (let* ((str-start-pos
3027 (or (python-syntax-context 'string
)
3028 (and (equal (string-to-syntax "|")
3029 (syntax-after (point)))
3031 (num-quotes (python-syntax-count-quotes
3032 (char-after str-start-pos
) str-start-pos
))
3035 (goto-char (+ str-start-pos num-quotes
))
3036 (or (re-search-forward (rx (syntax string-delimiter
)) nil t
)
3037 (goto-char (point-max)))
3040 ;; Docstring styles may vary for oneliners and multi-liners.
3041 (> (count-matches "\n" str-start-pos str-end-pos
) 0))
3043 (pcase python-fill-docstring-style
3044 ;; delimiters-style is a cons cell with the form
3045 ;; (START-NEWLINES . END-NEWLINES). When any of the sexps
3046 ;; is NIL means to not add any newlines for start or end
3047 ;; of docstring. See `python-fill-docstring-style' for a
3048 ;; graphic idea of each style.
3049 (`django
(cons 1 1))
3050 (`onetwo
(and multi-line-p
(cons 1 2)))
3051 (`pep-257
(and multi-line-p
(cons nil
2)))
3052 (`pep-257-nn
(and multi-line-p
(cons nil
1)))
3053 (`symmetric
(and multi-line-p
(cons 1 1)))))
3054 (docstring-p (save-excursion
3055 ;; Consider docstrings those strings which
3056 ;; start on a line by themselves.
3057 (python-nav-beginning-of-statement)
3058 (and (= (point) str-start-pos
))))
3059 (fill-paragraph-function))
3061 (narrow-to-region str-start-pos str-end-pos
)
3062 (fill-paragraph justify
))
3064 (when (and docstring-p python-fill-docstring-style
)
3065 ;; Add the number of newlines indicated by the selected style
3066 ;; at the start of the docstring.
3067 (goto-char (+ str-start-pos num-quotes
))
3068 (delete-region (point) (progn
3069 (skip-syntax-forward "> ")
3071 (and (car delimiters-style
)
3072 (or (newline (car delimiters-style
)) t
)
3073 ;; Indent only if a newline is added.
3074 (indent-according-to-mode))
3075 ;; Add the number of newlines indicated by the selected style
3076 ;; at the end of the docstring.
3077 (goto-char (if (not (= str-end-pos
(point-max)))
3078 (- str-end-pos num-quotes
)
3080 (delete-region (point) (progn
3081 (skip-syntax-backward "> ")
3083 (and (cdr delimiters-style
)
3084 ;; Add newlines only if string ends.
3085 (not (= str-end-pos
(point-max)))
3086 (or (newline (cdr delimiters-style
)) t
)
3087 ;; Again indent only if a newline is added.
3088 (indent-according-to-mode))))) t
)
3090 (defun python-fill-decorator (&optional _justify
)
3091 "Decorator fill function for `python-fill-paragraph'.
3092 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
3095 (defun python-fill-paren (&optional justify
)
3096 "Paren fill function for `python-fill-paragraph'.
3097 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
3099 (narrow-to-region (progn
3100 (while (python-syntax-context 'paren
)
3101 (goto-char (1- (point-marker))))
3103 (line-beginning-position))
3105 (when (not (python-syntax-context 'paren
))
3107 (when (not (python-syntax-context 'paren
))
3108 (skip-syntax-backward "^)")))
3109 (while (and (python-syntax-context 'paren
)
3111 (goto-char (1+ (point-marker))))
3113 (let ((paragraph-start "\f\\|[ \t]*$")
3114 (paragraph-separate ",")
3115 (fill-paragraph-function))
3116 (goto-char (point-min))
3117 (fill-paragraph justify
))
3120 (python-indent-line)
3121 (goto-char (line-end-position))))
3127 (defcustom python-skeleton-autoinsert nil
3128 "Non-nil means template skeletons will be automagically inserted.
3129 This happens when pressing \"if<SPACE>\", for example, to prompt for
3135 (define-obsolete-variable-alias
3136 'python-use-skeletons
'python-skeleton-autoinsert
"24.3")
3138 (defvar python-skeleton-available
'()
3139 "Internal list of available skeletons.")
3141 (define-abbrev-table 'python-mode-skeleton-abbrev-table
()
3142 "Abbrev table for Python mode skeletons."
3144 ;; Allow / inside abbrevs.
3145 :regexp
"\\(?:^\\|[^/]\\)\\<\\([[:word:]/]+\\)\\W*"
3146 ;; Only expand in code.
3147 :enable-function
(lambda ()
3149 (not (python-syntax-comment-or-string-p))
3150 python-skeleton-autoinsert
)))
3152 (defmacro python-skeleton-define
(name doc
&rest skel
)
3153 "Define a `python-mode' skeleton using NAME DOC and SKEL.
3154 The skeleton will be bound to python-skeleton-NAME and will
3155 be added to `python-mode-skeleton-abbrev-table'."
3156 (declare (indent 2))
3157 (let* ((name (symbol-name name
))
3158 (function-name (intern (concat "python-skeleton-" name
))))
3160 (define-abbrev python-mode-skeleton-abbrev-table
3161 ,name
"" ',function-name
:system t
)
3162 (setq python-skeleton-available
3163 (cons ',function-name python-skeleton-available
))
3164 (define-skeleton ,function-name
3166 (format "Insert %s statement." name
))
3169 (define-abbrev-table 'python-mode-abbrev-table
()
3170 "Abbrev table for Python mode."
3171 :parents
(list python-mode-skeleton-abbrev-table
))
3173 (defmacro python-define-auxiliary-skeleton
(name doc
&optional
&rest skel
)
3174 "Define a `python-mode' auxiliary skeleton using NAME DOC and SKEL.
3175 The skeleton will be bound to python-skeleton-NAME."
3176 (declare (indent 2))
3177 (let* ((name (symbol-name name
))
3178 (function-name (intern (concat "python-skeleton--" name
)))
3180 "Add '%s' clause? " name
)))
3183 `(< ,(format "%s:" name
) \n \n
3185 `(define-skeleton ,function-name
3187 (format "Auxiliary skeleton for %s statement." name
))
3189 (unless (y-or-n-p ,msg
)
3193 (python-define-auxiliary-skeleton else nil
)
3195 (python-define-auxiliary-skeleton except nil
)
3197 (python-define-auxiliary-skeleton finally nil
)
3199 (python-skeleton-define if nil
3203 ("other condition, %s: "
3207 '(python-skeleton--else) | ^
)
3209 (python-skeleton-define while nil
3213 '(python-skeleton--else) | ^
)
3215 (python-skeleton-define for nil
3219 '(python-skeleton--else) | ^
)
3221 (python-skeleton-define try nil
3227 "except " str
":" \n
3230 '(python-skeleton--except)
3231 '(python-skeleton--else)
3232 '(python-skeleton--finally) | ^
)
3234 (python-skeleton-define def nil
3236 "def " str
"(" ("Parameter, %s: "
3237 (unless (equal ?\
( (char-before)) ", ")
3239 "\"\"\"" -
"\"\"\"" \n
3242 (python-skeleton-define class nil
3244 "class " str
"(" ("Inheritance, %s: "
3245 (unless (equal ?\
( (char-before)) ", ")
3249 "\"\"\"" -
"\"\"\"" \n
3252 (defun python-skeleton-add-menu-items ()
3253 "Add menu items to Python->Skeletons menu."
3254 (let ((skeletons (sort python-skeleton-available
'string
<)))
3255 (dolist (skeleton skeletons
)
3257 nil
'("Python" "Skeletons")
3259 "Insert %s" (nth 2 (split-string (symbol-name skeleton
) "-")))
3264 (defcustom python-ffap-setup-code
3265 "def __FFAP_get_module_path(module):
3268 path = __import__(module).__file__
3269 if path[-4:] == '.pyc' and os.path.exists(path[0:-1]):
3274 "Python code to get a module path."
3278 (defcustom python-ffap-string-code
3279 "__FFAP_get_module_path('''%s''')\n"
3280 "Python code used to get a string with the path of a module."
3284 (defun python-ffap-module-path (module)
3285 "Function for `ffap-alist' to return path for MODULE."
3287 (and (eq major-mode
'inferior-python-mode
)
3288 (get-buffer-process (current-buffer)))
3289 (python-shell-get-process))))
3293 (python-shell-send-string-no-output
3294 (format python-ffap-string-code module
) process
)))
3296 (substring-no-properties module-file
1 -
1))))))
3300 (eval-after-load "ffap"
3302 (push '(python-mode . python-ffap-module-path
) ffap-alist
)
3303 (push '(inferior-python-mode . python-ffap-module-path
) ffap-alist
)))
3308 (defcustom python-check-command
3310 "Command used to check a Python file."
3314 (defcustom python-check-buffer-name
3315 "*Python check: %s*"
3316 "Buffer name used for check commands."
3320 (defvar python-check-custom-command nil
3323 (defun python-check (command)
3324 "Check a Python file (default current buffer's file).
3325 Runs COMMAND, a shell command, as if by `compile'.
3326 See `python-check-command' for the default."
3328 (list (read-string "Check command: "
3329 (or python-check-custom-command
3330 (concat python-check-command
" "
3331 (shell-quote-argument
3333 (let ((name (buffer-file-name)))
3335 (file-name-nondirectory name
)))
3337 (setq python-check-custom-command command
)
3338 (save-some-buffers (not compilation-ask-about-save
) nil
)
3339 (let ((process-environment (python-shell-calculate-process-environment))
3340 (exec-path (python-shell-calculate-exec-path)))
3341 (compilation-start command nil
3343 (format python-check-buffer-name command
)))))
3348 (defcustom python-eldoc-setup-code
3349 "def __PYDOC_get_help(obj):
3352 if hasattr(obj, 'startswith'):
3353 obj = eval(obj, globals())
3354 doc = inspect.getdoc(obj)
3355 if not doc and callable(obj):
3357 if inspect.isclass(obj) and hasattr(obj, '__init__'):
3358 target = obj.__init__
3364 args = inspect.formatargspec(
3365 *inspect.getargspec(target)
3368 doc = '{objtype} {name}{args}'.format(
3369 objtype=objtype, name=name, args=args
3372 doc = doc.splitlines()[0]
3379 "Python code to setup documentation retrieval."
3383 (defcustom python-eldoc-string-code
3384 "__PYDOC_get_help('''%s''')\n"
3385 "Python code used to get a string with the documentation of an object."
3389 (defun python-eldoc--get-doc-at-point (&optional force-input force-process
)
3390 "Internal implementation to get documentation at point.
3391 If not FORCE-INPUT is passed then what `python-info-current-symbol'
3392 returns will be used. If not FORCE-PROCESS is passed what
3393 `python-shell-get-process' returns is used."
3394 (let ((process (or force-process
(python-shell-get-process))))
3396 (error "Eldoc needs an inferior Python process running")
3397 (let ((input (or force-input
3398 (python-info-current-symbol t
))))
3400 (python-shell-send-string-no-output
3401 (format python-eldoc-string-code input
)
3404 (defun python-eldoc-function ()
3405 "`eldoc-documentation-function' for Python.
3406 For this to work as best as possible you should call
3407 `python-shell-send-buffer' from time to time so context in
3408 inferior Python process is updated properly."
3409 (python-eldoc--get-doc-at-point))
3411 (defun python-eldoc-at-point (symbol)
3412 "Get help on SYMBOL using `help'.
3413 Interactively, prompt for symbol."
3415 (let ((symbol (python-info-current-symbol t
))
3416 (enable-recursive-minibuffers t
))
3417 (list (read-string (if symbol
3418 (format "Describe symbol (default %s): " symbol
)
3419 "Describe symbol: ")
3421 (message (python-eldoc--get-doc-at-point symbol
)))
3423 (add-to-list 'debug-ignored-errors
3424 "^Eldoc needs an inferior Python process running.")
3429 (defvar python-imenu-format-item-label-function
3430 'python-imenu-format-item-label
3431 "Imenu function used to format an item label.
3432 It must be a function with two arguments: TYPE and NAME.")
3434 (defvar python-imenu-format-parent-item-label-function
3435 'python-imenu-format-parent-item-label
3436 "Imenu function used to format a parent item label.
3437 It must be a function with two arguments: TYPE and NAME.")
3439 (defvar python-imenu-format-parent-item-jump-label-function
3440 'python-imenu-format-parent-item-jump-label
3441 "Imenu function used to format a parent jump item label.
3442 It must be a function with two arguments: TYPE and NAME.")
3444 (defun python-imenu-format-item-label (type name
)
3445 "Return Imenu label for single node using TYPE and NAME."
3446 (format "%s (%s)" name type
))
3448 (defun python-imenu-format-parent-item-label (type name
)
3449 "Return Imenu label for parent node using TYPE and NAME."
3450 (format "%s..." (python-imenu-format-item-label type name
)))
3452 (defun python-imenu-format-parent-item-jump-label (type _name
)
3453 "Return Imenu label for parent node jump using TYPE and NAME."
3454 (if (string= type
"class")
3455 "*class definition*"
3456 "*function definition*"))
3458 (defun python-imenu--put-parent (type name pos tree
)
3459 "Add the parent with TYPE, NAME and POS to TREE."
3461 (funcall python-imenu-format-item-label-function type name
))
3463 (funcall python-imenu-format-parent-item-jump-label-function type name
)))
3466 (cons label
(cons (cons jump-label pos
) tree
)))))
3468 (defun python-imenu--build-tree (&optional min-indent prev-indent tree
)
3469 "Recursively build the tree of nested definitions of a node.
3470 Arguments MIN-INDENT, PREV-INDENT and TREE are internal and should
3471 not be passed explicitly unless you know what you are doing."
3472 (setq min-indent
(or min-indent
0)
3473 prev-indent
(or prev-indent python-indent-offset
))
3474 (let* ((pos (python-nav-backward-defun))
3476 (name (when (and pos
(looking-at python-nav-beginning-of-defun-regexp
))
3477 (let ((split (split-string (match-string-no-properties 0))))
3478 (setq type
(car split
))
3481 (funcall python-imenu-format-item-label-function type name
)))
3482 (indent (current-indentation))
3483 (children-indent-limit (+ python-indent-offset min-indent
)))
3485 ;; Nothing found, probably near to bobp.
3487 ((<= indent min-indent
)
3488 ;; The current indentation points that this is a parent
3489 ;; node, add it to the tree and stop recursing.
3490 (python-imenu--put-parent type name pos tree
))
3492 (python-imenu--build-tree
3495 (if (<= indent children-indent-limit
)
3496 ;; This lies within the children indent offset range,
3497 ;; so it's a normal child of its parent (i.e., not
3498 ;; a child of a child).
3499 (cons (cons label pos
) tree
)
3500 ;; Oh no, a child of a child?! Fear not, we
3501 ;; know how to roll. We recursively parse these by
3502 ;; swapping prev-indent and min-indent plus adding this
3503 ;; newly found item to a fresh subtree. This works, I
3506 (python-imenu--build-tree
3507 prev-indent indent
(list (cons label pos
)))
3510 (defun python-imenu-create-index ()
3511 "Return tree Imenu alist for the current Python buffer.
3512 Change `python-imenu-format-item-label-function',
3513 `python-imenu-format-parent-item-label-function',
3514 `python-imenu-format-parent-item-jump-label-function' to
3515 customize how labels are formatted."
3516 (goto-char (point-max))
3519 (while (setq tree
(python-imenu--build-tree))
3520 (setq index
(cons tree index
)))
3523 (defun python-imenu-create-flat-index (&optional alist prefix
)
3524 "Return flat outline of the current Python buffer for Imenu.
3525 Optional argument ALIST is the tree to be flattened; when nil
3526 `python-imenu-build-index' is used with
3527 `python-imenu-format-parent-item-jump-label-function'
3528 `python-imenu-format-parent-item-label-function'
3529 `python-imenu-format-item-label-function' set to
3530 (lambda (type name) name)
3531 Optional argument PREFIX is used in recursive calls and should
3532 not be passed explicitly.
3539 (\"decorator\" . 173)
3542 (\"wrapped_f\" . 393))))
3548 (\"decorator\" . 173)
3549 (\"decorator.wrap\" . 353)
3550 (\"decorator.wrapped_f\" . 393))"
3551 ;; Inspired by imenu--flatten-index-alist removed in revno 21853.
3556 (let ((name (if prefix
3557 (concat prefix
"." (car item
))
3560 (cond ((or (numberp pos
) (markerp pos
))
3561 (list (cons name pos
)))
3564 (cons name
(cdar pos
))
3565 (python-imenu-create-flat-index (cddr item
) name
))))))
3567 (let* ((fn (lambda (_type name
) name
))
3568 (python-imenu-format-item-label-function fn
)
3569 (python-imenu-format-parent-item-label-function fn
)
3570 (python-imenu-format-parent-item-jump-label-function fn
))
3571 (python-imenu-create-index))))))
3576 (defun python-info-current-defun (&optional include-type
)
3577 "Return name of surrounding function with Python compatible dotty syntax.
3578 Optional argument INCLUDE-TYPE indicates to include the type of the defun.
3579 This function can be used as the value of `add-log-current-defun-function'
3580 since it returns nil if point is not inside a defun."
3586 (starting-indentation (current-indentation))
3587 (starting-pos (point))
3592 (while (python-nav-beginning-of-defun 1)
3593 (when (save-match-data
3595 (or (not last-indent
)
3596 (< (current-indentation) last-indent
))
3600 ;; If this is the first run, we may add
3601 ;; the current defun at point.
3602 (setq first-run nil
)
3603 (goto-char starting-pos
)
3604 (python-nav-beginning-of-statement)
3605 (beginning-of-line 1)
3607 python-nav-beginning-of-defun-regexp
)))
3611 (+ (current-indentation)
3612 python-indent-offset
)))
3613 (if (< starting-indentation min-indent
)
3614 ;; If the starting indentation is not
3615 ;; within the min defun indent make the
3618 ;; Else go to the end of defun and add
3619 ;; up the current indentation to the
3621 (python-nav-end-of-defun)
3623 (if (>= (current-indentation) min-indent
)
3624 (1+ (current-indentation))
3626 (save-match-data (setq last-indent
(current-indentation)))
3627 (if (or (not include-type
) type
)
3628 (setq names
(cons (match-string-no-properties 1) names
))
3629 (let ((match (split-string (match-string-no-properties 0))))
3630 (setq type
(car match
))
3631 (setq names
(cons (cadr match
) names
)))))
3632 ;; Stop searching ASAP.
3633 (and (= (current-indentation) 0) (throw 'exit t
))))
3635 (concat (and type
(format "%s " type
))
3636 (mapconcat 'identity names
".")))))))
3638 (defun python-info-current-symbol (&optional replace-self
)
3639 "Return current symbol using dotty syntax.
3640 With optional argument REPLACE-SELF convert \"self\" to current
3643 (and (not (python-syntax-comment-or-string-p))
3644 (with-syntax-table python-dotty-syntax-table
3645 (let ((sym (symbol-at-point)))
3647 (substring-no-properties (symbol-name sym
))))))))
3649 (if (not replace-self
)
3651 (let ((current-defun (python-info-current-defun)))
3652 (if (not current-defun
)
3654 (replace-regexp-in-string
3655 (python-rx line-start word-start
"self" word-end ?.
)
3657 (mapconcat 'identity
3658 (butlast (split-string current-defun
"\\."))
3662 (defun python-info-statement-starts-block-p ()
3663 "Return non-nil if current statement opens a block."
3665 (python-nav-beginning-of-statement)
3666 (looking-at (python-rx block-start
))))
3668 (defun python-info-statement-ends-block-p ()
3669 "Return non-nil if point is at end of block."
3670 (let ((end-of-block-pos (save-excursion
3671 (python-nav-end-of-block)))
3672 (end-of-statement-pos (save-excursion
3673 (python-nav-end-of-statement))))
3674 (and end-of-block-pos end-of-statement-pos
3675 (= end-of-block-pos end-of-statement-pos
))))
3677 (defun python-info-beginning-of-statement-p ()
3678 "Return non-nil if point is at beginning of statement."
3679 (= (point) (save-excursion
3680 (python-nav-beginning-of-statement)
3683 (defun python-info-end-of-statement-p ()
3684 "Return non-nil if point is at end of statement."
3685 (= (point) (save-excursion
3686 (python-nav-end-of-statement)
3689 (defun python-info-beginning-of-block-p ()
3690 "Return non-nil if point is at beginning of block."
3691 (and (python-info-beginning-of-statement-p)
3692 (python-info-statement-starts-block-p)))
3694 (defun python-info-end-of-block-p ()
3695 "Return non-nil if point is at end of block."
3696 (and (python-info-end-of-statement-p)
3697 (python-info-statement-ends-block-p)))
3699 (define-obsolete-function-alias
3700 'python-info-closing-block
3701 'python-info-dedenter-opening-block-position
"24.4")
3703 (defun python-info-dedenter-opening-block-position ()
3704 "Return the point of the closest block the current line closes.
3705 Returns nil if point is not on a dedenter statement or no opening
3706 block can be detected. The latter case meaning current file is
3707 likely an invalid python file."
3708 (let ((positions (python-info-dedenter-opening-block-positions))
3709 (indentation (current-indentation))
3711 (while (and (not position
)
3714 (goto-char (car positions
))
3715 (if (<= (current-indentation) indentation
)
3716 (setq position
(car positions
))
3717 (setq positions
(cdr positions
)))))
3720 (defun python-info-dedenter-opening-block-positions ()
3721 "Return points of blocks the current line may close sorted by closer.
3722 Returns nil if point is not on a dedenter statement or no opening
3723 block can be detected. The latter case meaning current file is
3724 likely an invalid python file."
3726 (let ((dedenter-pos (python-info-dedenter-statement-p)))
3728 (goto-char dedenter-pos
)
3729 (let* ((pairs '(("elif" "elif" "if")
3730 ("else" "if" "elif" "except" "for" "while")
3731 ("except" "except" "try")
3732 ("finally" "else" "except" "try")))
3733 (dedenter (match-string-no-properties 0))
3734 (possible-opening-blocks (cdr (assoc-string dedenter pairs
)))
3735 (collected-indentations)
3738 (while (python-nav--syntactically
3740 (re-search-backward (python-rx block-start
) nil t
))
3742 (let ((indentation (current-indentation)))
3743 (when (and (not (memq indentation collected-indentations
))
3744 (or (not collected-indentations
)
3745 (< indentation
(apply #'min collected-indentations
))))
3746 (setq collected-indentations
3747 (cons indentation collected-indentations
))
3748 (when (member (match-string-no-properties 0)
3749 possible-opening-blocks
)
3750 (setq opening-blocks
(cons (point) opening-blocks
))))
3751 (when (zerop indentation
)
3752 (throw 'exit nil
)))))
3754 (nreverse opening-blocks
))))))
3756 (define-obsolete-function-alias
3757 'python-info-closing-block-message
3758 'python-info-dedenter-opening-block-message
"24.4")
3760 (defun python-info-dedenter-opening-block-message ()
3761 "Message the first line of the block the current statement closes."
3762 (let ((point (python-info-dedenter-opening-block-position)))
3766 (message "Closes %s" (save-excursion
3769 (point) (line-end-position))))))))
3771 (defun python-info-dedenter-statement-p ()
3772 "Return point if current statement is a dedenter.
3773 Sets `match-data' to the keyword that starts the dedenter
3776 (python-nav-beginning-of-statement)
3777 (when (and (not (python-syntax-context-type))
3778 (looking-at (python-rx dedenter
)))
3781 (defun python-info-line-ends-backslash-p (&optional line-number
)
3782 "Return non-nil if current line ends with backslash.
3783 With optional argument LINE-NUMBER, check that line instead."
3788 (python-util-goto-line line-number
))
3789 (while (and (not (eobp))
3790 (goto-char (line-end-position))
3791 (python-syntax-context 'paren
)
3792 (not (equal (char-before (point)) ?
\\)))
3794 (when (equal (char-before) ?
\\)
3797 (defun python-info-beginning-of-backslash (&optional line-number
)
3798 "Return the point where the backslashed line start.
3799 Optional argument LINE-NUMBER forces the line number to check against."
3804 (python-util-goto-line line-number
))
3805 (when (python-info-line-ends-backslash-p)
3806 (while (save-excursion
3807 (goto-char (line-beginning-position))
3808 (python-syntax-context 'paren
))
3810 (back-to-indentation)
3813 (defun python-info-continuation-line-p ()
3814 "Check if current line is continuation of another.
3815 When current line is continuation of another return the point
3816 where the continued line ends."
3820 (let* ((context-type (progn
3821 (back-to-indentation)
3822 (python-syntax-context-type)))
3823 (line-start (line-number-at-pos))
3824 (context-start (when context-type
3825 (python-syntax-context context-type
))))
3826 (cond ((equal context-type
'paren
)
3827 ;; Lines inside a paren are always a continuation line
3828 ;; (except the first one).
3829 (python-util-forward-comment -
1)
3831 ((member context-type
'(string comment
))
3832 ;; move forward an roll again
3833 (goto-char context-start
)
3834 (python-util-forward-comment)
3835 (python-info-continuation-line-p))
3837 ;; Not within a paren, string or comment, the only way
3838 ;; we are dealing with a continuation line is that
3839 ;; previous line contains a backslash, and this can
3840 ;; only be the previous line from current
3841 (back-to-indentation)
3842 (python-util-forward-comment -
1)
3843 (when (and (equal (1- line-start
) (line-number-at-pos))
3844 (python-info-line-ends-backslash-p))
3845 (point-marker))))))))
3847 (defun python-info-block-continuation-line-p ()
3848 "Return non-nil if current line is a continuation of a block."
3850 (when (python-info-continuation-line-p)
3852 (back-to-indentation)
3853 (when (looking-at (python-rx block-start
))
3856 (defun python-info-assignment-continuation-line-p ()
3857 "Check if current line is a continuation of an assignment.
3858 When current line is continuation of another with an assignment
3859 return the point of the first non-blank character after the
3862 (when (python-info-continuation-line-p)
3864 (back-to-indentation)
3865 (when (and (not (looking-at (python-rx block-start
)))
3866 (and (re-search-forward (python-rx not-simple-operator
3868 not-simple-operator
)
3869 (line-end-position) t
)
3870 (not (python-syntax-context-type))))
3871 (skip-syntax-forward "\s")
3874 (defun python-info-looking-at-beginning-of-defun (&optional syntax-ppss
)
3875 "Check if point is at `beginning-of-defun' using SYNTAX-PPSS."
3876 (and (not (python-syntax-context-type (or syntax-ppss
(syntax-ppss))))
3878 (beginning-of-line 1)
3879 (looking-at python-nav-beginning-of-defun-regexp
))))
3881 (defun python-info-current-line-comment-p ()
3882 "Return non-nil if current line is a comment line."
3884 (or (char-after (+ (line-beginning-position) (current-indentation))) ?_
)
3887 (defun python-info-current-line-empty-p ()
3888 "Return non-nil if current line is empty, ignoring whitespace."
3890 (beginning-of-line 1)
3892 (python-rx line-start
(* whitespace
)
3893 (group (* not-newline
))
3894 (* whitespace
) line-end
))
3895 (string-equal "" (match-string-no-properties 1))))
3898 ;;; Utility functions
3900 (defun python-util-goto-line (line-number)
3901 "Move point to LINE-NUMBER."
3902 (goto-char (point-min))
3903 (forward-line (1- line-number
)))
3905 ;; Stolen from org-mode
3906 (defun python-util-clone-local-variables (from-buffer &optional regexp
)
3907 "Clone local variables from FROM-BUFFER.
3908 Optional argument REGEXP selects variables to clone and defaults
3912 (and (symbolp (car pair
))
3913 (string-match (or regexp
"^python-")
3914 (symbol-name (car pair
)))
3915 (set (make-local-variable (car pair
))
3917 (buffer-local-variables from-buffer
)))
3919 (defun python-util-forward-comment (&optional direction
)
3920 "Python mode specific version of `forward-comment'.
3921 Optional argument DIRECTION defines the direction to move to."
3922 (let ((comment-start (python-syntax-context 'comment
))
3923 (factor (if (< (or direction
0) 0)
3927 (goto-char comment-start
))
3928 (forward-comment factor
)))
3930 (defun python-util-popn (lst n
)
3931 "Return LST first N elements.
3932 N should be an integer, when negative its opposite is used.
3933 When N is bigger than the length of LST, the list is
3935 (let* ((n (min (abs n
)))
3941 (setq acc
(cons (car lst
) acc
)
3946 (defun python-util-strip-string (string)
3947 "Strip STRING whitespace and newlines from end and beginning."
3948 (replace-regexp-in-string
3949 (rx (or (: string-start
(* (any whitespace ?
\r ?
\n)))
3950 (: (* (any whitespace ?
\r ?
\n)) string-end
)))
3954 (defun python-util-valid-regexp-p (regexp)
3955 "Return non-nil if REGEXP is valid."
3956 (ignore-errors (string-match regexp
"") t
))
3959 (defun python-electric-pair-string-delimiter ()
3960 (when (and electric-pair-mode
3961 (memq last-command-event
'(?
\" ?
\'))
3963 (while (eq (char-before (- (point) count
)) last-command-event
)
3966 (eq (char-after) last-command-event
))
3967 (save-excursion (insert (make-string 2 last-command-event
)))))
3969 (defvar electric-indent-inhibit
)
3972 (define-derived-mode python-mode prog-mode
"Python"
3973 "Major mode for editing Python files.
3975 \\{python-mode-map}"
3976 (set (make-local-variable 'tab-width
) 8)
3977 (set (make-local-variable 'indent-tabs-mode
) nil
)
3979 (set (make-local-variable 'comment-start
) "# ")
3980 (set (make-local-variable 'comment-start-skip
) "#+\\s-*")
3982 (set (make-local-variable 'parse-sexp-lookup-properties
) t
)
3983 (set (make-local-variable 'parse-sexp-ignore-comments
) t
)
3985 (set (make-local-variable 'forward-sexp-function
)
3986 'python-nav-forward-sexp
)
3988 (set (make-local-variable 'font-lock-defaults
)
3989 '(python-font-lock-keywords nil nil nil nil
))
3991 (set (make-local-variable 'syntax-propertize-function
)
3992 python-syntax-propertize-function
)
3994 (set (make-local-variable 'indent-line-function
)
3995 #'python-indent-line-function
)
3996 (set (make-local-variable 'indent-region-function
) #'python-indent-region
)
3997 ;; Because indentation is not redundant, we cannot safely reindent code.
3998 (setq-local electric-indent-inhibit t
)
3999 (setq-local electric-indent-chars
(cons ?
: electric-indent-chars
))
4001 ;; Add """ ... """ pairing to electric-pair-mode.
4002 (add-hook 'post-self-insert-hook
4003 #'python-electric-pair-string-delimiter
'append t
)
4005 (set (make-local-variable 'paragraph-start
) "\\s-*$")
4006 (set (make-local-variable 'fill-paragraph-function
)
4007 #'python-fill-paragraph
)
4009 (set (make-local-variable 'beginning-of-defun-function
)
4010 #'python-nav-beginning-of-defun
)
4011 (set (make-local-variable 'end-of-defun-function
)
4012 #'python-nav-end-of-defun
)
4014 (add-hook 'completion-at-point-functions
4015 #'python-completion-complete-at-point nil
'local
)
4017 (add-hook 'post-self-insert-hook
4018 #'python-indent-post-self-insert-function
'append
'local
)
4020 (set (make-local-variable 'imenu-create-index-function
)
4021 #'python-imenu-create-index
)
4023 (set (make-local-variable 'add-log-current-defun-function
)
4024 #'python-info-current-defun
)
4026 (add-hook 'which-func-functions
#'python-info-current-defun
nil t
)
4028 (set (make-local-variable 'skeleton-further-elements
)
4030 (< '(backward-delete-char-untabify (min python-indent-offset
4032 (^
'(- (1+ (current-indentation))))))
4034 (set (make-local-variable 'eldoc-documentation-function
)
4035 #'python-eldoc-function
)
4037 (add-to-list 'hs-special-modes-alist
4038 `(python-mode "^\\s-*\\(?:def\\|class\\)\\>" nil
"#"
4040 (python-nav-end-of-defun)) nil
))
4042 (set (make-local-variable 'outline-regexp
)
4043 (python-rx (* space
) block-start
))
4044 (set (make-local-variable 'outline-heading-end-regexp
) ":[^\n]*\n")
4045 (set (make-local-variable 'outline-level
)
4047 "`outline-level' function for Python mode."
4048 (1+ (/ (current-indentation) python-indent-offset
))))
4050 (python-skeleton-add-menu-items)
4052 (make-local-variable 'python-shell-internal-buffer
)
4054 (when python-indent-guess-indent-offset
4055 (python-indent-guess-indent-offset)))
4062 ;; indent-tabs-mode: nil
4065 ;;; python.el ends here