1 ;;; python.el --- Python's flying circus support for Emacs
3 ;; Copyright (C) 2003-2013 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',
54 ;; `python-nav-beginning-of-statement', `python-nav-end-of-statement',
55 ;; `python-nav-beginning-of-block' and `python-nav-end-of-block' are
56 ;; included but no bound to any key. At last but not least the
57 ;; specialized `python-nav-forward-sexp' allows easy navigation
58 ;; between code blocks. If you prefer `cc-mode'-like `forward-sexp'
59 ;; movement, setting `forward-sexp-function' to nil is enough, You can
60 ;; do that using the `python-mode-hook':
62 ;; (add-hook 'python-mode-hook
63 ;; (lambda () (setq forward-sexp-function nil)))
65 ;; Shell interaction: is provided and allows you to execute easily any
66 ;; block of code of your current buffer in an inferior Python process.
68 ;; Shell completion: hitting tab will try to complete the current
69 ;; word. Shell completion is implemented in a manner that if you
70 ;; change the `python-shell-interpreter' to any other (for example
71 ;; IPython) it should be easy to integrate another way to calculate
72 ;; completions. You just need to specify your custom
73 ;; `python-shell-completion-setup-code' and
74 ;; `python-shell-completion-string-code'.
76 ;; Here is a complete example of the settings you would use for
80 ;; python-shell-interpreter "ipython"
81 ;; python-shell-interpreter-args ""
82 ;; python-shell-prompt-regexp "In \\[[0-9]+\\]: "
83 ;; python-shell-prompt-output-regexp "Out\\[[0-9]+\\]: "
84 ;; python-shell-completion-setup-code
85 ;; "from IPython.core.completerlib import module_completion"
86 ;; python-shell-completion-module-string-code
87 ;; "';'.join(module_completion('''%s'''))\n"
88 ;; python-shell-completion-string-code
89 ;; "';'.join(get_ipython().Completer.all_completions('''%s'''))\n")
91 ;; For iPython 0.10 everything would be the same except for
92 ;; `python-shell-completion-string-code' and
93 ;; `python-shell-completion-module-string-code':
95 ;; (setq python-shell-completion-string-code
96 ;; "';'.join(__IP.complete('''%s'''))\n"
97 ;; python-shell-completion-module-string-code "")
99 ;; Unfortunately running iPython on Windows needs some more tweaking.
100 ;; The way you must set `python-shell-interpreter' and
101 ;; `python-shell-interpreter-args' is as follows:
104 ;; python-shell-interpreter "C:\\Python27\\python.exe"
105 ;; python-shell-interpreter-args
106 ;; "-i C:\\Python27\\Scripts\\ipython-script.py")
108 ;; That will spawn the iPython process correctly (Of course you need
109 ;; to modify the paths according to your system).
111 ;; Please note that the default completion system depends on the
112 ;; readline module, so if you are using some Operating System that
113 ;; bundles Python without it (like Windows) just install the
114 ;; pyreadline from http://ipython.scipy.org/moin/PyReadline/Intro and
115 ;; you should be good to go.
117 ;; Shell virtualenv support: The shell also contains support for
118 ;; virtualenvs and other special environment modifications thanks to
119 ;; `python-shell-process-environment' and `python-shell-exec-path'.
120 ;; These two variables allows you to modify execution paths and
121 ;; environment variables to make easy for you to setup virtualenv rules
122 ;; or behavior modifications when running shells. Here is an example
123 ;; of how to make shell processes to be run using the /path/to/env/
126 ;; (setq python-shell-process-environment
128 ;; (format "PATH=%s" (mapconcat
131 ;; (cons (getenv "PATH")
132 ;; '("/path/to/env/bin/")))
134 ;; "VIRTUAL_ENV=/path/to/env/"))
135 ;; (python-shell-exec-path . ("/path/to/env/bin/"))
137 ;; Since the above is cumbersome and can be programmatically
138 ;; calculated, the variable `python-shell-virtualenv-path' is
139 ;; provided. When this variable is set with the path of the
140 ;; virtualenv to use, `process-environment' and `exec-path' get proper
141 ;; values in order to run shells inside the specified virtualenv. So
142 ;; the following will achieve the same as the previous example:
144 ;; (setq python-shell-virtualenv-path "/path/to/env/")
146 ;; Also the `python-shell-extra-pythonpaths' variable have been
147 ;; introduced as simple way of adding paths to the PYTHONPATH without
148 ;; affecting existing values.
150 ;; Pdb tracking: when you execute a block of code that contains some
151 ;; call to pdb (or ipdb) it will prompt the block of code and will
152 ;; follow the execution of pdb marking the current line with an arrow.
154 ;; Symbol completion: you can complete the symbol at point. It uses
155 ;; the shell completion in background so you should run
156 ;; `python-shell-send-buffer' from time to time to get better results.
158 ;; Skeletons: 6 skeletons are provided for simple inserting of class,
159 ;; def, for, if, try and while. These skeletons are integrated with
160 ;; dabbrev. If you have `dabbrev-mode' activated and
161 ;; `python-skeleton-autoinsert' is set to t, then whenever you type
162 ;; the name of any of those defined and hit SPC, they will be
163 ;; automatically expanded. As an alternative you can use the defined
164 ;; skeleton commands: `python-skeleton-class', `python-skeleton-def'
165 ;; `python-skeleton-for', `python-skeleton-if', `python-skeleton-try'
166 ;; and `python-skeleton-while'.
168 ;; FFAP: You can find the filename for a given module when using ffap
169 ;; out of the box. This feature needs an inferior python shell
172 ;; Code check: Check the current file for errors with `python-check'
173 ;; using the program defined in `python-check-command'.
175 ;; Eldoc: returns documentation for object at point by using the
176 ;; inferior python subprocess to inspect its documentation. As you
177 ;; might guessed you should run `python-shell-send-buffer' from time
178 ;; to time to get better results too.
180 ;; Imenu: This mode supports Imenu in its most basic form, letting it
181 ;; build the necessary alist via `imenu-default-create-index-function'
182 ;; by having set `imenu-extract-index-name-function' to
183 ;; `python-info-current-defun' and
184 ;; `imenu-prev-index-position-function' to
185 ;; `python-imenu-prev-index-position'.
187 ;; If you used python-mode.el you probably will miss auto-indentation
188 ;; when inserting newlines. To achieve the same behavior you have
191 ;; 1) Use GNU/Emacs' standard binding for `newline-and-indent': C-j.
193 ;; 2) Add the following hook in your .emacs:
195 ;; (add-hook 'python-mode-hook
197 ;; (define-key python-mode-map "\C-m" 'newline-and-indent)))
199 ;; I'd recommend the first one since you'll get the same behavior for
200 ;; all modes out-of-the-box.
204 ;; Add this to your .emacs:
206 ;; (add-to-list 'load-path "/folder/containing/file")
213 (require 'ansi-color
)
216 ;; Avoid compiler warnings
217 (defvar view-return-to-alist
)
218 (defvar compilation-error-regexp-alist
)
219 (defvar outline-heading-end-regexp
)
221 (autoload 'comint-mode
"comint")
224 (add-to-list 'auto-mode-alist
(cons (purecopy "\\.py\\'") 'python-mode
))
226 (add-to-list 'interpreter-mode-alist
(cons (purecopy "python") 'python-mode
))
229 "Python Language's flying circus support for Emacs."
232 :link
'(emacs-commentary-link "python"))
237 (defvar python-mode-map
238 (let ((map (make-sparse-keymap)))
240 (define-key map
[remap backward-sentence
] 'python-nav-backward-block
)
241 (define-key map
[remap forward-sentence
] 'python-nav-forward-block
)
242 (define-key map
[remap backward-up-list
] 'python-nav-backward-up-list
)
243 (define-key map
"\C-c\C-j" 'imenu
)
245 (define-key map
"\177" 'python-indent-dedent-line-backspace
)
246 (define-key map
(kbd "<backtab>") 'python-indent-dedent-line
)
247 (define-key map
"\C-c<" 'python-indent-shift-left
)
248 (define-key map
"\C-c>" 'python-indent-shift-right
)
249 (define-key map
":" 'python-indent-electric-colon
)
251 (define-key map
"\C-c\C-tc" 'python-skeleton-class
)
252 (define-key map
"\C-c\C-td" 'python-skeleton-def
)
253 (define-key map
"\C-c\C-tf" 'python-skeleton-for
)
254 (define-key map
"\C-c\C-ti" 'python-skeleton-if
)
255 (define-key map
"\C-c\C-tt" 'python-skeleton-try
)
256 (define-key map
"\C-c\C-tw" 'python-skeleton-while
)
258 (define-key map
"\C-c\C-p" 'run-python
)
259 (define-key map
"\C-c\C-s" 'python-shell-send-string
)
260 (define-key map
"\C-c\C-r" 'python-shell-send-region
)
261 (define-key map
"\C-\M-x" 'python-shell-send-defun
)
262 (define-key map
"\C-c\C-c" 'python-shell-send-buffer
)
263 (define-key map
"\C-c\C-l" 'python-shell-send-file
)
264 (define-key map
"\C-c\C-z" 'python-shell-switch-to-shell
)
265 ;; Some util commands
266 (define-key map
"\C-c\C-v" 'python-check
)
267 (define-key map
"\C-c\C-f" 'python-eldoc-at-point
)
269 (substitute-key-definition 'complete-symbol
'completion-at-point
271 (easy-menu-define python-menu map
"Python Mode menu"
273 :help
"Python-specific Features"
274 ["Shift region left" python-indent-shift-left
:active mark-active
275 :help
"Shift region left by a single indentation step"]
276 ["Shift region right" python-indent-shift-right
:active mark-active
277 :help
"Shift region right by a single indentation step"]
279 ["Start of def/class" beginning-of-defun
280 :help
"Go to start of outermost definition around point"]
281 ["End of def/class" end-of-defun
282 :help
"Go to end of definition around point"]
283 ["Mark def/class" mark-defun
284 :help
"Mark outermost definition around point"]
285 ["Jump to def/class" imenu
286 :help
"Jump to a class or function definition"]
290 ["Start interpreter" run-python
291 :help
"Run inferior Python process in a separate buffer"]
292 ["Switch to shell" python-shell-switch-to-shell
293 :help
"Switch to running inferior Python process"]
294 ["Eval string" python-shell-send-string
295 :help
"Eval string in inferior Python session"]
296 ["Eval buffer" python-shell-send-buffer
297 :help
"Eval buffer in inferior Python session"]
298 ["Eval region" python-shell-send-region
299 :help
"Eval region in inferior Python session"]
300 ["Eval defun" python-shell-send-defun
301 :help
"Eval defun in inferior Python session"]
302 ["Eval file" python-shell-send-file
303 :help
"Eval file in inferior Python session"]
304 ["Debugger" pdb
:help
"Run pdb under GUD"]
306 ["Check file" python-check
307 :help
"Check file for errors"]
308 ["Help on symbol" python-eldoc-at-point
309 :help
"Get help on symbol at point"]
310 ["Complete symbol" completion-at-point
311 :help
"Complete symbol before point"]))
313 "Keymap for `python-mode'.")
316 ;;; Python specialized rx
319 (defconst python-rx-constituents
320 `((block-start .
,(rx symbol-start
321 (or "def" "class" "if" "elif" "else" "try"
322 "except" "finally" "for" "while" "with")
324 (decorator .
,(rx line-start
(* space
) ?
@ (any letter ?_
)
326 (defun .
,(rx symbol-start
(or "def" "class") symbol-end
))
327 (if-name-main .
,(rx line-start
"if" (+ space
) "__name__"
328 (+ space
) "==" (+ space
)
329 (any ?
' ?
\") "__main__" (any ?
' ?
\")
331 (symbol-name .
,(rx (any letter ?_
) (* (any word ?_
))))
332 (open-paren .
,(rx (or "{" "[" "(")))
333 (close-paren .
,(rx (or "}" "]" ")")))
334 (simple-operator .
,(rx (any ?
+ ?- ?
/ ?
& ?^ ?~ ?| ?
* ?
< ?
> ?
= ?%
)))
335 ;; FIXME: rx should support (not simple-operator).
336 (not-simple-operator .
,(rx
338 (any ?
+ ?- ?
/ ?
& ?^ ?~ ?| ?
* ?
< ?
> ?
= ?%
))))
339 ;; FIXME: Use regexp-opt.
340 (operator .
,(rx (or "+" "-" "/" "&" "^" "~" "|" "*" "<" ">"
341 "=" "%" "**" "//" "<<" ">>" "<=" "!="
342 "==" ">=" "is" "not")))
343 ;; FIXME: Use regexp-opt.
344 (assignment-operator .
,(rx (or "=" "+=" "-=" "*=" "/=" "//=" "%=" "**="
345 ">>=" "<<=" "&=" "^=" "|=")))
346 (string-delimiter .
,(rx (and
347 ;; Match even number of backslashes.
348 (or (not (any ?
\\ ?
\' ?
\")) point
349 ;; Quotes might be preceded by a escaped quote.
350 (and (or (not (any ?
\\)) point
) ?
\\
351 (* ?
\\ ?
\\) (any ?
\' ?
\")))
353 ;; Match single or triple quotes of any kind.
354 (group (or "\"" "\"\"\"" "'" "'''"))))))
355 "Additional Python specific sexps for `python-rx'")
357 (defmacro python-rx
(&rest regexps
)
358 "Python mode specialized rx macro.
359 This variant of `rx' supports common python named REGEXPS."
360 (let ((rx-constituents (append python-rx-constituents rx-constituents
)))
361 (cond ((null regexps
)
364 (rx-to-string `(and ,@regexps
) t
))
366 (rx-to-string (car regexps
) t
))))))
369 ;;; Font-lock and syntax
372 (defun python-syntax--context-compiler-macro (form type
&optional syntax-ppss
)
375 `(let ((ppss (or ,syntax-ppss
(syntax-ppss))))
376 (and (nth 4 ppss
) (nth 8 ppss
))))
378 `(let ((ppss (or ,syntax-ppss
(syntax-ppss))))
379 (and (nth 3 ppss
) (nth 8 ppss
))))
381 `(nth 1 (or ,syntax-ppss
(syntax-ppss))))
384 (defun python-syntax-context (type &optional syntax-ppss
)
385 "Return non-nil if point is on TYPE using SYNTAX-PPSS.
386 TYPE can be `comment', `string' or `paren'. It returns the start
387 character address of the specified TYPE."
388 (declare (compiler-macro python-syntax--context-compiler-macro
))
389 (let ((ppss (or syntax-ppss
(syntax-ppss))))
391 (`comment
(and (nth 4 ppss
) (nth 8 ppss
)))
392 (`string
(and (nth 3 ppss
) (nth 8 ppss
)))
393 (`paren
(nth 1 ppss
))
396 (defun python-syntax-context-type (&optional syntax-ppss
)
397 "Return the context type using SYNTAX-PPSS.
398 The type returned can be `comment', `string' or `paren'."
399 (let ((ppss (or syntax-ppss
(syntax-ppss))))
401 ((nth 8 ppss
) (if (nth 4 ppss
) 'comment
'string
))
402 ((nth 1 ppss
) 'paren
))))
404 (defsubst python-syntax-comment-or-string-p
()
405 "Return non-nil if point is inside 'comment or 'string."
406 (nth 8 (syntax-ppss)))
408 (define-obsolete-function-alias
409 'python-info-ppss-context
#'python-syntax-context
"24.3")
411 (define-obsolete-function-alias
412 'python-info-ppss-context-type
#'python-syntax-context-type
"24.3")
414 (define-obsolete-function-alias
415 'python-info-ppss-comment-or-string-p
416 #'python-syntax-comment-or-string-p
"24.3")
418 (defvar python-font-lock-keywords
422 "and" "del" "from" "not" "while" "as" "elif" "global" "or" "with"
423 "assert" "else" "if" "pass" "yield" "break" "except" "import" "class"
424 "in" "raise" "continue" "finally" "is" "return" "def" "for" "lambda"
429 ;; False, None, and True are listed as keywords on the Python 3
430 ;; documentation, but since they also qualify as constants they are
431 ;; fontified like that in order to keep font-lock consistent between
438 (,(rx symbol-start
"def" (1+ space
) (group (1+ (or word ?_
))))
439 (1 font-lock-function-name-face
))
441 (,(rx symbol-start
"class" (1+ space
) (group (1+ (or word ?_
))))
442 (1 font-lock-type-face
))
446 "Ellipsis" "False" "None" "NotImplemented" "True" "__debug__"
447 ;; copyright, license, credits, quit and exit are added by the site
448 ;; module and they are not intended to be used in programs
449 "copyright" "credits" "exit" "license" "quit")
450 symbol-end
) . font-lock-constant-face
)
452 (,(rx line-start
(* (any " \t")) (group "@" (1+ (or word ?_
))
453 (0+ "." (1+ (or word ?_
)))))
454 (1 font-lock-type-face
))
455 ;; Builtin Exceptions
458 "ArithmeticError" "AssertionError" "AttributeError" "BaseException"
459 "DeprecationWarning" "EOFError" "EnvironmentError" "Exception"
460 "FloatingPointError" "FutureWarning" "GeneratorExit" "IOError"
461 "ImportError" "ImportWarning" "IndexError" "KeyError"
462 "KeyboardInterrupt" "LookupError" "MemoryError" "NameError"
463 "NotImplementedError" "OSError" "OverflowError"
464 "PendingDeprecationWarning" "ReferenceError" "RuntimeError"
465 "RuntimeWarning" "StopIteration" "SyntaxError" "SyntaxWarning"
466 "SystemError" "SystemExit" "TypeError" "UnboundLocalError"
467 "UnicodeDecodeError" "UnicodeEncodeError" "UnicodeError"
468 "UnicodeTranslateError" "UnicodeWarning" "UserWarning" "VMSError"
469 "ValueError" "Warning" "WindowsError" "ZeroDivisionError"
473 "BufferError" "BytesWarning" "IndentationError" "ResourceWarning"
475 symbol-end
) . font-lock-type-face
)
479 "abs" "all" "any" "bin" "bool" "callable" "chr" "classmethod"
480 "compile" "complex" "delattr" "dict" "dir" "divmod" "enumerate"
481 "eval" "filter" "float" "format" "frozenset" "getattr" "globals"
482 "hasattr" "hash" "help" "hex" "id" "input" "int" "isinstance"
483 "issubclass" "iter" "len" "list" "locals" "map" "max" "memoryview"
484 "min" "next" "object" "oct" "open" "ord" "pow" "print" "property"
485 "range" "repr" "reversed" "round" "set" "setattr" "slice" "sorted"
486 "staticmethod" "str" "sum" "super" "tuple" "type" "vars" "zip"
489 "basestring" "cmp" "execfile" "file" "long" "raw_input" "reduce"
490 "reload" "unichr" "unicode" "xrange" "apply" "buffer" "coerce"
493 "ascii" "bytearray" "bytes" "exec"
495 "__all__" "__doc__" "__name__" "__package__")
496 symbol-end
) . font-lock-builtin-face
)
498 ;; support for a = b = c = 5
500 (let ((re (python-rx (group (+ (any word ?. ?_
)))
501 (? ?\
[ (+ (not (any ?\
]))) ?\
]) (* space
)
502 assignment-operator
)))
503 (when (re-search-forward re limit t
)
504 (while (and (python-syntax-context 'paren
)
505 (re-search-forward re limit t
)))
506 (if (not (or (python-syntax-context 'paren
)
507 (equal (char-after (point-marker)) ?
=)))
509 (set-match-data nil
)))))
510 (1 font-lock-variable-name-face nil nil
))
511 ;; support for a, b, c = (1, 2, 3)
513 (let ((re (python-rx (group (+ (any word ?. ?_
))) (* space
)
514 (* ?
, (* space
) (+ (any word ?. ?_
)) (* space
))
515 ?
, (* space
) (+ (any word ?. ?_
)) (* space
)
516 assignment-operator
)))
517 (when (and (re-search-forward re limit t
)
518 (goto-char (nth 3 (match-data))))
519 (while (and (python-syntax-context 'paren
)
520 (re-search-forward re limit t
))
521 (goto-char (nth 3 (match-data))))
522 (if (not (python-syntax-context 'paren
))
524 (set-match-data nil
)))))
525 (1 font-lock-variable-name-face nil nil
))))
527 (defconst python-syntax-propertize-function
528 (syntax-propertize-rules
529 ((python-rx string-delimiter
)
530 (0 (ignore (python-syntax-stringify))))))
532 (defsubst python-syntax-count-quotes
(quote-char &optional point limit
)
533 "Count number of quotes around point (max is 3).
534 QUOTE-CHAR is the quote char to count. Optional argument POINT is
535 the point where scan starts (defaults to current point) and LIMIT
536 is used to limit the scan."
539 (or (not limit
) (< (+ point i
) limit
))
540 (eq (char-after (+ point i
)) quote-char
))
544 (defun python-syntax-stringify ()
545 "Put `syntax-table' property correctly on single/triple quotes."
546 (let* ((num-quotes (length (match-string-no-properties 1)))
548 (backward-char num-quotes
)
550 (forward-char num-quotes
)))
551 (string-start (and (not (nth 4 ppss
)) (nth 8 ppss
)))
552 (quote-starting-pos (- (point) num-quotes
))
553 (quote-ending-pos (point))
556 (python-syntax-count-quotes
557 (char-before) string-start quote-starting-pos
))))
558 (cond ((and string-start
(= num-closing-quotes
0))
559 ;; This set of quotes doesn't match the string starting
563 ;; This set of quotes delimit the start of a string.
564 (put-text-property quote-starting-pos
(1+ quote-starting-pos
)
565 'syntax-table
(string-to-syntax "|")))
566 ((= num-quotes num-closing-quotes
)
567 ;; This set of quotes delimit the end of a string.
568 (put-text-property (1- quote-ending-pos
) quote-ending-pos
569 'syntax-table
(string-to-syntax "|")))
570 ((> num-quotes num-closing-quotes
)
571 ;; This may only happen whenever a triple quote is closing
572 ;; a single quoted string. Add string delimiter syntax to
574 (put-text-property quote-starting-pos quote-ending-pos
575 'syntax-table
(string-to-syntax "|"))))))
577 (defvar python-mode-syntax-table
578 (let ((table (make-syntax-table)))
579 ;; Give punctuation syntax to ASCII that normally has symbol
580 ;; syntax or has word syntax and isn't a letter.
581 (let ((symbol (string-to-syntax "_"))
582 (sst (standard-syntax-table)))
585 (if (equal symbol
(aref sst i
))
586 (modify-syntax-entry i
"." table
)))))
587 (modify-syntax-entry ?$
"." table
)
588 (modify-syntax-entry ?%
"." table
)
590 (modify-syntax-entry ?
# "<" table
)
591 (modify-syntax-entry ?
\n ">" table
)
592 (modify-syntax-entry ?
' "\"" table
)
593 (modify-syntax-entry ?
` "$" table
)
595 "Syntax table for Python files.")
597 (defvar python-dotty-syntax-table
598 (let ((table (make-syntax-table python-mode-syntax-table
)))
599 (modify-syntax-entry ?.
"w" table
)
600 (modify-syntax-entry ?_
"w" table
)
602 "Dotty syntax table for Python files.
603 It makes underscores and dots word constituent chars.")
608 (defcustom python-indent-offset
4
609 "Default indentation offset for Python."
614 (defcustom python-indent-guess-indent-offset t
615 "Non-nil tells Python mode to guess `python-indent-offset' value."
620 (defcustom python-indent-trigger-commands
621 '(indent-for-tab-command yas-expand yas
/expand
)
622 "Commands that might trigger a `python-indent-line' call."
623 :type
'(repeat symbol
)
626 (define-obsolete-variable-alias
627 'python-indent
'python-indent-offset
"24.3")
629 (define-obsolete-variable-alias
630 'python-guess-indent
'python-indent-guess-indent-offset
"24.3")
632 (defvar python-indent-current-level
0
633 "Current indentation level `python-indent-line-function' is using.")
635 (defvar python-indent-levels
'(0)
636 "Levels of indentation available for `python-indent-line-function'.")
638 (defvar python-indent-dedenters
'("else" "elif" "except" "finally")
639 "List of words that should be dedented.
640 These make `python-indent-calculate-indentation' subtract the value of
641 `python-indent-offset'.")
643 (defvar python-indent-block-enders
'("return" "pass")
644 "List of words that mark the end of a block.
645 These make `python-indent-calculate-indentation' subtract the
646 value of `python-indent-offset' when `python-indent-context' is
649 (defun python-indent-guess-indent-offset ()
650 "Guess and set `python-indent-offset' for the current buffer."
655 (goto-char (point-min))
657 (while (and (not block-end
)
659 (python-rx line-start block-start
) nil t
))
661 (not (python-syntax-context-type))
663 (goto-char (line-end-position))
664 (python-util-forward-comment -
1)
665 (if (equal (char-before) ?
:)
668 (when (python-info-block-continuation-line-p)
669 (while (and (python-info-continuation-line-p)
672 (python-util-forward-comment -
1)
673 (when (equal (char-before) ?
:)
675 (setq block-end
(point-marker))))
678 (goto-char block-end
)
679 (python-util-forward-comment)
680 (current-indentation))))
682 (set (make-local-variable 'python-indent-offset
) indentation
)
683 (message "Can't guess python-indent-offset, using defaults: %s"
684 python-indent-offset
)))))))
686 (defun python-indent-context ()
687 "Get information on indentation context.
688 Context information is returned with a cons with the form:
691 Where status can be any of the following symbols:
692 * inside-paren: If point in between (), {} or []
693 * inside-string: If point is inside a string
694 * after-backslash: Previous line ends in a backslash
695 * after-beginning-of-block: Point is after beginning of block
696 * after-line: Point is after normal line
697 * no-indent: Point is at beginning of buffer or other special case
698 START is the buffer position where the sexp starts."
701 (let ((ppss (save-excursion (beginning-of-line) (syntax-ppss)))
705 ;; Beginning of buffer
707 (goto-char (line-beginning-position))
711 ((setq start
(python-syntax-context 'string ppss
))
714 ((setq start
(python-syntax-context 'paren ppss
))
717 ((setq start
(when (not (or (python-syntax-context 'string ppss
)
718 (python-syntax-context 'comment ppss
)))
719 (let ((line-beg-pos (line-number-at-pos)))
720 (python-info-line-ends-backslash-p
721 (1- line-beg-pos
)))))
723 ;; After beginning of block
724 ((setq start
(save-excursion
726 (back-to-indentation)
727 (python-util-forward-comment -
1)
728 (equal (char-before) ?
:))
729 ;; Move to the first block start that's not in within
730 ;; a string, comment or paren and that's not a
731 ;; continuation line.
732 (while (and (re-search-backward
733 (python-rx block-start
) nil t
)
735 (python-syntax-context-type)
736 (python-info-continuation-line-p))))
737 (when (looking-at (python-rx block-start
))
739 'after-beginning-of-block
)
741 ((setq start
(save-excursion
742 (back-to-indentation)
743 (skip-chars-backward (rx (or whitespace ?
\n)))
744 (python-nav-beginning-of-statement)
751 (defun python-indent-calculate-indentation ()
752 "Calculate correct indentation offset for the current line."
753 (let* ((indentation-context (python-indent-context))
754 (context-status (car indentation-context
))
755 (context-start (cdr indentation-context
)))
759 (pcase context-status
761 ;; When point is after beginning of block just add one level
762 ;; of indentation relative to the context-start
763 (`after-beginning-of-block
764 (goto-char context-start
)
765 (+ (current-indentation) python-indent-offset
))
766 ;; When after a simple line just use previous line
767 ;; indentation, in the case current line starts with a
768 ;; `python-indent-dedenters' de-indent one level.
772 (goto-char context-start
)
773 (current-indentation))
774 (if (or (save-excursion
775 (back-to-indentation)
776 (looking-at (regexp-opt python-indent-dedenters
)))
778 (python-util-forward-comment -
1)
779 (python-nav-beginning-of-statement)
780 (member (current-word) python-indent-block-enders
)))
783 ;; When inside of a string, do nothing. just use the current
784 ;; indentation. XXX: perhaps it would be a good idea to
785 ;; invoke standard text indentation here
787 (goto-char context-start
)
788 (current-indentation))
789 ;; After backslash we have several possibilities.
792 ;; Check if current line is a dot continuation. For this
793 ;; the current line must start with a dot and previous
794 ;; line must contain a dot too.
796 (back-to-indentation)
797 (when (looking-at "\\.")
798 ;; If after moving one line back point is inside a paren it
799 ;; needs to move back until it's not anymore
803 (python-syntax-context 'paren
))))
804 (goto-char (line-end-position))
805 (while (and (re-search-backward
806 "\\." (line-beginning-position) t
)
807 (python-syntax-context-type)))
808 (if (and (looking-at "\\.")
809 (not (python-syntax-context-type)))
810 ;; The indentation is the same column of the
811 ;; first matching dot that's not inside a
812 ;; comment, a string or a paren
814 ;; No dot found on previous line, just add another
815 ;; indentation level.
816 (+ (current-indentation) python-indent-offset
)))))
817 ;; Check if prev line is a block continuation
818 ((let ((block-continuation-start
819 (python-info-block-continuation-line-p)))
820 (when block-continuation-start
821 ;; If block-continuation-start is set jump to that
822 ;; marker and use first column after the block start
823 ;; as indentation value.
824 (goto-char block-continuation-start
)
826 (python-rx block-start
(* space
))
827 (line-end-position) t
)
829 ;; Check if current line is an assignment continuation
830 ((let ((assignment-continuation-start
831 (python-info-assignment-continuation-line-p)))
832 (when assignment-continuation-start
833 ;; If assignment-continuation is set jump to that
834 ;; marker and use first column after the assignment
835 ;; operator as indentation value.
836 (goto-char assignment-continuation-start
)
840 (goto-char (python-info-beginning-of-backslash))
845 (or (python-info-beginning-of-backslash) (point)))
846 (python-info-line-ends-backslash-p)))
847 ;; The two previous lines ended in a backslash so we must
848 ;; respect previous line indentation.
849 (current-indentation)
850 ;; What happens here is that we are dealing with the second
851 ;; line of a backslash continuation, in that case we just going
852 ;; to add one indentation level.
853 (+ (current-indentation) python-indent-offset
)))))
854 ;; When inside a paren there's a need to handle nesting
858 ;; If current line closes the outermost open paren use the
859 ;; current indentation of the context-start line.
861 (skip-syntax-forward "\s" (line-end-position))
862 (when (and (looking-at (regexp-opt '(")" "]" "}")))
865 (not (python-syntax-context 'paren
))))
866 (goto-char context-start
)
867 (current-indentation))))
868 ;; If open paren is contained on a line by itself add another
869 ;; indentation level, else look for the first word after the
870 ;; opening paren and use it's column position as indentation
872 ((let* ((content-starts-in-newline)
875 (if (setq content-starts-in-newline
877 (goto-char context-start
)
881 (line-beginning-position)
883 (python-util-forward-comment))
885 (+ (current-indentation) python-indent-offset
)
889 ;; If current line closes a nested open paren de-indent one
892 (back-to-indentation)
893 (looking-at (regexp-opt '(")" "]" "}"))))
894 (- indent python-indent-offset
))
895 ;; If the line of the opening paren that wraps the current
896 ;; line starts a block add another level of indentation to
897 ;; follow new pep8 recommendation. See: http://ur1.ca/5rojx
899 (when (and content-starts-in-newline
901 (goto-char context-start
)
902 (back-to-indentation)
903 (looking-at (python-rx block-start
))))
904 (+ indent python-indent-offset
))))
907 (defun python-indent-calculate-levels ()
908 "Calculate `python-indent-levels' and reset `python-indent-current-level'."
909 (let* ((indentation (python-indent-calculate-indentation))
910 (remainder (% indentation python-indent-offset
))
911 (steps (/ (- indentation remainder
) python-indent-offset
)))
912 (setq python-indent-levels
(list 0))
913 (dotimes (step steps
)
914 (push (* python-indent-offset
(1+ step
)) python-indent-levels
))
915 (when (not (eq 0 remainder
))
916 (push (+ (* python-indent-offset steps
) remainder
) python-indent-levels
))
917 (setq python-indent-levels
(nreverse python-indent-levels
))
918 (setq python-indent-current-level
(1- (length python-indent-levels
)))))
920 (defun python-indent-toggle-levels ()
921 "Toggle `python-indent-current-level' over `python-indent-levels'."
922 (setq python-indent-current-level
(1- python-indent-current-level
))
923 (when (< python-indent-current-level
0)
924 (setq python-indent-current-level
(1- (length python-indent-levels
)))))
926 (defun python-indent-line (&optional force-toggle
)
927 "Internal implementation of `python-indent-line-function'.
928 Uses the offset calculated in
929 `python-indent-calculate-indentation' and available levels
930 indicated by the variable `python-indent-levels' to set the
933 When the variable `last-command' is equal to one of the symbols
934 inside `python-indent-trigger-commands' or FORCE-TOGGLE is
935 non-nil it cycles levels indicated in the variable
936 `python-indent-levels' by setting the current level in the
937 variable `python-indent-current-level'.
939 When the variable `last-command' is not equal to one of the
940 symbols inside `python-indent-trigger-commands' and FORCE-TOGGLE
941 is nil it calculates possible indentation levels and saves it in
942 the variable `python-indent-levels'. Afterwards it sets the
943 variable `python-indent-current-level' correctly so offset is
944 equal to (`nth' `python-indent-current-level'
945 `python-indent-levels')"
947 (and (or (and (memq this-command python-indent-trigger-commands
)
948 (eq last-command this-command
))
950 (not (equal python-indent-levels
'(0)))
951 (or (python-indent-toggle-levels) t
))
952 (python-indent-calculate-levels))
953 (let* ((starting-pos (point-marker))
954 (indent-ending-position
955 (+ (line-beginning-position) (current-indentation)))
956 (follow-indentation-p
958 (and (<= (line-beginning-position) starting-pos
)
959 (>= indent-ending-position starting-pos
))))
960 (next-indent (nth python-indent-current-level python-indent-levels
)))
961 (unless (= next-indent
(current-indentation))
963 (delete-horizontal-space)
964 (indent-to next-indent
)
965 (goto-char starting-pos
))
966 (and follow-indentation-p
(back-to-indentation)))
967 (python-info-closing-block-message))
969 (defun python-indent-line-function ()
970 "`indent-line-function' for Python mode.
971 See `python-indent-line' for details."
972 (python-indent-line))
974 (defun python-indent-dedent-line ()
975 "De-indent current line."
977 (when (and (not (python-syntax-comment-or-string-p))
978 (<= (point-marker) (save-excursion
979 (back-to-indentation)
981 (> (current-column) 0))
982 (python-indent-line t
)
985 (defun python-indent-dedent-line-backspace (arg)
986 "De-indent current line.
987 Argument ARG is passed to `backward-delete-char-untabify' when
988 point is not in between the indentation."
990 (when (not (python-indent-dedent-line))
991 (backward-delete-char-untabify arg
)))
992 (put 'python-indent-dedent-line-backspace
'delete-selection
'supersede
)
994 (defun python-indent-region (start end
)
995 "Indent a python region automagically.
997 Called from a program, START and END specify the region to indent."
998 (let ((deactivate-mark nil
))
1001 (setq end
(point-marker))
1003 (or (bolp) (forward-line 1))
1004 (while (< (point) end
)
1005 (or (and (bolp) (eolp))
1008 (back-to-indentation)
1009 (setq word
(current-word))
1012 ;; Don't mess with strings, unless it's the
1013 ;; enclosing set of quotes.
1014 (or (not (python-syntax-context 'string
))
1018 (current-indentation)
1019 (python-syntax-count-quotes (char-after) (point))))
1020 (string-to-syntax "|"))))
1022 (delete-horizontal-space)
1023 (indent-to (python-indent-calculate-indentation)))))
1025 (move-marker end nil
))))
1027 (defun python-indent-shift-left (start end
&optional count
)
1028 "Shift lines contained in region START END by COUNT columns to the left.
1029 COUNT defaults to `python-indent-offset'. If region isn't
1030 active, the current line is shifted. The shifted region includes
1031 the lines in which START and END lie. An error is signaled if
1032 any lines in the region are indented less than COUNT columns."
1035 (list (region-beginning) (region-end) current-prefix-arg
)
1036 (list (line-beginning-position) (line-end-position) current-prefix-arg
)))
1038 (setq count
(prefix-numeric-value count
))
1039 (setq count python-indent-offset
))
1041 (let ((deactivate-mark nil
))
1044 (while (< (point) end
)
1045 (if (and (< (current-indentation) count
)
1046 (not (looking-at "[ \t]*$")))
1047 (error "Can't shift all lines enough"))
1049 (indent-rigidly start end
(- count
))))))
1051 (add-to-list 'debug-ignored-errors
"^Can't shift all lines enough")
1053 (defun python-indent-shift-right (start end
&optional count
)
1054 "Shift lines contained in region START END by COUNT columns to the left.
1055 COUNT defaults to `python-indent-offset'. If region isn't
1056 active, the current line is shifted. The shifted region includes
1057 the lines in which START and END lie."
1060 (list (region-beginning) (region-end) current-prefix-arg
)
1061 (list (line-beginning-position) (line-end-position) current-prefix-arg
)))
1062 (let ((deactivate-mark nil
))
1064 (setq count
(prefix-numeric-value count
))
1065 (setq count python-indent-offset
))
1066 (indent-rigidly start end count
)))
1068 (defun python-indent-electric-colon (arg)
1069 "Insert a colon and maybe de-indent the current line.
1070 With numeric ARG, just insert that many colons. With
1071 \\[universal-argument], just insert a single colon."
1073 (self-insert-command (if (not (integerp arg
)) 1 arg
))
1074 (when (and (not arg
)
1076 (not (equal ?
: (char-after (- (point-marker) 2))))
1077 (not (python-syntax-comment-or-string-p)))
1078 (let ((indentation (current-indentation))
1079 (calculated-indentation (python-indent-calculate-indentation)))
1080 (python-info-closing-block-message)
1081 (when (> indentation calculated-indentation
)
1083 (indent-line-to calculated-indentation
)
1084 (when (not (python-info-closing-block-message))
1085 (indent-line-to indentation
)))))))
1086 (put 'python-indent-electric-colon
'delete-selection t
)
1088 (defun python-indent-post-self-insert-function ()
1089 "Adjust closing paren line indentation after a char is added.
1090 This function is intended to be added to the
1091 `post-self-insert-hook.' If a line renders a paren alone, after
1092 adding a char before it, the line will be re-indented
1093 automatically if needed."
1094 (when (and (eq (char-before) last-command-event
)
1096 (memq (char-after) '(?\
) ?\
] ?\
})))
1098 (goto-char (line-beginning-position))
1099 ;; If after going to the beginning of line the point
1100 ;; is still inside a paren it's ok to do the trick
1101 (when (python-syntax-context 'paren
)
1102 (let ((indentation (python-indent-calculate-indentation)))
1103 (when (< (current-indentation) indentation
)
1104 (indent-line-to indentation
)))))))
1109 (defvar python-nav-beginning-of-defun-regexp
1110 (python-rx line-start
(* space
) defun
(+ space
) (group symbol-name
))
1111 "Regexp matching class or function definition.
1112 The name of the defun should be grouped so it can be retrieved
1113 via `match-string'.")
1115 (defun python-nav--beginning-of-defun (&optional arg
)
1116 "Internal implementation of `python-nav-beginning-of-defun'.
1117 With positive ARG search backwards, else search forwards."
1118 (when (or (null arg
) (= arg
0)) (setq arg
1))
1119 (let* ((re-search-fn (if (> arg
0)
1120 #'re-search-backward
1121 #'re-search-forward
))
1122 (line-beg-pos (line-beginning-position))
1123 (line-content-start (+ line-beg-pos
(current-indentation)))
1124 (pos (point-marker))
1129 (not (python-info-looking-at-beginning-of-defun))
1130 (python-nav-backward-block)))
1131 (or (and (python-info-looking-at-beginning-of-defun)
1132 (+ (current-indentation) python-indent-offset
))
1136 (when (and (< arg
0)
1137 (python-info-looking-at-beginning-of-defun))
1139 (while (and (funcall re-search-fn
1140 python-nav-beginning-of-defun-regexp nil t
)
1141 (or (python-syntax-context-type)
1142 ;; Handle nested defuns when moving
1143 ;; backwards by checking indentation.
1145 (not (= (current-indentation) 0))
1146 (>= (current-indentation) beg-indentation
)))))
1147 (and (python-info-looking-at-beginning-of-defun)
1148 (or (not (= (line-number-at-pos pos
)
1149 (line-number-at-pos)))
1150 (and (>= (point) line-beg-pos
)
1151 (<= (point) line-content-start
)
1152 (> pos line-content-start
)))))))
1154 (or (beginning-of-line 1) t
)
1155 (and (goto-char pos
) nil
))))
1157 (defun python-nav-beginning-of-defun (&optional arg
)
1158 "Move point to `beginning-of-defun'.
1159 With positive ARG search backwards else search forward. When ARG
1160 is nil or 0 defaults to 1. When searching backwards nested
1161 defuns are handled with care depending on current point
1162 position. Return non-nil if point is moved to
1163 `beginning-of-defun'."
1164 (when (or (null arg
) (= arg
0)) (setq arg
1))
1166 (cond ((and (eq this-command
'mark-defun
)
1167 (python-info-looking-at-beginning-of-defun)))
1169 (dotimes (i (if (> arg
0) arg
(- arg
)))
1170 (when (and (python-nav--beginning-of-defun arg)
1175 (defun python-nav-end-of-defun ()
1176 "Move point to the end of def or class.
1177 Returns nil if point is not in a def or class."
1179 (let ((beg-defun-indent)
1181 (when (or (python-info-looking-at-beginning-of-defun)
1182 (python-nav-beginning-of-defun 1)
1183 (python-nav-beginning-of-defun -1))
1184 (setq beg-defun-indent
(current-indentation))
1186 (python-nav-end-of-statement)
1187 (python-util-forward-comment 1)
1188 (and (> (current-indentation) beg-defun-indent
)
1190 (python-util-forward-comment -
1)
1192 ;; Ensure point moves forward.
1193 (and (> beg-pos
(point)) (goto-char beg-pos
)))))
1195 (defun python-nav--syntactically (fn poscompfn
&optional pos
)
1196 "Move to point using FN ignoring non-code or paren context.
1197 FN must take no arguments and could be used to set match-data.
1198 POSCOMPFN is a two arguments function used to compare current and
1199 previous point after it is moved using FN, this is normally a
1200 less-than or greater-than comparison. Optional argument POS is
1201 internally used in recursive calls and should not be explicitly
1207 (not (python-syntax-context-type))
1209 (current-match-data (match-data)))
1210 (cond ((or (and (not pos
) newpos
)
1211 (and pos newpos
(funcall poscompfn newpos pos
)))
1212 (set-match-data current-match-data
)
1214 ((and (not pos
) (not newpos
)) nil
)
1215 (t (python-nav--syntactically
1216 fn poscompfn
(point-marker))))))
1218 (defun python-nav--forward-defun (arg)
1219 "Internal implementation of python-nav-{backward,forward}-defun.
1220 Uses ARG to define which function to call, and how many times
1223 (while (and (> arg
0)
1225 (python-nav--syntactically
1228 python-nav-beginning-of-defun-regexp nil t
))
1230 (setq arg
(1- arg
)))
1231 (while (and (< arg
0)
1233 (python-nav--syntactically
1236 python-nav-beginning-of-defun-regexp nil t
))
1238 (setq arg
(1+ arg
)))
1241 (defun python-nav-backward-defun (&optional arg
)
1242 "Navigate to closer defun backward ARG times.
1243 Unlikely `python-nav-beginning-of-defun' this doesn't care about
1244 nested definitions."
1246 (python-nav--forward-defun (- (or arg
1))))
1248 (defun python-nav-forward-defun (&optional arg
)
1249 "Navigate to closer defun forward ARG times.
1250 Unlikely `python-nav-beginning-of-defun' this doesn't care about
1251 nested definitions."
1253 (python-nav--forward-defun (or arg
1)))
1255 (defun python-nav-beginning-of-statement ()
1256 "Move to start of current statement."
1258 (while (and (or (back-to-indentation) t
)
1263 (python-info-line-ends-backslash-p))
1264 (python-syntax-context 'string
)
1265 (python-syntax-context 'paren
))
1266 (forward-line -
1))))
1269 (defun python-nav-end-of-statement (&optional noend
)
1270 "Move to end of current statement.
1271 Optional argument NOEND is internal and makes the logic to not
1272 jump to the end of line when moving forward searching for the end
1275 (let (string-start bs-pos
)
1276 (while (and (or noend
(goto-char (line-end-position)))
1278 (cond ((setq string-start
(python-syntax-context 'string
))
1279 (goto-char string-start
)
1280 (if (python-syntax-context 'paren
)
1281 ;; Ended up inside a paren, roll again.
1282 (python-nav-end-of-statement t
)
1283 ;; This is not inside a paren, move to the
1284 ;; end of this string.
1285 (goto-char (+ (point)
1286 (python-syntax-count-quotes
1287 (char-after (point)) (point))))
1288 (or (re-search-forward (rx (syntax string-delimiter
)) nil t
)
1289 (goto-char (point-max)))))
1290 ((python-syntax-context 'paren
)
1291 ;; The statement won't end before we've escaped
1292 ;; at least one level of parenthesis.
1294 (goto-char (scan-lists (point) 1 -
1))
1295 (scan-error (goto-char (nth 3 err
)))))
1296 ((setq bs-pos
(python-info-line-ends-backslash-p))
1298 (forward-line 1))))))
1301 (defun python-nav-backward-statement (&optional arg
)
1302 "Move backward to previous statement.
1303 With ARG, repeat. See `python-nav-forward-statement'."
1305 (or arg
(setq arg
1))
1306 (python-nav-forward-statement (- arg
)))
1308 (defun python-nav-forward-statement (&optional arg
)
1309 "Move forward to next statement.
1310 With ARG, repeat. With negative argument, move ARG times
1311 backward to previous statement."
1313 (or arg
(setq arg
1))
1315 (python-nav-end-of-statement)
1316 (python-util-forward-comment)
1317 (python-nav-beginning-of-statement)
1318 (setq arg
(1- arg
)))
1320 (python-nav-beginning-of-statement)
1321 (python-util-forward-comment -
1)
1322 (python-nav-beginning-of-statement)
1323 (setq arg
(1+ arg
))))
1325 (defun python-nav-beginning-of-block ()
1326 "Move to start of current block."
1328 (let ((starting-pos (point))
1329 (block-regexp (python-rx
1330 line-start
(* whitespace
) block-start
)))
1332 (python-nav-beginning-of-statement)
1333 (looking-at (python-rx block-start
)))
1335 ;; Go to first line beginning a statement
1336 (while (and (not (bobp))
1337 (or (and (python-nav-beginning-of-statement) nil
)
1338 (python-info-current-line-comment-p)
1339 (python-info-current-line-empty-p)))
1341 (let ((block-matching-indent
1342 (- (current-indentation) python-indent-offset
)))
1344 (and (python-nav-backward-block)
1345 (> (current-indentation) block-matching-indent
)))
1346 (if (and (looking-at (python-rx block-start
))
1347 (= (current-indentation) block-matching-indent
))
1349 (and (goto-char starting-pos
) nil
))))))
1351 (defun python-nav-end-of-block ()
1352 "Move to end of current block."
1354 (when (python-nav-beginning-of-block)
1355 (let ((block-indentation (current-indentation)))
1356 (python-nav-end-of-statement)
1357 (while (and (forward-line 1)
1359 (or (and (> (current-indentation) block-indentation
)
1360 (or (python-nav-end-of-statement) t
))
1361 (python-info-current-line-comment-p)
1362 (python-info-current-line-empty-p))))
1363 (python-util-forward-comment -
1)
1366 (defun python-nav-backward-block (&optional arg
)
1367 "Move backward to previous block of code.
1368 With ARG, repeat. See `python-nav-forward-block'."
1370 (or arg
(setq arg
1))
1371 (python-nav-forward-block (- arg
)))
1373 (defun python-nav-forward-block (&optional arg
)
1374 "Move forward to next block of code.
1375 With ARG, repeat. With negative argument, move ARG times
1376 backward to previous block."
1378 (or arg
(setq arg
1))
1379 (let ((block-start-regexp
1380 (python-rx line-start
(* whitespace
) block-start
))
1381 (starting-pos (point)))
1383 (python-nav-end-of-statement)
1385 (re-search-forward block-start-regexp nil t
)
1386 (python-syntax-context-type)))
1387 (setq arg
(1- arg
)))
1389 (python-nav-beginning-of-statement)
1391 (re-search-backward block-start-regexp nil t
)
1392 (python-syntax-context-type)))
1393 (setq arg
(1+ arg
)))
1394 (python-nav-beginning-of-statement)
1395 (if (not (looking-at (python-rx block-start
)))
1396 (and (goto-char starting-pos
) nil
)
1397 (and (not (= (point) starting-pos
)) (point-marker)))))
1399 (defun python-nav-lisp-forward-sexp-safe (&optional arg
)
1400 "Safe version of standard `forward-sexp'.
1401 When ARG > 0 move forward, else if ARG is < 0."
1402 (or arg
(setq arg
1))
1403 (let ((forward-sexp-function)
1405 (if (> arg
0) (python-rx close-paren
) (python-rx open-paren
)))
1407 (if (> arg
0) #'re-search-forward
#'re-search-backward
)))
1411 (while (and (funcall search-fn paren-regexp nil t
)
1412 (python-syntax-context 'paren
)))))))
1414 (defun python-nav--forward-sexp (&optional dir
)
1415 "Move to forward sexp.
1416 With positive Optional argument DIR direction move forward, else
1418 (setq dir
(or dir
1))
1420 (let* ((forward-p (if (> dir
0)
1421 (and (setq dir
1) t
)
1422 (and (setq dir -
1) nil
)))
1423 (re-search-fn (if forward-p
1425 're-search-backward
))
1426 (context-type (python-syntax-context-type)))
1428 ((memq context-type
'(string comment
))
1429 ;; Inside of a string, get out of it.
1430 (let ((forward-sexp-function))
1431 (forward-sexp dir
)))
1432 ((or (eq context-type
'paren
)
1433 (and forward-p
(looking-at (python-rx open-paren
)))
1434 (and (not forward-p
)
1435 (eq (syntax-class (syntax-after (1- (point))))
1436 (car (string-to-syntax ")")))))
1437 ;; Inside a paren or looking at it, lisp knows what to do.
1438 (python-nav-lisp-forward-sexp-safe dir
))
1440 ;; This part handles the lispy feel of
1441 ;; `python-nav-forward-sexp'. Knowing everything about the
1442 ;; current context and the context of the next sexp tries to
1443 ;; follow the lisp sexp motion commands in a symmetric manner.
1446 ((python-info-beginning-of-block-p) 'block-start
)
1447 ((python-info-end-of-block-p) 'block-end
)
1448 ((python-info-beginning-of-statement-p) 'statement-start
)
1449 ((python-info-end-of-statement-p) 'statement-end
)))
1452 (python-nav-lisp-forward-sexp-safe dir
)
1456 (goto-char next-sexp-pos
)
1458 ((python-info-beginning-of-block-p) 'block-start
)
1459 ((python-info-end-of-block-p) 'block-end
)
1460 ((python-info-beginning-of-statement-p) 'statement-start
)
1461 ((python-info-end-of-statement-p) 'statement-end
)
1462 ((python-info-statement-starts-block-p) 'starts-block
)
1463 ((python-info-statement-ends-block-p) 'ends-block
)))))
1465 (cond ((and (not (eobp))
1466 (python-info-current-line-empty-p))
1467 (python-util-forward-comment dir
)
1468 (python-nav--forward-sexp dir
))
1469 ((eq context
'block-start
)
1470 (python-nav-end-of-block))
1471 ((eq context
'statement-start
)
1472 (python-nav-end-of-statement))
1473 ((and (memq context
'(statement-end block-end
))
1474 (eq next-sexp-context
'ends-block
))
1475 (goto-char next-sexp-pos
)
1476 (python-nav-end-of-block))
1477 ((and (memq context
'(statement-end block-end
))
1478 (eq next-sexp-context
'starts-block
))
1479 (goto-char next-sexp-pos
)
1480 (python-nav-end-of-block))
1481 ((memq context
'(statement-end block-end
))
1482 (goto-char next-sexp-pos
)
1483 (python-nav-end-of-statement))
1484 (t (goto-char next-sexp-pos
)))
1485 (cond ((and (not (bobp))
1486 (python-info-current-line-empty-p))
1487 (python-util-forward-comment dir
)
1488 (python-nav--forward-sexp dir
))
1489 ((eq context
'block-end
)
1490 (python-nav-beginning-of-block))
1491 ((eq context
'statement-end
)
1492 (python-nav-beginning-of-statement))
1493 ((and (memq context
'(statement-start block-start
))
1494 (eq next-sexp-context
'starts-block
))
1495 (goto-char next-sexp-pos
)
1496 (python-nav-beginning-of-block))
1497 ((and (memq context
'(statement-start block-start
))
1498 (eq next-sexp-context
'ends-block
))
1499 (goto-char next-sexp-pos
)
1500 (python-nav-beginning-of-block))
1501 ((memq context
'(statement-start block-start
))
1502 (goto-char next-sexp-pos
)
1503 (python-nav-beginning-of-statement))
1504 (t (goto-char next-sexp-pos
))))))))))
1506 (defun python-nav--backward-sexp ()
1507 "Move to backward sexp."
1508 (python-nav--forward-sexp -
1))
1510 (defun python-nav-forward-sexp (&optional arg
)
1511 "Move forward across one block of code.
1512 With ARG, do it that many times. Negative arg -N means
1513 move backward N times."
1515 (or arg
(setq arg
1))
1517 (python-nav--forward-sexp)
1518 (setq arg
(1- arg
)))
1520 (python-nav--backward-sexp)
1521 (setq arg
(1+ arg
))))
1523 (defun python-nav--up-list (&optional dir
)
1524 "Internal implementation of `python-nav-up-list'.
1525 DIR is always 1 or -1 and comes sanitized from
1526 `python-nav-up-list' calls."
1527 (let ((context (python-syntax-context-type))
1528 (forward-p (> dir
0)))
1530 ((memq context
'(string comment
)))
1531 ((eq context
'paren
)
1532 (let ((forward-sexp-function))
1534 ((and forward-p
(python-info-end-of-block-p))
1535 (let ((parent-end-pos
1537 (let ((indentation (and
1538 (python-nav-beginning-of-block)
1539 (current-indentation))))
1540 (while (and indentation
1542 (>= (current-indentation) indentation
)
1543 (python-nav-backward-block)))
1544 (python-nav-end-of-block)))))
1545 (and (> (or parent-end-pos
(point)) (point))
1546 (goto-char parent-end-pos
))))
1547 (forward-p (python-nav-end-of-block))
1548 ((and (not forward-p
)
1549 (> (current-indentation) 0)
1550 (python-info-beginning-of-block-p))
1551 (let ((prev-block-pos
1553 (let ((indentation (current-indentation)))
1554 (while (and (python-nav-backward-block)
1555 (>= (current-indentation) indentation
))))
1557 (and (> (point) prev-block-pos
)
1558 (goto-char prev-block-pos
))))
1559 ((not forward-p
) (python-nav-beginning-of-block)))))
1561 (defun python-nav-up-list (&optional arg
)
1562 "Move forward out of one level of parentheses (or blocks).
1563 With ARG, do this that many times.
1564 A negative argument means move backward but still to a less deep spot.
1565 This command assumes point is not in a string or comment."
1567 (or arg
(setq arg
1))
1569 (python-nav--up-list 1)
1570 (setq arg
(1- arg
)))
1572 (python-nav--up-list -
1)
1573 (setq arg
(1+ arg
))))
1575 (defun python-nav-backward-up-list (&optional arg
)
1576 "Move backward out of one level of parentheses (or blocks).
1577 With ARG, do this that many times.
1578 A negative argument means move backward but still to a less deep spot.
1579 This command assumes point is not in a string or comment."
1581 (or arg
(setq arg
1))
1582 (python-nav-up-list (- arg
)))
1585 ;;; Shell integration
1587 (defcustom python-shell-buffer-name
"Python"
1588 "Default buffer name for Python interpreter."
1593 (defcustom python-shell-interpreter
"python"
1594 "Default Python interpreter for shell."
1598 (defcustom python-shell-internal-buffer-name
"Python Internal"
1599 "Default buffer name for the Internal Python interpreter."
1604 (defcustom python-shell-interpreter-args
"-i"
1605 "Default arguments for the Python interpreter."
1609 (defcustom python-shell-prompt-regexp
">>> "
1610 "Regular Expression matching top\-level input prompt of python shell.
1611 It should not contain a caret (^) at the beginning."
1616 (defcustom python-shell-prompt-block-regexp
"[.][.][.] "
1617 "Regular Expression matching block input prompt of python shell.
1618 It should not contain a caret (^) at the beginning."
1623 (defcustom python-shell-prompt-output-regexp
""
1624 "Regular Expression matching output prompt of python shell.
1625 It should not contain a caret (^) at the beginning."
1630 (defcustom python-shell-prompt-pdb-regexp
"[(<]*[Ii]?[Pp]db[>)]+ "
1631 "Regular Expression matching pdb input prompt of python shell.
1632 It should not contain a caret (^) at the beginning."
1637 (defcustom python-shell-enable-font-lock t
1638 "Should syntax highlighting be enabled in the python shell buffer?
1639 Restart the python shell after changing this variable for it to take effect."
1644 (defcustom python-shell-process-environment nil
1645 "List of environment variables for Python shell.
1646 This variable follows the same rules as `process-environment'
1647 since it merges with it before the process creation routines are
1648 called. When this variable is nil, the Python shell is run with
1649 the default `process-environment'."
1650 :type
'(repeat string
)
1654 (defcustom python-shell-extra-pythonpaths nil
1655 "List of extra pythonpaths for Python shell.
1656 The values of this variable are added to the existing value of
1657 PYTHONPATH in the `process-environment' variable."
1658 :type
'(repeat string
)
1662 (defcustom python-shell-exec-path nil
1663 "List of path to search for binaries.
1664 This variable follows the same rules as `exec-path' since it
1665 merges with it before the process creation routines are called.
1666 When this variable is nil, the Python shell is run with the
1667 default `exec-path'."
1668 :type
'(repeat string
)
1672 (defcustom python-shell-virtualenv-path nil
1673 "Path to virtualenv root.
1674 This variable, when set to a string, makes the values stored in
1675 `python-shell-process-environment' and `python-shell-exec-path'
1676 to be modified properly so shells are started with the specified
1682 (defcustom python-shell-setup-codes
'(python-shell-completion-setup-code
1683 python-ffap-setup-code
1684 python-eldoc-setup-code
)
1685 "List of code run by `python-shell-send-setup-codes'."
1686 :type
'(repeat symbol
)
1690 (defcustom python-shell-compilation-regexp-alist
1691 `((,(rx line-start
(1+ (any " \t")) "File \""
1692 (group (1+ (not (any "\"<")))) ; avoid `<stdin>' &c
1693 "\", line " (group (1+ digit
)))
1695 (,(rx " in file " (group (1+ not-newline
)) " on line "
1698 (,(rx line-start
"> " (group (1+ (not (any "(\"<"))))
1699 "(" (group (1+ digit
)) ")" (1+ (not (any "("))) "()")
1701 "`compilation-error-regexp-alist' for inferior Python."
1702 :type
'(alist string
)
1705 (defun python-shell-get-process-name (dedicated)
1706 "Calculate the appropriate process name for inferior Python process.
1707 If DEDICATED is t and the variable `buffer-file-name' is non-nil
1708 returns a string with the form
1709 `python-shell-buffer-name'[variable `buffer-file-name'] else
1710 returns the value of `python-shell-buffer-name'."
1714 (format "%s[%s]" python-shell-buffer-name buffer-file-name
)
1715 (format "%s" python-shell-buffer-name
))))
1718 (defun python-shell-internal-get-process-name ()
1719 "Calculate the appropriate process name for Internal Python process.
1720 The name is calculated from `python-shell-global-buffer-name' and
1721 a hash of all relevant global shell settings in order to ensure
1722 uniqueness for different types of configurations."
1724 python-shell-internal-buffer-name
1727 (python-shell-parse-command)
1728 python-shell-prompt-regexp
1729 python-shell-prompt-block-regexp
1730 python-shell-prompt-output-regexp
1731 (mapconcat #'symbol-value python-shell-setup-codes
"")
1732 (mapconcat #'identity python-shell-process-environment
"")
1733 (mapconcat #'identity python-shell-extra-pythonpaths
"")
1734 (mapconcat #'identity python-shell-exec-path
"")
1735 (or python-shell-virtualenv-path
"")
1736 (mapconcat #'identity python-shell-exec-path
"")))))
1738 (defun python-shell-parse-command ()
1739 "Calculate the string used to execute the inferior Python process."
1740 (let ((process-environment (python-shell-calculate-process-environment))
1741 (exec-path (python-shell-calculate-exec-path)))
1743 (executable-find python-shell-interpreter
)
1744 python-shell-interpreter-args
)))
1746 (defun python-shell-calculate-process-environment ()
1747 "Calculate process environment given `python-shell-virtualenv-path'."
1748 (let ((process-environment (append
1749 python-shell-process-environment
1750 process-environment nil
))
1751 (virtualenv (if python-shell-virtualenv-path
1752 (directory-file-name python-shell-virtualenv-path
)
1754 (when python-shell-extra-pythonpaths
1755 (setenv "PYTHONPATH"
1757 (mapconcat 'identity
1758 python-shell-extra-pythonpaths
1761 (or (getenv "PYTHONPATH") ""))))
1762 (if (not virtualenv
)
1764 (setenv "PYTHONHOME" nil
)
1765 (setenv "PATH" (format "%s/bin%s%s"
1766 virtualenv path-separator
1767 (or (getenv "PATH") "")))
1768 (setenv "VIRTUAL_ENV" virtualenv
))
1769 process-environment
))
1771 (defun python-shell-calculate-exec-path ()
1772 "Calculate exec path given `python-shell-virtualenv-path'."
1773 (let ((path (append python-shell-exec-path
1775 (if (not python-shell-virtualenv-path
)
1777 (cons (format "%s/bin"
1778 (directory-file-name python-shell-virtualenv-path
))
1781 (defun python-comint-output-filter-function (output)
1782 "Hook run after content is put into comint buffer.
1783 OUTPUT is a string with the contents of the buffer."
1784 (ansi-color-filter-apply output
))
1786 (defvar python-shell--parent-buffer nil
)
1788 (defvar python-shell-output-syntax-table
1789 (let ((table (make-syntax-table python-dotty-syntax-table
)))
1790 (modify-syntax-entry ?
\' "." table
)
1791 (modify-syntax-entry ?
\" "." table
)
1792 (modify-syntax-entry ?\
( "." table
)
1793 (modify-syntax-entry ?\
[ "." table
)
1794 (modify-syntax-entry ?\
{ "." table
)
1795 (modify-syntax-entry ?\
) "." table
)
1796 (modify-syntax-entry ?\
] "." table
)
1797 (modify-syntax-entry ?\
} "." table
)
1799 "Syntax table for shell output.
1800 It makes parens and quotes be treated as punctuation chars.")
1802 (define-derived-mode inferior-python-mode comint-mode
"Inferior Python"
1803 "Major mode for Python inferior process.
1804 Runs a Python interpreter as a subprocess of Emacs, with Python
1805 I/O through an Emacs buffer. Variables
1806 `python-shell-interpreter' and `python-shell-interpreter-args'
1807 controls which Python interpreter is run. Variables
1808 `python-shell-prompt-regexp',
1809 `python-shell-prompt-output-regexp',
1810 `python-shell-prompt-block-regexp',
1811 `python-shell-enable-font-lock',
1812 `python-shell-completion-setup-code',
1813 `python-shell-completion-string-code',
1814 `python-shell-completion-module-string-code',
1815 `python-eldoc-setup-code', `python-eldoc-string-code',
1816 `python-ffap-setup-code' and `python-ffap-string-code' can
1817 customize this mode for different Python interpreters.
1819 You can also add additional setup code to be run at
1820 initialization of the interpreter via `python-shell-setup-codes'
1823 \(Type \\[describe-mode] in the process buffer for a list of commands.)"
1824 (and python-shell--parent-buffer
1825 (python-util-clone-local-variables python-shell--parent-buffer
))
1826 (setq comint-prompt-regexp
(format "^\\(?:%s\\|%s\\|%s\\)"
1827 python-shell-prompt-regexp
1828 python-shell-prompt-block-regexp
1829 python-shell-prompt-pdb-regexp
))
1830 (setq mode-line-process
'(":%s"))
1831 (make-local-variable 'comint-output-filter-functions
)
1832 (add-hook 'comint-output-filter-functions
1833 'python-comint-output-filter-function
)
1834 (add-hook 'comint-output-filter-functions
1835 'python-pdbtrack-comint-output-filter-function
)
1836 (set (make-local-variable 'compilation-error-regexp-alist
)
1837 python-shell-compilation-regexp-alist
)
1838 (define-key inferior-python-mode-map
[remap complete-symbol
]
1839 'completion-at-point
)
1840 (add-hook 'completion-at-point-functions
1841 'python-shell-completion-complete-at-point nil
'local
)
1842 (add-to-list (make-local-variable 'comint-dynamic-complete-functions
)
1843 'python-shell-completion-complete-at-point
)
1844 (define-key inferior-python-mode-map
"\t"
1845 'python-shell-completion-complete-or-indent
)
1846 (make-local-variable 'python-pdbtrack-buffers-to-kill
)
1847 (make-local-variable 'python-pdbtrack-tracked-buffer
)
1848 (make-local-variable 'python-shell-internal-last-output
)
1849 (when python-shell-enable-font-lock
1850 (set-syntax-table python-mode-syntax-table
)
1851 (set (make-local-variable 'font-lock-defaults
)
1852 '(python-font-lock-keywords nil nil nil nil
))
1853 (set (make-local-variable 'syntax-propertize-function
)
1855 ;; XXX: Unfortunately eval is needed here to make use of the
1856 ;; dynamic value of `comint-prompt-regexp'.
1857 `(syntax-propertize-rules
1858 (,comint-prompt-regexp
1861 comint-last-input-start end
'syntax-table
1862 python-shell-output-syntax-table
)
1863 ;; XXX: This might look weird, but it is the easiest
1864 ;; way to ensure font lock gets cleaned up before the
1865 ;; current prompt, which is needed for unclosed
1866 ;; strings to not mess up with current input.
1867 (font-lock-unfontify-region comint-last-input-start end
))))
1868 (,(python-rx string-delimiter
)
1870 (and (not (eq (get-text-property start
'field
) 'output
))
1871 (python-syntax-stringify)))))))))
1872 (compilation-shell-minor-mode 1))
1874 (defun python-shell-make-comint (cmd proc-name
&optional pop internal
)
1875 "Create a python shell comint buffer.
1876 CMD is the python command to be executed and PROC-NAME is the
1877 process name the comint buffer will get. After the comint buffer
1878 is created the `inferior-python-mode' is activated. When
1879 optional argument POP is non-nil the buffer is shown. When
1880 optional argument INTERNAL is non-nil this process is run on a
1881 buffer with a name that starts with a space, following the Emacs
1882 convention for temporary/internal buffers, and also makes sure
1883 the user is not queried for confirmation when the process is
1886 (let* ((proc-buffer-name
1887 (format (if (not internal
) "*%s*" " *%s*") proc-name
))
1888 (process-environment (python-shell-calculate-process-environment))
1889 (exec-path (python-shell-calculate-exec-path)))
1890 (when (not (comint-check-proc proc-buffer-name
))
1891 (let* ((cmdlist (split-string-and-unquote cmd
))
1892 (buffer (apply #'make-comint-in-buffer proc-name proc-buffer-name
1893 (car cmdlist
) nil
(cdr cmdlist
)))
1894 (python-shell--parent-buffer (current-buffer))
1895 (process (get-buffer-process buffer
)))
1896 (with-current-buffer buffer
1897 (inferior-python-mode))
1898 (accept-process-output process
)
1899 (and pop
(pop-to-buffer buffer t
))
1900 (and internal
(set-process-query-on-exit-flag process nil
))))
1904 (defun run-python (cmd &optional dedicated show
)
1905 "Run an inferior Python process.
1906 Input and output via buffer named after
1907 `python-shell-buffer-name'. If there is a process already
1908 running in that buffer, just switch to it.
1910 With argument, allows you to define CMD so you can edit the
1911 command used to call the interpreter and define DEDICATED, so a
1912 dedicated process for the current buffer is open. When numeric
1913 prefix arg is other than 0 or 4 do not SHOW.
1915 Runs the hook `inferior-python-mode-hook' (after the
1916 `comint-mode-hook' is run). \(Type \\[describe-mode] in the
1917 process buffer for a list of commands.)"
1919 (if current-prefix-arg
1921 (read-string "Run Python: " (python-shell-parse-command))
1922 (y-or-n-p "Make dedicated process? ")
1923 (= (prefix-numeric-value current-prefix-arg
) 4))
1924 (list (python-shell-parse-command) nil t
)))
1925 (python-shell-make-comint
1926 cmd
(python-shell-get-process-name dedicated
) show
)
1929 (defun run-python-internal ()
1930 "Run an inferior Internal Python process.
1931 Input and output via buffer named after
1932 `python-shell-internal-buffer-name' and what
1933 `python-shell-internal-get-process-name' returns.
1935 This new kind of shell is intended to be used for generic
1936 communication related to defined configurations, the main
1937 difference with global or dedicated shells is that these ones are
1938 attached to a configuration, not a buffer. This means that can
1939 be used for example to retrieve the sys.path and other stuff,
1940 without messing with user shells. Note that
1941 `python-shell-enable-font-lock' and `inferior-python-mode-hook'
1942 are set to nil for these shells, so setup codes are not sent at
1944 (let ((python-shell-enable-font-lock nil
)
1945 (inferior-python-mode-hook nil
))
1947 (python-shell-make-comint
1948 (python-shell-parse-command)
1949 (python-shell-internal-get-process-name) nil t
))))
1951 (defun python-shell-get-process ()
1952 "Get inferior Python process for current buffer and return it."
1953 (let* ((dedicated-proc-name (python-shell-get-process-name t
))
1954 (dedicated-proc-buffer-name (format "*%s*" dedicated-proc-name
))
1955 (global-proc-name (python-shell-get-process-name nil
))
1956 (global-proc-buffer-name (format "*%s*" global-proc-name
))
1957 (dedicated-running (comint-check-proc dedicated-proc-buffer-name
))
1958 (global-running (comint-check-proc global-proc-buffer-name
)))
1959 ;; Always prefer dedicated
1960 (get-buffer-process (or (and dedicated-running dedicated-proc-buffer-name
)
1961 (and global-running global-proc-buffer-name
)))))
1963 (defun python-shell-get-or-create-process ()
1964 "Get or create an inferior Python process for current buffer and return it."
1965 (let* ((dedicated-proc-name (python-shell-get-process-name t
))
1966 (dedicated-proc-buffer-name (format "*%s*" dedicated-proc-name
))
1967 (global-proc-name (python-shell-get-process-name nil
))
1968 (global-proc-buffer-name (format "*%s*" global-proc-name
))
1969 (dedicated-running (comint-check-proc dedicated-proc-buffer-name
))
1970 (global-running (comint-check-proc global-proc-buffer-name
))
1971 (current-prefix-arg 16))
1972 (when (and (not dedicated-running
) (not global-running
))
1973 (if (call-interactively 'run-python
)
1974 (setq dedicated-running t
)
1975 (setq global-running t
)))
1976 ;; Always prefer dedicated
1977 (get-buffer-process (if dedicated-running
1978 dedicated-proc-buffer-name
1979 global-proc-buffer-name
))))
1981 (defvar python-shell-internal-buffer nil
1982 "Current internal shell buffer for the current buffer.
1983 This is really not necessary at all for the code to work but it's
1984 there for compatibility with CEDET.")
1986 (defvar python-shell-internal-last-output nil
1987 "Last output captured by the internal shell.
1988 This is really not necessary at all for the code to work but it's
1989 there for compatibility with CEDET.")
1991 (defun python-shell-internal-get-or-create-process ()
1992 "Get or create an inferior Internal Python process."
1993 (let* ((proc-name (python-shell-internal-get-process-name))
1994 (proc-buffer-name (format " *%s*" proc-name
)))
1995 (when (not (process-live-p proc-name
))
1996 (run-python-internal)
1997 (setq python-shell-internal-buffer proc-buffer-name
)
1998 ;; XXX: Why is this `sit-for' needed?
1999 ;; `python-shell-make-comint' calls `accept-process-output'
2000 ;; already but it is not helping to get proper output on
2001 ;; 'gnu/linux when the internal shell process is not running and
2002 ;; a call to `python-shell-internal-send-string' is issued.
2004 (get-buffer-process proc-buffer-name
)))
2006 (define-obsolete-function-alias
2007 'python-proc
'python-shell-internal-get-or-create-process
"24.3")
2009 (define-obsolete-variable-alias
2010 'python-buffer
'python-shell-internal-buffer
"24.3")
2012 (define-obsolete-variable-alias
2013 'python-preoutput-result
'python-shell-internal-last-output
"24.3")
2015 (defun python-shell-send-string (string &optional process msg
)
2016 "Send STRING to inferior Python PROCESS.
2017 When MSG is non-nil messages the first line of STRING."
2018 (interactive "sPython command: ")
2019 (let ((process (or process
(python-shell-get-or-create-process)))
2020 (lines (split-string string
"\n" t
)))
2021 (and msg
(message "Sent: %s..." (nth 0 lines
)))
2022 (if (> (length lines
) 1)
2023 (let* ((temporary-file-directory
2024 (if (file-remote-p default-directory
)
2025 (concat (file-remote-p default-directory
) "/tmp")
2026 temporary-file-directory
))
2027 (temp-file-name (make-temp-file "py"))
2028 (file-name (or (buffer-file-name) temp-file-name
)))
2029 (with-temp-file temp-file-name
2031 (delete-trailing-whitespace))
2032 (python-shell-send-file file-name process temp-file-name
))
2033 (comint-send-string process string
)
2034 (when (or (not (string-match "\n$" string
))
2035 (string-match "\n[ \t].*\n?$" string
))
2036 (comint-send-string process
"\n")))))
2038 (defvar python-shell-output-filter-in-progress nil
)
2039 (defvar python-shell-output-filter-buffer nil
)
2041 (defun python-shell-output-filter (string)
2042 "Filter used in `python-shell-send-string-no-output' to grab output.
2043 STRING is the output received to this point from the process.
2044 This filter saves received output from the process in
2045 `python-shell-output-filter-buffer' and stops receiving it after
2046 detecting a prompt at the end of the buffer."
2048 string
(ansi-color-filter-apply string
)
2049 python-shell-output-filter-buffer
2050 (concat python-shell-output-filter-buffer string
))
2052 ;; XXX: It seems on OSX an extra carriage return is attached
2053 ;; at the end of output, this handles that too.
2054 (format "\r?\n\\(?:%s\\|%s\\|%s\\)$"
2055 python-shell-prompt-regexp
2056 python-shell-prompt-block-regexp
2057 python-shell-prompt-pdb-regexp
)
2058 python-shell-output-filter-buffer
)
2059 ;; Output ends when `python-shell-output-filter-buffer' contains
2060 ;; the prompt attached at the end of it.
2061 (setq python-shell-output-filter-in-progress nil
2062 python-shell-output-filter-buffer
2063 (substring python-shell-output-filter-buffer
2064 0 (match-beginning 0)))
2065 (when (and (> (length python-shell-prompt-output-regexp
) 0)
2066 (string-match (concat "^" python-shell-prompt-output-regexp
)
2067 python-shell-output-filter-buffer
))
2068 ;; Some shells, like iPython might append a prompt before the
2069 ;; output, clean that.
2070 (setq python-shell-output-filter-buffer
2071 (substring python-shell-output-filter-buffer
(match-end 0)))))
2074 (defun python-shell-send-string-no-output (string &optional process msg
)
2075 "Send STRING to PROCESS and inhibit output.
2076 When MSG is non-nil messages the first line of STRING. Return
2078 (let ((process (or process
(python-shell-get-or-create-process)))
2079 (comint-preoutput-filter-functions
2080 '(python-shell-output-filter))
2081 (python-shell-output-filter-in-progress t
)
2085 (python-shell-send-string string process msg
)
2086 (while python-shell-output-filter-in-progress
2087 ;; `python-shell-output-filter' takes care of setting
2088 ;; `python-shell-output-filter-in-progress' to NIL after it
2089 ;; detects end of output.
2090 (accept-process-output process
))
2092 python-shell-output-filter-buffer
2093 (setq python-shell-output-filter-buffer nil
)))
2094 (with-current-buffer (process-buffer process
)
2095 (comint-interrupt-subjob)))))
2097 (defun python-shell-internal-send-string (string)
2098 "Send STRING to the Internal Python interpreter.
2099 Returns the output. See `python-shell-send-string-no-output'."
2100 ;; XXX Remove `python-shell-internal-last-output' once CEDET is
2101 ;; updated to support this new mode.
2102 (setq python-shell-internal-last-output
2103 (python-shell-send-string-no-output
2104 ;; Makes this function compatible with the old
2105 ;; python-send-receive. (At least for CEDET).
2106 (replace-regexp-in-string "_emacs_out +" "" string
)
2107 (python-shell-internal-get-or-create-process) nil
)))
2109 (define-obsolete-function-alias
2110 'python-send-receive
'python-shell-internal-send-string
"24.3")
2112 (define-obsolete-function-alias
2113 'python-send-string
'python-shell-internal-send-string
"24.3")
2115 (defun python-shell-send-region (start end
)
2116 "Send the region delimited by START and END to inferior Python process."
2118 (python-shell-send-string
2120 (let ((line-num (line-number-at-pos start
)))
2121 ;; When sending a region, add blank lines for non sent code so
2122 ;; backtraces remain correct.
2123 (make-string (1- line-num
) ?
\n))
2124 (buffer-substring start end
))
2127 (defun python-shell-send-buffer (&optional arg
)
2128 "Send the entire buffer to inferior Python process.
2129 With prefix ARG allow execution of code inside blocks delimited
2130 by \"if __name__== '__main__':\""
2134 (let ((str (buffer-substring (point-min) (point-max))))
2137 (setq str
(replace-regexp-in-string
2138 (python-rx if-name-main
)
2139 "if __name__ == '__main__ ':" str
)))
2140 (python-shell-send-string str
))))
2142 (defun python-shell-send-defun (arg)
2143 "Send the current defun to inferior Python process.
2144 When argument ARG is non-nil do not include decorators."
2147 (python-shell-send-region
2150 (while (and (or (python-nav-beginning-of-defun)
2151 (beginning-of-line 1))
2152 (> (current-indentation) 0)))
2154 (while (and (forward-line -
1)
2155 (looking-at (python-rx decorator
))))
2159 (or (python-nav-end-of-defun)
2163 (defun python-shell-send-file (file-name &optional process temp-file-name
)
2164 "Send FILE-NAME to inferior Python PROCESS.
2165 If TEMP-FILE-NAME is passed then that file is used for processing
2166 instead, while internally the shell will continue to use
2168 (interactive "fFile to send: ")
2169 (let* ((process (or process
(python-shell-get-or-create-process)))
2170 (temp-file-name (when temp-file-name
2172 (or (file-remote-p temp-file-name
'localname
)
2174 (file-name (or (when file-name
2176 (or (file-remote-p file-name
'localname
)
2179 (when (not file-name
)
2180 (error "If FILE-NAME is nil then TEMP-FILE-NAME must be non-nil"))
2181 (python-shell-send-string
2183 (concat "__pyfile = open('''%s''');"
2184 "exec(compile(__pyfile.read(), '''%s''', 'exec'));"
2186 (or temp-file-name file-name
) file-name
)
2189 (defun python-shell-switch-to-shell ()
2190 "Switch to inferior Python process buffer."
2192 (pop-to-buffer (process-buffer (python-shell-get-or-create-process)) t
))
2194 (defun python-shell-send-setup-code ()
2195 "Send all setup code for shell.
2196 This function takes the list of setup code to send from the
2197 `python-shell-setup-codes' list."
2198 (let ((process (get-buffer-process (current-buffer))))
2199 (dolist (code python-shell-setup-codes
)
2201 (message "Sent %s" code
)
2202 (python-shell-send-string
2203 (symbol-value code
) process
)))))
2205 (add-hook 'inferior-python-mode-hook
2206 #'python-shell-send-setup-code
)
2209 ;;; Shell completion
2211 (defcustom python-shell-completion-setup-code
2215 def __COMPLETER_all_completions(text): []
2218 readline.set_completer(rlcompleter.Completer().complete)
2219 def __COMPLETER_all_completions(text):
2225 res = readline.get_completer()(text, i)
2228 completions.append(res)
2232 "Code used to setup completion in inferior Python processes."
2236 (defcustom python-shell-completion-string-code
2237 "';'.join(__COMPLETER_all_completions('''%s'''))\n"
2238 "Python code used to get a string of completions separated by semicolons."
2242 (defcustom python-shell-completion-module-string-code
""
2243 "Python code used to get completions separated by semicolons for imports.
2245 For IPython v0.11, add the following line to
2246 `python-shell-completion-setup-code':
2248 from IPython.core.completerlib import module_completion
2250 and use the following as the value of this variable:
2252 ';'.join(module_completion('''%s'''))\n"
2256 (defcustom python-shell-completion-pdb-string-code
2257 "';'.join(globals().keys() + locals().keys())"
2258 "Python code used to get completions separated by semicolons for [i]pdb."
2262 (defun python-shell-completion-get-completions (process line input
)
2263 "Do completion at point for PROCESS.
2264 LINE is used to detect the context on how to complete given
2267 ;; Get the last prompt for the inferior process
2268 ;; buffer. This is used for the completion code selection
2270 (with-current-buffer (process-buffer process
)
2271 (buffer-substring-no-properties
2272 (overlay-start comint-last-prompt-overlay
)
2273 (overlay-end comint-last-prompt-overlay
))))
2275 ;; Check whether a prompt matches a pdb string, an import
2276 ;; statement or just the standard prompt and use the
2277 ;; correct python-shell-completion-*-code string
2278 (cond ((and (> (length python-shell-completion-pdb-string-code
) 0)
2280 (concat "^" python-shell-prompt-pdb-regexp
) prompt
))
2283 (length python-shell-completion-module-string-code
) 0)
2285 (concat "^" python-shell-prompt-regexp
) prompt
)
2286 (string-match "^[ \t]*\\(from\\|import\\)[ \t]" line
))
2289 (concat "^" python-shell-prompt-regexp
) prompt
)
2293 (pcase completion-context
2294 (`pdb python-shell-completion-pdb-string-code
)
2295 (`import python-shell-completion-module-string-code
)
2296 (`default python-shell-completion-string-code
)
2299 (if (eq completion-context
'import
)
2300 (replace-regexp-in-string "^[ \t]+" "" line
)
2302 (and completion-code
2303 (> (length input
) 0)
2304 (with-current-buffer (process-buffer process
)
2305 (let ((completions (python-shell-send-string-no-output
2306 (format completion-code input
) process
)))
2307 (and (> (length completions
) 2)
2308 (split-string completions
2309 "^'\\|^\"\\|;\\|'$\\|\"$" t
)))))))
2311 (defun python-shell-completion-complete-at-point (&optional process
)
2312 "Perform completion at point in inferior Python.
2313 Optional argument PROCESS forces completions to be retrieved
2314 using that one instead of current buffer's process."
2315 (setq process
(or process
(get-buffer-process (current-buffer))))
2318 (with-syntax-table python-dotty-syntax-table
2319 (let* ((paren-depth (car (syntax-ppss)))
2320 (syntax-string "w_")
2321 (syntax-list (string-to-syntax syntax-string
)))
2322 ;; Stop scanning for the beginning of the completion
2323 ;; subject after the char before point matches a
2326 (car (syntax-after (1- (point)))) syntax-list
)
2327 (skip-syntax-backward syntax-string
)
2328 (when (or (equal (char-before) ?\
))
2329 (equal (char-before) ?
\"))
2332 ;; honor initial paren depth
2333 (> (car (syntax-ppss)) paren-depth
)
2334 (python-syntax-context 'string
))
2339 (completion-table-dynamic
2341 #'python-shell-completion-get-completions
2342 process
(buffer-substring-no-properties
2343 (line-beginning-position) end
))))))
2345 (defun python-shell-completion-complete-or-indent ()
2346 "Complete or indent depending on the context.
2347 If content before pointer is all whitespace indent. If not try
2350 (if (string-match "^[[:space:]]*$"
2351 (buffer-substring (comint-line-beginning-position)
2353 (indent-for-tab-command)
2354 (completion-at-point)))
2357 ;;; PDB Track integration
2359 (defcustom python-pdbtrack-activate t
2360 "Non-nil makes python shell enable pdbtracking."
2365 (defcustom python-pdbtrack-stacktrace-info-regexp
2366 "^> \\([^\"(<]+\\)(\\([0-9]+\\))\\([?a-zA-Z0-9_<>]+\\)()"
2367 "Regular Expression matching stacktrace information.
2368 Used to extract the current line and module being inspected."
2373 (defvar python-pdbtrack-tracked-buffer nil
2374 "Variable containing the value of the current tracked buffer.
2375 Never set this variable directly, use
2376 `python-pdbtrack-set-tracked-buffer' instead.")
2378 (defvar python-pdbtrack-buffers-to-kill nil
2379 "List of buffers to be deleted after tracking finishes.")
2381 (defun python-pdbtrack-set-tracked-buffer (file-name)
2382 "Set the buffer for FILE-NAME as the tracked buffer.
2383 Internally it uses the `python-pdbtrack-tracked-buffer' variable.
2384 Returns the tracked buffer."
2385 (let ((file-buffer (get-file-buffer file-name
)))
2387 (setq python-pdbtrack-tracked-buffer file-buffer
)
2388 (setq file-buffer
(find-file-noselect file-name
))
2389 (when (not (member file-buffer python-pdbtrack-buffers-to-kill
))
2390 (add-to-list 'python-pdbtrack-buffers-to-kill file-buffer
)))
2393 (defun python-pdbtrack-comint-output-filter-function (output)
2394 "Move overlay arrow to current pdb line in tracked buffer.
2395 Argument OUTPUT is a string with the output from the comint process."
2396 (when (and python-pdbtrack-activate
(not (string= output
"")))
2397 (let* ((full-output (ansi-color-filter-apply
2398 (buffer-substring comint-last-input-end
(point-max))))
2402 (insert full-output
)
2403 ;; When the debugger encounters a pdb.set_trace()
2404 ;; command, it prints a single stack frame. Sometimes
2405 ;; it prints a bit of extra information about the
2406 ;; arguments of the present function. When ipdb
2407 ;; encounters an exception, it prints the _entire_ stack
2408 ;; trace. To handle all of these cases, we want to find
2409 ;; the _last_ stack frame printed in the most recent
2410 ;; batch of output, then jump to the corresponding
2411 ;; file/line number.
2412 (goto-char (point-max))
2413 (when (re-search-backward python-pdbtrack-stacktrace-info-regexp nil t
)
2414 (setq line-number
(string-to-number
2415 (match-string-no-properties 2)))
2416 (match-string-no-properties 1)))))
2417 (if (and file-name line-number
)
2418 (let* ((tracked-buffer
2419 (python-pdbtrack-set-tracked-buffer file-name
))
2420 (shell-buffer (current-buffer))
2421 (tracked-buffer-window (get-buffer-window tracked-buffer
))
2422 (tracked-buffer-line-pos))
2423 (with-current-buffer tracked-buffer
2424 (set (make-local-variable 'overlay-arrow-string
) "=>")
2425 (set (make-local-variable 'overlay-arrow-position
) (make-marker))
2426 (setq tracked-buffer-line-pos
(progn
2427 (goto-char (point-min))
2428 (forward-line (1- line-number
))
2430 (when tracked-buffer-window
2432 tracked-buffer-window tracked-buffer-line-pos
))
2433 (set-marker overlay-arrow-position tracked-buffer-line-pos
))
2434 (pop-to-buffer tracked-buffer
)
2435 (switch-to-buffer-other-window shell-buffer
))
2436 (when python-pdbtrack-tracked-buffer
2437 (with-current-buffer python-pdbtrack-tracked-buffer
2438 (set-marker overlay-arrow-position nil
))
2439 (mapc #'(lambda (buffer)
2440 (ignore-errors (kill-buffer buffer
)))
2441 python-pdbtrack-buffers-to-kill
)
2442 (setq python-pdbtrack-tracked-buffer nil
2443 python-pdbtrack-buffers-to-kill nil
)))))
2447 ;;; Symbol completion
2449 (defun python-completion-complete-at-point ()
2450 "Complete current symbol at point.
2451 For this to work the best as possible you should call
2452 `python-shell-send-buffer' from time to time so context in
2453 inferior python process is updated properly."
2454 (let ((process (python-shell-get-process)))
2456 (error "Completion needs an inferior Python process running")
2457 (python-shell-completion-complete-at-point process
))))
2459 (add-to-list 'debug-ignored-errors
2460 "^Completion needs an inferior Python process running.")
2465 (defcustom python-fill-comment-function
'python-fill-comment
2466 "Function to fill comments.
2467 This is the function used by `python-fill-paragraph' to
2472 (defcustom python-fill-string-function
'python-fill-string
2473 "Function to fill strings.
2474 This is the function used by `python-fill-paragraph' to
2479 (defcustom python-fill-decorator-function
'python-fill-decorator
2480 "Function to fill decorators.
2481 This is the function used by `python-fill-paragraph' to
2486 (defcustom python-fill-paren-function
'python-fill-paren
2487 "Function to fill parens.
2488 This is the function used by `python-fill-paragraph' to
2493 (defcustom python-fill-docstring-style
'pep-257
2494 "Style used to fill docstrings.
2495 This affects `python-fill-string' behavior with regards to
2496 triple quotes positioning.
2498 Possible values are DJANGO, ONETWO, PEP-257, PEP-257-NN,
2499 SYMMETRIC, and NIL. A value of NIL won't care about quotes
2500 position and will treat docstrings a normal string, any other
2501 value may result in one of the following docstring styles:
2506 Process foo, return bar.
2510 Process foo, return bar.
2512 If processing fails throw ProcessingError.
2517 \"\"\"Process foo, return bar.\"\"\"
2520 Process foo, return bar.
2522 If processing fails throw ProcessingError.
2528 \"\"\"Process foo, return bar.\"\"\"
2530 \"\"\"Process foo, return bar.
2532 If processing fails throw ProcessingError.
2538 \"\"\"Process foo, return bar.\"\"\"
2540 \"\"\"Process foo, return bar.
2542 If processing fails throw ProcessingError.
2547 \"\"\"Process foo, return bar.\"\"\"
2550 Process foo, return bar.
2552 If processing fails throw ProcessingError.
2555 (const :tag
"Don't format docstrings" nil
)
2556 (const :tag
"Django's coding standards style." django
)
2557 (const :tag
"One newline and start and Two at end style." onetwo
)
2558 (const :tag
"PEP-257 with 2 newlines at end of string." pep-257
)
2559 (const :tag
"PEP-257 with 1 newline at end of string." pep-257-nn
)
2560 (const :tag
"Symmetric style." symmetric
))
2563 (memq val
'(django onetwo pep-257 pep-257-nn symmetric nil
))))
2565 (defun python-fill-paragraph (&optional justify
)
2566 "`fill-paragraph-function' handling multi-line strings and possibly comments.
2567 If any of the current line is in or at the end of a multi-line string,
2568 fill the string or the paragraph of it that point is in, preserving
2569 the string's indentation.
2570 Optional argument JUSTIFY defines if the paragraph should be justified."
2575 ((python-syntax-context 'comment
)
2576 (funcall python-fill-comment-function justify
))
2577 ;; Strings/Docstrings
2578 ((save-excursion (or (python-syntax-context 'string
)
2579 (equal (string-to-syntax "|")
2580 (syntax-after (point)))))
2581 (funcall python-fill-string-function justify
))
2583 ((equal (char-after (save-excursion
2584 (python-nav-beginning-of-statement))) ?
@)
2585 (funcall python-fill-decorator-function justify
))
2587 ((or (python-syntax-context 'paren
)
2588 (looking-at (python-rx open-paren
))
2590 (skip-syntax-forward "^(" (line-end-position))
2591 (looking-at (python-rx open-paren
))))
2592 (funcall python-fill-paren-function justify
))
2595 (defun python-fill-comment (&optional justify
)
2596 "Comment fill function for `python-fill-paragraph'.
2597 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
2598 (fill-comment-paragraph justify
))
2600 (defun python-fill-string (&optional justify
)
2601 "String fill function for `python-fill-paragraph'.
2602 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
2603 (let* ((marker (point-marker))
2607 (or (python-syntax-context 'string
)
2608 (and (equal (string-to-syntax "|")
2609 (syntax-after (point)))
2611 (num-quotes (python-syntax-count-quotes
2612 (char-after str-start-pos
) str-start-pos
))
2615 (goto-char (+ str-start-pos num-quotes
))
2616 (or (re-search-forward (rx (syntax string-delimiter
)) nil t
)
2617 (goto-char (point-max)))
2620 ;; Docstring styles may vary for oneliners and multi-liners.
2621 (> (count-matches "\n" str-start-pos str-end-pos
) 0))
2623 (pcase python-fill-docstring-style
2624 ;; delimiters-style is a cons cell with the form
2625 ;; (START-NEWLINES . END-NEWLINES). When any of the sexps
2626 ;; is NIL means to not add any newlines for start or end
2627 ;; of docstring. See `python-fill-docstring-style' for a
2628 ;; graphic idea of each style.
2629 (`django
(cons 1 1))
2630 (`onetwo
(and multi-line-p
(cons 1 2)))
2631 (`pep-257
(and multi-line-p
(cons nil
2)))
2632 (`pep-257-nn
(and multi-line-p
(cons nil
1)))
2633 (`symmetric
(and multi-line-p
(cons 1 1)))))
2634 (docstring-p (save-excursion
2635 ;; Consider docstrings those strings which
2636 ;; start on a line by themselves.
2637 (python-nav-beginning-of-statement)
2638 (and (= (point) str-start-pos
))))
2639 (fill-paragraph-function))
2641 (narrow-to-region str-start-pos str-end-pos
)
2642 (fill-paragraph justify
))
2644 (when (and docstring-p python-fill-docstring-style
)
2645 ;; Add the number of newlines indicated by the selected style
2646 ;; at the start of the docstring.
2647 (goto-char (+ str-start-pos num-quotes
))
2648 (delete-region (point) (progn
2649 (skip-syntax-forward "> ")
2651 (and (car delimiters-style
)
2652 (or (newline (car delimiters-style
)) t
)
2653 ;; Indent only if a newline is added.
2654 (indent-according-to-mode))
2655 ;; Add the number of newlines indicated by the selected style
2656 ;; at the end of the docstring.
2657 (goto-char (if (not (= str-end-pos
(point-max)))
2658 (- str-end-pos num-quotes
)
2660 (delete-region (point) (progn
2661 (skip-syntax-backward "> ")
2663 (and (cdr delimiters-style
)
2664 ;; Add newlines only if string ends.
2665 (not (= str-end-pos
(point-max)))
2666 (or (newline (cdr delimiters-style
)) t
)
2667 ;; Again indent only if a newline is added.
2668 (indent-according-to-mode))))) t
)
2670 (defun python-fill-decorator (&optional justify
)
2671 "Decorator fill function for `python-fill-paragraph'.
2672 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
2675 (defun python-fill-paren (&optional justify
)
2676 "Paren fill function for `python-fill-paragraph'.
2677 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
2679 (narrow-to-region (progn
2680 (while (python-syntax-context 'paren
)
2681 (goto-char (1- (point-marker))))
2683 (line-beginning-position))
2685 (when (not (python-syntax-context 'paren
))
2687 (when (not (python-syntax-context 'paren
))
2688 (skip-syntax-backward "^)")))
2689 (while (python-syntax-context 'paren
)
2690 (goto-char (1+ (point-marker))))
2692 (let ((paragraph-start "\f\\|[ \t]*$")
2693 (paragraph-separate ",")
2694 (fill-paragraph-function))
2695 (goto-char (point-min))
2696 (fill-paragraph justify
))
2699 (python-indent-line)
2700 (goto-char (line-end-position)))) t
)
2705 (defcustom python-skeleton-autoinsert nil
2706 "Non-nil means template skeletons will be automagically inserted.
2707 This happens when pressing \"if<SPACE>\", for example, to prompt for
2713 (define-obsolete-variable-alias
2714 'python-use-skeletons
'python-skeleton-autoinsert
"24.3")
2716 (defvar python-skeleton-available
'()
2717 "Internal list of available skeletons.")
2719 (define-abbrev-table 'python-mode-skeleton-abbrev-table
()
2720 "Abbrev table for Python mode skeletons."
2722 ;; Allow / inside abbrevs.
2723 :regexp
"\\(?:^\\|[^/]\\)\\<\\([[:word:]/]+\\)\\W*"
2724 ;; Only expand in code.
2725 :enable-function
(lambda ()
2727 (not (python-syntax-comment-or-string-p))
2728 python-skeleton-autoinsert
)))
2730 (defmacro python-skeleton-define
(name doc
&rest skel
)
2731 "Define a `python-mode' skeleton using NAME DOC and SKEL.
2732 The skeleton will be bound to python-skeleton-NAME and will
2733 be added to `python-mode-skeleton-abbrev-table'."
2734 (declare (indent 2))
2735 (let* ((name (symbol-name name
))
2736 (function-name (intern (concat "python-skeleton-" name
))))
2738 (define-abbrev python-mode-skeleton-abbrev-table
2739 ,name
"" ',function-name
:system t
)
2740 (setq python-skeleton-available
2741 (cons ',function-name python-skeleton-available
))
2742 (define-skeleton ,function-name
2744 (format "Insert %s statement." name
))
2747 (define-abbrev-table 'python-mode-abbrev-table
()
2748 "Abbrev table for Python mode."
2749 :parents
(list python-mode-skeleton-abbrev-table
))
2751 (defmacro python-define-auxiliary-skeleton
(name doc
&optional
&rest skel
)
2752 "Define a `python-mode' auxiliary skeleton using NAME DOC and SKEL.
2753 The skeleton will be bound to python-skeleton-NAME."
2754 (declare (indent 2))
2755 (let* ((name (symbol-name name
))
2756 (function-name (intern (concat "python-skeleton--" name
)))
2758 "Add '%s' clause? " name
)))
2761 `(< ,(format "%s:" name
) \n \n
2763 `(define-skeleton ,function-name
2765 (format "Auxiliary skeleton for %s statement." name
))
2767 (unless (y-or-n-p ,msg
)
2771 (python-define-auxiliary-skeleton else nil
)
2773 (python-define-auxiliary-skeleton except nil
)
2775 (python-define-auxiliary-skeleton finally nil
)
2777 (python-skeleton-define if nil
2781 ("other condition, %s: "
2785 '(python-skeleton--else) | ^
)
2787 (python-skeleton-define while nil
2791 '(python-skeleton--else) | ^
)
2793 (python-skeleton-define for nil
2797 '(python-skeleton--else) | ^
)
2799 (python-skeleton-define try nil
2805 "except " str
":" \n
2808 '(python-skeleton--except)
2809 '(python-skeleton--else)
2810 '(python-skeleton--finally) | ^
)
2812 (python-skeleton-define def nil
2814 "def " str
"(" ("Parameter, %s: "
2815 (unless (equal ?\
( (char-before)) ", ")
2817 "\"\"\"" -
"\"\"\"" \n
2820 (python-skeleton-define class nil
2822 "class " str
"(" ("Inheritance, %s: "
2823 (unless (equal ?\
( (char-before)) ", ")
2827 "\"\"\"" -
"\"\"\"" \n
2830 (defun python-skeleton-add-menu-items ()
2831 "Add menu items to Python->Skeletons menu."
2832 (let ((skeletons (sort python-skeleton-available
'string
<))
2834 (dolist (skeleton skeletons
)
2836 nil
'("Python" "Skeletons")
2838 "Insert %s" (nth 2 (split-string (symbol-name skeleton
) "-")))
2843 (defcustom python-ffap-setup-code
2844 "def __FFAP_get_module_path(module):
2847 path = __import__(module).__file__
2848 if path[-4:] == '.pyc' and os.path.exists(path[0:-1]):
2853 "Python code to get a module path."
2857 (defcustom python-ffap-string-code
2858 "__FFAP_get_module_path('''%s''')\n"
2859 "Python code used to get a string with the path of a module."
2863 (defun python-ffap-module-path (module)
2864 "Function for `ffap-alist' to return path for MODULE."
2866 (and (eq major-mode
'inferior-python-mode
)
2867 (get-buffer-process (current-buffer)))
2868 (python-shell-get-process))))
2872 (python-shell-send-string-no-output
2873 (format python-ffap-string-code module
) process
)))
2875 (substring-no-properties module-file
1 -
1))))))
2877 (eval-after-load "ffap"
2879 (push '(python-mode . python-ffap-module-path
) ffap-alist
)
2880 (push '(inferior-python-mode . python-ffap-module-path
) ffap-alist
)))
2885 (defcustom python-check-command
2887 "Command used to check a Python file."
2891 (defcustom python-check-buffer-name
2892 "*Python check: %s*"
2893 "Buffer name used for check commands."
2897 (defvar python-check-custom-command nil
2900 (defun python-check (command)
2901 "Check a Python file (default current buffer's file).
2902 Runs COMMAND, a shell command, as if by `compile'. See
2903 `python-check-command' for the default."
2905 (list (read-string "Check command: "
2906 (or python-check-custom-command
2907 (concat python-check-command
" "
2908 (shell-quote-argument
2910 (let ((name (buffer-file-name)))
2912 (file-name-nondirectory name
)))
2914 (setq python-check-custom-command command
)
2915 (save-some-buffers (not compilation-ask-about-save
) nil
)
2916 (let ((process-environment (python-shell-calculate-process-environment))
2917 (exec-path (python-shell-calculate-exec-path)))
2918 (compilation-start command nil
2920 (format python-check-buffer-name command
)))))
2925 (defcustom python-eldoc-setup-code
2926 "def __PYDOC_get_help(obj):
2929 if hasattr(obj, 'startswith'):
2930 obj = eval(obj, globals())
2931 doc = inspect.getdoc(obj)
2932 if not doc and callable(obj):
2934 if inspect.isclass(obj) and hasattr(obj, '__init__'):
2935 target = obj.__init__
2941 args = inspect.formatargspec(
2942 *inspect.getargspec(target)
2945 doc = '{objtype} {name}{args}'.format(
2946 objtype=objtype, name=name, args=args
2949 doc = doc.splitlines()[0]
2956 "Python code to setup documentation retrieval."
2960 (defcustom python-eldoc-string-code
2961 "__PYDOC_get_help('''%s''')\n"
2962 "Python code used to get a string with the documentation of an object."
2966 (defun python-eldoc--get-doc-at-point (&optional force-input force-process
)
2967 "Internal implementation to get documentation at point.
2968 If not FORCE-INPUT is passed then what
2969 `python-info-current-symbol' returns will be used. If not
2970 FORCE-PROCESS is passed what `python-shell-get-process' returns
2972 (let ((process (or force-process
(python-shell-get-process))))
2974 (error "Eldoc needs an inferior Python process running")
2975 (let ((input (or force-input
2976 (python-info-current-symbol t
))))
2978 (python-shell-send-string-no-output
2979 (format python-eldoc-string-code input
)
2982 (defun python-eldoc-function ()
2983 "`eldoc-documentation-function' for Python.
2984 For this to work the best as possible you should call
2985 `python-shell-send-buffer' from time to time so context in
2986 inferior python process is updated properly."
2987 (python-eldoc--get-doc-at-point))
2989 (defun python-eldoc-at-point (symbol)
2990 "Get help on SYMBOL using `help'.
2991 Interactively, prompt for symbol."
2993 (let ((symbol (python-info-current-symbol t
))
2994 (enable-recursive-minibuffers t
))
2995 (list (read-string (if symbol
2996 (format "Describe symbol (default %s): " symbol
)
2997 "Describe symbol: ")
2999 (message (python-eldoc--get-doc-at-point symbol
)))
3001 (add-to-list 'debug-ignored-errors
3002 "^Eldoc needs an inferior Python process running.")
3007 (defun python-imenu-prev-index-position ()
3008 "Python mode's `imenu-prev-index-position-function'."
3010 (while (and (setq found
3011 (re-search-backward python-nav-beginning-of-defun-regexp nil t
))
3012 (not (python-info-looking-at-beginning-of-defun))))
3014 (python-info-looking-at-beginning-of-defun)
3015 (python-info-current-defun))))
3020 (defun python-info-current-defun (&optional include-type
)
3021 "Return name of surrounding function with Python compatible dotty syntax.
3022 Optional argument INCLUDE-TYPE indicates to include the type of the defun.
3023 This function is compatible to be used as
3024 `add-log-current-defun-function' since it returns nil if point is
3025 not inside a defun."
3031 (starting-indentation (current-indentation))
3032 (starting-pos (point))
3037 (while (python-nav-beginning-of-defun 1)
3038 (when (save-match-data
3040 (or (not last-indent
)
3041 (< (current-indentation) last-indent
))
3045 ;; If this is the first run, we may add
3046 ;; the current defun at point.
3047 (setq first-run nil
)
3048 (goto-char starting-pos
)
3049 (python-nav-beginning-of-statement)
3050 (beginning-of-line 1)
3052 python-nav-beginning-of-defun-regexp
)))
3056 (+ (current-indentation)
3057 python-indent-offset
)))
3058 (if (< starting-indentation min-indent
)
3059 ;; If the starting indentation is not
3060 ;; within the min defun indent make the
3063 ;; Else go to the end of defun and add
3064 ;; up the current indentation to the
3066 (python-nav-end-of-defun)
3068 (if (>= (current-indentation) min-indent
)
3069 (1+ (current-indentation))
3071 (save-match-data (setq last-indent
(current-indentation)))
3072 (if (or (not include-type
) type
)
3073 (setq names
(cons (match-string-no-properties 1) names
))
3074 (let ((match (split-string (match-string-no-properties 0))))
3075 (setq type
(car match
))
3076 (setq names
(cons (cadr match
) names
)))))
3077 ;; Stop searching ASAP.
3078 (and (= (current-indentation) 0) (throw 'exit t
))))
3080 (concat (and type
(format "%s " type
))
3081 (mapconcat 'identity names
".")))))))
3083 (defun python-info-current-symbol (&optional replace-self
)
3084 "Return current symbol using dotty syntax.
3085 With optional argument REPLACE-SELF convert \"self\" to current
3088 (and (not (python-syntax-comment-or-string-p))
3089 (with-syntax-table python-dotty-syntax-table
3090 (let ((sym (symbol-at-point)))
3092 (substring-no-properties (symbol-name sym
))))))))
3094 (if (not replace-self
)
3096 (let ((current-defun (python-info-current-defun)))
3097 (if (not current-defun
)
3099 (replace-regexp-in-string
3100 (python-rx line-start word-start
"self" word-end ?.
)
3102 (mapconcat 'identity
3103 (butlast (split-string current-defun
"\\."))
3107 (defun python-info-statement-starts-block-p ()
3108 "Return non-nil if current statement opens a block."
3110 (python-nav-beginning-of-statement)
3111 (looking-at (python-rx block-start
))))
3113 (defun python-info-statement-ends-block-p ()
3114 "Return non-nil if point is at end of block."
3115 (let ((end-of-block-pos (save-excursion
3116 (python-nav-end-of-block)))
3117 (end-of-statement-pos (save-excursion
3118 (python-nav-end-of-statement))))
3119 (and end-of-block-pos end-of-statement-pos
3120 (= end-of-block-pos end-of-statement-pos
))))
3122 (defun python-info-beginning-of-statement-p ()
3123 "Return non-nil if point is at beginning of statement."
3124 (= (point) (save-excursion
3125 (python-nav-beginning-of-statement)
3128 (defun python-info-end-of-statement-p ()
3129 "Return non-nil if point is at end of statement."
3130 (= (point) (save-excursion
3131 (python-nav-end-of-statement)
3134 (defun python-info-beginning-of-block-p ()
3135 "Return non-nil if point is at beginning of block."
3136 (and (python-info-beginning-of-statement-p)
3137 (python-info-statement-starts-block-p)))
3139 (defun python-info-end-of-block-p ()
3140 "Return non-nil if point is at end of block."
3141 (and (python-info-end-of-statement-p)
3142 (python-info-statement-ends-block-p)))
3144 (defun python-info-closing-block ()
3145 "Return the point of the block the current line closes."
3146 (let ((closing-word (save-excursion
3147 (back-to-indentation)
3149 (indentation (current-indentation)))
3150 (when (member closing-word python-indent-dedenters
)
3153 (while (and (> (current-indentation) indentation
)
3155 (not (back-to-indentation))
3157 (back-to-indentation)
3159 ((not (equal indentation
(current-indentation))) nil
)
3160 ((string= closing-word
"elif")
3161 (when (member (current-word) '("if" "elif"))
3163 ((string= closing-word
"else")
3164 (when (member (current-word) '("if" "elif" "except" "for" "while"))
3166 ((string= closing-word
"except")
3167 (when (member (current-word) '("try"))
3169 ((string= closing-word
"finally")
3170 (when (member (current-word) '("except" "else"))
3171 (point-marker))))))))
3173 (defun python-info-closing-block-message (&optional closing-block-point
)
3174 "Message the contents of the block the current line closes.
3175 With optional argument CLOSING-BLOCK-POINT use that instead of
3176 recalculating it calling `python-info-closing-block'."
3177 (let ((point (or closing-block-point
(python-info-closing-block))))
3181 (message "Closes %s" (save-excursion
3183 (back-to-indentation)
3185 (point) (line-end-position))))))))
3187 (defun python-info-line-ends-backslash-p (&optional line-number
)
3188 "Return non-nil if current line ends with backslash.
3189 With optional argument LINE-NUMBER, check that line instead."
3194 (python-util-goto-line line-number
))
3195 (while (and (not (eobp))
3196 (goto-char (line-end-position))
3197 (python-syntax-context 'paren
)
3198 (not (equal (char-before (point)) ?
\\)))
3200 (when (equal (char-before) ?
\\)
3203 (defun python-info-beginning-of-backslash (&optional line-number
)
3204 "Return the point where the backslashed line start.
3205 Optional argument LINE-NUMBER forces the line number to check against."
3210 (python-util-goto-line line-number
))
3211 (when (python-info-line-ends-backslash-p)
3212 (while (save-excursion
3213 (goto-char (line-beginning-position))
3214 (python-syntax-context 'paren
))
3216 (back-to-indentation)
3219 (defun python-info-continuation-line-p ()
3220 "Check if current line is continuation of another.
3221 When current line is continuation of another return the point
3222 where the continued line ends."
3226 (let* ((context-type (progn
3227 (back-to-indentation)
3228 (python-syntax-context-type)))
3229 (line-start (line-number-at-pos))
3230 (context-start (when context-type
3231 (python-syntax-context context-type
))))
3232 (cond ((equal context-type
'paren
)
3233 ;; Lines inside a paren are always a continuation line
3234 ;; (except the first one).
3235 (python-util-forward-comment -
1)
3237 ((member context-type
'(string comment
))
3238 ;; move forward an roll again
3239 (goto-char context-start
)
3240 (python-util-forward-comment)
3241 (python-info-continuation-line-p))
3243 ;; Not within a paren, string or comment, the only way
3244 ;; we are dealing with a continuation line is that
3245 ;; previous line contains a backslash, and this can
3246 ;; only be the previous line from current
3247 (back-to-indentation)
3248 (python-util-forward-comment -
1)
3249 (when (and (equal (1- line-start
) (line-number-at-pos))
3250 (python-info-line-ends-backslash-p))
3251 (point-marker))))))))
3253 (defun python-info-block-continuation-line-p ()
3254 "Return non-nil if current line is a continuation of a block."
3256 (when (python-info-continuation-line-p)
3258 (back-to-indentation)
3259 (when (looking-at (python-rx block-start
))
3262 (defun python-info-assignment-continuation-line-p ()
3263 "Check if current line is a continuation of an assignment.
3264 When current line is continuation of another with an assignment
3265 return the point of the first non-blank character after the
3268 (when (python-info-continuation-line-p)
3270 (back-to-indentation)
3271 (when (and (not (looking-at (python-rx block-start
)))
3272 (and (re-search-forward (python-rx not-simple-operator
3274 not-simple-operator
)
3275 (line-end-position) t
)
3276 (not (python-syntax-context-type))))
3277 (skip-syntax-forward "\s")
3280 (defun python-info-looking-at-beginning-of-defun (&optional syntax-ppss
)
3281 "Check if point is at `beginning-of-defun' using SYNTAX-PPSS."
3282 (and (not (python-syntax-context-type (or syntax-ppss
(syntax-ppss))))
3284 (beginning-of-line 1)
3285 (looking-at python-nav-beginning-of-defun-regexp
))))
3287 (defun python-info-current-line-comment-p ()
3288 "Check if current line is a comment line."
3290 (or (char-after (+ (line-beginning-position) (current-indentation))) ?_
)
3293 (defun python-info-current-line-empty-p ()
3294 "Check if current line is empty, ignoring whitespace."
3296 (beginning-of-line 1)
3298 (python-rx line-start
(* whitespace
)
3299 (group (* not-newline
))
3300 (* whitespace
) line-end
))
3301 (string-equal "" (match-string-no-properties 1))))
3304 ;;; Utility functions
3306 (defun python-util-goto-line (line-number)
3307 "Move point to LINE-NUMBER."
3308 (goto-char (point-min))
3309 (forward-line (1- line-number
)))
3311 ;; Stolen from org-mode
3312 (defun python-util-clone-local-variables (from-buffer &optional regexp
)
3313 "Clone local variables from FROM-BUFFER.
3314 Optional argument REGEXP selects variables to clone and defaults
3318 (and (symbolp (car pair
))
3319 (string-match (or regexp
"^python-")
3320 (symbol-name (car pair
)))
3321 (set (make-local-variable (car pair
))
3323 (buffer-local-variables from-buffer
)))
3325 (defun python-util-forward-comment (&optional direction
)
3326 "Python mode specific version of `forward-comment'.
3327 Optional argument DIRECTION defines the direction to move to."
3328 (let ((comment-start (python-syntax-context 'comment
))
3329 (factor (if (< (or direction
0) 0)
3333 (goto-char comment-start
))
3334 (forward-comment factor
)))
3338 (define-derived-mode python-mode prog-mode
"Python"
3339 "Major mode for editing Python files.
3342 Entry to this mode calls the value of `python-mode-hook'
3343 if that value is non-nil."
3344 (set (make-local-variable 'tab-width
) 8)
3345 (set (make-local-variable 'indent-tabs-mode
) nil
)
3347 (set (make-local-variable 'comment-start
) "# ")
3348 (set (make-local-variable 'comment-start-skip
) "#+\\s-*")
3350 (set (make-local-variable 'parse-sexp-lookup-properties
) t
)
3351 (set (make-local-variable 'parse-sexp-ignore-comments
) t
)
3353 (set (make-local-variable 'forward-sexp-function
)
3354 'python-nav-forward-sexp
)
3356 (set (make-local-variable 'font-lock-defaults
)
3357 '(python-font-lock-keywords nil nil nil nil
))
3359 (set (make-local-variable 'syntax-propertize-function
)
3360 python-syntax-propertize-function
)
3362 (set (make-local-variable 'indent-line-function
)
3363 #'python-indent-line-function
)
3364 (set (make-local-variable 'indent-region-function
) #'python-indent-region
)
3366 (set (make-local-variable 'paragraph-start
) "\\s-*$")
3367 (set (make-local-variable 'fill-paragraph-function
)
3368 'python-fill-paragraph
)
3370 (set (make-local-variable 'beginning-of-defun-function
)
3371 #'python-nav-beginning-of-defun
)
3372 (set (make-local-variable 'end-of-defun-function
)
3373 #'python-nav-end-of-defun
)
3375 (add-hook 'completion-at-point-functions
3376 'python-completion-complete-at-point nil
'local
)
3378 (add-hook 'post-self-insert-hook
3379 'python-indent-post-self-insert-function nil
'local
)
3381 (set (make-local-variable 'imenu-extract-index-name-function
)
3382 #'python-info-current-defun
)
3384 (set (make-local-variable 'imenu-prev-index-position-function
)
3385 #'python-imenu-prev-index-position
)
3387 (set (make-local-variable 'add-log-current-defun-function
)
3388 #'python-info-current-defun
)
3390 (add-hook 'which-func-functions
#'python-info-current-defun
nil t
)
3392 (set (make-local-variable 'skeleton-further-elements
)
3394 (< '(backward-delete-char-untabify (min python-indent-offset
3396 (^
'(- (1+ (current-indentation))))))
3398 (set (make-local-variable 'eldoc-documentation-function
)
3399 #'python-eldoc-function
)
3401 (add-to-list 'hs-special-modes-alist
3402 `(python-mode "^\\s-*\\(?:def\\|class\\)\\>" nil
"#"
3404 (python-nav-end-of-defun)) nil
))
3406 (set (make-local-variable 'mode-require-final-newline
) t
)
3408 (set (make-local-variable 'outline-regexp
)
3409 (python-rx (* space
) block-start
))
3410 (set (make-local-variable 'outline-heading-end-regexp
) ":\\s-*\n")
3411 (set (make-local-variable 'outline-level
)
3413 "`outline-level' function for Python mode."
3414 (1+ (/ (current-indentation) python-indent-offset
))))
3416 (python-skeleton-add-menu-items)
3418 (make-local-variable 'python-shell-internal-buffer
)
3420 (when python-indent-guess-indent-offset
3421 (python-indent-guess-indent-offset)))
3428 ;; indent-tabs-mode: nil
3431 ;;; python.el ends here