1 ;;; python.el --- Python's flying circus support for Emacs
3 ;; Copyright (C) 2010, 2011 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 NOT part of GNU Emacs.
14 ;; python.el is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; python.el is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with python.el. 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 ;; While it probably has less features than Dave Love's python.el and
34 ;; PSF's python-mode.el it provides the main stuff you'll need while
35 ;; keeping it simple :)
37 ;; Implements Syntax highlighting, Indentation, Movement, Shell
38 ;; interaction, Shell completion, Shell virtualenv support, Pdb
39 ;; tracking, Symbol completion, Skeletons, FFAP, Code Check, Eldoc,
42 ;; Syntax highlighting: Fontification of code is provided and supports
43 ;; python's triple quoted strings properly.
45 ;; Indentation: Automatic indentation with indentation cycling is
46 ;; provided, it allows you to navigate different available levels of
47 ;; indentation by hitting <tab> several times. Also when inserting a
48 ;; colon the `python-indent-electric-colon' command is invoked and
49 ;; causes the current line to be dedented automatically if needed.
51 ;; Movement: `beginning-of-defun' and `end-of-defun' functions are
52 ;; properly implemented. Also there are specialized
53 ;; `forward-sentence' and `backward-sentence' replacements
54 ;; (`python-nav-forward-sentence', `python-nav-backward-sentence'
55 ;; respectively). Extra functions `python-nav-sentence-start' and
56 ;; `python-nav-sentence-end' are included to move to the beginning and
57 ;; to the end of a setence while taking care of multiline definitions.
59 ;; Shell interaction: is provided and allows you easily execute any
60 ;; block of code of your current buffer in an inferior Python process.
62 ;; Shell completion: hitting tab will try to complete the current
63 ;; word. Shell completion is implemented in a manner that if you
64 ;; change the `python-shell-interpreter' to any other (for example
65 ;; IPython) it should be easy to integrate another way to calculate
66 ;; completions. You just need to specify your custom
67 ;; `python-shell-completion-setup-code' and
68 ;; `python-shell-completion-string-code'.
70 ;; Here is a complete example of the settings you would use for
74 ;; python-shell-interpreter "ipython"
75 ;; python-shell-interpreter-args ""
76 ;; python-shell-prompt-regexp "In \\[[0-9]+\\]: "
77 ;; python-shell-prompt-output-regexp "Out\\[[0-9]+\\]: "
78 ;; python-shell-completion-setup-code ""
79 ;; python-shell-completion-string-code
80 ;; "';'.join(__IP.complete('''%s'''))\n")
82 ;; Please note that the default completion system depends on the
83 ;; readline module, so if you are using some Operating System that
84 ;; bundles Python without it (like Windows) just install the
85 ;; pyreadline from http://ipython.scipy.org/moin/PyReadline/Intro and
86 ;; you should be good to go.
88 ;; Shell virtualenv support: The shell also contains support for
89 ;; virtualenvs and other special environment modifications thanks to
90 ;; `python-shell-process-environment' and `python-shell-exec-path'.
91 ;; These two variables allows you to modify execution paths and
92 ;; environment variables to make easy for you to setup virtualenv rules
93 ;; or behavior modifications when running shells. Here is an example
94 ;; of how to make shell processes to be run using the /path/to/env/
97 ;; (setq python-shell-process-environment
99 ;; (format "PATH=%s" (mapconcat
102 ;; (cons (getenv "PATH")
103 ;; '("/path/to/env/bin/")))
105 ;; "VIRTUAL_ENV=/path/to/env/"))
106 ;; (python-shell-exec-path . ("/path/to/env/bin/"))
108 ;; Since the above is cumbersome and can be programatically
109 ;; calculated, the variable `python-shell-virtualenv-path' is
110 ;; provided. When this variable is set with the path of the
111 ;; virtualenv to use, `process-environment' and `exec-path' get proper
112 ;; values in order to run shells inside the specified virtualenv. So
113 ;; the following will achieve the same as the previous example:
115 ;; (setq python-shell-virtualenv-path "/path/to/env/")
117 ;; Pdb tracking: when you execute a block of code that contains some
118 ;; call to pdb (or ipdb) it will prompt the block of code and will
119 ;; follow the execution of pdb marking the current line with an arrow.
121 ;; Symbol completion: you can complete the symbol at point. It uses
122 ;; the shell completion in background so you should run
123 ;; `python-shell-send-buffer' from time to time to get better results.
125 ;; Skeletons: 6 skeletons are provided for simple inserting of class,
126 ;; def, for, if, try and while. These skeletons are integrated with
127 ;; dabbrev. If you have `dabbrev-mode' activated and
128 ;; `python-skeleton-autoinsert' is set to t, then whenever you type
129 ;; the name of any of those defined and hit SPC, they will be
130 ;; automatically expanded.
132 ;; FFAP: You can find the filename for a given module when using ffap
133 ;; out of the box. This feature needs an inferior python shell
136 ;; Code check: Check the current file for errors with `python-check'
137 ;; using the program defined in `python-check-command'.
139 ;; Eldoc: returns documentation for object at point by using the
140 ;; inferior python subprocess to inspect its documentation. As you
141 ;; might guessed you should run `python-shell-send-buffer' from time
142 ;; to time to get better results too.
144 ;; imenu: This mode supports imenu. It builds a plain or tree menu
145 ;; depending on the value of `python-imenu-make-tree'. Also you can
146 ;; customize if menu items should include its type using
147 ;; `python-imenu-include-defun-type'.
149 ;; If you used python-mode.el you probably will miss auto-indentation
150 ;; when inserting newlines. To achieve the same behavior you have
153 ;; 1) Use GNU/Emacs' standard binding for `newline-and-indent': C-j.
155 ;; 2) Add the following hook in your .emacs:
157 ;; (add-hook 'python-mode-hook
159 ;; (define-key python-mode-map "\C-m" 'newline-and-indent)))
161 ;; I'd recommend the first one since you'll get the same behavior for
162 ;; all modes out-of-the-box.
166 ;; Add this to your .emacs:
168 ;; (add-to-list 'load-path "/folder/containing/file")
175 (require 'ansi-color)
180 ;; Avoid compiler warnings
181 (defvar view-return-to-alist)
182 (defvar compilation-error-regexp-alist)
183 (defvar outline-heading-end-regexp))
185 (autoload 'comint-mode "comint")
188 (add-to-list 'auto-mode-alist (cons (purecopy "\\.py\\'") 'python-mode))
190 (add-to-list 'interpreter-mode-alist (cons (purecopy "python") 'python-mode))
193 "Python Language's flying circus support for Emacs."
196 :link '(emacs-commentary-link "python"))
201 (defvar python-mode-map
202 (let ((map (make-sparse-keymap)))
204 (substitute-key-definition 'backward-sentence
205 'python-nav-backward-sentence
207 (substitute-key-definition 'forward-sentence
208 'python-nav-forward-sentence
211 (define-key map "\177" 'python-indent-dedent-line-backspace)
212 (define-key map (kbd "<backtab>") 'python-indent-dedent-line)
213 (define-key map "\C-c<" 'python-indent-shift-left)
214 (define-key map "\C-c>" 'python-indent-shift-right)
215 (define-key map ":" 'python-indent-electric-colon)
217 (define-key map "\C-c\C-tc" 'python-skeleton-class)
218 (define-key map "\C-c\C-td" 'python-skeleton-def)
219 (define-key map "\C-c\C-tf" 'python-skeleton-for)
220 (define-key map "\C-c\C-ti" 'python-skeleton-if)
221 (define-key map "\C-c\C-tt" 'python-skeleton-try)
222 (define-key map "\C-c\C-tw" 'python-skeleton-while)
224 (define-key map "\C-c\C-s" 'python-shell-send-string)
225 (define-key map "\C-c\C-r" 'python-shell-send-region)
226 (define-key map "\C-\M-x" 'python-shell-send-defun)
227 (define-key map "\C-c\C-c" 'python-shell-send-buffer)
228 (define-key map "\C-c\C-l" 'python-shell-send-file)
229 (define-key map "\C-c\C-z" 'python-shell-switch-to-shell)
230 ;; Some util commands
231 (define-key map "\C-c\C-v" 'python-check)
232 (define-key map "\C-c\C-f" 'python-eldoc-at-point)
234 (substitute-key-definition 'complete-symbol 'completion-at-point
236 (easy-menu-define python-menu map "Python Mode menu"
238 :help "Python-specific Features"
239 ["Shift region left" python-indent-shift-left :active mark-active
240 :help "Shift region left by a single indentation step"]
241 ["Shift region right" python-indent-shift-right :active mark-active
242 :help "Shift region right by a single indentation step"]
244 ["Mark def/class" mark-defun
245 :help "Mark outermost definition around point"]
247 ["Start of def/class" beginning-of-defun
248 :help "Go to start of outermost definition around point"]
249 ["End of def/class" end-of-defun
250 :help "Go to end of definition around point"]
254 ["Start interpreter" run-python
255 :help "Run inferior Python process in a separate buffer"]
256 ["Switch to shell" python-shell-switch-to-shell
257 :help "Switch to running inferior Python process"]
258 ["Eval string" python-shell-send-string
259 :help "Eval string in inferior Python session"]
260 ["Eval buffer" python-shell-send-buffer
261 :help "Eval buffer in inferior Python session"]
262 ["Eval region" python-shell-send-region
263 :help "Eval region in inferior Python session"]
264 ["Eval defun" python-shell-send-defun
265 :help "Eval defun in inferior Python session"]
266 ["Eval file" python-shell-send-file
267 :help "Eval file in inferior Python session"]
268 ["Debugger" pdb :help "Run pdb under GUD"]
270 ["Check file" python-check
271 :help "Check file for errors"]
272 ["Help on symbol" python-eldoc-at-point
273 :help "Get help on symbol at point"]
274 ["Complete symbol" completion-at-point
275 :help "Complete symbol before point"]))
277 "Keymap for `python-mode'.")
280 ;;; Python specialized rx
283 (defconst python-rx-constituents
285 `(block-start . ,(rx symbol-start
286 (or "def" "class" "if" "elif" "else" "try"
287 "except" "finally" "for" "while" "with")
289 `(decorator . ,(rx line-start (* space) ?@ (any letter ?_)
291 `(defun . ,(rx symbol-start (or "def" "class") symbol-end))
292 `(symbol-name . ,(rx (any letter ?_) (* (any word ?_))))
293 `(open-paren . ,(rx (or "{" "[" "(")))
294 `(close-paren . ,(rx (or "}" "]" ")")))
295 `(simple-operator . ,(rx (any ?+ ?- ?/ ?& ?^ ?~ ?| ?* ?< ?> ?= ?%)))
296 `(not-simple-operator . ,(rx (not (any ?+ ?- ?/ ?& ?^ ?~ ?| ?* ?< ?> ?= ?%))))
297 `(operator . ,(rx (or "+" "-" "/" "&" "^" "~" "|" "*" "<" ">"
298 "=" "%" "**" "//" "<<" ">>" "<=" "!="
299 "==" ">=" "is" "not")))
300 `(assignment-operator . ,(rx (or "=" "+=" "-=" "*=" "/=" "//=" "%=" "**="
301 ">>=" "<<=" "&=" "^=" "|="))))
302 "Additional Python specific sexps for `python-rx'"))
304 (defmacro python-rx (&rest regexps)
305 "Python mode specialized rx macro which supports common python named REGEXPS."
306 (let ((rx-constituents (append python-rx-constituents rx-constituents)))
307 (cond ((null regexps)
310 (rx-to-string `(and ,@regexps) t))
312 (rx-to-string (car regexps) t)))))
315 ;;; Font-lock and syntax
317 (defvar python-font-lock-keywords
320 (or "and" "del" "from" "not" "while" "as" "elif" "global" "or" "with"
321 "assert" "else" "if" "pass" "yield" "break" "except" "import"
322 "print" "class" "exec" "in" "raise" "continue" "finally" "is"
323 "return" "def" "for" "lambda" "try" "self")
326 (,(rx symbol-start "def" (1+ space) (group (1+ (or word ?_))))
327 (1 font-lock-function-name-face))
329 (,(rx symbol-start "class" (1+ space) (group (1+ (or word ?_))))
330 (1 font-lock-type-face))
333 ;; copyright, license, credits, quit, exit are added by the
334 ;; site module and since they are not intended to be used in
335 ;; programs they are not added here either.
336 (or "None" "True" "False" "Ellipsis" "__debug__" "NotImplemented")
337 symbol-end) . font-lock-constant-face)
339 (,(rx line-start (* (any " \t")) (group "@" (1+ (or word ?_))
340 (0+ "." (1+ (or word ?_)))))
341 (1 font-lock-type-face))
342 ;; Builtin Exceptions
344 (or "ArithmeticError" "AssertionError" "AttributeError"
345 "BaseException" "BufferError" "BytesWarning" "DeprecationWarning"
346 "EOFError" "EnvironmentError" "Exception" "FloatingPointError"
347 "FutureWarning" "GeneratorExit" "IOError" "ImportError"
348 "ImportWarning" "IndentationError" "IndexError" "KeyError"
349 "KeyboardInterrupt" "LookupError" "MemoryError" "NameError"
350 "NotImplementedError" "OSError" "OverflowError"
351 "PendingDeprecationWarning" "ReferenceError" "RuntimeError"
352 "RuntimeWarning" "StandardError" "StopIteration" "SyntaxError"
353 "SyntaxWarning" "SystemError" "SystemExit" "TabError" "TypeError"
354 "UnboundLocalError" "UnicodeDecodeError" "UnicodeEncodeError"
355 "UnicodeError" "UnicodeTranslateError" "UnicodeWarning"
356 "UserWarning" "ValueError" "Warning" "ZeroDivisionError")
357 symbol-end) . font-lock-type-face)
360 (or "_" "__doc__" "__import__" "__name__" "__package__" "abs" "all"
361 "any" "apply" "basestring" "bin" "bool" "buffer" "bytearray"
362 "bytes" "callable" "chr" "classmethod" "cmp" "coerce" "compile"
363 "complex" "delattr" "dict" "dir" "divmod" "enumerate" "eval"
364 "execfile" "file" "filter" "float" "format" "frozenset"
365 "getattr" "globals" "hasattr" "hash" "help" "hex" "id" "input"
366 "int" "intern" "isinstance" "issubclass" "iter" "len" "list"
367 "locals" "long" "map" "max" "min" "next" "object" "oct" "open"
368 "ord" "pow" "print" "property" "range" "raw_input" "reduce"
369 "reload" "repr" "reversed" "round" "set" "setattr" "slice"
370 "sorted" "staticmethod" "str" "sum" "super" "tuple" "type"
371 "unichr" "unicode" "vars" "xrange" "zip")
372 symbol-end) . font-lock-builtin-face)
374 ;; support for a = b = c = 5
376 (let ((re (python-rx (group (+ (any word ?. ?_)))
377 (? ?\[ (+ (not (any ?\]))) ?\]) (* space)
378 assignment-operator)))
379 (when (re-search-forward re limit t)
380 (while (and (python-info-ppss-context 'paren)
381 (re-search-forward re limit t)))
382 (if (and (not (python-info-ppss-context 'paren))
383 (not (equal (char-after (point-marker)) ?=)))
385 (set-match-data nil)))))
386 (1 font-lock-variable-name-face nil nil))
387 ;; support for a, b, c = (1, 2, 3)
389 (let ((re (python-rx (group (+ (any word ?. ?_))) (* space)
390 (* ?, (* space) (+ (any word ?. ?_)) (* space))
391 ?, (* space) (+ (any word ?. ?_)) (* space)
392 assignment-operator)))
393 (when (and (re-search-forward re limit t)
394 (goto-char (nth 3 (match-data))))
395 (while (and (python-info-ppss-context 'paren)
396 (re-search-forward re limit t))
397 (goto-char (nth 3 (match-data))))
398 (if (not (python-info-ppss-context 'paren))
400 (set-match-data nil)))))
401 (1 font-lock-variable-name-face nil nil))))
403 (defconst python-font-lock-syntactic-keywords
404 ;; Make outer chars of matching triple-quote sequences into generic
405 ;; string delimiters. Fixme: Is there a better way?
406 ;; First avoid a sequence preceded by an odd number of backslashes.
407 `((,(concat "\\(?:\\([RUru]\\)[Rr]?\\|^\\|[^\\]\\(?:\\\\.\\)*\\)" ;Prefix.
408 "\\(?:\\('\\)'\\('\\)\\|\\(?2:\"\\)\"\\(?3:\"\\)\\)")
409 (3 (python-quote-syntax)))))
411 (defun python-quote-syntax ()
412 "Put `syntax-table' property correctly on triple quote.
413 Used for syntactic keywords. N is the match number (1, 2 or 3)."
414 ;; Given a triple quote, we have to check the context to know
415 ;; whether this is an opening or closing triple or whether it's
416 ;; quoted anyhow, and should be ignored. (For that we need to do
417 ;; the same job as `syntax-ppss' to be correct and it seems to be OK
418 ;; to use it here despite initial worries.) We also have to sort
419 ;; out a possible prefix -- well, we don't _have_ to, but I think it
420 ;; should be treated as part of the string.
423 ;; ur"""ar""" x='"' # """
426 ;; x '"""' x """ \"""" x
428 (goto-char (match-beginning 0))
429 (let ((syntax (save-match-data (syntax-ppss))))
431 ((eq t (nth 3 syntax)) ; after unclosed fence
432 ;; Consider property for the last char if in a fenced string.
433 (goto-char (nth 8 syntax)) ; fence position
434 (skip-chars-forward "uUrR") ; skip any prefix
435 ;; Is it a matching sequence?
436 (if (eq (char-after) (char-after (match-beginning 2)))
437 (put-text-property (match-beginning 3) (match-end 3)
438 'syntax-table (string-to-syntax "|"))))
440 ;; Consider property for initial char, accounting for prefixes.
441 (put-text-property (match-beginning 1) (match-end 1)
442 'syntax-table (string-to-syntax "|")))
444 ;; Consider property for initial char, accounting for prefixes.
445 (put-text-property (match-beginning 2) (match-end 2)
446 'syntax-table (string-to-syntax "|"))))
449 (defvar python-mode-syntax-table
450 (let ((table (make-syntax-table)))
451 ;; Give punctuation syntax to ASCII that normally has symbol
452 ;; syntax or has word syntax and isn't a letter.
453 (let ((symbol (string-to-syntax "_"))
454 (sst (standard-syntax-table)))
457 (if (equal symbol (aref sst i))
458 (modify-syntax-entry i "." table)))))
459 (modify-syntax-entry ?$ "." table)
460 (modify-syntax-entry ?% "." table)
462 (modify-syntax-entry ?# "<" table)
463 (modify-syntax-entry ?\n ">" table)
464 (modify-syntax-entry ?' "\"" table)
465 (modify-syntax-entry ?` "$" table)
467 "Syntax table for Python files.")
469 (defvar python-dotty-syntax-table
470 (let ((table (make-syntax-table python-mode-syntax-table)))
471 (modify-syntax-entry ?. "w" table)
472 (modify-syntax-entry ?_ "w" table)
474 "Dotty syntax table for Python files.
475 It makes underscores and dots word constituent chars.")
480 (defcustom python-indent-offset 4
481 "Default indentation offset for Python."
486 (defcustom python-indent-guess-indent-offset t
487 "Non-nil tells Python mode to guess `python-indent-offset' value."
492 (defvar python-indent-current-level 0
493 "Current indentation level `python-indent-line-function' is using.")
495 (defvar python-indent-levels '(0)
496 "Levels of indentation available for `python-indent-line-function'.")
498 (defvar python-indent-dedenters '("else" "elif" "except" "finally")
499 "List of words that should be dedented.
500 These make `python-indent-calculate-indentation' subtract the value of
501 `python-indent-offset'.")
503 (defun python-indent-guess-indent-offset ()
504 "Guess and set `python-indent-offset' for the current buffer."
508 (goto-char (point-min))
510 (while (and (not found-block)
512 (python-rx line-start block-start) nil t))
513 (when (and (not (python-info-ppss-context 'string))
514 (not (python-info-ppss-context 'comment))
516 (goto-char (line-end-position))
517 (forward-comment -9999)
518 (eq ?: (char-before))))
519 (setq found-block t)))
520 (if (not found-block)
521 (message "Can't guess python-indent-offset, using defaults: %s"
522 python-indent-offset)
524 (goto-char (line-end-position))
525 (python-info-continuation-line-p))
529 (forward-comment 9999)
530 (let ((indent-offset (current-indentation)))
531 (when (> indent-offset 0)
532 (setq python-indent-offset indent-offset))))))))
534 (defun python-indent-context ()
535 "Get information on indentation context.
536 Context information is returned with a cons with the form:
539 Where status can be any of the following symbols:
540 * inside-paren: If point in between (), {} or []
541 * inside-string: If point is inside a string
542 * after-backslash: Previous line ends in a backslash
543 * after-beginning-of-block: Point is after beginning of block
544 * after-line: Point is after normal line
545 * no-indent: Point is at beginning of buffer or other special case
546 START is the buffer position where the sexp starts."
549 (let ((ppss (save-excursion (beginning-of-line) (syntax-ppss)))
553 ;; Beginning of buffer
555 (goto-char (line-beginning-position))
559 ((setq start (python-info-ppss-context 'paren ppss))
562 ((setq start (python-info-ppss-context 'string ppss))
565 ((setq start (when (not (or (python-info-ppss-context 'string ppss)
566 (python-info-ppss-context 'comment ppss)))
567 (let ((line-beg-pos (line-beginning-position)))
568 (when (eq ?\\ (char-before (1- line-beg-pos)))
569 (- line-beg-pos 2)))))
571 ;; After beginning of block
572 ((setq start (save-excursion
573 (let ((block-regexp (python-rx block-start))
574 (block-start-line-end ":[[:space:]]*$"))
575 (back-to-indentation)
576 (forward-comment -9999)
577 (back-to-indentation)
578 (when (or (python-info-continuation-line-p)
579 (and (not (looking-at block-regexp))
583 (line-end-position) t))))
584 (while (and (forward-line -1)
585 (python-info-continuation-line-p)
587 (when (not (looking-at block-regexp))
589 (back-to-indentation)
590 (when (and (looking-at block-regexp)
591 (or (re-search-forward
593 (line-end-position) t)
594 (python-info-continuation-line-p)))
596 'after-beginning-of-block)
598 ((setq start (save-excursion
599 (back-to-indentation)
600 (forward-comment -9999)
601 (python-nav-sentence-start)
608 (defun python-indent-calculate-indentation ()
609 "Calculate correct indentation offset for the current line."
610 (let* ((indentation-context (python-indent-context))
611 (context-status (car indentation-context))
612 (context-start (cdr indentation-context)))
618 ('after-beginning-of-block
619 (goto-char context-start)
620 (+ (current-indentation) python-indent-offset))
624 (goto-char context-start)
625 (current-indentation))
627 (back-to-indentation)
628 (looking-at (regexp-opt python-indent-dedenters)))
632 (goto-char context-start)
633 (current-indentation))
635 (let* ((block-continuation
638 (python-info-block-continuation-line-p)))
639 (assignment-continuation
642 (python-info-assignment-continuation-line-p)))
645 (back-to-indentation)
646 (when (looking-at "\\.")
648 (goto-char (line-end-position))
649 (while (and (re-search-backward "\\." (line-beginning-position) t)
650 (or (python-info-ppss-context 'comment)
651 (python-info-ppss-context 'string)
652 (python-info-ppss-context 'paren))))
653 (if (and (looking-at "\\.")
654 (not (or (python-info-ppss-context 'comment)
655 (python-info-ppss-context 'string)
656 (python-info-ppss-context 'paren))))
658 (+ (current-indentation) python-indent-offset)))))
663 (goto-char block-continuation)
665 (python-rx block-start (* space))
666 (line-end-position) t)
668 (assignment-continuation
669 (goto-char assignment-continuation)
671 (python-rx simple-operator)
672 (line-end-position) t)
675 (python-rx (* space))
676 (line-end-position) t)
679 (goto-char context-start)
682 (back-to-indentation)
684 "\\(?:return\\|from\\|import\\)\s+")))
685 (current-indentation)
686 (+ (current-indentation)
688 (match-string-no-properties 0))))))))
692 (skip-syntax-forward "\s" (line-end-position))
693 (when (and (looking-at (regexp-opt '(")" "]" "}")))
694 (not (forward-char 1))
695 (not (python-info-ppss-context 'paren)))
696 (goto-char context-start)
697 (back-to-indentation)
701 (goto-char context-start)
705 (line-beginning-position)
707 (forward-comment 9999))
709 (+ (current-indentation) python-indent-offset)
710 (forward-comment 9999)
713 (back-to-indentation)
714 (looking-at (regexp-opt '(")" "]" "}"))))
718 (defun python-indent-calculate-levels ()
719 "Calculate `python-indent-levels' and reset `python-indent-current-level'."
720 (let* ((indentation (python-indent-calculate-indentation))
721 (remainder (% indentation python-indent-offset))
722 (steps (/ (- indentation remainder) python-indent-offset)))
723 (setq python-indent-levels (list 0))
724 (dotimes (step steps)
725 (push (* python-indent-offset (1+ step)) python-indent-levels))
726 (when (not (eq 0 remainder))
727 (push (+ (* python-indent-offset steps) remainder) python-indent-levels))
728 (setq python-indent-levels (nreverse python-indent-levels))
729 (setq python-indent-current-level (1- (length python-indent-levels)))))
731 (defun python-indent-toggle-levels ()
732 "Toggle `python-indent-current-level' over `python-indent-levels'."
733 (setq python-indent-current-level (1- python-indent-current-level))
734 (when (< python-indent-current-level 0)
735 (setq python-indent-current-level (1- (length python-indent-levels)))))
737 (defun python-indent-line (&optional force-toggle)
738 "Internal implementation of `python-indent-line-function'.
739 Uses the offset calculated in
740 `python-indent-calculate-indentation' and available levels
741 indicated by the variable `python-indent-levels' to set the
744 When the variable `last-command' is equal to
745 `indent-for-tab-command' or FORCE-TOGGLE is non-nil it cycles
746 levels indicated in the variable `python-indent-levels' by
747 setting the current level in the variable
748 `python-indent-current-level'.
750 When the variable `last-command' is not equal to
751 `indent-for-tab-command' and FORCE-TOGGLE is nil it calculates
752 possible indentation levels and saves it in the variable
753 `python-indent-levels'. Afterwards it sets the variable
754 `python-indent-current-level' correctly so offset is equal
755 to (`nth' `python-indent-current-level' `python-indent-levels')"
756 (if (or (and (eq this-command 'indent-for-tab-command)
757 (eq last-command this-command))
759 (if (not (equal python-indent-levels '(0)))
760 (python-indent-toggle-levels)
761 (python-indent-calculate-levels))
762 (python-indent-calculate-levels))
764 (delete-horizontal-space)
765 (indent-to (nth python-indent-current-level python-indent-levels))
768 (let ((closing-block-point (python-info-closing-block)))
769 (when closing-block-point
770 (message "Closes %s" (buffer-substring
773 (goto-char closing-block-point)
774 (line-end-position))))))))
776 (defun python-indent-line-function ()
777 "`indent-line-function' for Python mode.
778 See `python-indent-line' for details."
779 (python-indent-line))
781 (defun python-indent-dedent-line ()
782 "De-indent current line."
784 (when (and (not (or (python-info-ppss-context 'string)
785 (python-info-ppss-context 'comment)))
786 (<= (point-marker) (save-excursion
787 (back-to-indentation)
789 (> (current-column) 0))
790 (python-indent-line t)
793 (defun python-indent-dedent-line-backspace (arg)
794 "De-indent current line.
795 Argument ARG is passed to `backward-delete-char-untabify' when
796 point is not in between the indentation."
798 (when (not (python-indent-dedent-line))
799 (backward-delete-char-untabify arg)))
800 (put 'python-indent-dedent-line-backspace 'delete-selection 'supersede)
802 (defun python-indent-region (start end)
803 "Indent a python region automagically.
805 Called from a program, START and END specify the region to indent."
806 (let ((deactivate-mark nil))
809 (setq end (point-marker))
811 (or (bolp) (forward-line 1))
812 (while (< (point) end)
813 (or (and (bolp) (eolp))
816 (back-to-indentation)
817 (setq word (current-word))
821 (delete-horizontal-space)
822 (indent-to (python-indent-calculate-indentation)))))
824 (move-marker end nil))))
826 (defun python-indent-shift-left (start end &optional count)
827 "Shift lines contained in region START END by COUNT columns to the left.
828 COUNT defaults to `python-indent-offset'. If region isn't
829 active, the current line is shifted. The shifted region includes
830 the lines in which START and END lie. An error is signaled if
831 any lines in the region are indented less than COUNT columns."
834 (list (region-beginning) (region-end) current-prefix-arg)
835 (list (line-beginning-position) (line-end-position) current-prefix-arg)))
837 (setq count (prefix-numeric-value count))
838 (setq count python-indent-offset))
840 (let ((deactivate-mark nil))
843 (while (< (point) end)
844 (if (and (< (current-indentation) count)
845 (not (looking-at "[ \t]*$")))
846 (error "Can't shift all lines enough"))
848 (indent-rigidly start end (- count))))))
850 (add-to-list 'debug-ignored-errors "^Can't shift all lines enough")
852 (defun python-indent-shift-right (start end &optional count)
853 "Shift lines contained in region START END by COUNT columns to the left.
854 COUNT defaults to `python-indent-offset'. If region isn't
855 active, the current line is shifted. The shifted region includes
856 the lines in which START and END lie."
859 (list (region-beginning) (region-end) current-prefix-arg)
860 (list (line-beginning-position) (line-end-position) current-prefix-arg)))
861 (let ((deactivate-mark nil))
863 (setq count (prefix-numeric-value count))
864 (setq count python-indent-offset))
865 (indent-rigidly start end count)))
867 (defun python-indent-electric-colon (arg)
868 "Insert a colon and maybe de-indent the current line.
869 With numeric ARG, just insert that many colons. With
870 \\[universal-argument], just insert a single colon."
872 (self-insert-command (if (not (integerp arg)) 1 arg))
875 (not (equal ?: (char-after (- (point-marker) 2))))
876 (not (or (python-info-ppss-context 'string)
877 (python-info-ppss-context 'comment))))
878 (let ((indentation (current-indentation))
879 (calculated-indentation (python-indent-calculate-indentation)))
880 (when (> indentation calculated-indentation)
882 (indent-line-to calculated-indentation)
883 (when (not (python-info-closing-block))
884 (indent-line-to indentation)))))))
885 (put 'python-indent-electric-colon 'delete-selection t)
890 (defvar python-nav-beginning-of-defun-regexp
891 (python-rx line-start (* space) defun (+ space) (group symbol-name))
892 "Regular expresion matching beginning of class or function.
893 The name of the defun should be grouped so it can be retrieved
894 via `match-string'.")
896 (defun python-nav-beginning-of-defun (&optional nodecorators)
897 "Move point to `beginning-of-defun'.
898 When NODECORATORS is non-nil decorators are not included. This
899 is the main part of`python-beginning-of-defun-function'
900 implementation. Return non-nil if point is moved to the
901 `beginning-of-defun'."
902 (let ((indent-pos (save-excursion
903 (back-to-indentation)
908 (when (not nodecorators)
909 (when (save-excursion
911 (looking-at (python-rx decorator)))
912 (while (and (not (bobp))
914 (looking-at (python-rx decorator))))
915 (when (not (bobp)) (forward-line 1)))))))
916 (if (and (> (point) indent-pos)
918 (goto-char (line-beginning-position))
919 (looking-at python-nav-beginning-of-defun-regexp)))
921 (goto-char (line-beginning-position))
922 (funcall include-decorators)
924 (goto-char (line-beginning-position))
925 (when (re-search-backward python-nav-beginning-of-defun-regexp nil t)
927 (goto-char (or (python-info-ppss-context 'string) (point)))
928 (funcall include-decorators))
931 (defun python-beginning-of-defun-function (&optional arg nodecorators)
932 "Move point to the beginning of def or class.
933 With positive ARG move that number of functions forward. With
934 negative do the same but backwards. When NODECORATORS is non-nil
935 decorators are not included. Return non-nil if point is moved to the
936 `beginning-of-defun'."
937 (when (or (null arg) (= arg 0)) (setq arg 1))
939 (dotimes (i arg (python-nav-beginning-of-defun nodecorators)))
941 (dotimes (i (- arg) found)
942 (python-end-of-defun-function)
943 (forward-comment 9999)
944 (goto-char (line-end-position))
947 (python-nav-beginning-of-defun nodecorators)))))))
949 (defun python-end-of-defun-function ()
950 "Move point to the end of def or class.
951 Returns nil if point is not in a def or class."
953 (let ((beg-defun-indent)
954 (decorator-regexp "[[:space:]]*@"))
955 (when (looking-at decorator-regexp)
956 (while (and (not (eobp))
958 (looking-at decorator-regexp))))
959 (when (not (looking-at python-nav-beginning-of-defun-regexp))
960 (python-beginning-of-defun-function))
961 (setq beg-defun-indent (current-indentation))
963 (while (and (forward-line 1)
965 (or (not (current-word))
966 (> (current-indentation) beg-defun-indent))))
967 (forward-comment 9999)
968 (goto-char (line-beginning-position))))
970 (defun python-nav-sentence-start ()
971 "Move to start of current sentence."
973 (while (and (not (back-to-indentation))
978 (python-info-line-ends-backslash-p))
979 (python-info-ppss-context 'string)
980 (python-info-ppss-context 'paren))
981 (forward-line -1)))))
983 (defun python-nav-sentence-end ()
984 "Move to end of current sentence."
986 (while (and (goto-char (line-end-position))
989 (python-info-line-ends-backslash-p)
990 (python-info-ppss-context 'string)
991 (python-info-ppss-context 'paren))
994 (defun python-nav-backward-sentence (&optional arg)
995 "Move backward to start of sentence. With ARG, do it arg times.
996 See `python-nav-forward-sentence' for more information."
998 (or arg (setq arg 1))
999 (python-nav-forward-sentence (- arg)))
1001 (defun python-nav-forward-sentence (&optional arg)
1002 "Move forward to next end of sentence. With ARG, repeat.
1003 With negative argument, move backward repeatedly to start of sentence."
1005 (or arg (setq arg 1))
1007 (forward-comment 9999)
1008 (python-nav-sentence-end)
1010 (setq arg (1- arg)))
1012 (python-nav-sentence-end)
1013 (forward-comment -9999)
1014 (python-nav-sentence-start)
1016 (setq arg (1+ arg))))
1019 ;;; Shell integration
1021 (defcustom python-shell-buffer-name "Python"
1022 "Default buffer name for Python interpreter."
1027 (defcustom python-shell-interpreter "python"
1028 "Default Python interpreter for shell."
1033 (defcustom python-shell-internal-buffer-name "Python Internal"
1034 "Default buffer name for the Internal Python interpreter."
1039 (defcustom python-shell-interpreter-args "-i"
1040 "Default arguments for the Python interpreter."
1045 (defcustom python-shell-prompt-regexp ">>> "
1046 "Regular Expression matching top\-level input prompt of python shell.
1047 It should not contain a caret (^) at the beginning."
1052 (defcustom python-shell-prompt-block-regexp "[.][.][.] "
1053 "Regular Expression matching block input prompt of python shell.
1054 It should not contain a caret (^) at the beginning."
1059 (defcustom python-shell-prompt-output-regexp ""
1060 "Regular Expression matching output prompt of python shell.
1061 It should not contain a caret (^) at the beginning."
1066 (defcustom python-shell-prompt-pdb-regexp "[(<]*[Ii]?[Pp]db[>)]+ "
1067 "Regular Expression matching pdb input prompt of python shell.
1068 It should not contain a caret (^) at the beginning."
1073 (defcustom python-shell-send-setup-max-wait 5
1074 "Seconds to wait for process output before code setup.
1075 If output is received before the especified time then control is
1076 returned in that moment and not after waiting."
1081 (defcustom python-shell-process-environment nil
1082 "List of environment variables for Python shell.
1083 This variable follows the same rules as `process-environment'
1084 since it merges with it before the process creation routines are
1085 called. When this variable is nil, the Python shell is run with
1086 the default `process-environment'."
1087 :type '(repeat string)
1091 (defcustom python-shell-exec-path nil
1092 "List of path to search for binaries.
1093 This variable follows the same rules as `exec-path' since it
1094 merges with it before the process creation routines are called.
1095 When this variable is nil, the Python shell is run with the
1096 default `exec-path'."
1097 :type '(repeat string)
1101 (defcustom python-shell-virtualenv-path nil
1102 "Path to virtualenv root.
1103 This variable, when set to a string, makes the values stored in
1104 `python-shell-process-environment' and `python-shell-exec-path'
1105 to be modified properly so shells are started with the specified
1111 (defcustom python-shell-setup-codes '(python-shell-completion-setup-code
1112 python-ffap-setup-code
1113 python-eldoc-setup-code)
1114 "List of code run by `python-shell-send-setup-codes'.
1115 Each variable can contain either a simple string with the code to
1116 execute or a cons with the form (CODE . DESCRIPTION), where CODE
1117 is a string with the code to execute and DESCRIPTION is the
1119 :type '(repeat symbol)
1123 (defcustom python-shell-compilation-regexp-alist
1124 `((,(rx line-start (1+ (any " \t")) "File \""
1125 (group (1+ (not (any "\"<")))) ; avoid `<stdin>' &c
1126 "\", line " (group (1+ digit)))
1128 (,(rx " in file " (group (1+ not-newline)) " on line "
1131 (,(rx line-start "> " (group (1+ (not (any "(\"<"))))
1132 "(" (group (1+ digit)) ")" (1+ (not (any "("))) "()")
1134 "`compilation-error-regexp-alist' for inferior Python."
1135 :type '(alist string)
1138 (defun python-shell-get-process-name (dedicated)
1139 "Calculate the appropiate process name for inferior Python process.
1140 If DEDICATED is t and the variable `buffer-file-name' is non-nil
1141 returns a string with the form
1142 `python-shell-buffer-name'[variable `buffer-file-name'] else
1143 returns the value of `python-shell-buffer-name'. After
1144 calculating the process name adds the buffer name for the process
1145 in the `same-window-buffer-names' list."
1149 (format "%s[%s]" python-shell-buffer-name buffer-file-name)
1150 (format "%s" python-shell-buffer-name))))
1151 (add-to-list 'same-window-buffer-names (purecopy
1152 (format "*%s*" process-name)))
1155 (defun python-shell-internal-get-process-name ()
1156 "Calculate the appropiate process name for Internal Python process.
1157 The name is calculated from `python-shell-global-buffer-name' and
1158 a hash of all relevant global shell settings in order to ensure
1159 uniqueness for different types of configurations."
1161 python-shell-internal-buffer-name
1164 (python-shell-parse-command)
1165 (mapconcat #'symbol-value python-shell-setup-codes "")
1166 (mapconcat #'indentity python-shell-process-environment "")
1167 (or python-shell-virtualenv-path "")
1168 (mapconcat #'indentity python-shell-exec-path "")))))
1170 (defun python-shell-parse-command ()
1171 "Calculate the string used to execute the inferior Python process."
1172 (format "%s %s" python-shell-interpreter python-shell-interpreter-args))
1174 (defun python-shell-calculate-process-environment ()
1175 "Calculate process environment given `python-shell-virtualenv-path'."
1176 (let ((env (python-util-merge 'list python-shell-process-environment
1177 process-environment 'string=))
1178 (virtualenv (if python-shell-virtualenv-path
1179 (directory-file-name python-shell-virtualenv-path)
1181 (if (not virtualenv)
1183 (dolist (envvar env)
1184 (let* ((split (split-string envvar "=" t))
1185 (name (nth 0 split))
1186 (value (nth 1 split)))
1187 (when (not (string= name "PYTHONHOME"))
1188 (when (string= name "PATH")
1189 (setq value (format "%s/bin:%s" virtualenv value)))
1190 (setq env (cons (format "%s=%s" name value) env)))))
1191 (cons (format "VIRTUAL_ENV=%s" virtualenv) env))))
1193 (defun python-shell-calculate-exec-path ()
1194 "Calculate exec path given `python-shell-virtualenv-path'."
1195 (let ((path (python-util-merge 'list python-shell-exec-path
1196 exec-path 'string=)))
1197 (if (not python-shell-virtualenv-path)
1199 (cons (format "%s/bin"
1200 (directory-file-name python-shell-virtualenv-path))
1203 (defun python-comint-output-filter-function (output)
1204 "Hook run after content is put into comint buffer.
1205 OUTPUT is a string with the contents of the buffer."
1206 (ansi-color-filter-apply output))
1208 (defvar inferior-python-mode-current-file nil
1209 "Current file from which a region was sent.")
1210 (make-variable-buffer-local 'inferior-python-mode-current-file)
1212 (define-derived-mode inferior-python-mode comint-mode "Inferior Python"
1213 "Major mode for Python inferior process.
1214 Runs a Python interpreter as a subprocess of Emacs, with Python
1215 I/O through an Emacs buffer. Variables
1216 `python-shell-interpreter' and `python-shell-interpreter-args'
1217 controls which Python interpreter is run. Variables
1218 `python-shell-prompt-regexp',
1219 `python-shell-prompt-output-regexp',
1220 `python-shell-prompt-block-regexp',
1221 `python-shell-completion-setup-code',
1222 `python-shell-completion-string-code', `python-eldoc-setup-code',
1223 `python-eldoc-string-code', `python-ffap-setup-code' and
1224 `python-ffap-string-code' can customize this mode for different
1225 Python interpreters.
1227 You can also add additional setup code to be run at
1228 initialization of the interpreter via `python-shell-setup-codes'
1231 \(Type \\[describe-mode] in the process buffer for a list of commands.)"
1232 (set-syntax-table python-mode-syntax-table)
1233 (setq mode-line-process '(":%s"))
1234 (setq comint-prompt-regexp (format "^\\(?:%s\\|%s\\|%s\\)"
1235 python-shell-prompt-regexp
1236 python-shell-prompt-block-regexp
1237 python-shell-prompt-pdb-regexp))
1238 (make-local-variable 'comint-output-filter-functions)
1239 (add-hook 'comint-output-filter-functions
1240 'python-comint-output-filter-function)
1241 (add-hook 'comint-output-filter-functions
1242 'python-pdbtrack-comint-output-filter-function)
1243 (set (make-local-variable 'compilation-error-regexp-alist)
1244 python-shell-compilation-regexp-alist)
1245 (define-key inferior-python-mode-map [remap complete-symbol]
1246 'completion-at-point)
1247 (add-hook 'completion-at-point-functions
1248 'python-shell-completion-complete-at-point nil 'local)
1249 (add-to-list (make-local-variable 'comint-dynamic-complete-functions)
1250 'python-shell-completion-complete-at-point)
1251 (define-key inferior-python-mode-map (kbd "<tab>")
1252 'python-shell-completion-complete-or-indent)
1253 (compilation-shell-minor-mode 1))
1255 (defun python-shell-make-comint (cmd proc-name &optional pop)
1256 "Create a python shell comint buffer.
1257 CMD is the python command to be executed and PROC-NAME is the
1258 process name the comint buffer will get. After the comint buffer
1259 is created the `inferior-python-mode' is activated. If POP is
1260 non-nil the buffer is shown."
1262 (let* ((proc-buffer-name (format "*%s*" proc-name))
1263 (process-environment (python-shell-calculate-process-environment))
1264 (exec-path (python-shell-calculate-exec-path)))
1265 (when (not (comint-check-proc proc-buffer-name))
1266 (let* ((cmdlist (split-string-and-unquote cmd))
1267 (buffer (apply 'make-comint proc-name (car cmdlist) nil
1269 (current-buffer (current-buffer)))
1270 (with-current-buffer buffer
1271 (inferior-python-mode)
1272 (python-clone-local-variables current-buffer))))
1274 (pop-to-buffer proc-buffer-name)))))
1276 (defun run-python (dedicated cmd)
1277 "Run an inferior Python process.
1278 Input and output via buffer named after
1279 `python-shell-buffer-name'. If there is a process already
1280 running in that buffer, just switch to it.
1281 With argument, allows you to define DEDICATED, so a dedicated
1282 process for the current buffer is open, and define CMD so you can
1283 edit the command used to call the interpreter (default is value
1284 of `python-shell-interpreter' and arguments defined in
1285 `python-shell-interpreter-args'). Runs the hook
1286 `inferior-python-mode-hook' (after the `comint-mode-hook' is
1288 \(Type \\[describe-mode] in the process buffer for a list of commands.)"
1290 (if current-prefix-arg
1292 (y-or-n-p "Make dedicated process? ")
1293 (read-string "Run Python: " (python-shell-parse-command)))
1294 (list nil (python-shell-parse-command))))
1295 (python-shell-make-comint cmd (python-shell-get-process-name dedicated) t)
1298 (defun run-python-internal ()
1299 "Run an inferior Internal Python process.
1300 Input and output via buffer named after
1301 `python-shell-internal-buffer-name' and what
1302 `python-shell-internal-get-process-name' returns. This new kind
1303 of shell is intended to be used for generic communication related
1304 to defined configurations. The main difference with global or
1305 dedicated shells is that these ones are attached to a
1306 configuration, not a buffer. This means that can be used for
1307 example to retrieve the sys.path and other stuff, without messing
1308 with user shells. Runs the hook
1309 `inferior-python-mode-hook' (after the `comint-mode-hook' is
1310 run). \(Type \\[describe-mode] in the process buffer for a list
1313 (python-shell-make-comint
1314 (python-shell-parse-command)
1315 (python-shell-internal-get-process-name)))
1317 (defun python-shell-get-process ()
1318 "Get inferior Python process for current buffer and return it."
1319 (let* ((dedicated-proc-name (python-shell-get-process-name t))
1320 (dedicated-proc-buffer-name (format "*%s*" dedicated-proc-name))
1321 (global-proc-name (python-shell-get-process-name nil))
1322 (global-proc-buffer-name (format "*%s*" global-proc-name))
1323 (dedicated-running (comint-check-proc dedicated-proc-buffer-name))
1324 (global-running (comint-check-proc global-proc-buffer-name)))
1325 ;; Always prefer dedicated
1326 (get-buffer-process (or (and dedicated-running dedicated-proc-buffer-name)
1327 (and global-running global-proc-buffer-name)))))
1329 (defun python-shell-get-or-create-process ()
1330 "Get or create an inferior Python process for current buffer and return it."
1331 (let* ((old-buffer (current-buffer))
1332 (dedicated-proc-name (python-shell-get-process-name t))
1333 (dedicated-proc-buffer-name (format "*%s*" dedicated-proc-name))
1334 (global-proc-name (python-shell-get-process-name nil))
1335 (global-proc-buffer-name (format "*%s*" global-proc-name))
1336 (dedicated-running (comint-check-proc dedicated-proc-buffer-name))
1337 (global-running (comint-check-proc global-proc-buffer-name))
1338 (current-prefix-arg 4))
1339 (when (and (not dedicated-running) (not global-running))
1340 (if (call-interactively 'run-python)
1341 (setq dedicated-running t)
1342 (setq global-running t)))
1343 ;; Always prefer dedicated
1344 (switch-to-buffer old-buffer)
1345 (get-buffer-process (if dedicated-running
1346 dedicated-proc-buffer-name
1347 global-proc-buffer-name))))
1349 (defun python-shell-internal-get-or-create-process ()
1350 "Get or create an inferior Internal Python process."
1351 (let* ((proc-name (python-shell-internal-get-process-name))
1352 (proc-buffer-name (format "*%s*" proc-name)))
1353 (run-python-internal)
1354 (get-buffer-process proc-buffer-name)))
1356 (defun python-shell-send-string (string &optional process msg)
1357 "Send STRING to inferior Python PROCESS.
1358 When MSG is non-nil messages the first line of STRING."
1359 (interactive "sPython command: ")
1360 (let ((process (or process (python-shell-get-or-create-process)))
1361 (lines (split-string string "\n" t)))
1363 (message (format "Sent: %s..." (nth 0 lines))))
1364 (if (> (length lines) 1)
1365 (let* ((temp-file-name (make-temp-file "py"))
1366 (file-name (or (buffer-file-name) temp-file-name)))
1367 (with-temp-file temp-file-name
1369 (delete-trailing-whitespace))
1370 (python-shell-send-file file-name process temp-file-name))
1371 (comint-send-string process string)
1372 (when (or (not (string-match "\n$" string))
1373 (string-match "\n[ \t].*\n?$" string))
1374 (comint-send-string process "\n")))))
1376 (defun python-shell-send-string-no-output (string &optional process msg)
1377 "Send STRING to PROCESS and inhibit output.
1378 When MSG is non-nil messages the first line of STRING. Return
1380 (let* ((output-buffer)
1381 (process (or process (python-shell-get-or-create-process)))
1382 (comint-preoutput-filter-functions
1383 (append comint-preoutput-filter-functions
1384 '(ansi-color-filter-apply
1386 (setq output-buffer (concat output-buffer string))
1388 (python-shell-send-string string process msg)
1389 (accept-process-output process)
1390 ;; Cleanup output prompt regexp
1391 (when (and (not (string= "" output-buffer))
1392 (> (length python-shell-prompt-output-regexp) 0))
1395 (insert output-buffer)
1396 (goto-char (point-min))
1397 (forward-comment 9999)
1398 (buffer-substring-no-properties
1400 (and (looking-at python-shell-prompt-output-regexp)
1402 python-shell-prompt-output-regexp nil t 1))
1406 (lambda (string) string)
1407 (butlast (split-string output-buffer "\n")) "\n")))
1409 (defun python-shell-internal-send-string (string)
1410 "Send STRING to the Internal Python interpreter.
1411 Returns the output. See `python-shell-send-string-no-output'."
1412 (python-shell-send-string-no-output
1413 ;; Makes this function compatible with the old
1414 ;; python-send-receive. (At least for CEDET).
1415 (replace-regexp-in-string "_emacs_out +" "" string)
1416 (python-shell-internal-get-or-create-process) nil))
1418 (define-obsolete-function-alias
1419 'python-send-receive 'python-shell-internal-send-string "23.3"
1420 "Send STRING to inferior Python (if any) and return result.
1421 The result is what follows `_emacs_out' in the output.
1422 This is a no-op if `python-check-comint-prompt' returns nil.")
1424 (defun python-shell-send-region (start end)
1425 "Send the region delimited by START and END to inferior Python process."
1427 (let ((deactivate-mark nil))
1428 (python-shell-send-string (buffer-substring start end) nil t)))
1430 (defun python-shell-send-buffer ()
1431 "Send the entire buffer to inferior Python process."
1435 (python-shell-send-region (point-min) (point-max))))
1437 (defun python-shell-send-defun (arg)
1438 "Send the current defun to inferior Python process.
1439 When argument ARG is non-nil sends the innermost defun."
1442 (python-shell-send-region
1444 (or (python-beginning-of-defun-function)
1445 (progn (beginning-of-line) (point-marker))))
1447 (or (python-end-of-defun-function)
1448 (progn (end-of-line) (point-marker)))))))
1450 (defun python-shell-send-file (file-name &optional process temp-file-name)
1451 "Send FILE-NAME to inferior Python PROCESS.
1452 If TEMP-FILE-NAME is passed then that file is used for processing
1453 instead, while internally the shell will continue to use
1455 (interactive "fFile to send: ")
1456 (let* ((process (or process (python-shell-get-or-create-process)))
1457 (temp-file-name (when temp-file-name
1458 (expand-file-name temp-file-name)))
1459 (file-name (or (expand-file-name file-name) temp-file-name)))
1460 (when (not file-name)
1461 (error "If FILE-NAME is nil then TEMP-FILE-NAME must be non-nil"))
1462 (with-current-buffer (process-buffer process)
1463 (setq inferior-python-mode-current-file
1464 (convert-standard-filename file-name)))
1465 (python-shell-send-string
1467 (concat "__pyfile = open('''%s''');"
1468 "exec(compile(__pyfile.read(), '''%s''', 'exec'));"
1470 (or temp-file-name file-name) file-name)
1473 (defun python-shell-switch-to-shell ()
1474 "Switch to inferior Python process buffer."
1476 (pop-to-buffer (process-buffer (python-shell-get-or-create-process)) t))
1478 (defun python-shell-send-setup-code ()
1479 "Send all setup code for shell.
1480 This function takes the list of setup code to send from the
1481 `python-shell-setup-codes' list."
1482 (let ((msg "Sent %s")
1483 (process (get-buffer-process (current-buffer))))
1484 (accept-process-output process python-shell-send-setup-max-wait)
1485 (dolist (code python-shell-setup-codes)
1488 (setq msg (cdr code)))
1489 (message (format msg code))
1490 (python-shell-send-string-no-output
1491 (symbol-value code) process)))))
1493 (add-hook 'inferior-python-mode-hook
1494 #'python-shell-send-setup-code)
1497 ;;; Shell completion
1499 (defcustom python-shell-completion-setup-code
1503 def __COMPLETER_all_completions(text): []
1506 readline.set_completer(rlcompleter.Completer().complete)
1507 def __COMPLETER_all_completions(text):
1513 res = readline.get_completer()(text, i)
1516 completions.append(res)
1520 "Code used to setup completion in inferior Python processes."
1525 (defcustom python-shell-completion-string-code
1526 "';'.join(__COMPLETER_all_completions('''%s'''))\n"
1527 "Python code used to get a string of completions separated by semicolons."
1532 (defun python-shell-completion--get-completions (input process)
1533 "Retrieve available completions for INPUT using PROCESS."
1534 (with-current-buffer (process-buffer process)
1535 (let ((completions (python-shell-send-string-no-output
1536 (format python-shell-completion-string-code input)
1538 (when (> (length completions) 2)
1539 (split-string completions "^'\\|^\"\\|;\\|'$\\|\"$" t)))))
1541 (defun python-shell-completion--get-completion (input completions)
1542 "Get completion for INPUT using COMPLETIONS."
1543 (let ((completion (when completions
1544 (try-completion input completions))))
1545 (cond ((eq completion t)
1548 (message "Can't find completion for \"%s\"" input)
1551 ((not (string= input completion))
1554 (message "Making completion list...")
1555 (with-output-to-temp-buffer "*Python Completions*"
1556 (display-completion-list
1557 (all-completions input completions)))
1560 (defun python-shell-completion-complete-at-point ()
1561 "Perform completion at point in inferior Python process."
1563 (with-syntax-table python-dotty-syntax-table
1564 (when (and comint-last-prompt-overlay
1565 (> (point-marker) (overlay-end comint-last-prompt-overlay)))
1566 (let* ((process (get-buffer-process (current-buffer)))
1567 (input (substring-no-properties
1568 (or (comint-word (current-word)) "") nil nil)))
1569 (delete-char (- (length input)))
1571 (python-shell-completion--get-completion
1572 input (python-shell-completion--get-completions input process)))))))
1574 (defun python-shell-completion-complete-or-indent ()
1575 "Complete or indent depending on the context.
1576 If content before pointer is all whitespace indent. If not try
1579 (if (string-match "^[[:space:]]*$"
1580 (buffer-substring (comint-line-beginning-position)
1582 (indent-for-tab-command)
1583 (comint-dynamic-complete)))
1586 ;;; PDB Track integration
1588 (defcustom python-pdbtrack-stacktrace-info-regexp
1589 "> %s(\\([0-9]+\\))\\([?a-zA-Z0-9_<>]+\\)()"
1590 "Regular Expression matching stacktrace information.
1591 Used to extract the current line and module being inspected. The
1592 regexp should not start with a caret (^) and can contain a string
1593 placeholder (\%s) which is replaced with the filename beign
1594 inspected (so other files in the debugging process are not
1600 (defvar python-pdbtrack-tracking-buffers '()
1601 "Alist containing elements of form (#<buffer> . #<buffer>).
1602 The car of each element of the alist is the tracking buffer and
1603 the cdr is the tracked buffer.")
1605 (defun python-pdbtrack-get-or-add-tracking-buffers ()
1606 "Get/Add a tracked buffer for the current buffer.
1607 Internally it uses the `python-pdbtrack-tracking-buffers' alist.
1608 Returns a cons with the form:
1609 * (#<tracking buffer> . #< tracked buffer>)."
1611 (assq (current-buffer) python-pdbtrack-tracking-buffers)
1612 (let* ((file (with-current-buffer (current-buffer)
1613 inferior-python-mode-current-file))
1615 `(,(current-buffer) .
1616 ,(or (get-file-buffer file)
1617 (find-file-noselect file)))))
1618 (set-buffer (cdr tracking-buffers))
1620 (set-buffer (car tracking-buffers))
1621 (setq python-pdbtrack-tracking-buffers
1622 (cons tracking-buffers python-pdbtrack-tracking-buffers))
1625 (defun python-pdbtrack-comint-output-filter-function (output)
1626 "Move overlay arrow to current pdb line in tracked buffer.
1627 Argument OUTPUT is a string with the output from the comint process."
1628 (when (not (string= output ""))
1629 (let ((full-output (ansi-color-filter-apply
1630 (buffer-substring comint-last-input-end
1632 (if (string-match python-shell-prompt-pdb-regexp full-output)
1633 (let* ((tracking-buffers (python-pdbtrack-get-or-add-tracking-buffers))
1637 (format python-pdbtrack-stacktrace-info-regexp
1639 inferior-python-mode-current-file))
1641 (string-to-number (or (match-string-no-properties 1 full-output) ""))))
1642 (tracked-buffer-window (get-buffer-window (cdr tracking-buffers)))
1643 (tracked-buffer-line-pos))
1645 (with-current-buffer (cdr tracking-buffers)
1646 (set (make-local-variable 'overlay-arrow-string) "=>")
1647 (set (make-local-variable 'overlay-arrow-position) (make-marker))
1648 (setq tracked-buffer-line-pos (progn
1649 (goto-char (point-min))
1650 (forward-line (1- line-num))
1652 (when tracked-buffer-window
1653 (set-window-point tracked-buffer-window tracked-buffer-line-pos))
1654 (set-marker overlay-arrow-position tracked-buffer-line-pos)))
1655 (pop-to-buffer (cdr tracking-buffers))
1656 (switch-to-buffer-other-window (car tracking-buffers)))
1657 (let ((tracking-buffers (assq (current-buffer)
1658 python-pdbtrack-tracking-buffers)))
1659 (when tracking-buffers
1660 (if inferior-python-mode-current-file
1661 (with-current-buffer (cdr tracking-buffers)
1662 (set-marker overlay-arrow-position nil))
1663 (kill-buffer (cdr tracking-buffers)))
1664 (setq python-pdbtrack-tracking-buffers
1665 (assq-delete-all (current-buffer)
1666 python-pdbtrack-tracking-buffers)))))))
1670 ;;; Symbol completion
1672 (defun python-completion-complete-at-point ()
1673 "Complete current symbol at point.
1674 For this to work the best as possible you should call
1675 `python-shell-send-buffer' from time to time so context in
1676 inferior python process is updated properly."
1678 (let ((process (python-shell-get-process)))
1680 (error "Completion needs an inferior Python process running")
1681 (with-syntax-table python-dotty-syntax-table
1682 (let* ((input (substring-no-properties
1683 (or (comint-word (current-word)) "") nil nil))
1684 (completions (python-shell-completion--get-completions
1686 (delete-char (- (length input)))
1688 (python-shell-completion--get-completion
1689 input completions)))))))
1691 (add-to-list 'debug-ignored-errors "^Completion needs an inferior Python process running.")
1696 (defcustom python-fill-comment-function 'python-fill-comment
1697 "Function to fill comments.
1698 This is the function used by `python-fill-paragraph-function' to
1704 (defcustom python-fill-string-function 'python-fill-string
1705 "Function to fill strings.
1706 This is the function used by `python-fill-paragraph-function' to
1712 (defcustom python-fill-decorator-function 'python-fill-decorator
1713 "Function to fill decorators.
1714 This is the function used by `python-fill-paragraph-function' to
1720 (defcustom python-fill-paren-function 'python-fill-paren
1721 "Function to fill parens.
1722 This is the function used by `python-fill-paragraph-function' to
1728 (defun python-fill-paragraph-function (&optional justify)
1729 "`fill-paragraph-function' handling multi-line strings and possibly comments.
1730 If any of the current line is in or at the end of a multi-line string,
1731 fill the string or the paragraph of it that point is in, preserving
1732 the string's indentation.
1733 Optional argument JUSTIFY defines if the paragraph should be justified."
1736 (back-to-indentation)
1739 ((funcall python-fill-comment-function justify))
1740 ;; Strings/Docstrings
1741 ((save-excursion (skip-chars-forward "\"'uUrR")
1742 (python-info-ppss-context 'string))
1743 (funcall python-fill-string-function justify))
1745 ((equal (char-after (save-excursion
1746 (back-to-indentation)
1747 (point-marker))) ?@)
1748 (funcall python-fill-decorator-function justify))
1750 ((or (python-info-ppss-context 'paren)
1751 (looking-at (python-rx open-paren))
1753 (skip-syntax-forward "^(" (line-end-position))
1754 (looking-at (python-rx open-paren))))
1755 (funcall python-fill-paren-function justify))
1758 (defun python-fill-comment (&optional justify)
1759 "Comment fill function for `python-fill-paragraph-function'.
1760 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
1761 (fill-comment-paragraph justify))
1763 (defun python-fill-string (&optional justify)
1764 "String fill function for `python-fill-paragraph-function'.
1765 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
1766 (let ((marker (point-marker))
1767 (string-start-marker
1769 (skip-chars-forward "\"'uUrR")
1770 (goto-char (python-info-ppss-context 'string))
1771 (skip-chars-forward "\"'uUrR")
1773 (reg-start (line-beginning-position))
1776 (while (python-info-ppss-context 'string)
1777 (goto-char (1+ (point-marker))))
1778 (skip-chars-backward "\"'")
1780 (reg-end (line-end-position))
1781 (fill-paragraph-function))
1783 (narrow-to-region reg-start reg-end)
1785 (goto-char string-start-marker)
1786 (delete-region (point-marker) (progn
1787 (skip-syntax-forward "> ")
1789 (goto-char string-end-marker)
1790 (delete-region (point-marker) (progn
1791 (skip-syntax-backward "> ")
1795 (fill-paragraph justify))
1796 ;; If there is a newline in the docstring lets put triple
1797 ;; quote in it's own line to follow pep 8
1798 (when (save-excursion
1799 (re-search-backward "\n" string-start-marker t))
1801 (newline-and-indent))
1802 (fill-paragraph justify)))) t)
1804 (defun python-fill-decorator (&optional justify)
1805 "Decorator fill function for `python-fill-paragraph-function'.
1806 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
1809 (defun python-fill-paren (&optional justify)
1810 "Paren fill function for `python-fill-paragraph-function'.
1811 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
1813 (narrow-to-region (progn
1814 (while (python-info-ppss-context 'paren)
1815 (goto-char (1- (point-marker))))
1817 (line-beginning-position))
1819 (when (not (python-info-ppss-context 'paren))
1821 (when (not (python-info-ppss-context 'paren))
1822 (skip-syntax-backward "^)")))
1823 (while (python-info-ppss-context 'paren)
1824 (goto-char (1+ (point-marker))))
1826 (let ((paragraph-start "\f\\|[ \t]*$")
1827 (paragraph-separate ",")
1828 (fill-paragraph-function))
1829 (goto-char (point-min))
1830 (fill-paragraph justify))
1833 (python-indent-line)
1834 (goto-char (line-end-position)))) t)
1839 (defcustom python-skeleton-autoinsert nil
1840 "Non-nil means template skeletons will be automagically inserted.
1841 This happens when pressing \"if<SPACE>\", for example, to prompt for
1847 (defvar python-skeleton-available '()
1848 "Internal list of available skeletons.")
1850 (define-abbrev-table 'python-mode-abbrev-table ()
1851 "Abbrev table for Python mode."
1853 ;; Allow / inside abbrevs.
1854 :regexp "\\(?:^\\|[^/]\\)\\<\\([[:word:]/]+\\)\\W*"
1855 ;; Only expand in code.
1856 :enable-function (lambda ()
1858 (not (or (python-info-ppss-context 'string)
1859 (python-info-ppss-context 'comment)))
1860 python-skeleton-autoinsert)))
1862 (defmacro python-skeleton-define (name doc &rest skel)
1863 "Define a `python-mode' skeleton using NAME DOC and SKEL.
1864 The skeleton will be bound to python-skeleton-NAME and will
1865 be added to `python-mode-abbrev-table'."
1866 (let* ((name (symbol-name name))
1867 (function-name (intern (concat "python-skeleton-" name))))
1869 (define-abbrev python-mode-abbrev-table ,name "" ',function-name)
1870 (setq python-skeleton-available
1871 (cons ',function-name python-skeleton-available))
1872 (define-skeleton ,function-name
1874 (format "Insert %s statement." name))
1876 (put 'python-skeleton-define 'lisp-indent-function 2)
1878 (defmacro python-define-auxiliary-skeleton (name doc &optional &rest skel)
1879 "Define a `python-mode' auxiliary skeleton using NAME DOC and SKEL.
1880 The skeleton will be bound to python-skeleton-NAME."
1881 (let* ((name (symbol-name name))
1882 (function-name (intern (concat "python-skeleton--" name)))
1884 "Add '%s' clause? " name)))
1887 `(< ,(format "%s:" name) \n \n
1889 `(define-skeleton ,function-name
1891 (format "Auxiliary skeleton for %s statement." name))
1893 (unless (y-or-n-p ,msg)
1896 (put 'python-define-auxiliary-skeleton 'lisp-indent-function 2)
1898 (python-define-auxiliary-skeleton else nil)
1900 (python-define-auxiliary-skeleton except nil)
1902 (python-define-auxiliary-skeleton finally nil)
1904 (python-skeleton-define if nil
1908 ("other condition, %s: "
1912 '(python-skeleton--else) | ^)
1914 (python-skeleton-define while nil
1918 '(python-skeleton--else) | ^)
1920 (python-skeleton-define for nil
1924 '(python-skeleton--else) | ^)
1926 (python-skeleton-define try nil
1932 "except " str ":" \n
1935 '(python-skeleton--except)
1936 '(python-skeleton--else)
1937 '(python-skeleton--finally) | ^)
1939 (python-skeleton-define def nil
1941 "def " str " (" ("Parameter, %s: "
1942 (unless (equal ?\( (char-before)) ", ")
1944 "\"\"\"" - "\"\"\"" \n
1947 (python-skeleton-define class nil
1949 "class " str " (" ("Inheritance, %s: "
1950 (unless (equal ?\( (char-before)) ", ")
1954 "\"\"\"" - "\"\"\"" \n
1957 (defun python-skeleton-add-menu-items ()
1958 "Add menu items to Python->Skeletons menu."
1959 (let ((skeletons (sort python-skeleton-available 'string<))
1961 (dolist (skeleton skeletons)
1963 nil '("Python" "Skeletons")
1965 "Insert %s" (caddr (split-string (symbol-name skeleton) "-")))
1970 (defcustom python-ffap-setup-code
1971 "def __FFAP_get_module_path(module):
1974 path = __import__(module).__file__
1975 if path[-4:] == '.pyc' and os.path.exists(path[0:-1]):
1980 "Python code to get a module path."
1985 (defcustom python-ffap-string-code
1986 "__FFAP_get_module_path('''%s''')\n"
1987 "Python code used to get a string with the path of a module."
1992 (defun python-ffap-module-path (module)
1993 "Function for `ffap-alist' to return path for MODULE."
1995 (and (eq major-mode 'inferior-python-mode)
1996 (get-buffer-process (current-buffer)))
1997 (python-shell-get-process))))
2001 (python-shell-send-string-no-output
2002 (format python-ffap-string-code module) process)))
2004 (substring-no-properties module-file 1 -1))))))
2006 (eval-after-load "ffap"
2008 (push '(python-mode . python-ffap-module-path) ffap-alist)
2009 (push '(inferior-python-mode . python-ffap-module-path) ffap-alist)))
2014 (defcustom python-check-command
2015 "pychecker --stdlib"
2016 "Command used to check a Python file."
2021 (defvar python-check-custom-command nil
2024 (defun python-check (command)
2025 "Check a Python file (default current buffer's file).
2026 Runs COMMAND, a shell command, as if by `compile'. See
2027 `python-check-command' for the default."
2029 (list (read-string "Check command: "
2030 (or python-check-custom-command
2031 (concat python-check-command " "
2032 (shell-quote-argument
2034 (let ((name (buffer-file-name)))
2036 (file-name-nondirectory name)))
2038 (setq python-check-custom-command command)
2039 (save-some-buffers (not compilation-ask-about-save) nil)
2040 (compilation-start command))
2045 (defcustom python-eldoc-setup-code
2046 "def __PYDOC_get_help(obj):
2049 if hasattr(obj, 'startswith'):
2050 obj = eval(obj, globals())
2051 doc = inspect.getdoc(obj)
2052 if not doc and callable(obj):
2054 if inspect.isclass(obj) and hasattr(obj, '__init__'):
2055 target = obj.__init__
2061 args = inspect.formatargspec(
2062 *inspect.getargspec(target)
2065 doc = '{objtype} {name}{args}'.format(
2066 objtype=objtype, name=name, args=args
2069 doc = doc.splitlines()[0]
2076 "Python code to setup documentation retrieval."
2081 (defcustom python-eldoc-string-code
2082 "__PYDOC_get_help('''%s''')\n"
2083 "Python code used to get a string with the documentation of an object."
2088 (defun python-eldoc--get-doc-at-point (&optional force-input force-process)
2089 "Internal implementation to get documentation at point.
2090 If not FORCE-INPUT is passed then what `current-word' returns
2091 will be used. If not FORCE-PROCESS is passed what
2092 `python-shell-get-process' returns is used."
2093 (let ((process (or force-process (python-shell-get-process))))
2095 "Eldoc needs an inferior Python process running."
2096 (let* ((current-defun (python-info-current-defun))
2097 (input (or force-input
2098 (with-syntax-table python-dotty-syntax-table
2099 (if (not current-defun)
2101 (concat current-defun "." (current-word))))))
2102 (ppss (syntax-ppss))
2103 (help (when (and input
2104 (not (string= input (concat current-defun ".")))
2105 (not (or (python-info-ppss-context 'string ppss)
2106 (python-info-ppss-context 'comment ppss))))
2107 (when (string-match (concat
2108 (regexp-quote (concat current-defun "."))
2112 (goto-char (point-min))
2115 (delete-region (point-marker) (search-forward "self."))
2116 (setq input (buffer-substring (point-min) (point-max)))))
2117 (python-shell-send-string-no-output
2118 (format python-eldoc-string-code input) process))))
2119 (with-current-buffer (process-buffer process)
2120 (when comint-last-prompt-overlay
2121 (delete-region comint-last-input-end
2122 (overlay-start comint-last-prompt-overlay))))
2124 (not (string= help "\n")))
2127 (defun python-eldoc-function ()
2128 "`eldoc-documentation-function' for Python.
2129 For this to work the best as possible you should call
2130 `python-shell-send-buffer' from time to time so context in
2131 inferior python process is updated properly."
2132 (python-eldoc--get-doc-at-point))
2134 (defun python-eldoc-at-point (symbol)
2135 "Get help on SYMBOL using `help'.
2136 Interactively, prompt for symbol."
2138 (let ((symbol (with-syntax-table python-dotty-syntax-table
2140 (enable-recursive-minibuffers t))
2141 (list (read-string (if symbol
2142 (format "Describe symbol (default %s): " symbol)
2143 "Describe symbol: ")
2145 (let ((process (python-shell-get-process)))
2147 (message "Eldoc needs an inferior Python process running.")
2148 (message (python-eldoc--get-doc-at-point symbol process)))))
2153 (defcustom python-imenu-include-defun-type t
2154 "Non-nil make imenu items to include its type."
2159 (defcustom python-imenu-make-tree t
2160 "Non-nil make imenu to build a tree menu.
2161 Set to nil for speed."
2166 (defcustom python-imenu-subtree-root-label "<Jump to %s>"
2167 "Label displayed to navigate to root from a subtree.
2168 It can contain a \"%s\" which will be replaced with the root name."
2173 (defvar python-imenu-index-alist nil
2174 "Calculated index tree for imenu.")
2176 (defun python-imenu-tree-assoc (keylist tree)
2177 "Using KEYLIST traverse TREE."
2179 (python-imenu-tree-assoc (cdr keylist)
2180 (ignore-errors (assoc (car keylist) tree)))
2183 (defun python-imenu-make-element-tree (element-list full-element plain-index)
2184 "Make a tree from plain alist of module names.
2185 ELEMENT-LIST is the defun name splitted by \".\" and FULL-ELEMENT
2186 is the same thing, the difference is that FULL-ELEMENT remains
2187 untouched in all recursive calls.
2188 Argument PLAIN-INDEX is the calculated plain index used to build the tree."
2189 (when (not (python-imenu-tree-assoc full-element python-imenu-index-alist))
2191 (let* ((subelement-point (cdr (assoc
2192 (mapconcat #'identity full-element ".")
2194 (subelement-name (car element-list))
2195 (subelement-position (python-util-position
2196 subelement-name full-element))
2197 (subelement-path (when subelement-position
2200 (- (length full-element)
2201 subelement-position)))))
2202 (let ((path-ref (python-imenu-tree-assoc subelement-path
2203 python-imenu-index-alist)))
2205 (push (cons subelement-name subelement-point)
2206 python-imenu-index-alist)
2207 (when (not (listp (cdr path-ref)))
2208 ;; Modifiy root cdr to be a list
2210 (list (cons (format python-imenu-subtree-root-label
2213 (mapconcat #'identity
2214 subelement-path ".")
2216 (when (not (assoc subelement-name path-ref))
2217 (push (cons subelement-name subelement-point) (cdr path-ref))))))
2218 (python-imenu-make-element-tree (cdr element-list)
2219 full-element plain-index))))
2221 (defun python-imenu-make-tree (index)
2222 "Build the imenu alist tree from plain INDEX.
2224 The idea of this function is that given the alist:
2227 (\"Test.__init__\" . 200)
2228 (\"Test.some_method\" . 300)
2229 (\"Test.some_method.another\" . 400)
2230 (\"Test.something_else\" . 500)
2232 (\"test.reprint\" . 700)
2233 (\"test.reprint\" . 800))
2235 This tree gets built:
2237 '((\"Test\" . ((\"jump to...\" . 100)
2238 (\"__init__\" . 200)
2239 (\"some_method\" . ((\"jump to...\" . 300)
2240 (\"another\" . 400)))
2241 (\"something_else\" . 500)))
2242 (\"test\" . ((\"jump to...\" . 600)
2244 (\"reprint\" . 800))))
2246 Internally it uses `python-imenu-make-element-tree' to create all
2247 branches for each element."
2248 (setq python-imenu-index-alist nil)
2249 (mapc (lambda (element)
2250 (python-imenu-make-element-tree element element index))
2251 (mapcar (lambda (element)
2252 (split-string (car element) "\\." t)) index))
2253 python-imenu-index-alist)
2255 (defun python-imenu-create-index ()
2256 "`imenu-create-index-function' for Python."
2258 (goto-char (point-max))
2259 (while (python-beginning-of-defun-function 1 t)
2260 (let ((defun-dotted-name
2261 (python-info-current-defun python-imenu-include-defun-type)))
2262 (push (cons defun-dotted-name (point)) index)))
2263 (if python-imenu-make-tree
2264 (python-imenu-make-tree index)
2270 (defun python-info-current-defun (&optional include-type)
2271 "Return name of surrounding function with Python compatible dotty syntax.
2272 Optional argument INCLUDE-TYPE indicates to include the type of the defun.
2273 This function is compatible to be used as
2274 `add-log-current-defun-function' since it returns nil if point is
2275 not inside a defun."
2282 (goto-char (line-end-position))
2283 (forward-comment -9999)
2284 (setq min-indent (current-indentation))
2285 (while (python-beginning-of-defun-function 1 t)
2286 (when (or (< (current-indentation) min-indent)
2288 (setq first-run nil)
2289 (setq min-indent (current-indentation))
2290 (looking-at python-nav-beginning-of-defun-regexp)
2292 (if (not include-type)
2293 (match-string-no-properties 1)
2294 (mapconcat 'identity
2296 (match-string-no-properties 0)) " "))
2299 (mapconcat (lambda (string) string) names "."))))
2301 (defun python-info-closing-block ()
2302 "Return the point of the block the current line closes."
2303 (let ((closing-word (save-excursion
2304 (back-to-indentation)
2306 (indentation (current-indentation)))
2307 (when (member closing-word python-indent-dedenters)
2310 (while (and (> (current-indentation) indentation)
2312 (not (back-to-indentation))
2314 (back-to-indentation)
2316 ((not (equal indentation (current-indentation))) nil)
2317 ((string= closing-word "elif")
2318 (when (member (current-word) '("if" "elif"))
2320 ((string= closing-word "else")
2321 (when (member (current-word) '("if" "elif" "except" "for" "while"))
2323 ((string= closing-word "except")
2324 (when (member (current-word) '("try"))
2326 ((string= closing-word "finally")
2327 (when (member (current-word) '("except" "else"))
2328 (point-marker))))))))
2330 (defun python-info-line-ends-backslash-p ()
2331 "Return non-nil if current line ends with backslash."
2332 (string= (or (ignore-errors
2335 (- (line-end-position) 1))) "") "\\"))
2337 (defun python-info-continuation-line-p ()
2338 "Return non-nil if current line is continuation of another."
2339 (let ((current-ppss-context-type (python-info-ppss-context-type)))
2341 (equal (save-excursion
2342 (goto-char (line-end-position))
2343 (forward-comment 9999)
2344 (python-info-ppss-context-type))
2345 current-ppss-context-type)
2346 (or (python-info-line-ends-backslash-p)
2347 (string-match ",[[:space:]]*$" (buffer-substring
2348 (line-beginning-position)
2349 (line-end-position)))
2351 (let ((innermost-paren (progn
2352 (goto-char (line-end-position))
2353 (python-info-ppss-context 'paren))))
2354 (when (and innermost-paren
2355 (and (<= (line-beginning-position) innermost-paren)
2356 (>= (line-end-position) innermost-paren)))
2357 (goto-char innermost-paren)
2358 (looking-at (python-rx open-paren (* space) line-end)))))
2360 (back-to-indentation)
2361 (python-info-ppss-context 'paren))))))
2363 (defun python-info-block-continuation-line-p ()
2364 "Return non-nil if current line is a continuation of a block."
2366 (while (and (not (bobp))
2367 (python-info-continuation-line-p))
2370 (back-to-indentation)
2371 (when (looking-at (python-rx block-start))
2374 (defun python-info-assignment-continuation-line-p ()
2375 "Return non-nil if current line is a continuation of an assignment."
2377 (while (and (not (bobp))
2378 (python-info-continuation-line-p))
2381 (back-to-indentation)
2382 (when (and (not (looking-at (python-rx block-start)))
2384 (and (re-search-forward (python-rx not-simple-operator
2386 not-simple-operator)
2387 (line-end-position) t)
2388 (not (or (python-info-ppss-context 'string)
2389 (python-info-ppss-context 'paren)
2390 (python-info-ppss-context 'comment))))))
2393 (defun python-info-ppss-context (type &optional syntax-ppss)
2394 "Return non-nil if point is on TYPE using SYNTAX-PPSS.
2395 TYPE can be 'comment, 'string or 'paren. It returns the start
2396 character address of the specified TYPE."
2397 (let ((ppss (or syntax-ppss (syntax-ppss))))
2408 (defun python-info-ppss-context-type (&optional syntax-ppss)
2409 "Return the context type using SYNTAX-PPSS.
2410 The type returned can be 'comment, 'string or 'paren."
2411 (let ((ppss (or syntax-ppss (syntax-ppss))))
2423 ;;; Utility functions
2426 (defun python-util-merge (type list1 list2 pred)
2427 "Destructively merge lists to produce a new one.
2428 Argument TYPE is for compatibility and ignored. LIST1 and LIST2
2429 are the list to be merged. Ordering of the elements is preserved
2430 according to PRED, a `less-than' predicate on the elements."
2432 (while (and list1 list2)
2433 (if (funcall pred (car list2) (car list1))
2434 (push (pop list2) res)
2435 (push (pop list1) res)))
2436 (nconc (nreverse res) list1 list2)))
2438 (defun python-util-position (item seq)
2439 "Find the first occurrence of ITEM in SEQ.
2440 Return the index of the matching item, or nil if not found."
2441 (let ((member-result (member item seq)))
2443 (- (length seq) (length member-result)))))
2445 ;; Stolen from org-mode
2446 (defun python-clone-local-variables (from-buffer &optional regexp)
2447 "Clone local variables from FROM-BUFFER.
2448 Optional argument REGEXP selects variables to clone and defaults
2452 (and (symbolp (car pair))
2453 (string-match (or regexp "^python-")
2454 (symbol-name (car pair)))
2455 (set (make-local-variable (car pair))
2457 (buffer-local-variables from-buffer)))
2461 (define-derived-mode python-mode fundamental-mode "Python"
2462 "Major mode for editing Python files.
2465 Entry to this mode calls the value of `python-mode-hook'
2466 if that value is non-nil."
2467 (set (make-local-variable 'tab-width) 8)
2468 (set (make-local-variable 'indent-tabs-mode) nil)
2470 (set (make-local-variable 'comment-start) "# ")
2471 (set (make-local-variable 'comment-start-skip) "#+\\s-*")
2473 (set (make-local-variable 'parse-sexp-lookup-properties) t)
2474 (set (make-local-variable 'parse-sexp-ignore-comments) t)
2476 (set (make-local-variable 'font-lock-defaults)
2477 '(python-font-lock-keywords
2479 (font-lock-syntactic-keywords . python-font-lock-syntactic-keywords)))
2481 (set (make-local-variable 'indent-line-function) #'python-indent-line-function)
2482 (set (make-local-variable 'indent-region-function) #'python-indent-region)
2484 (set (make-local-variable 'paragraph-start) "\\s-*$")
2485 (set (make-local-variable 'fill-paragraph-function) 'python-fill-paragraph-function)
2487 (set (make-local-variable 'beginning-of-defun-function)
2488 #'python-beginning-of-defun-function)
2489 (set (make-local-variable 'end-of-defun-function)
2490 #'python-end-of-defun-function)
2492 (add-hook 'completion-at-point-functions
2493 'python-completion-complete-at-point nil 'local)
2495 (setq imenu-create-index-function #'python-imenu-create-index)
2497 (set (make-local-variable 'add-log-current-defun-function)
2498 #'python-info-current-defun)
2500 (set (make-local-variable 'skeleton-further-elements)
2502 (< '(backward-delete-char-untabify (min python-indent-offset
2504 (^ '(- (1+ (current-indentation))))))
2506 (set (make-local-variable 'eldoc-documentation-function)
2507 #'python-eldoc-function)
2509 (add-to-list 'hs-special-modes-alist
2510 `(python-mode "^\\s-*\\(?:def\\|class\\)\\>" nil "#"
2512 (python-end-of-defun-function)) nil))
2514 (set (make-local-variable 'mode-require-final-newline) t)
2516 (set (make-local-variable 'outline-regexp)
2517 (python-rx (* space) block-start))
2518 (set (make-local-variable 'outline-heading-end-regexp) ":\\s-*\n")
2519 (set (make-local-variable 'outline-level)
2521 "`outline-level' function for Python mode."
2522 (1+ (/ (current-indentation) python-indent-offset))))
2524 (python-skeleton-add-menu-items)
2526 (when python-indent-guess-indent-offset
2527 (python-indent-guess-indent-offset)))
2531 ;;; python.el ends here