1 ;;; python.el --- Python's flying circus support for Emacs -*- coding: utf-8 -*-
3 ;; Copyright (C) 2003-2012 Free Software Foundation, Inc.
5 ;; Author: Fabián E. Gallina <fabian@anue.biz>
6 ;; URL: https://github.com/fgallina/python.el
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 when inserting a
44 ;; colon the `python-indent-electric-colon' command is invoked and
45 ;; causes the current line to be 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', `python-nav-statement-start',
54 ;; `python-nav-statement-end', `python-nav-block-start' and
55 ;; `python-nav-block-end' are included but no bound to any key.
57 ;; Shell interaction: is provided and allows you to execute easily any
58 ;; block of code of your current buffer in an inferior Python process.
60 ;; Shell completion: hitting tab will try to complete the current
61 ;; word. Shell completion is implemented in a manner that if you
62 ;; change the `python-shell-interpreter' to any other (for example
63 ;; IPython) it should be easy to integrate another way to calculate
64 ;; completions. You just need to specify your custom
65 ;; `python-shell-completion-setup-code' and
66 ;; `python-shell-completion-string-code'.
68 ;; Here is a complete example of the settings you would use for
72 ;; python-shell-interpreter "ipython"
73 ;; python-shell-interpreter-args ""
74 ;; python-shell-prompt-regexp "In \\[[0-9]+\\]: "
75 ;; python-shell-prompt-output-regexp "Out\\[[0-9]+\\]: "
76 ;; python-shell-completion-setup-code
77 ;; "from IPython.core.completerlib import module_completion"
78 ;; python-shell-completion-module-string-code
79 ;; "';'.join(module_completion('''%s'''))\n"
80 ;; python-shell-completion-string-code
81 ;; "';'.join(get_ipython().Completer.all_completions('''%s'''))\n")
83 ;; For iPython 0.10 everything would be the same except for
84 ;; `python-shell-completion-string-code' and
85 ;; `python-shell-completion-module-string-code':
87 ;; (setq python-shell-completion-string-code
88 ;; "';'.join(__IP.complete('''%s'''))\n"
89 ;; python-shell-completion-module-string-code "")
91 ;; Unfortunately running iPython on Windows needs some more tweaking.
92 ;; The way you must set `python-shell-interpreter' and
93 ;; `python-shell-interpreter-args' is as follows:
96 ;; python-shell-interpreter "C:\\Python27\\python.exe"
97 ;; python-shell-interpreter-args
98 ;; "-i C:\\Python27\\Scripts\\ipython-script.py")
100 ;; That will spawn the iPython process correctly (Of course you need
101 ;; to modify the paths according to your system).
103 ;; Please note that the default completion system depends on the
104 ;; readline module, so if you are using some Operating System that
105 ;; bundles Python without it (like Windows) just install the
106 ;; pyreadline from http://ipython.scipy.org/moin/PyReadline/Intro and
107 ;; you should be good to go.
109 ;; Shell virtualenv support: The shell also contains support for
110 ;; virtualenvs and other special environment modifications thanks to
111 ;; `python-shell-process-environment' and `python-shell-exec-path'.
112 ;; These two variables allows you to modify execution paths and
113 ;; environment variables to make easy for you to setup virtualenv rules
114 ;; or behavior modifications when running shells. Here is an example
115 ;; of how to make shell processes to be run using the /path/to/env/
118 ;; (setq python-shell-process-environment
120 ;; (format "PATH=%s" (mapconcat
123 ;; (cons (getenv "PATH")
124 ;; '("/path/to/env/bin/")))
126 ;; "VIRTUAL_ENV=/path/to/env/"))
127 ;; (python-shell-exec-path . ("/path/to/env/bin/"))
129 ;; Since the above is cumbersome and can be programmatically
130 ;; calculated, the variable `python-shell-virtualenv-path' is
131 ;; provided. When this variable is set with the path of the
132 ;; virtualenv to use, `process-environment' and `exec-path' get proper
133 ;; values in order to run shells inside the specified virtualenv. So
134 ;; the following will achieve the same as the previous example:
136 ;; (setq python-shell-virtualenv-path "/path/to/env/")
138 ;; Also the `python-shell-extra-pythonpaths' variable have been
139 ;; introduced as simple way of adding paths to the PYTHONPATH without
140 ;; affecting existing values.
142 ;; Pdb tracking: when you execute a block of code that contains some
143 ;; call to pdb (or ipdb) it will prompt the block of code and will
144 ;; follow the execution of pdb marking the current line with an arrow.
146 ;; Symbol completion: you can complete the symbol at point. It uses
147 ;; the shell completion in background so you should run
148 ;; `python-shell-send-buffer' from time to time to get better results.
150 ;; Skeletons: 6 skeletons are provided for simple inserting of class,
151 ;; def, for, if, try and while. These skeletons are integrated with
152 ;; dabbrev. If you have `dabbrev-mode' activated and
153 ;; `python-skeleton-autoinsert' is set to t, then whenever you type
154 ;; the name of any of those defined and hit SPC, they will be
155 ;; automatically expanded.
157 ;; FFAP: You can find the filename for a given module when using ffap
158 ;; out of the box. This feature needs an inferior python shell
161 ;; Code check: Check the current file for errors with `python-check'
162 ;; using the program defined in `python-check-command'.
164 ;; Eldoc: returns documentation for object at point by using the
165 ;; inferior python subprocess to inspect its documentation. As you
166 ;; might guessed you should run `python-shell-send-buffer' from time
167 ;; to time to get better results too.
169 ;; imenu: This mode supports imenu in its most basic form, letting it
170 ;; build the necessary alist via `imenu-default-create-index-function'
171 ;; by having set `imenu-extract-index-name-function' to
172 ;; `python-info-current-defun'.
174 ;; If you used python-mode.el you probably will miss auto-indentation
175 ;; when inserting newlines. To achieve the same behavior you have
178 ;; 1) Use GNU/Emacs' standard binding for `newline-and-indent': C-j.
180 ;; 2) Add the following hook in your .emacs:
182 ;; (add-hook 'python-mode-hook
184 ;; (define-key python-mode-map "\C-m" 'newline-and-indent)))
186 ;; I'd recommend the first one since you'll get the same behavior for
187 ;; all modes out-of-the-box.
191 ;; Add this to your .emacs:
193 ;; (add-to-list 'load-path "/folder/containing/file")
200 (require 'ansi-color)
205 ;; Avoid compiler warnings
206 (defvar view-return-to-alist)
207 (defvar compilation-error-regexp-alist)
208 (defvar outline-heading-end-regexp))
210 (autoload 'comint-mode "comint")
213 (add-to-list 'auto-mode-alist (cons (purecopy "\\.py\\'") 'python-mode))
215 (add-to-list 'interpreter-mode-alist (cons (purecopy "python") 'python-mode))
218 "Python Language's flying circus support for Emacs."
221 :link '(emacs-commentary-link "python"))
226 (defvar python-mode-map
227 (let ((map (make-sparse-keymap)))
229 (substitute-key-definition 'backward-sentence
230 'python-nav-backward-block
232 (substitute-key-definition 'forward-sentence
233 'python-nav-forward-block
235 (define-key map "\C-c\C-j" 'imenu)
237 (define-key map "\177" 'python-indent-dedent-line-backspace)
238 (define-key map (kbd "<backtab>") 'python-indent-dedent-line)
239 (define-key map "\C-c<" 'python-indent-shift-left)
240 (define-key map "\C-c>" 'python-indent-shift-right)
241 (define-key map ":" 'python-indent-electric-colon)
243 (define-key map "\C-c\C-tc" 'python-skeleton-class)
244 (define-key map "\C-c\C-td" 'python-skeleton-def)
245 (define-key map "\C-c\C-tf" 'python-skeleton-for)
246 (define-key map "\C-c\C-ti" 'python-skeleton-if)
247 (define-key map "\C-c\C-tt" 'python-skeleton-try)
248 (define-key map "\C-c\C-tw" 'python-skeleton-while)
250 (define-key map "\C-c\C-s" 'python-shell-send-string)
251 (define-key map "\C-c\C-r" 'python-shell-send-region)
252 (define-key map "\C-\M-x" 'python-shell-send-defun)
253 (define-key map "\C-c\C-c" 'python-shell-send-buffer)
254 (define-key map "\C-c\C-l" 'python-shell-send-file)
255 (define-key map "\C-c\C-z" 'python-shell-switch-to-shell)
256 ;; Some util commands
257 (define-key map "\C-c\C-v" 'python-check)
258 (define-key map "\C-c\C-f" 'python-eldoc-at-point)
260 (substitute-key-definition 'complete-symbol 'completion-at-point
262 (easy-menu-define python-menu map "Python Mode menu"
264 :help "Python-specific Features"
265 ["Shift region left" python-indent-shift-left :active mark-active
266 :help "Shift region left by a single indentation step"]
267 ["Shift region right" python-indent-shift-right :active mark-active
268 :help "Shift region right by a single indentation step"]
270 ["Start of def/class" beginning-of-defun
271 :help "Go to start of outermost definition around point"]
272 ["End of def/class" end-of-defun
273 :help "Go to end of definition around point"]
274 ["Mark def/class" mark-defun
275 :help "Mark outermost definition around point"]
276 ["Jump to def/class" imenu
277 :help "Jump to a class or function definition"]
281 ["Start interpreter" run-python
282 :help "Run inferior Python process in a separate buffer"]
283 ["Switch to shell" python-shell-switch-to-shell
284 :help "Switch to running inferior Python process"]
285 ["Eval string" python-shell-send-string
286 :help "Eval string in inferior Python session"]
287 ["Eval buffer" python-shell-send-buffer
288 :help "Eval buffer in inferior Python session"]
289 ["Eval region" python-shell-send-region
290 :help "Eval region in inferior Python session"]
291 ["Eval defun" python-shell-send-defun
292 :help "Eval defun in inferior Python session"]
293 ["Eval file" python-shell-send-file
294 :help "Eval file in inferior Python session"]
295 ["Debugger" pdb :help "Run pdb under GUD"]
297 ["Check file" python-check
298 :help "Check file for errors"]
299 ["Help on symbol" python-eldoc-at-point
300 :help "Get help on symbol at point"]
301 ["Complete symbol" completion-at-point
302 :help "Complete symbol before point"]))
304 "Keymap for `python-mode'.")
307 ;;; Python specialized rx
310 (defconst python-rx-constituents
311 `((block-start . ,(rx symbol-start
312 (or "def" "class" "if" "elif" "else" "try"
313 "except" "finally" "for" "while" "with")
315 (decorator . ,(rx line-start (* space) ?@ (any letter ?_)
317 (defun . ,(rx symbol-start (or "def" "class") symbol-end))
318 (if-name-main . ,(rx line-start "if" (+ space) "__name__"
319 (+ space) "==" (+ space)
320 (any ?' ?\") "__main__" (any ?' ?\")
322 (symbol-name . ,(rx (any letter ?_) (* (any word ?_))))
323 (open-paren . ,(rx (or "{" "[" "(")))
324 (close-paren . ,(rx (or "}" "]" ")")))
325 (simple-operator . ,(rx (any ?+ ?- ?/ ?& ?^ ?~ ?| ?* ?< ?> ?= ?%)))
326 ;; FIXME: rx should support (not simple-operator).
327 (not-simple-operator . ,(rx
329 (any ?+ ?- ?/ ?& ?^ ?~ ?| ?* ?< ?> ?= ?%))))
330 ;; FIXME: Use regexp-opt.
331 (operator . ,(rx (or "+" "-" "/" "&" "^" "~" "|" "*" "<" ">"
332 "=" "%" "**" "//" "<<" ">>" "<=" "!="
333 "==" ">=" "is" "not")))
334 ;; FIXME: Use regexp-opt.
335 (assignment-operator . ,(rx (or "=" "+=" "-=" "*=" "/=" "//=" "%=" "**="
336 ">>=" "<<=" "&=" "^=" "|="))))
337 "Additional Python specific sexps for `python-rx'"))
339 (defmacro python-rx (&rest regexps)
340 "Python mode specialized rx macro.
341 This variant of `rx' supports common python named REGEXPS."
342 (let ((rx-constituents (append python-rx-constituents rx-constituents)))
343 (cond ((null regexps)
346 (rx-to-string `(and ,@regexps) t))
348 (rx-to-string (car regexps) t)))))
351 ;;; Font-lock and syntax
352 (defvar python-font-lock-keywords
356 "and" "del" "from" "not" "while" "as" "elif" "global" "or" "with"
357 "assert" "else" "if" "pass" "yield" "break" "except" "import" "class"
358 "in" "raise" "continue" "finally" "is" "return" "def" "for" "lambda"
363 ;; False, None, and True are listed as keywords on the Python 3
364 ;; documentation, but since they also qualify as constants they are
365 ;; fontified like that in order to keep font-lock consistent between
372 (,(rx symbol-start "def" (1+ space) (group (1+ (or word ?_))))
373 (1 font-lock-function-name-face))
375 (,(rx symbol-start "class" (1+ space) (group (1+ (or word ?_))))
376 (1 font-lock-type-face))
380 "Ellipsis" "False" "None" "NotImplemented" "True" "__debug__"
381 ;; copyright, license, credits, quit and exit are added by the site
382 ;; module and they are not intended to be used in programs
383 "copyright" "credits" "exit" "license" "quit")
384 symbol-end) . font-lock-constant-face)
386 (,(rx line-start (* (any " \t")) (group "@" (1+ (or word ?_))
387 (0+ "." (1+ (or word ?_)))))
388 (1 font-lock-type-face))
389 ;; Builtin Exceptions
392 "ArithmeticError" "AssertionError" "AttributeError" "BaseException"
393 "DeprecationWarning" "EOFError" "EnvironmentError" "Exception"
394 "FloatingPointError" "FutureWarning" "GeneratorExit" "IOError"
395 "ImportError" "ImportWarning" "IndexError" "KeyError"
396 "KeyboardInterrupt" "LookupError" "MemoryError" "NameError"
397 "NotImplementedError" "OSError" "OverflowError"
398 "PendingDeprecationWarning" "ReferenceError" "RuntimeError"
399 "RuntimeWarning" "StopIteration" "SyntaxError" "SyntaxWarning"
400 "SystemError" "SystemExit" "TypeError" "UnboundLocalError"
401 "UnicodeDecodeError" "UnicodeEncodeError" "UnicodeError"
402 "UnicodeTranslateError" "UnicodeWarning" "UserWarning" "VMSError"
403 "ValueError" "Warning" "WindowsError" "ZeroDivisionError"
407 "BufferError" "BytesWarning" "IndentationError" "ResourceWarning"
409 symbol-end) . font-lock-type-face)
413 "abs" "all" "any" "bin" "bool" "callable" "chr" "classmethod"
414 "compile" "complex" "delattr" "dict" "dir" "divmod" "enumerate"
415 "eval" "filter" "float" "format" "frozenset" "getattr" "globals"
416 "hasattr" "hash" "help" "hex" "id" "input" "int" "isinstance"
417 "issubclass" "iter" "len" "list" "locals" "map" "max" "memoryview"
418 "min" "next" "object" "oct" "open" "ord" "pow" "print" "property"
419 "range" "repr" "reversed" "round" "set" "setattr" "slice" "sorted"
420 "staticmethod" "str" "sum" "super" "tuple" "type" "vars" "zip"
423 "basestring" "cmp" "execfile" "file" "long" "raw_input" "reduce"
424 "reload" "unichr" "unicode" "xrange" "apply" "buffer" "coerce"
427 "ascii" "bytearray" "bytes" "exec"
429 "__all__" "__doc__" "__name__" "__package__")
430 symbol-end) . font-lock-builtin-face)
432 ;; support for a = b = c = 5
434 (let ((re (python-rx (group (+ (any word ?. ?_)))
435 (? ?\[ (+ (not (any ?\]))) ?\]) (* space)
436 assignment-operator)))
437 (when (re-search-forward re limit t)
438 (while (and (python-info-ppss-context 'paren)
439 (re-search-forward re limit t)))
440 (if (and (not (python-info-ppss-context 'paren))
441 (not (equal (char-after (point-marker)) ?=)))
443 (set-match-data nil)))))
444 (1 font-lock-variable-name-face nil nil))
445 ;; support for a, b, c = (1, 2, 3)
447 (let ((re (python-rx (group (+ (any word ?. ?_))) (* space)
448 (* ?, (* space) (+ (any word ?. ?_)) (* space))
449 ?, (* space) (+ (any word ?. ?_)) (* space)
450 assignment-operator)))
451 (when (and (re-search-forward re limit t)
452 (goto-char (nth 3 (match-data))))
453 (while (and (python-info-ppss-context 'paren)
454 (re-search-forward re limit t))
455 (goto-char (nth 3 (match-data))))
456 (if (not (python-info-ppss-context 'paren))
458 (set-match-data nil)))))
459 (1 font-lock-variable-name-face nil nil))))
461 (defconst python-syntax-propertize-function
462 ;; Make outer chars of matching triple-quote sequences into generic
463 ;; string delimiters. Fixme: Is there a better way?
464 ;; First avoid a sequence preceded by an odd number of backslashes.
465 (syntax-propertize-rules
466 (;; ¡Backrefs don't work in syntax-propertize-rules!
467 (concat "\\(?:\\([RUru]\\)[Rr]?\\|^\\|[^\\]\\(?:\\\\.\\)*\\)" ;Prefix.
468 "\\(?:\\('\\)'\\('\\)\\|\\(?2:\"\\)\"\\(?3:\"\\)\\)")
469 (3 (ignore (python-quote-syntax))))))
471 (defun python-quote-syntax ()
472 "Put `syntax-table' property correctly on triple quote.
473 Used for syntactic keywords. N is the match number (1, 2 or 3)."
474 ;; Given a triple quote, we have to check the context to know
475 ;; whether this is an opening or closing triple or whether it's
476 ;; quoted anyhow, and should be ignored. (For that we need to do
477 ;; the same job as `syntax-ppss' to be correct and it seems to be OK
478 ;; to use it here despite initial worries.) We also have to sort
479 ;; out a possible prefix -- well, we don't _have_ to, but I think it
480 ;; should be treated as part of the string.
483 ;; ur"""ar""" x='"' # """
486 ;; x '"""' x """ \"""" x
488 (goto-char (match-beginning 0))
489 (let ((syntax (save-match-data (syntax-ppss))))
491 ((eq t (nth 3 syntax)) ; after unclosed fence
492 ;; Consider property for the last char if in a fenced string.
493 (goto-char (nth 8 syntax)) ; fence position
494 (skip-chars-forward "uUrR") ; skip any prefix
495 ;; Is it a matching sequence?
496 (if (eq (char-after) (char-after (match-beginning 2)))
497 (put-text-property (match-beginning 3) (match-end 3)
498 'syntax-table (string-to-syntax "|"))))
500 ;; Consider property for initial char, accounting for prefixes.
501 (put-text-property (match-beginning 1) (match-end 1)
502 'syntax-table (string-to-syntax "|")))
504 ;; Consider property for initial char, accounting for prefixes.
505 (put-text-property (match-beginning 2) (match-end 2)
506 'syntax-table (string-to-syntax "|"))))
509 (defvar python-mode-syntax-table
510 (let ((table (make-syntax-table)))
511 ;; Give punctuation syntax to ASCII that normally has symbol
512 ;; syntax or has word syntax and isn't a letter.
513 (let ((symbol (string-to-syntax "_"))
514 (sst (standard-syntax-table)))
517 (if (equal symbol (aref sst i))
518 (modify-syntax-entry i "." table)))))
519 (modify-syntax-entry ?$ "." table)
520 (modify-syntax-entry ?% "." table)
522 (modify-syntax-entry ?# "<" table)
523 (modify-syntax-entry ?\n ">" table)
524 (modify-syntax-entry ?' "\"" table)
525 (modify-syntax-entry ?` "$" table)
527 "Syntax table for Python files.")
529 (defvar python-dotty-syntax-table
530 (let ((table (make-syntax-table python-mode-syntax-table)))
531 (modify-syntax-entry ?. "w" table)
532 (modify-syntax-entry ?_ "w" table)
534 "Dotty syntax table for Python files.
535 It makes underscores and dots word constituent chars.")
540 (defcustom python-indent-offset 4
541 "Default indentation offset for Python."
546 (defcustom python-indent-guess-indent-offset t
547 "Non-nil tells Python mode to guess `python-indent-offset' value."
552 (define-obsolete-variable-alias
553 'python-indent 'python-indent-offset "24.2")
555 (define-obsolete-variable-alias
556 'python-guess-indent 'python-indent-guess-indent-offset "24.2")
558 (defvar python-indent-current-level 0
559 "Current indentation level `python-indent-line-function' is using.")
561 (defvar python-indent-levels '(0)
562 "Levels of indentation available for `python-indent-line-function'.")
564 (defvar python-indent-dedenters '("else" "elif" "except" "finally")
565 "List of words that should be dedented.
566 These make `python-indent-calculate-indentation' subtract the value of
567 `python-indent-offset'.")
569 (defun python-indent-guess-indent-offset ()
570 "Guess and set `python-indent-offset' for the current buffer."
575 (goto-char (point-min))
577 (while (and (not block-end)
579 (python-rx line-start block-start) nil t))
581 (not (python-info-ppss-context-type))
583 (goto-char (line-end-position))
584 (python-util-forward-comment -1)
585 (if (equal (char-before) ?:)
588 (when (python-info-block-continuation-line-p)
589 (while (and (python-info-continuation-line-p)
592 (python-util-forward-comment -1)
593 (when (equal (char-before) ?:)
595 (setq block-end (point-marker))))
598 (goto-char block-end)
599 (python-util-forward-comment)
600 (current-indentation))))
602 (setq python-indent-offset indentation)
603 (message "Can't guess python-indent-offset, using defaults: %s"
604 python-indent-offset)))))))
606 (defun python-indent-context ()
607 "Get information on indentation context.
608 Context information is returned with a cons with the form:
611 Where status can be any of the following symbols:
612 * inside-paren: If point in between (), {} or []
613 * inside-string: If point is inside a string
614 * after-backslash: Previous line ends in a backslash
615 * after-beginning-of-block: Point is after beginning of block
616 * after-line: Point is after normal line
617 * no-indent: Point is at beginning of buffer or other special case
618 START is the buffer position where the sexp starts."
621 (let ((ppss (save-excursion (beginning-of-line) (syntax-ppss)))
625 ;; Beginning of buffer
627 (goto-char (line-beginning-position))
631 ((setq start (python-info-ppss-context 'paren ppss))
634 ((setq start (python-info-ppss-context 'string ppss))
637 ((setq start (when (not (or (python-info-ppss-context 'string ppss)
638 (python-info-ppss-context 'comment ppss)))
639 (let ((line-beg-pos (line-beginning-position)))
640 (when (python-info-line-ends-backslash-p
642 (- line-beg-pos 2)))))
644 ;; After beginning of block
645 ((setq start (save-excursion
647 (back-to-indentation)
648 (python-util-forward-comment -1)
649 (equal (char-before) ?:))
650 ;; Move to the first block start that's not in within
651 ;; a string, comment or paren and that's not a
652 ;; continuation line.
653 (while (and (re-search-backward
654 (python-rx block-start) nil t)
656 (python-info-ppss-context 'string)
657 (python-info-ppss-context 'comment)
658 (python-info-ppss-context 'paren)
659 (python-info-continuation-line-p))))
660 (when (looking-at (python-rx block-start))
662 'after-beginning-of-block)
664 ((setq start (save-excursion
665 (back-to-indentation)
666 (python-util-forward-comment -1)
667 (python-nav-statement-start)
674 (defun python-indent-calculate-indentation ()
675 "Calculate correct indentation offset for the current line."
676 (let* ((indentation-context (python-indent-context))
677 (context-status (car indentation-context))
678 (context-start (cdr indentation-context)))
684 ;; When point is after beginning of block just add one level
685 ;; of indentation relative to the context-start
686 ('after-beginning-of-block
687 (goto-char context-start)
688 (+ (current-indentation) python-indent-offset))
689 ;; When after a simple line just use previous line
690 ;; indentation, in the case current line starts with a
691 ;; `python-indent-dedenters' de-indent one level.
695 (goto-char context-start)
696 (current-indentation))
698 (back-to-indentation)
699 (looking-at (regexp-opt python-indent-dedenters)))
702 ;; When inside of a string, do nothing. just use the current
703 ;; indentation. XXX: perhaps it would be a good idea to
704 ;; invoke standard text indentation here
706 (goto-char context-start)
707 (current-indentation))
708 ;; After backslash we have several possibilities.
711 ;; Check if current line is a dot continuation. For this
712 ;; the current line must start with a dot and previous
713 ;; line must contain a dot too.
715 (back-to-indentation)
716 (when (looking-at "\\.")
717 ;; If after moving one line back point is inside a paren it
718 ;; needs to move back until it's not anymore
722 (python-info-ppss-context 'paren))))
723 (goto-char (line-end-position))
724 (while (and (re-search-backward
725 "\\." (line-beginning-position) t)
726 (or (python-info-ppss-context 'comment)
727 (python-info-ppss-context 'string)
728 (python-info-ppss-context 'paren))))
729 (if (and (looking-at "\\.")
730 (not (or (python-info-ppss-context 'comment)
731 (python-info-ppss-context 'string)
732 (python-info-ppss-context 'paren))))
733 ;; The indentation is the same column of the
734 ;; first matching dot that's not inside a
735 ;; comment, a string or a paren
737 ;; No dot found on previous line, just add another
738 ;; indentation level.
739 (+ (current-indentation) python-indent-offset)))))
740 ;; Check if prev line is a block continuation
741 ((let ((block-continuation-start
742 (python-info-block-continuation-line-p)))
743 (when block-continuation-start
744 ;; If block-continuation-start is set jump to that
745 ;; marker and use first column after the block start
746 ;; as indentation value.
747 (goto-char block-continuation-start)
749 (python-rx block-start (* space))
750 (line-end-position) t)
752 ;; Check if current line is an assignment continuation
753 ((let ((assignment-continuation-start
754 (python-info-assignment-continuation-line-p)))
755 (when assignment-continuation-start
756 ;; If assignment-continuation is set jump to that
757 ;; marker and use first column after the assignment
758 ;; operator as indentation value.
759 (goto-char assignment-continuation-start)
763 (goto-char (python-info-beginning-of-backslash))
768 (or (python-info-beginning-of-backslash) (point)))
769 (python-info-line-ends-backslash-p)))
770 ;; The two previous lines ended in a backslash so we must
771 ;; respect previous line indentation.
772 (current-indentation)
773 ;; What happens here is that we are dealing with the second
774 ;; line of a backslash continuation, in that case we just going
775 ;; to add one indentation level.
776 (+ (current-indentation) python-indent-offset)))))
777 ;; When inside a paren there's a need to handle nesting
781 ;; If current line closes the outermost open paren use the
782 ;; current indentation of the context-start line.
784 (skip-syntax-forward "\s" (line-end-position))
785 (when (and (looking-at (regexp-opt '(")" "]" "}")))
788 (not (python-info-ppss-context 'paren))))
789 (goto-char context-start)
790 (current-indentation))))
791 ;; If open paren is contained on a line by itself add another
792 ;; indentation level, else look for the first word after the
793 ;; opening paren and use it's column position as indentation
795 ((let* ((content-starts-in-newline)
798 (if (setq content-starts-in-newline
800 (goto-char context-start)
804 (line-beginning-position)
806 (python-util-forward-comment))
808 (+ (current-indentation) python-indent-offset)
812 ;; If current line closes a nested open paren de-indent one
815 (back-to-indentation)
816 (looking-at (regexp-opt '(")" "]" "}"))))
817 (- indent python-indent-offset))
818 ;; If the line of the opening paren that wraps the current
819 ;; line starts a block add another level of indentation to
820 ;; follow new pep8 recommendation. See: http://ur1.ca/5rojx
822 (when (and content-starts-in-newline
824 (goto-char context-start)
825 (back-to-indentation)
826 (looking-at (python-rx block-start))))
827 (+ indent python-indent-offset))))
830 (defun python-indent-calculate-levels ()
831 "Calculate `python-indent-levels' and reset `python-indent-current-level'."
832 (let* ((indentation (python-indent-calculate-indentation))
833 (remainder (% indentation python-indent-offset))
834 (steps (/ (- indentation remainder) python-indent-offset)))
835 (setq python-indent-levels (list 0))
836 (dotimes (step steps)
837 (push (* python-indent-offset (1+ step)) python-indent-levels))
838 (when (not (eq 0 remainder))
839 (push (+ (* python-indent-offset steps) remainder) python-indent-levels))
840 (setq python-indent-levels (nreverse python-indent-levels))
841 (setq python-indent-current-level (1- (length python-indent-levels)))))
843 (defun python-indent-toggle-levels ()
844 "Toggle `python-indent-current-level' over `python-indent-levels'."
845 (setq python-indent-current-level (1- python-indent-current-level))
846 (when (< python-indent-current-level 0)
847 (setq python-indent-current-level (1- (length python-indent-levels)))))
849 (defun python-indent-line (&optional force-toggle)
850 "Internal implementation of `python-indent-line-function'.
851 Uses the offset calculated in
852 `python-indent-calculate-indentation' and available levels
853 indicated by the variable `python-indent-levels' to set the
856 When the variable `last-command' is equal to
857 `indent-for-tab-command' or FORCE-TOGGLE is non-nil it cycles
858 levels indicated in the variable `python-indent-levels' by
859 setting the current level in the variable
860 `python-indent-current-level'.
862 When the variable `last-command' is not equal to
863 `indent-for-tab-command' and FORCE-TOGGLE is nil it calculates
864 possible indentation levels and saves it in the variable
865 `python-indent-levels'. Afterwards it sets the variable
866 `python-indent-current-level' correctly so offset is equal
867 to (`nth' `python-indent-current-level' `python-indent-levels')"
868 (if (or (and (eq this-command 'indent-for-tab-command)
869 (eq last-command this-command))
871 (if (not (equal python-indent-levels '(0)))
872 (python-indent-toggle-levels)
873 (python-indent-calculate-levels))
874 (python-indent-calculate-levels))
876 (delete-horizontal-space)
877 (indent-to (nth python-indent-current-level python-indent-levels))
878 (python-info-closing-block-message))
880 (defun python-indent-line-function ()
881 "`indent-line-function' for Python mode.
882 See `python-indent-line' for details."
883 (python-indent-line))
885 (defun python-indent-dedent-line ()
886 "De-indent current line."
888 (when (and (not (or (python-info-ppss-context 'string)
889 (python-info-ppss-context 'comment)))
890 (<= (point-marker) (save-excursion
891 (back-to-indentation)
893 (> (current-column) 0))
894 (python-indent-line t)
897 (defun python-indent-dedent-line-backspace (arg)
898 "De-indent current line.
899 Argument ARG is passed to `backward-delete-char-untabify' when
900 point is not in between the indentation."
902 (when (not (python-indent-dedent-line))
903 (backward-delete-char-untabify arg)))
904 (put 'python-indent-dedent-line-backspace 'delete-selection 'supersede)
906 (defun python-indent-region (start end)
907 "Indent a python region automagically.
909 Called from a program, START and END specify the region to indent."
910 (let ((deactivate-mark nil))
913 (setq end (point-marker))
915 (or (bolp) (forward-line 1))
916 (while (< (point) end)
917 (or (and (bolp) (eolp))
920 (back-to-indentation)
921 (setq word (current-word))
925 (delete-horizontal-space)
926 (indent-to (python-indent-calculate-indentation)))))
928 (move-marker end nil))))
930 (defun python-indent-shift-left (start end &optional count)
931 "Shift lines contained in region START END by COUNT columns to the left.
932 COUNT defaults to `python-indent-offset'. If region isn't
933 active, the current line is shifted. The shifted region includes
934 the lines in which START and END lie. An error is signaled if
935 any lines in the region are indented less than COUNT columns."
938 (list (region-beginning) (region-end) current-prefix-arg)
939 (list (line-beginning-position) (line-end-position) current-prefix-arg)))
941 (setq count (prefix-numeric-value count))
942 (setq count python-indent-offset))
944 (let ((deactivate-mark nil))
947 (while (< (point) end)
948 (if (and (< (current-indentation) count)
949 (not (looking-at "[ \t]*$")))
950 (error "Can't shift all lines enough"))
952 (indent-rigidly start end (- count))))))
954 (add-to-list 'debug-ignored-errors "^Can't shift all lines enough")
956 (defun python-indent-shift-right (start end &optional count)
957 "Shift lines contained in region START END by COUNT columns to the left.
958 COUNT defaults to `python-indent-offset'. If region isn't
959 active, the current line is shifted. The shifted region includes
960 the lines in which START and END lie."
963 (list (region-beginning) (region-end) current-prefix-arg)
964 (list (line-beginning-position) (line-end-position) current-prefix-arg)))
965 (let ((deactivate-mark nil))
967 (setq count (prefix-numeric-value count))
968 (setq count python-indent-offset))
969 (indent-rigidly start end count)))
971 (defun python-indent-electric-colon (arg)
972 "Insert a colon and maybe de-indent the current line.
973 With numeric ARG, just insert that many colons. With
974 \\[universal-argument], just insert a single colon."
976 (self-insert-command (if (not (integerp arg)) 1 arg))
979 (not (equal ?: (char-after (- (point-marker) 2))))
980 (not (or (python-info-ppss-context 'string)
981 (python-info-ppss-context 'comment))))
982 (let ((indentation (current-indentation))
983 (calculated-indentation (python-indent-calculate-indentation)))
984 (python-info-closing-block-message)
985 (when (> indentation calculated-indentation)
987 (indent-line-to calculated-indentation)
988 (when (not (python-info-closing-block-message))
989 (indent-line-to indentation)))))))
990 (put 'python-indent-electric-colon 'delete-selection t)
992 (defun python-indent-post-self-insert-function ()
993 "Adjust closing paren line indentation after a char is added.
994 This function is intended to be added to the
995 `post-self-insert-hook.' If a line renders a paren alone, after
996 adding a char before it, the line will be re-indented
997 automatically if needed."
998 (when (and (eq (char-before) last-command-event)
1000 (memq (char-after) '(?\) ?\] ?\})))
1002 (goto-char (line-beginning-position))
1003 ;; If after going to the beginning of line the point
1004 ;; is still inside a paren it's ok to do the trick
1005 (when (python-info-ppss-context 'paren)
1006 (let ((indentation (python-indent-calculate-indentation)))
1007 (when (< (current-indentation) indentation)
1008 (indent-line-to indentation)))))))
1013 (defvar python-nav-beginning-of-defun-regexp
1014 (python-rx line-start (* space) defun (+ space) (group symbol-name))
1015 "Regexp matching class or function definition.
1016 The name of the defun should be grouped so it can be retrieved
1017 via `match-string'.")
1019 (defun python-nav-beginning-of-defun (&optional arg)
1020 "Move point to `beginning-of-defun'.
1021 With positive ARG move search backwards. With negative do the
1022 same but forward. When ARG is nil or 0 defaults to 1. This is
1023 the main part of `python-beginning-of-defun-function'. Return
1024 non-nil if point is moved to `beginning-of-defun'."
1025 (when (or (null arg) (= arg 0)) (setq arg 1))
1026 (let* ((re-search-fn (if (> arg 0)
1027 #'re-search-backward
1028 #'re-search-forward))
1029 (line-beg-pos (line-beginning-position))
1030 (line-content-start (+ line-beg-pos (current-indentation)))
1031 (pos (point-marker))
1034 (when (and (< arg 0)
1035 (python-info-looking-at-beginning-of-defun))
1037 (while (and (funcall re-search-fn
1038 python-nav-beginning-of-defun-regexp nil t)
1039 (python-info-ppss-context-type)))
1040 (and (python-info-looking-at-beginning-of-defun)
1041 (or (not (= (line-number-at-pos pos)
1042 (line-number-at-pos)))
1043 (and (>= (point) line-beg-pos)
1044 (<= (point) line-content-start)
1045 (> pos line-content-start)))))))
1047 (or (beginning-of-line 1) t)
1048 (and (goto-char pos) nil))))
1050 (defun python-beginning-of-defun-function (&optional arg)
1051 "Move point to the beginning of def or class.
1052 With positive ARG move that number of functions backwards. With
1053 negative do the same but forward. When ARG is nil or 0 defaults
1054 to 1. Return non-nil if point is moved to `beginning-of-defun'."
1055 (when (or (null arg) (= arg 0)) (setq arg 1))
1057 (cond ((and (eq this-command 'mark-defun)
1058 (python-info-looking-at-beginning-of-defun)))
1060 (dotimes (i (if (> arg 0) arg (- arg)))
1061 (when (and (python-nav-beginning-of-defun arg)
1066 (defun python-end-of-defun-function ()
1067 "Move point to the end of def or class.
1068 Returns nil if point is not in a def or class."
1070 (let ((beg-defun-indent))
1071 (when (or (python-info-looking-at-beginning-of-defun)
1072 (python-beginning-of-defun-function 1)
1073 (python-beginning-of-defun-function -1))
1074 (setq beg-defun-indent (current-indentation))
1076 ;; Go as forward as possible
1078 (python-nav-beginning-of-defun -1)
1079 (and (goto-char (point-max)) nil))
1080 (> (current-indentation) beg-defun-indent)))
1081 (beginning-of-line 1)
1082 ;; Go as backwards as possible
1083 (while (and (forward-line -1)
1085 (or (not (current-word))
1086 (equal (char-after (+ (point) (current-indentation))) ?#)
1087 (<= (current-indentation) beg-defun-indent)
1088 (looking-at (python-rx decorator))
1089 (python-info-ppss-context-type))))
1091 ;; If point falls inside a paren or string context the point is
1092 ;; forwarded at the end of it (or end of buffer if its not closed)
1093 (let ((context-type (python-info-ppss-context-type)))
1094 (when (memq context-type '(paren string))
1096 (while (and (not (eobp))
1097 (python-info-ppss-context-type))
1098 (forward-line 1)))))))
1100 (defun python-nav-statement-start ()
1101 "Move to start of current statement."
1103 (while (and (or (back-to-indentation) t)
1108 (python-info-line-ends-backslash-p))
1109 (python-info-ppss-context 'string)
1110 (python-info-ppss-context 'paren))
1111 (forward-line -1)))))
1113 (defun python-nav-statement-end ()
1114 "Move to end of current statement."
1116 (while (and (goto-char (line-end-position))
1119 (python-info-line-ends-backslash-p)
1120 (python-info-ppss-context 'string)
1121 (python-info-ppss-context 'paren))
1122 (forward-line 1)))))
1124 (defun python-nav-backward-statement (&optional arg)
1125 "Move backward to previous statement.
1126 With ARG, repeat. See `python-nav-forward-statement'."
1128 (or arg (setq arg 1))
1129 (python-nav-forward-statement (- arg)))
1131 (defun python-nav-forward-statement (&optional arg)
1132 "Move forward to next statement.
1133 With ARG, repeat. With negative argument, move ARG times
1134 backward to previous statement."
1136 (or arg (setq arg 1))
1138 (python-nav-statement-end)
1139 (python-util-forward-comment)
1140 (python-nav-statement-start)
1141 (setq arg (1- arg)))
1143 (python-nav-statement-start)
1144 (python-util-forward-comment -1)
1145 (python-nav-statement-start)
1146 (setq arg (1+ arg))))
1148 (defun python-nav-block-start ()
1149 "Move to start of current block."
1151 (let ((starting-pos (point))
1152 (block-regexp (python-rx
1153 line-start (* whitespace) block-start)))
1155 (python-nav-statement-start)
1156 (looking-at (python-rx block-start)))
1158 ;; Go to first line beginning a statement
1159 (while (and (not (bobp))
1160 (or (and (python-nav-statement-start) nil)
1161 (python-info-current-line-comment-p)
1162 (python-info-current-line-empty-p)))
1164 (let ((block-matching-indent
1165 (- (current-indentation) python-indent-offset)))
1167 (and (python-nav-backward-block)
1168 (> (current-indentation) block-matching-indent)))
1169 (if (and (looking-at (python-rx block-start))
1170 (= (current-indentation) block-matching-indent))
1172 (and (goto-char starting-pos) nil))))))
1174 (defun python-nav-block-end ()
1175 "Move to end of current block."
1177 (when (python-nav-block-start)
1178 (let ((block-indentation (current-indentation)))
1179 (python-nav-statement-end)
1180 (while (and (forward-line 1)
1182 (or (and (> (current-indentation) block-indentation)
1183 (or (python-nav-statement-end) t))
1184 (python-info-current-line-comment-p)
1185 (python-info-current-line-empty-p))))
1186 (python-util-forward-comment -1)
1189 (defun python-nav-backward-block (&optional arg)
1190 "Move backward to previous block of code.
1191 With ARG, repeat. See `python-nav-forward-block'."
1193 (or arg (setq arg 1))
1194 (python-nav-forward-block (- arg)))
1196 (defun python-nav-forward-block (&optional arg)
1197 "Move forward to next block of code.
1198 With ARG, repeat. With negative argument, move ARG times
1199 backward to previous block."
1201 (or arg (setq arg 1))
1202 (let ((block-start-regexp
1203 (python-rx line-start (* whitespace) block-start))
1204 (starting-pos (point)))
1206 (python-nav-statement-end)
1208 (re-search-forward block-start-regexp nil t)
1209 (or (python-info-ppss-context 'string)
1210 (python-info-ppss-context 'comment)
1211 (python-info-ppss-context 'paren))))
1212 (setq arg (1- arg)))
1214 (python-nav-statement-start)
1216 (re-search-backward block-start-regexp nil t)
1217 (or (python-info-ppss-context 'string)
1218 (python-info-ppss-context 'comment)
1219 (python-info-ppss-context 'paren))))
1220 (setq arg (1+ arg)))
1221 (python-nav-statement-start)
1222 (if (not (looking-at (python-rx block-start)))
1223 (and (goto-char starting-pos) nil)
1224 (and (not (= (point) starting-pos)) (point-marker)))))
1226 (defun python-nav-forward-sexp-function (&optional arg)
1227 "Move forward across one block of code.
1228 With ARG, do it that many times. Negative arg -N means
1229 move backward N times."
1231 (or arg (setq arg 1))
1233 (let ((block-starting-pos
1234 (save-excursion (python-nav-block-start)))
1236 (save-excursion (python-nav-block-end)))
1237 (next-block-starting-pos
1238 (save-excursion (python-nav-forward-block))))
1239 (cond ((not block-starting-pos)
1240 (python-nav-forward-block))
1241 ((= (point) block-starting-pos)
1242 (if (or (not next-block-starting-pos)
1243 (< block-ending-pos next-block-starting-pos))
1244 (python-nav-block-end)
1245 (python-nav-forward-block)))
1246 ((= block-ending-pos (point))
1247 (let ((parent-block-end-pos
1249 (python-util-forward-comment)
1250 (python-nav-block-start)
1251 (python-nav-block-end))))
1252 (if (and parent-block-end-pos
1253 (or (not next-block-starting-pos)
1254 (> next-block-starting-pos parent-block-end-pos)))
1255 (goto-char parent-block-end-pos)
1256 (python-nav-forward-block))))
1257 (t (python-nav-block-end))))
1258 (setq arg (1- arg)))
1260 (let* ((block-starting-pos
1261 (save-excursion (python-nav-block-start)))
1263 (save-excursion (python-nav-block-end)))
1264 (prev-block-ending-pos
1265 (save-excursion (when (python-nav-backward-block)
1266 (python-nav-block-end))))
1267 (prev-block-parent-ending-pos
1269 (when prev-block-ending-pos
1270 (goto-char prev-block-ending-pos)
1271 (python-util-forward-comment)
1272 (python-nav-block-start)
1273 (python-nav-block-end)))))
1274 (cond ((not block-ending-pos)
1275 (and (python-nav-backward-block)
1276 (python-nav-block-end)))
1277 ((= (point) block-ending-pos)
1280 '(prev-block-parent-ending-pos
1281 prev-block-ending-pos
1283 block-starting-pos))
1284 (when (and (symbol-value name)
1285 (< (symbol-value name) (point)))
1286 (add-to-list 'candidates (symbol-value name))))
1287 (goto-char (apply 'max candidates))))
1288 ((> (point) block-ending-pos)
1289 (python-nav-block-end))
1290 ((= (point) block-starting-pos)
1291 (if (not (> (point) (or prev-block-ending-pos (point))))
1292 (python-nav-backward-block)
1293 (goto-char prev-block-ending-pos)
1294 (let ((parent-block-ending-pos
1296 (python-nav-forward-sexp-function)
1297 (and (not (looking-at (python-rx block-start)))
1299 (when (and parent-block-ending-pos
1300 (> parent-block-ending-pos prev-block-ending-pos))
1301 (goto-char parent-block-ending-pos)))))
1302 (t (python-nav-block-start))))
1303 (setq arg (1+ arg))))
1306 ;;; Shell integration
1308 (defcustom python-shell-buffer-name "Python"
1309 "Default buffer name for Python interpreter."
1314 (defcustom python-shell-interpreter "python"
1315 "Default Python interpreter for shell."
1319 (defcustom python-shell-internal-buffer-name "Python Internal"
1320 "Default buffer name for the Internal Python interpreter."
1325 (defcustom python-shell-interpreter-args "-i"
1326 "Default arguments for the Python interpreter."
1330 (defcustom python-shell-prompt-regexp ">>> "
1331 "Regular Expression matching top\-level input prompt of python shell.
1332 It should not contain a caret (^) at the beginning."
1337 (defcustom python-shell-prompt-block-regexp "[.][.][.] "
1338 "Regular Expression matching block input prompt of python shell.
1339 It should not contain a caret (^) at the beginning."
1344 (defcustom python-shell-prompt-output-regexp ""
1345 "Regular Expression matching output prompt of python shell.
1346 It should not contain a caret (^) at the beginning."
1351 (defcustom python-shell-prompt-pdb-regexp "[(<]*[Ii]?[Pp]db[>)]+ "
1352 "Regular Expression matching pdb input prompt of python shell.
1353 It should not contain a caret (^) at the beginning."
1358 (defcustom python-shell-enable-font-lock t
1359 "Should syntax highlighting be enabled in the python shell buffer?
1360 Restart the python shell after changing this variable for it to take effect."
1365 (defcustom python-shell-send-setup-max-wait 5
1366 "Seconds to wait for process output before code setup.
1367 If output is received before the specified time then control is
1368 returned in that moment and not after waiting."
1373 (defcustom python-shell-process-environment nil
1374 "List of environment variables for Python shell.
1375 This variable follows the same rules as `process-environment'
1376 since it merges with it before the process creation routines are
1377 called. When this variable is nil, the Python shell is run with
1378 the default `process-environment'."
1379 :type '(repeat string)
1383 (defcustom python-shell-extra-pythonpaths nil
1384 "List of extra pythonpaths for Python shell.
1385 The values of this variable are added to the existing value of
1386 PYTHONPATH in the `process-environment' variable."
1387 :type '(repeat string)
1391 (defcustom python-shell-exec-path nil
1392 "List of path to search for binaries.
1393 This variable follows the same rules as `exec-path' since it
1394 merges with it before the process creation routines are called.
1395 When this variable is nil, the Python shell is run with the
1396 default `exec-path'."
1397 :type '(repeat string)
1401 (defcustom python-shell-virtualenv-path nil
1402 "Path to virtualenv root.
1403 This variable, when set to a string, makes the values stored in
1404 `python-shell-process-environment' and `python-shell-exec-path'
1405 to be modified properly so shells are started with the specified
1411 (defcustom python-shell-setup-codes '(python-shell-completion-setup-code
1412 python-ffap-setup-code
1413 python-eldoc-setup-code)
1414 "List of code run by `python-shell-send-setup-codes'."
1415 :type '(repeat symbol)
1419 (defcustom python-shell-compilation-regexp-alist
1420 `((,(rx line-start (1+ (any " \t")) "File \""
1421 (group (1+ (not (any "\"<")))) ; avoid `<stdin>' &c
1422 "\", line " (group (1+ digit)))
1424 (,(rx " in file " (group (1+ not-newline)) " on line "
1427 (,(rx line-start "> " (group (1+ (not (any "(\"<"))))
1428 "(" (group (1+ digit)) ")" (1+ (not (any "("))) "()")
1430 "`compilation-error-regexp-alist' for inferior Python."
1431 :type '(alist string)
1434 (defun python-shell-get-process-name (dedicated)
1435 "Calculate the appropriate process name for inferior Python process.
1436 If DEDICATED is t and the variable `buffer-file-name' is non-nil
1437 returns a string with the form
1438 `python-shell-buffer-name'[variable `buffer-file-name'] else
1439 returns the value of `python-shell-buffer-name'. After
1440 calculating the process name adds the buffer name for the process
1441 in the `same-window-buffer-names' list."
1445 (format "%s[%s]" python-shell-buffer-name buffer-file-name)
1446 (format "%s" python-shell-buffer-name))))
1447 (add-to-list 'same-window-buffer-names (purecopy
1448 (format "*%s*" process-name)))
1451 (defun python-shell-internal-get-process-name ()
1452 "Calculate the appropriate process name for Internal Python process.
1453 The name is calculated from `python-shell-global-buffer-name' and
1454 a hash of all relevant global shell settings in order to ensure
1455 uniqueness for different types of configurations."
1457 python-shell-internal-buffer-name
1460 (python-shell-parse-command)
1461 python-shell-prompt-regexp
1462 python-shell-prompt-block-regexp
1463 python-shell-prompt-output-regexp
1464 (mapconcat #'symbol-value python-shell-setup-codes "")
1465 (mapconcat #'identity python-shell-process-environment "")
1466 (mapconcat #'identity python-shell-extra-pythonpaths "")
1467 (mapconcat #'identity python-shell-exec-path "")
1468 (or python-shell-virtualenv-path "")
1469 (mapconcat #'identity python-shell-exec-path "")))))
1471 (defun python-shell-parse-command ()
1472 "Calculate the string used to execute the inferior Python process."
1473 (format "%s %s" python-shell-interpreter python-shell-interpreter-args))
1475 (defun python-shell-calculate-process-environment ()
1476 "Calculate process environment given `python-shell-virtualenv-path'."
1477 (let ((process-environment (append
1478 python-shell-process-environment
1479 process-environment nil))
1480 (virtualenv (if python-shell-virtualenv-path
1481 (directory-file-name python-shell-virtualenv-path)
1483 (when python-shell-extra-pythonpaths
1484 (setenv "PYTHONPATH"
1486 (mapconcat 'identity
1487 python-shell-extra-pythonpaths
1490 (or (getenv "PYTHONPATH") ""))))
1491 (if (not virtualenv)
1493 (setenv "PYTHONHOME" nil)
1494 (setenv "PATH" (format "%s/bin%s%s"
1495 virtualenv path-separator
1496 (or (getenv "PATH") "")))
1497 (setenv "VIRTUAL_ENV" virtualenv))
1498 process-environment))
1500 (defun python-shell-calculate-exec-path ()
1501 "Calculate exec path given `python-shell-virtualenv-path'."
1502 (let ((path (append python-shell-exec-path
1504 (if (not python-shell-virtualenv-path)
1506 (cons (format "%s/bin"
1507 (directory-file-name python-shell-virtualenv-path))
1510 (defun python-comint-output-filter-function (output)
1511 "Hook run after content is put into comint buffer.
1512 OUTPUT is a string with the contents of the buffer."
1513 (ansi-color-filter-apply output))
1515 (define-derived-mode inferior-python-mode comint-mode "Inferior Python"
1516 "Major mode for Python inferior process.
1517 Runs a Python interpreter as a subprocess of Emacs, with Python
1518 I/O through an Emacs buffer. Variables
1519 `python-shell-interpreter' and `python-shell-interpreter-args'
1520 controls which Python interpreter is run. Variables
1521 `python-shell-prompt-regexp',
1522 `python-shell-prompt-output-regexp',
1523 `python-shell-prompt-block-regexp',
1524 `python-shell-enable-font-lock',
1525 `python-shell-completion-setup-code',
1526 `python-shell-completion-string-code',
1527 `python-shell-completion-module-string-code',
1528 `python-eldoc-setup-code', `python-eldoc-string-code',
1529 `python-ffap-setup-code' and `python-ffap-string-code' can
1530 customize this mode for different Python interpreters.
1532 You can also add additional setup code to be run at
1533 initialization of the interpreter via `python-shell-setup-codes'
1536 \(Type \\[describe-mode] in the process buffer for a list of commands.)"
1537 (set-syntax-table python-mode-syntax-table)
1538 (setq mode-line-process '(":%s"))
1539 (setq comint-prompt-regexp (format "^\\(?:%s\\|%s\\|%s\\)"
1540 python-shell-prompt-regexp
1541 python-shell-prompt-block-regexp
1542 python-shell-prompt-pdb-regexp))
1543 (make-local-variable 'comint-output-filter-functions)
1544 (add-hook 'comint-output-filter-functions
1545 'python-comint-output-filter-function)
1546 (add-hook 'comint-output-filter-functions
1547 'python-pdbtrack-comint-output-filter-function)
1548 (set (make-local-variable 'compilation-error-regexp-alist)
1549 python-shell-compilation-regexp-alist)
1550 (define-key inferior-python-mode-map [remap complete-symbol]
1551 'completion-at-point)
1552 (add-hook 'completion-at-point-functions
1553 'python-shell-completion-complete-at-point nil 'local)
1554 (add-to-list (make-local-variable 'comint-dynamic-complete-functions)
1555 'python-shell-completion-complete-at-point)
1556 (define-key inferior-python-mode-map (kbd "<tab>")
1557 'python-shell-completion-complete-or-indent)
1558 (when python-shell-enable-font-lock
1559 (set (make-local-variable 'font-lock-defaults)
1560 '(python-font-lock-keywords nil nil nil nil))
1561 (set (make-local-variable 'syntax-propertize-function)
1562 python-syntax-propertize-function))
1563 (compilation-shell-minor-mode 1))
1565 (defun python-shell-make-comint (cmd proc-name &optional pop)
1566 "Create a python shell comint buffer.
1567 CMD is the python command to be executed and PROC-NAME is the
1568 process name the comint buffer will get. After the comint buffer
1569 is created the `inferior-python-mode' is activated. If POP is
1570 non-nil the buffer is shown."
1572 (let* ((proc-buffer-name (format "*%s*" proc-name))
1573 (process-environment (python-shell-calculate-process-environment))
1574 (exec-path (python-shell-calculate-exec-path)))
1575 (when (not (comint-check-proc proc-buffer-name))
1576 (let* ((cmdlist (split-string-and-unquote cmd))
1577 (buffer (apply 'make-comint proc-name (car cmdlist) nil
1579 (current-buffer (current-buffer)))
1580 (with-current-buffer buffer
1581 (inferior-python-mode)
1582 (python-util-clone-local-variables current-buffer))))
1584 (pop-to-buffer proc-buffer-name))
1587 (defun run-python (dedicated cmd)
1588 "Run an inferior Python process.
1589 Input and output via buffer named after
1590 `python-shell-buffer-name'. If there is a process already
1591 running in that buffer, just switch to it.
1592 With argument, allows you to define DEDICATED, so a dedicated
1593 process for the current buffer is open, and define CMD so you can
1594 edit the command used to call the interpreter (default is value
1595 of `python-shell-interpreter' and arguments defined in
1596 `python-shell-interpreter-args'). Runs the hook
1597 `inferior-python-mode-hook' (after the `comint-mode-hook' is
1599 \(Type \\[describe-mode] in the process buffer for a list of commands.)"
1601 (if current-prefix-arg
1603 (y-or-n-p "Make dedicated process? ")
1604 (read-string "Run Python: " (python-shell-parse-command)))
1605 (list nil (python-shell-parse-command))))
1606 (python-shell-make-comint cmd (python-shell-get-process-name dedicated))
1609 (defun run-python-internal ()
1610 "Run an inferior Internal Python process.
1611 Input and output via buffer named after
1612 `python-shell-internal-buffer-name' and what
1613 `python-shell-internal-get-process-name' returns. This new kind
1614 of shell is intended to be used for generic communication related
1615 to defined configurations. The main difference with global or
1616 dedicated shells is that these ones are attached to a
1617 configuration, not a buffer. This means that can be used for
1618 example to retrieve the sys.path and other stuff, without messing
1619 with user shells. Runs the hook
1620 `inferior-python-mode-hook' (after the `comint-mode-hook' is
1621 run). \(Type \\[describe-mode] in the process buffer for a list
1624 (set-process-query-on-exit-flag
1626 (python-shell-make-comint
1627 (python-shell-parse-command)
1628 (python-shell-internal-get-process-name))) nil))
1630 (defun python-shell-get-process ()
1631 "Get inferior Python process for current buffer and return it."
1632 (let* ((dedicated-proc-name (python-shell-get-process-name t))
1633 (dedicated-proc-buffer-name (format "*%s*" dedicated-proc-name))
1634 (global-proc-name (python-shell-get-process-name nil))
1635 (global-proc-buffer-name (format "*%s*" global-proc-name))
1636 (dedicated-running (comint-check-proc dedicated-proc-buffer-name))
1637 (global-running (comint-check-proc global-proc-buffer-name)))
1638 ;; Always prefer dedicated
1639 (get-buffer-process (or (and dedicated-running dedicated-proc-buffer-name)
1640 (and global-running global-proc-buffer-name)))))
1642 (defun python-shell-get-or-create-process ()
1643 "Get or create an inferior Python process for current buffer and return it."
1644 (let* ((dedicated-proc-name (python-shell-get-process-name t))
1645 (dedicated-proc-buffer-name (format "*%s*" dedicated-proc-name))
1646 (global-proc-name (python-shell-get-process-name nil))
1647 (global-proc-buffer-name (format "*%s*" global-proc-name))
1648 (dedicated-running (comint-check-proc dedicated-proc-buffer-name))
1649 (global-running (comint-check-proc global-proc-buffer-name))
1650 (current-prefix-arg 4))
1651 (when (and (not dedicated-running) (not global-running))
1652 (if (call-interactively 'run-python)
1653 (setq dedicated-running t)
1654 (setq global-running t)))
1655 ;; Always prefer dedicated
1656 (get-buffer-process (if dedicated-running
1657 dedicated-proc-buffer-name
1658 global-proc-buffer-name))))
1660 (defvar python-shell-internal-buffer nil
1661 "Current internal shell buffer for the current buffer.
1662 This is really not necessary at all for the code to work but it's
1663 there for compatibility with CEDET.")
1664 (make-variable-buffer-local 'python-shell-internal-buffer)
1666 (defun python-shell-internal-get-or-create-process ()
1667 "Get or create an inferior Internal Python process."
1668 (let* ((proc-name (python-shell-internal-get-process-name))
1669 (proc-buffer-name (format "*%s*" proc-name)))
1670 (run-python-internal)
1671 (setq python-shell-internal-buffer proc-buffer-name)
1672 (get-buffer-process proc-buffer-name)))
1674 (define-obsolete-function-alias
1675 'python-proc 'python-shell-internal-get-or-create-process "24.2")
1677 (define-obsolete-variable-alias
1678 'python-buffer 'python-shell-internal-buffer "24.2")
1680 (defun python-shell-send-string (string &optional process msg)
1681 "Send STRING to inferior Python PROCESS.
1682 When MSG is non-nil messages the first line of STRING."
1683 (interactive "sPython command: ")
1684 (let ((process (or process (python-shell-get-or-create-process)))
1685 (lines (split-string string "\n" t)))
1687 (message (format "Sent: %s..." (nth 0 lines))))
1688 (if (> (length lines) 1)
1689 (let* ((temp-file-name (make-temp-file "py"))
1690 (file-name (or (buffer-file-name) temp-file-name)))
1691 (with-temp-file temp-file-name
1693 (delete-trailing-whitespace))
1694 (python-shell-send-file file-name process temp-file-name))
1695 (comint-send-string process string)
1696 (when (or (not (string-match "\n$" string))
1697 (string-match "\n[ \t].*\n?$" string))
1698 (comint-send-string process "\n")))))
1700 (defun python-shell-send-string-no-output (string &optional process msg)
1701 "Send STRING to PROCESS and inhibit output.
1702 When MSG is non-nil messages the first line of STRING. Return
1704 (let* ((output-buffer)
1705 (process (or process (python-shell-get-or-create-process)))
1706 (comint-preoutput-filter-functions
1707 (append comint-preoutput-filter-functions
1708 '(ansi-color-filter-apply
1710 (setq output-buffer (concat output-buffer string))
1712 (python-shell-send-string string process msg)
1713 (accept-process-output process)
1714 (replace-regexp-in-string
1715 (if (> (length python-shell-prompt-output-regexp) 0)
1716 (format "\n*%s$\\|^%s\\|\n$"
1717 python-shell-prompt-regexp
1718 (or python-shell-prompt-output-regexp ""))
1719 (format "\n*$\\|^%s\\|\n$"
1720 python-shell-prompt-regexp))
1723 (defun python-shell-internal-send-string (string)
1724 "Send STRING to the Internal Python interpreter.
1725 Returns the output. See `python-shell-send-string-no-output'."
1726 (python-shell-send-string-no-output
1727 ;; Makes this function compatible with the old
1728 ;; python-send-receive. (At least for CEDET).
1729 (replace-regexp-in-string "_emacs_out +" "" string)
1730 (python-shell-internal-get-or-create-process) nil))
1732 (define-obsolete-function-alias
1733 'python-send-receive 'python-shell-internal-send-string "24.2")
1735 (define-obsolete-function-alias
1736 'python-send-string 'python-shell-internal-send-string "24.2")
1738 (defun python-shell-send-region (start end)
1739 "Send the region delimited by START and END to inferior Python process."
1741 (python-shell-send-string (buffer-substring start end) nil t))
1743 (defun python-shell-send-buffer (&optional arg)
1744 "Send the entire buffer to inferior Python process.
1746 With prefix ARG include lines surrounded by \"if __name__ == '__main__':\""
1750 (python-shell-send-region
1755 (re-search-forward (python-rx if-name-main) nil t))
1756 (match-beginning 0))
1759 (defun python-shell-send-defun (arg)
1760 "Send the current defun to inferior Python process.
1761 When argument ARG is non-nil do not include decorators."
1764 (python-shell-send-region
1767 (while (and (or (python-beginning-of-defun-function)
1768 (beginning-of-line 1))
1769 (> (current-indentation) 0)))
1771 (while (and (forward-line -1)
1772 (looking-at (python-rx decorator))))
1776 (or (python-end-of-defun-function)
1780 (defun python-shell-send-file (file-name &optional process temp-file-name)
1781 "Send FILE-NAME to inferior Python PROCESS.
1782 If TEMP-FILE-NAME is passed then that file is used for processing
1783 instead, while internally the shell will continue to use
1785 (interactive "fFile to send: ")
1786 (let* ((process (or process (python-shell-get-or-create-process)))
1787 (temp-file-name (when temp-file-name
1788 (expand-file-name temp-file-name)))
1789 (file-name (or (expand-file-name file-name) temp-file-name)))
1790 (when (not file-name)
1791 (error "If FILE-NAME is nil then TEMP-FILE-NAME must be non-nil"))
1792 (python-shell-send-string
1794 (concat "__pyfile = open('''%s''');"
1795 "exec(compile(__pyfile.read(), '''%s''', 'exec'));"
1797 (or temp-file-name file-name) file-name)
1800 (defun python-shell-switch-to-shell ()
1801 "Switch to inferior Python process buffer."
1803 (pop-to-buffer (process-buffer (python-shell-get-or-create-process)) t))
1805 (defun python-shell-send-setup-code ()
1806 "Send all setup code for shell.
1807 This function takes the list of setup code to send from the
1808 `python-shell-setup-codes' list."
1809 (let ((msg "Sent %s")
1810 (process (get-buffer-process (current-buffer))))
1811 (accept-process-output process python-shell-send-setup-max-wait)
1812 (dolist (code python-shell-setup-codes)
1814 (message (format msg code))
1815 (python-shell-send-string
1816 (symbol-value code) process)))))
1818 (add-hook 'inferior-python-mode-hook
1819 #'python-shell-send-setup-code)
1822 ;;; Shell completion
1824 (defcustom python-shell-completion-setup-code
1828 def __COMPLETER_all_completions(text): []
1831 readline.set_completer(rlcompleter.Completer().complete)
1832 def __COMPLETER_all_completions(text):
1838 res = readline.get_completer()(text, i)
1841 completions.append(res)
1845 "Code used to setup completion in inferior Python processes."
1849 (defcustom python-shell-completion-string-code
1850 "';'.join(__COMPLETER_all_completions('''%s'''))\n"
1851 "Python code used to get a string of completions separated by semicolons."
1855 (defcustom python-shell-completion-module-string-code ""
1856 "Python code used to get completions separated by semicolons for imports.
1858 For IPython v0.11, add the following line to
1859 `python-shell-completion-setup-code':
1861 from IPython.core.completerlib import module_completion
1863 and use the following as the value of this variable:
1865 ';'.join(module_completion('''%s'''))\n"
1869 (defcustom python-shell-completion-pdb-string-code
1870 "';'.join(globals().keys() + locals().keys())"
1871 "Python code used to get completions separated by semicolons for [i]pdb."
1875 (defun python-shell-completion--get-completions (input process completion-code)
1876 "Retrieve available completions for INPUT using PROCESS.
1877 Argument COMPLETION-CODE is the python code used to get
1878 completions on the current context."
1879 (with-current-buffer (process-buffer process)
1880 (let ((completions (python-shell-send-string-no-output
1881 (format completion-code input) process)))
1882 (when (> (length completions) 2)
1883 (split-string completions "^'\\|^\"\\|;\\|'$\\|\"$" t)))))
1885 (defun python-shell-completion--do-completion-at-point (process)
1886 "Do completion at point for PROCESS."
1887 (with-syntax-table python-dotty-syntax-table
1890 (let* ((paren-depth (car (syntax-ppss)))
1891 (syntax-string "w_")
1892 (syntax-list (string-to-syntax syntax-string)))
1893 ;; Stop scanning for the beginning of the completion subject
1894 ;; after the char before point matches a delimiter
1895 (while (member (car (syntax-after (1- (point)))) syntax-list)
1896 (skip-syntax-backward syntax-string)
1897 (when (or (equal (char-before) ?\))
1898 (equal (char-before) ?\"))
1901 ;; honor initial paren depth
1902 (> (car (syntax-ppss)) paren-depth)
1903 (python-info-ppss-context 'string))
1904 (forward-char -1))))
1907 (line (buffer-substring-no-properties (point-at-bol) end))
1908 (input (buffer-substring-no-properties beg end))
1909 ;; Get the last prompt for the inferior process buffer. This is
1910 ;; used for the completion code selection heuristic.
1912 (with-current-buffer (process-buffer process)
1913 (buffer-substring-no-properties
1914 (overlay-start comint-last-prompt-overlay)
1915 (overlay-end comint-last-prompt-overlay))))
1917 ;; Check whether a prompt matches a pdb string, an import statement
1918 ;; or just the standard prompt and use the correct
1919 ;; python-shell-completion-*-code string
1920 (cond ((and (> (length python-shell-completion-pdb-string-code) 0)
1922 (concat "^" python-shell-prompt-pdb-regexp) prompt))
1925 (length python-shell-completion-module-string-code) 0)
1927 (concat "^" python-shell-prompt-regexp) prompt)
1928 (string-match "^[ \t]*\\(from\\|import\\)[ \t]" line))
1931 (concat "^" python-shell-prompt-regexp) prompt)
1935 (case completion-context
1936 ('pdb python-shell-completion-pdb-string-code)
1937 ('import python-shell-completion-module-string-code)
1938 ('default python-shell-completion-string-code)
1941 (if (eq completion-context 'import)
1942 (replace-regexp-in-string "^[ \t]+" "" line)
1945 (and completion-code (> (length input) 0)
1946 (python-shell-completion--get-completions
1947 input process completion-code))))
1948 (list beg end completions))))
1950 (defun python-shell-completion-complete-at-point ()
1951 "Perform completion at point in inferior Python process."
1953 (and comint-last-prompt-overlay
1954 (> (point-marker) (overlay-end comint-last-prompt-overlay))
1955 (python-shell-completion--do-completion-at-point
1956 (get-buffer-process (current-buffer)))))
1958 (defun python-shell-completion-complete-or-indent ()
1959 "Complete or indent depending on the context.
1960 If content before pointer is all whitespace indent. If not try
1963 (if (string-match "^[[:space:]]*$"
1964 (buffer-substring (comint-line-beginning-position)
1966 (indent-for-tab-command)
1967 (completion-at-point)))
1970 ;;; PDB Track integration
1972 (defcustom python-pdbtrack-activate t
1973 "Non-nil makes python shell enable pdbtracking."
1978 (defcustom python-pdbtrack-stacktrace-info-regexp
1979 "^> \\([^\"(<]+\\)(\\([0-9]+\\))\\([?a-zA-Z0-9_<>]+\\)()"
1980 "Regular Expression matching stacktrace information.
1981 Used to extract the current line and module being inspected."
1986 (defvar python-pdbtrack-tracked-buffer nil
1987 "Variable containing the value of the current tracked buffer.
1988 Never set this variable directly, use
1989 `python-pdbtrack-set-tracked-buffer' instead.")
1990 (make-variable-buffer-local 'python-pdbtrack-tracked-buffer)
1992 (defvar python-pdbtrack-buffers-to-kill nil
1993 "List of buffers to be deleted after tracking finishes.")
1994 (make-variable-buffer-local 'python-pdbtrack-buffers-to-kill)
1996 (defun python-pdbtrack-set-tracked-buffer (file-name)
1997 "Set the buffer for FILE-NAME as the tracked buffer.
1998 Internally it uses the `python-pdbtrack-tracked-buffer' variable.
1999 Returns the tracked buffer."
2000 (let ((file-buffer (get-file-buffer file-name)))
2002 (setq python-pdbtrack-tracked-buffer file-buffer)
2003 (setq file-buffer (find-file-noselect file-name))
2004 (when (not (member file-buffer python-pdbtrack-buffers-to-kill))
2005 (add-to-list 'python-pdbtrack-buffers-to-kill file-buffer)))
2008 (defun python-pdbtrack-comint-output-filter-function (output)
2009 "Move overlay arrow to current pdb line in tracked buffer.
2010 Argument OUTPUT is a string with the output from the comint process."
2011 (when (and python-pdbtrack-activate (not (string= output "")))
2012 (let* ((full-output (ansi-color-filter-apply
2013 (buffer-substring comint-last-input-end (point-max))))
2017 (insert full-output)
2018 (goto-char (point-min))
2019 ;; OK, this sucked but now it became a cool hack. The
2020 ;; stacktrace information normally is on the first line
2021 ;; but in some cases (like when doing a step-in) it is
2023 (when (or (looking-at python-pdbtrack-stacktrace-info-regexp)
2026 (looking-at python-pdbtrack-stacktrace-info-regexp)))
2027 (setq line-number (string-to-number
2028 (match-string-no-properties 2)))
2029 (match-string-no-properties 1)))))
2030 (if (and file-name line-number)
2031 (let* ((tracked-buffer
2032 (python-pdbtrack-set-tracked-buffer file-name))
2033 (shell-buffer (current-buffer))
2034 (tracked-buffer-window (get-buffer-window tracked-buffer))
2035 (tracked-buffer-line-pos))
2036 (with-current-buffer tracked-buffer
2037 (set (make-local-variable 'overlay-arrow-string) "=>")
2038 (set (make-local-variable 'overlay-arrow-position) (make-marker))
2039 (setq tracked-buffer-line-pos (progn
2040 (goto-char (point-min))
2041 (forward-line (1- line-number))
2043 (when tracked-buffer-window
2045 tracked-buffer-window tracked-buffer-line-pos))
2046 (set-marker overlay-arrow-position tracked-buffer-line-pos))
2047 (pop-to-buffer tracked-buffer)
2048 (switch-to-buffer-other-window shell-buffer))
2049 (when python-pdbtrack-tracked-buffer
2050 (with-current-buffer python-pdbtrack-tracked-buffer
2051 (set-marker overlay-arrow-position nil))
2052 (mapc #'(lambda (buffer)
2053 (ignore-errors (kill-buffer buffer)))
2054 python-pdbtrack-buffers-to-kill)
2055 (setq python-pdbtrack-tracked-buffer nil
2056 python-pdbtrack-buffers-to-kill nil)))))
2060 ;;; Symbol completion
2062 (defun python-completion-complete-at-point ()
2063 "Complete current symbol at point.
2064 For this to work the best as possible you should call
2065 `python-shell-send-buffer' from time to time so context in
2066 inferior python process is updated properly."
2068 (let ((process (python-shell-get-process)))
2070 (error "Completion needs an inferior Python process running")
2071 (python-shell-completion--do-completion-at-point process))))
2073 (add-to-list 'debug-ignored-errors
2074 "^Completion needs an inferior Python process running.")
2079 (defcustom python-fill-comment-function 'python-fill-comment
2080 "Function to fill comments.
2081 This is the function used by `python-fill-paragraph-function' to
2087 (defcustom python-fill-string-function 'python-fill-string
2088 "Function to fill strings.
2089 This is the function used by `python-fill-paragraph-function' to
2095 (defcustom python-fill-decorator-function 'python-fill-decorator
2096 "Function to fill decorators.
2097 This is the function used by `python-fill-paragraph-function' to
2103 (defcustom python-fill-paren-function 'python-fill-paren
2104 "Function to fill parens.
2105 This is the function used by `python-fill-paragraph-function' to
2111 (defun python-fill-paragraph-function (&optional justify)
2112 "`fill-paragraph-function' handling multi-line strings and possibly comments.
2113 If any of the current line is in or at the end of a multi-line string,
2114 fill the string or the paragraph of it that point is in, preserving
2115 the string's indentation.
2116 Optional argument JUSTIFY defines if the paragraph should be justified."
2119 (back-to-indentation)
2122 ((funcall python-fill-comment-function justify))
2123 ;; Strings/Docstrings
2124 ((save-excursion (skip-chars-forward "\"'uUrR")
2125 (python-info-ppss-context 'string))
2126 (funcall python-fill-string-function justify))
2128 ((equal (char-after (save-excursion
2129 (back-to-indentation)
2130 (point-marker))) ?@)
2131 (funcall python-fill-decorator-function justify))
2133 ((or (python-info-ppss-context 'paren)
2134 (looking-at (python-rx open-paren))
2136 (skip-syntax-forward "^(" (line-end-position))
2137 (looking-at (python-rx open-paren))))
2138 (funcall python-fill-paren-function justify))
2141 (defun python-fill-comment (&optional justify)
2142 "Comment fill function for `python-fill-paragraph-function'.
2143 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
2144 (fill-comment-paragraph justify))
2146 (defun python-fill-string (&optional justify)
2147 "String fill function for `python-fill-paragraph-function'.
2148 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
2149 (let ((marker (point-marker))
2150 (string-start-marker
2152 (skip-chars-forward "\"'uUrR")
2153 (goto-char (python-info-ppss-context 'string))
2154 (skip-chars-forward "\"'uUrR")
2156 (reg-start (line-beginning-position))
2159 (while (python-info-ppss-context 'string)
2160 (goto-char (1+ (point-marker))))
2161 (skip-chars-backward "\"'")
2163 (reg-end (line-end-position))
2164 (fill-paragraph-function))
2166 (narrow-to-region reg-start reg-end)
2168 (goto-char string-start-marker)
2169 (delete-region (point-marker) (progn
2170 (skip-syntax-forward "> ")
2172 (goto-char string-end-marker)
2173 (delete-region (point-marker) (progn
2174 (skip-syntax-backward "> ")
2178 (fill-paragraph justify))
2179 ;; If there is a newline in the docstring lets put triple
2180 ;; quote in it's own line to follow pep 8
2181 (when (save-excursion
2182 (re-search-backward "\n" string-start-marker t))
2184 (newline-and-indent))
2185 (fill-paragraph justify)))) t)
2187 (defun python-fill-decorator (&optional justify)
2188 "Decorator fill function for `python-fill-paragraph-function'.
2189 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
2192 (defun python-fill-paren (&optional justify)
2193 "Paren fill function for `python-fill-paragraph-function'.
2194 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
2196 (narrow-to-region (progn
2197 (while (python-info-ppss-context 'paren)
2198 (goto-char (1- (point-marker))))
2200 (line-beginning-position))
2202 (when (not (python-info-ppss-context 'paren))
2204 (when (not (python-info-ppss-context 'paren))
2205 (skip-syntax-backward "^)")))
2206 (while (python-info-ppss-context 'paren)
2207 (goto-char (1+ (point-marker))))
2209 (let ((paragraph-start "\f\\|[ \t]*$")
2210 (paragraph-separate ",")
2211 (fill-paragraph-function))
2212 (goto-char (point-min))
2213 (fill-paragraph justify))
2216 (python-indent-line)
2217 (goto-char (line-end-position)))) t)
2222 (defcustom python-skeleton-autoinsert nil
2223 "Non-nil means template skeletons will be automagically inserted.
2224 This happens when pressing \"if<SPACE>\", for example, to prompt for
2230 (define-obsolete-variable-alias
2231 'python-use-skeletons 'python-skeleton-autoinsert "24.2")
2233 (defvar python-skeleton-available '()
2234 "Internal list of available skeletons.")
2236 (define-abbrev-table 'python-mode-abbrev-table ()
2237 "Abbrev table for Python mode."
2239 ;; Allow / inside abbrevs.
2240 :regexp "\\(?:^\\|[^/]\\)\\<\\([[:word:]/]+\\)\\W*"
2241 ;; Only expand in code.
2242 :enable-function (lambda ()
2244 (not (or (python-info-ppss-context 'string)
2245 (python-info-ppss-context 'comment)))
2246 python-skeleton-autoinsert)))
2248 (defmacro python-skeleton-define (name doc &rest skel)
2249 "Define a `python-mode' skeleton using NAME DOC and SKEL.
2250 The skeleton will be bound to python-skeleton-NAME and will
2251 be added to `python-mode-abbrev-table'."
2252 (declare (indent 2))
2253 (let* ((name (symbol-name name))
2254 (function-name (intern (concat "python-skeleton-" name))))
2256 (define-abbrev python-mode-abbrev-table ,name "" ',function-name
2258 (setq python-skeleton-available
2259 (cons ',function-name python-skeleton-available))
2260 (define-skeleton ,function-name
2262 (format "Insert %s statement." name))
2265 (defmacro python-define-auxiliary-skeleton (name doc &optional &rest skel)
2266 "Define a `python-mode' auxiliary skeleton using NAME DOC and SKEL.
2267 The skeleton will be bound to python-skeleton-NAME."
2268 (declare (indent 2))
2269 (let* ((name (symbol-name name))
2270 (function-name (intern (concat "python-skeleton--" name)))
2272 "Add '%s' clause? " name)))
2275 `(< ,(format "%s:" name) \n \n
2277 `(define-skeleton ,function-name
2279 (format "Auxiliary skeleton for %s statement." name))
2281 (unless (y-or-n-p ,msg)
2285 (python-define-auxiliary-skeleton else nil)
2287 (python-define-auxiliary-skeleton except nil)
2289 (python-define-auxiliary-skeleton finally nil)
2291 (python-skeleton-define if nil
2295 ("other condition, %s: "
2299 '(python-skeleton--else) | ^)
2301 (python-skeleton-define while nil
2305 '(python-skeleton--else) | ^)
2307 (python-skeleton-define for nil
2311 '(python-skeleton--else) | ^)
2313 (python-skeleton-define try nil
2319 "except " str ":" \n
2322 '(python-skeleton--except)
2323 '(python-skeleton--else)
2324 '(python-skeleton--finally) | ^)
2326 (python-skeleton-define def nil
2328 "def " str " (" ("Parameter, %s: "
2329 (unless (equal ?\( (char-before)) ", ")
2331 "\"\"\"" - "\"\"\"" \n
2334 (python-skeleton-define class nil
2336 "class " str " (" ("Inheritance, %s: "
2337 (unless (equal ?\( (char-before)) ", ")
2341 "\"\"\"" - "\"\"\"" \n
2344 (defun python-skeleton-add-menu-items ()
2345 "Add menu items to Python->Skeletons menu."
2346 (let ((skeletons (sort python-skeleton-available 'string<))
2348 (dolist (skeleton skeletons)
2350 nil '("Python" "Skeletons")
2352 "Insert %s" (caddr (split-string (symbol-name skeleton) "-")))
2357 (defcustom python-ffap-setup-code
2358 "def __FFAP_get_module_path(module):
2361 path = __import__(module).__file__
2362 if path[-4:] == '.pyc' and os.path.exists(path[0:-1]):
2367 "Python code to get a module path."
2371 (defcustom python-ffap-string-code
2372 "__FFAP_get_module_path('''%s''')\n"
2373 "Python code used to get a string with the path of a module."
2377 (defun python-ffap-module-path (module)
2378 "Function for `ffap-alist' to return path for MODULE."
2380 (and (eq major-mode 'inferior-python-mode)
2381 (get-buffer-process (current-buffer)))
2382 (python-shell-get-process))))
2386 (python-shell-send-string-no-output
2387 (format python-ffap-string-code module) process)))
2389 (substring-no-properties module-file 1 -1))))))
2391 (eval-after-load "ffap"
2393 (push '(python-mode . python-ffap-module-path) ffap-alist)
2394 (push '(inferior-python-mode . python-ffap-module-path) ffap-alist)))
2399 (defcustom python-check-command
2401 "Command used to check a Python file."
2405 (defcustom python-check-buffer-name
2406 "*Python check: %s*"
2407 "Buffer name used for check commands."
2411 (defvar python-check-custom-command nil
2414 (defun python-check (command)
2415 "Check a Python file (default current buffer's file).
2416 Runs COMMAND, a shell command, as if by `compile'. See
2417 `python-check-command' for the default."
2419 (list (read-string "Check command: "
2420 (or python-check-custom-command
2421 (concat python-check-command " "
2422 (shell-quote-argument
2424 (let ((name (buffer-file-name)))
2426 (file-name-nondirectory name)))
2428 (setq python-check-custom-command command)
2429 (save-some-buffers (not compilation-ask-about-save) nil)
2430 (let ((process-environment (python-shell-calculate-process-environment))
2431 (exec-path (python-shell-calculate-exec-path)))
2432 (compilation-start command nil
2434 (format python-check-buffer-name command)))))
2439 (defcustom python-eldoc-setup-code
2440 "def __PYDOC_get_help(obj):
2443 if hasattr(obj, 'startswith'):
2444 obj = eval(obj, globals())
2445 doc = inspect.getdoc(obj)
2446 if not doc and callable(obj):
2448 if inspect.isclass(obj) and hasattr(obj, '__init__'):
2449 target = obj.__init__
2455 args = inspect.formatargspec(
2456 *inspect.getargspec(target)
2459 doc = '{objtype} {name}{args}'.format(
2460 objtype=objtype, name=name, args=args
2463 doc = doc.splitlines()[0]
2470 "Python code to setup documentation retrieval."
2474 (defcustom python-eldoc-string-code
2475 "__PYDOC_get_help('''%s''')\n"
2476 "Python code used to get a string with the documentation of an object."
2480 (defun python-eldoc--get-doc-at-point (&optional force-input force-process)
2481 "Internal implementation to get documentation at point.
2482 If not FORCE-INPUT is passed then what `current-word' returns
2483 will be used. If not FORCE-PROCESS is passed what
2484 `python-shell-get-process' returns is used."
2485 (let ((process (or force-process (python-shell-get-process))))
2487 "Eldoc needs an inferior Python process running."
2488 (let* ((current-defun (python-info-current-defun))
2489 (input (or force-input
2490 (with-syntax-table python-dotty-syntax-table
2491 (if (not current-defun)
2493 (concat current-defun "." (current-word))))))
2494 (ppss (syntax-ppss))
2497 (not (string= input (concat current-defun ".")))
2498 (not (or (python-info-ppss-context 'string ppss)
2499 (python-info-ppss-context 'comment ppss))))
2502 (regexp-quote (concat current-defun "."))
2506 (goto-char (point-min))
2510 (point-marker) (search-forward "self."))
2511 (setq input (buffer-substring
2512 (point-min) (point-max)))))
2513 (python-shell-send-string-no-output
2514 (format python-eldoc-string-code input) process))))
2515 (with-current-buffer (process-buffer process)
2516 (when comint-last-prompt-overlay
2517 (delete-region comint-last-input-end
2518 (overlay-start comint-last-prompt-overlay))))
2520 (not (string= help "\n")))
2523 (defun python-eldoc-function ()
2524 "`eldoc-documentation-function' for Python.
2525 For this to work the best as possible you should call
2526 `python-shell-send-buffer' from time to time so context in
2527 inferior python process is updated properly."
2528 (python-eldoc--get-doc-at-point))
2530 (defun python-eldoc-at-point (symbol)
2531 "Get help on SYMBOL using `help'.
2532 Interactively, prompt for symbol."
2534 (let ((symbol (with-syntax-table python-dotty-syntax-table
2536 (enable-recursive-minibuffers t))
2537 (list (read-string (if symbol
2538 (format "Describe symbol (default %s): " symbol)
2539 "Describe symbol: ")
2541 (let ((process (python-shell-get-process)))
2543 (message "Eldoc needs an inferior Python process running.")
2544 (message (python-eldoc--get-doc-at-point symbol process)))))
2549 (defun python-info-current-defun (&optional include-type)
2550 "Return name of surrounding function with Python compatible dotty syntax.
2551 Optional argument INCLUDE-TYPE indicates to include the type of the defun.
2552 This function is compatible to be used as
2553 `add-log-current-defun-function' since it returns nil if point is
2554 not inside a defun."
2562 (setq min-indent (current-indentation))
2563 (while (python-beginning-of-defun-function 1)
2564 (when (or (< (current-indentation) min-indent)
2566 (setq first-run nil)
2567 (setq min-indent (current-indentation))
2568 (looking-at python-nav-beginning-of-defun-regexp)
2570 (if (not include-type)
2571 (match-string-no-properties 1)
2572 (mapconcat 'identity
2574 (match-string-no-properties 0)) " "))
2577 (mapconcat (lambda (string) string) names "."))))
2579 (defun python-info-closing-block ()
2580 "Return the point of the block the current line closes."
2581 (let ((closing-word (save-excursion
2582 (back-to-indentation)
2584 (indentation (current-indentation)))
2585 (when (member closing-word python-indent-dedenters)
2588 (while (and (> (current-indentation) indentation)
2590 (not (back-to-indentation))
2592 (back-to-indentation)
2594 ((not (equal indentation (current-indentation))) nil)
2595 ((string= closing-word "elif")
2596 (when (member (current-word) '("if" "elif"))
2598 ((string= closing-word "else")
2599 (when (member (current-word) '("if" "elif" "except" "for" "while"))
2601 ((string= closing-word "except")
2602 (when (member (current-word) '("try"))
2604 ((string= closing-word "finally")
2605 (when (member (current-word) '("except" "else"))
2606 (point-marker))))))))
2608 (defun python-info-closing-block-message (&optional closing-block-point)
2609 "Message the contents of the block the current line closes.
2610 With optional argument CLOSING-BLOCK-POINT use that instead of
2611 recalculating it calling `python-info-closing-block'."
2612 (let ((point (or closing-block-point (python-info-closing-block))))
2616 (message "Closes %s" (save-excursion
2618 (back-to-indentation)
2620 (point) (line-end-position))))))))
2622 (defun python-info-line-ends-backslash-p (&optional line-number)
2623 "Return non-nil if current line ends with backslash.
2624 With optional argument LINE-NUMBER, check that line instead."
2629 (goto-char line-number))
2630 (while (and (not (eobp))
2631 (goto-char (line-end-position))
2632 (python-info-ppss-context 'paren)
2633 (not (equal (char-before (point)) ?\\)))
2635 (when (equal (char-before) ?\\)
2638 (defun python-info-beginning-of-backslash (&optional line-number)
2639 "Return the point where the backslashed line start.
2640 Optional argument LINE-NUMBER forces the line number to check against."
2645 (goto-char line-number))
2646 (when (python-info-line-ends-backslash-p)
2647 (while (save-excursion
2648 (goto-char (line-beginning-position))
2649 (python-info-ppss-context 'paren))
2651 (back-to-indentation)
2654 (defun python-info-continuation-line-p ()
2655 "Check if current line is continuation of another.
2656 When current line is continuation of another return the point
2657 where the continued line ends."
2661 (let* ((context-type (progn
2662 (back-to-indentation)
2663 (python-info-ppss-context-type)))
2664 (line-start (line-number-at-pos))
2665 (context-start (when context-type
2666 (python-info-ppss-context context-type))))
2667 (cond ((equal context-type 'paren)
2668 ;; Lines inside a paren are always a continuation line
2669 ;; (except the first one).
2670 (when (equal (python-info-ppss-context-type) 'paren)
2671 (python-util-forward-comment -1)
2672 (python-util-forward-comment -1)
2674 ((or (equal context-type 'comment)
2675 (equal context-type 'string))
2676 ;; move forward an roll again
2677 (goto-char context-start)
2678 (python-util-forward-comment)
2679 (python-info-continuation-line-p))
2681 ;; Not within a paren, string or comment, the only way we are
2682 ;; dealing with a continuation line is that previous line
2683 ;; contains a backslash, and this can only be the previous line
2685 (back-to-indentation)
2686 (python-util-forward-comment -1)
2687 (python-util-forward-comment -1)
2688 (when (and (equal (1- line-start) (line-number-at-pos))
2689 (python-info-line-ends-backslash-p))
2690 (point-marker))))))))
2692 (defun python-info-block-continuation-line-p ()
2693 "Return non-nil if current line is a continuation of a block."
2695 (when (python-info-continuation-line-p)
2697 (back-to-indentation)
2698 (when (looking-at (python-rx block-start))
2701 (defun python-info-assignment-continuation-line-p ()
2702 "Check if current line is a continuation of an assignment.
2703 When current line is continuation of another with an assignment
2704 return the point of the first non-blank character after the
2707 (when (python-info-continuation-line-p)
2709 (back-to-indentation)
2710 (when (and (not (looking-at (python-rx block-start)))
2711 (and (re-search-forward (python-rx not-simple-operator
2713 not-simple-operator)
2714 (line-end-position) t)
2715 (not (or (python-info-ppss-context 'string)
2716 (python-info-ppss-context 'paren)
2717 (python-info-ppss-context 'comment)))))
2718 (skip-syntax-forward "\s")
2721 (defun python-info-ppss-context (type &optional syntax-ppss)
2722 "Return non-nil if point is on TYPE using SYNTAX-PPSS.
2723 TYPE can be 'comment, 'string or 'paren. It returns the start
2724 character address of the specified TYPE."
2725 (let ((ppss (or syntax-ppss (syntax-ppss))))
2736 (defun python-info-ppss-context-type (&optional syntax-ppss)
2737 "Return the context type using SYNTAX-PPSS.
2738 The type returned can be 'comment, 'string or 'paren."
2739 (let ((ppss (or syntax-ppss (syntax-ppss))))
2750 (defun python-info-looking-at-beginning-of-defun (&optional syntax-ppss)
2751 "Check if point is at `beginning-of-defun' using SYNTAX-PPSS."
2752 (and (not (python-info-ppss-context-type (or syntax-ppss (syntax-ppss))))
2754 (beginning-of-line 1)
2755 (looking-at python-nav-beginning-of-defun-regexp))))
2757 (defun python-info-current-line-comment-p ()
2758 "Check if current line is a comment line."
2759 (char-equal (or (char-after (+ (point) (current-indentation))) ?_) ?#))
2761 (defun python-info-current-line-empty-p ()
2762 "Check if current line is empty, ignoring whitespace."
2764 (beginning-of-line 1)
2766 (python-rx line-start (* whitespace)
2767 (group (* not-newline))
2768 (* whitespace) line-end))
2769 (string-equal "" (match-string-no-properties 1))))
2772 ;;; Utility functions
2774 (defun python-util-position (item seq)
2775 "Find the first occurrence of ITEM in SEQ.
2776 Return the index of the matching item, or nil if not found."
2777 (let ((member-result (member item seq)))
2779 (- (length seq) (length member-result)))))
2781 ;; Stolen from org-mode
2782 (defun python-util-clone-local-variables (from-buffer &optional regexp)
2783 "Clone local variables from FROM-BUFFER.
2784 Optional argument REGEXP selects variables to clone and defaults
2788 (and (symbolp (car pair))
2789 (string-match (or regexp "^python-")
2790 (symbol-name (car pair)))
2791 (set (make-local-variable (car pair))
2793 (buffer-local-variables from-buffer)))
2795 (defun python-util-forward-comment (&optional direction)
2796 "Python mode specific version of `forward-comment'.
2797 Optional argument DIRECTION defines the direction to move to."
2798 (let ((comment-start (python-info-ppss-context 'comment))
2799 (factor (if (< (or direction 0) 0)
2803 (goto-char comment-start))
2804 (forward-comment factor)))
2808 (define-derived-mode python-mode prog-mode "Python"
2809 "Major mode for editing Python files.
2812 Entry to this mode calls the value of `python-mode-hook'
2813 if that value is non-nil."
2814 (set (make-local-variable 'tab-width) 8)
2815 (set (make-local-variable 'indent-tabs-mode) nil)
2817 (set (make-local-variable 'comment-start) "# ")
2818 (set (make-local-variable 'comment-start-skip) "#+\\s-*")
2820 (set (make-local-variable 'parse-sexp-lookup-properties) t)
2821 (set (make-local-variable 'parse-sexp-ignore-comments) t)
2823 (set (make-local-variable 'forward-sexp-function)
2824 'python-nav-forward-sexp-function)
2826 (set (make-local-variable 'font-lock-defaults)
2827 '(python-font-lock-keywords nil nil nil nil))
2829 (set (make-local-variable 'syntax-propertize-function)
2830 python-syntax-propertize-function)
2832 (set (make-local-variable 'indent-line-function)
2833 #'python-indent-line-function)
2834 (set (make-local-variable 'indent-region-function) #'python-indent-region)
2836 (set (make-local-variable 'paragraph-start) "\\s-*$")
2837 (set (make-local-variable 'fill-paragraph-function)
2838 'python-fill-paragraph-function)
2840 (set (make-local-variable 'beginning-of-defun-function)
2841 #'python-beginning-of-defun-function)
2842 (set (make-local-variable 'end-of-defun-function)
2843 #'python-end-of-defun-function)
2845 (add-hook 'completion-at-point-functions
2846 'python-completion-complete-at-point nil 'local)
2848 (add-hook 'post-self-insert-hook
2849 'python-indent-post-self-insert-function nil 'local)
2851 (set (make-local-variable 'imenu-extract-index-name-function)
2852 #'python-info-current-defun)
2854 (set (make-local-variable 'add-log-current-defun-function)
2855 #'python-info-current-defun)
2857 (add-hook 'which-func-functions #'python-info-current-defun nil t)
2859 (set (make-local-variable 'skeleton-further-elements)
2861 (< '(backward-delete-char-untabify (min python-indent-offset
2863 (^ '(- (1+ (current-indentation))))))
2865 (set (make-local-variable 'eldoc-documentation-function)
2866 #'python-eldoc-function)
2868 (add-to-list 'hs-special-modes-alist
2869 `(python-mode "^\\s-*\\(?:def\\|class\\)\\>" nil "#"
2871 (python-end-of-defun-function)) nil))
2873 (set (make-local-variable 'mode-require-final-newline) t)
2875 (set (make-local-variable 'outline-regexp)
2876 (python-rx (* space) block-start))
2877 (set (make-local-variable 'outline-heading-end-regexp) ":\\s-*\n")
2878 (set (make-local-variable 'outline-level)
2880 "`outline-level' function for Python mode."
2881 (1+ (/ (current-indentation) python-indent-offset))))
2883 (python-skeleton-add-menu-items)
2885 (when python-indent-guess-indent-offset
2886 (python-indent-guess-indent-offset)))
2890 ;;; python.el ends here