1 ;;; python.el --- Python's flying circus support for Emacs
3 ;; Copyright (C) 2003-2012 Free Software Foundation, Inc.
5 ;; Author: Fabián E. Gallina <fabian@anue.biz>
6 ;; URL: https://github.com/fgallina/python.el
10 ;; Keywords: languages
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published
16 ;; by the Free Software Foundation, either version 3 of the License,
17 ;; or (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful, but
20 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 ;; General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
29 ;; Major mode for editing Python files with some fontification and
30 ;; indentation bits extracted from original Dave Love's python.el
31 ;; found in GNU/Emacs.
33 ;; Implements Syntax highlighting, Indentation, Movement, Shell
34 ;; interaction, Shell completion, Shell virtualenv support, Pdb
35 ;; tracking, Symbol completion, Skeletons, FFAP, Code Check, Eldoc,
38 ;; Syntax highlighting: Fontification of code is provided and supports
39 ;; python's triple quoted strings properly.
41 ;; Indentation: Automatic indentation with indentation cycling is
42 ;; provided, it allows you to navigate different available levels of
43 ;; indentation by hitting <tab> several times. Also when inserting a
44 ;; colon the `python-indent-electric-colon' command is invoked and
45 ;; causes the current line to be dedented automatically if needed.
47 ;; Movement: `beginning-of-defun' and `end-of-defun' functions are
48 ;; properly implemented. There are also specialized
49 ;; `forward-sentence' and `backward-sentence' replacements called
50 ;; `python-nav-forward-block', `python-nav-backward-block'
51 ;; respectively which navigate between beginning of blocks of code.
52 ;; Extra functions `python-nav-forward-statement',
53 ;; `python-nav-backward-statement',
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
58 ;; navigation between code blocks.
60 ;; Shell interaction: is provided and allows you to execute easily any
61 ;; block of code of your current buffer in an inferior Python process.
63 ;; Shell completion: hitting tab will try to complete the current
64 ;; word. Shell completion is implemented in a manner that if you
65 ;; change the `python-shell-interpreter' to any other (for example
66 ;; IPython) it should be easy to integrate another way to calculate
67 ;; completions. You just need to specify your custom
68 ;; `python-shell-completion-setup-code' and
69 ;; `python-shell-completion-string-code'.
71 ;; Here is a complete example of the settings you would use for
75 ;; python-shell-interpreter "ipython"
76 ;; python-shell-interpreter-args ""
77 ;; python-shell-prompt-regexp "In \\[[0-9]+\\]: "
78 ;; python-shell-prompt-output-regexp "Out\\[[0-9]+\\]: "
79 ;; python-shell-completion-setup-code
80 ;; "from IPython.core.completerlib import module_completion"
81 ;; python-shell-completion-module-string-code
82 ;; "';'.join(module_completion('''%s'''))\n"
83 ;; python-shell-completion-string-code
84 ;; "';'.join(get_ipython().Completer.all_completions('''%s'''))\n")
86 ;; For iPython 0.10 everything would be the same except for
87 ;; `python-shell-completion-string-code' and
88 ;; `python-shell-completion-module-string-code':
90 ;; (setq python-shell-completion-string-code
91 ;; "';'.join(__IP.complete('''%s'''))\n"
92 ;; python-shell-completion-module-string-code "")
94 ;; Unfortunately running iPython on Windows needs some more tweaking.
95 ;; The way you must set `python-shell-interpreter' and
96 ;; `python-shell-interpreter-args' is as follows:
99 ;; python-shell-interpreter "C:\\Python27\\python.exe"
100 ;; python-shell-interpreter-args
101 ;; "-i C:\\Python27\\Scripts\\ipython-script.py")
103 ;; That will spawn the iPython process correctly (Of course you need
104 ;; to modify the paths according to your system).
106 ;; Please note that the default completion system depends on the
107 ;; readline module, so if you are using some Operating System that
108 ;; bundles Python without it (like Windows) just install the
109 ;; pyreadline from http://ipython.scipy.org/moin/PyReadline/Intro and
110 ;; you should be good to go.
112 ;; Shell virtualenv support: The shell also contains support for
113 ;; virtualenvs and other special environment modifications thanks to
114 ;; `python-shell-process-environment' and `python-shell-exec-path'.
115 ;; These two variables allows you to modify execution paths and
116 ;; environment variables to make easy for you to setup virtualenv rules
117 ;; or behavior modifications when running shells. Here is an example
118 ;; of how to make shell processes to be run using the /path/to/env/
121 ;; (setq python-shell-process-environment
123 ;; (format "PATH=%s" (mapconcat
126 ;; (cons (getenv "PATH")
127 ;; '("/path/to/env/bin/")))
129 ;; "VIRTUAL_ENV=/path/to/env/"))
130 ;; (python-shell-exec-path . ("/path/to/env/bin/"))
132 ;; Since the above is cumbersome and can be programmatically
133 ;; calculated, the variable `python-shell-virtualenv-path' is
134 ;; provided. When this variable is set with the path of the
135 ;; virtualenv to use, `process-environment' and `exec-path' get proper
136 ;; values in order to run shells inside the specified virtualenv. So
137 ;; the following will achieve the same as the previous example:
139 ;; (setq python-shell-virtualenv-path "/path/to/env/")
141 ;; Also the `python-shell-extra-pythonpaths' variable have been
142 ;; introduced as simple way of adding paths to the PYTHONPATH without
143 ;; affecting existing values.
145 ;; Pdb tracking: when you execute a block of code that contains some
146 ;; call to pdb (or ipdb) it will prompt the block of code and will
147 ;; follow the execution of pdb marking the current line with an arrow.
149 ;; Symbol completion: you can complete the symbol at point. It uses
150 ;; the shell completion in background so you should run
151 ;; `python-shell-send-buffer' from time to time to get better results.
153 ;; Skeletons: 6 skeletons are provided for simple inserting of class,
154 ;; def, for, if, try and while. These skeletons are integrated with
155 ;; dabbrev. If you have `dabbrev-mode' activated and
156 ;; `python-skeleton-autoinsert' is set to t, then whenever you type
157 ;; the name of any of those defined and hit SPC, they will be
158 ;; automatically expanded.
160 ;; FFAP: You can find the filename for a given module when using ffap
161 ;; out of the box. This feature needs an inferior python shell
164 ;; Code check: Check the current file for errors with `python-check'
165 ;; using the program defined in `python-check-command'.
167 ;; Eldoc: returns documentation for object at point by using the
168 ;; inferior python subprocess to inspect its documentation. As you
169 ;; might guessed you should run `python-shell-send-buffer' from time
170 ;; to time to get better results too.
172 ;; Imenu: This mode supports Imenu in its most basic form, letting it
173 ;; build the necessary alist via `imenu-default-create-index-function'
174 ;; by having set `imenu-extract-index-name-function' to
175 ;; `python-info-current-defun' and
176 ;; `imenu-prev-index-position-function' to
177 ;; `python-imenu-prev-index-position'.
179 ;; If you used python-mode.el you probably will miss auto-indentation
180 ;; when inserting newlines. To achieve the same behavior you have
183 ;; 1) Use GNU/Emacs' standard binding for `newline-and-indent': C-j.
185 ;; 2) Add the following hook in your .emacs:
187 ;; (add-hook 'python-mode-hook
189 ;; (define-key python-mode-map "\C-m" 'newline-and-indent)))
191 ;; I'd recommend the first one since you'll get the same behavior for
192 ;; all modes out-of-the-box.
196 ;; Add this to your .emacs:
198 ;; (add-to-list 'load-path "/folder/containing/file")
205 (require 'ansi-color
)
208 ;; Avoid compiler warnings
209 (defvar view-return-to-alist
)
210 (defvar compilation-error-regexp-alist
)
211 (defvar outline-heading-end-regexp
)
213 (autoload 'comint-mode
"comint")
216 (add-to-list 'auto-mode-alist
(cons (purecopy "\\.py\\'") 'python-mode
))
218 (add-to-list 'interpreter-mode-alist
(cons (purecopy "python") 'python-mode
))
221 "Python Language's flying circus support for Emacs."
224 :link
'(emacs-commentary-link "python"))
229 (defvar python-mode-map
230 (let ((map (make-sparse-keymap)))
232 (define-key map
[remap backward-sentence
] 'python-nav-backward-block
)
233 (define-key map
[remap forward-sentence
] 'python-nav-forward-block
)
234 (define-key map
[remap backward-up-list
] 'python-nav-backward-up-list
)
235 (define-key map
"\C-c\C-j" 'imenu
)
237 (define-key map
"\177" 'python-indent-dedent-line-backspace
)
238 (define-key map
(kbd "<backtab>") 'python-indent-dedent-line
)
239 (define-key map
"\C-c<" 'python-indent-shift-left
)
240 (define-key map
"\C-c>" 'python-indent-shift-right
)
241 (define-key map
":" 'python-indent-electric-colon
)
243 (define-key map
"\C-c\C-tc" 'python-skeleton-class
)
244 (define-key map
"\C-c\C-td" 'python-skeleton-def
)
245 (define-key map
"\C-c\C-tf" 'python-skeleton-for
)
246 (define-key map
"\C-c\C-ti" 'python-skeleton-if
)
247 (define-key map
"\C-c\C-tt" 'python-skeleton-try
)
248 (define-key map
"\C-c\C-tw" 'python-skeleton-while
)
250 (define-key map
"\C-c\C-p" 'run-python
)
251 (define-key map
"\C-c\C-s" 'python-shell-send-string
)
252 (define-key map
"\C-c\C-r" 'python-shell-send-region
)
253 (define-key map
"\C-\M-x" 'python-shell-send-defun
)
254 (define-key map
"\C-c\C-c" 'python-shell-send-buffer
)
255 (define-key map
"\C-c\C-l" 'python-shell-send-file
)
256 (define-key map
"\C-c\C-z" 'python-shell-switch-to-shell
)
257 ;; Some util commands
258 (define-key map
"\C-c\C-v" 'python-check
)
259 (define-key map
"\C-c\C-f" 'python-eldoc-at-point
)
261 (substitute-key-definition 'complete-symbol
'completion-at-point
263 (easy-menu-define python-menu map
"Python Mode menu"
265 :help
"Python-specific Features"
266 ["Shift region left" python-indent-shift-left
:active mark-active
267 :help
"Shift region left by a single indentation step"]
268 ["Shift region right" python-indent-shift-right
:active mark-active
269 :help
"Shift region right by a single indentation step"]
271 ["Start of def/class" beginning-of-defun
272 :help
"Go to start of outermost definition around point"]
273 ["End of def/class" end-of-defun
274 :help
"Go to end of definition around point"]
275 ["Mark def/class" mark-defun
276 :help
"Mark outermost definition around point"]
277 ["Jump to def/class" imenu
278 :help
"Jump to a class or function definition"]
282 ["Start interpreter" run-python
283 :help
"Run inferior Python process in a separate buffer"]
284 ["Switch to shell" python-shell-switch-to-shell
285 :help
"Switch to running inferior Python process"]
286 ["Eval string" python-shell-send-string
287 :help
"Eval string in inferior Python session"]
288 ["Eval buffer" python-shell-send-buffer
289 :help
"Eval buffer in inferior Python session"]
290 ["Eval region" python-shell-send-region
291 :help
"Eval region in inferior Python session"]
292 ["Eval defun" python-shell-send-defun
293 :help
"Eval defun in inferior Python session"]
294 ["Eval file" python-shell-send-file
295 :help
"Eval file in inferior Python session"]
296 ["Debugger" pdb
:help
"Run pdb under GUD"]
298 ["Check file" python-check
299 :help
"Check file for errors"]
300 ["Help on symbol" python-eldoc-at-point
301 :help
"Get help on symbol at point"]
302 ["Complete symbol" completion-at-point
303 :help
"Complete symbol before point"]))
305 "Keymap for `python-mode'.")
308 ;;; Python specialized rx
311 (defconst python-rx-constituents
312 `((block-start .
,(rx symbol-start
313 (or "def" "class" "if" "elif" "else" "try"
314 "except" "finally" "for" "while" "with")
316 (decorator .
,(rx line-start
(* space
) ?
@ (any letter ?_
)
318 (defun .
,(rx symbol-start
(or "def" "class") symbol-end
))
319 (if-name-main .
,(rx line-start
"if" (+ space
) "__name__"
320 (+ space
) "==" (+ space
)
321 (any ?
' ?
\") "__main__" (any ?
' ?
\")
323 (symbol-name .
,(rx (any letter ?_
) (* (any word ?_
))))
324 (open-paren .
,(rx (or "{" "[" "(")))
325 (close-paren .
,(rx (or "}" "]" ")")))
326 (simple-operator .
,(rx (any ?
+ ?- ?
/ ?
& ?^ ?~ ?| ?
* ?
< ?
> ?
= ?%
)))
327 ;; FIXME: rx should support (not simple-operator).
328 (not-simple-operator .
,(rx
330 (any ?
+ ?- ?
/ ?
& ?^ ?~ ?| ?
* ?
< ?
> ?
= ?%
))))
331 ;; FIXME: Use regexp-opt.
332 (operator .
,(rx (or "+" "-" "/" "&" "^" "~" "|" "*" "<" ">"
333 "=" "%" "**" "//" "<<" ">>" "<=" "!="
334 "==" ">=" "is" "not")))
335 ;; FIXME: Use regexp-opt.
336 (assignment-operator .
,(rx (or "=" "+=" "-=" "*=" "/=" "//=" "%=" "**="
337 ">>=" "<<=" "&=" "^=" "|=")))
338 (string-delimiter .
,(rx (and
339 ;; Match even number of backslashes.
340 (or (not (any ?
\\ ?
\' ?
\")) point
341 ;; Quotes might be preceded by a escaped quote.
342 (and (or (not (any ?
\\)) point
) ?
\\
343 (* ?
\\ ?
\\) (any ?
\' ?
\")))
345 ;; Match single or triple quotes of any kind.
346 (group (or "\"" "\"\"\"" "'" "'''"))))))
347 "Additional Python specific sexps for `python-rx'")
349 (defmacro python-rx
(&rest regexps
)
350 "Python mode specialized rx macro.
351 This variant of `rx' supports common python named REGEXPS."
352 (let ((rx-constituents (append python-rx-constituents rx-constituents
)))
353 (cond ((null regexps
)
356 (rx-to-string `(and ,@regexps
) t
))
358 (rx-to-string (car regexps
) t
))))))
361 ;;; Font-lock and syntax
363 (defun python-syntax-context (type &optional syntax-ppss
)
364 "Return non-nil if point is on TYPE using SYNTAX-PPSS.
365 TYPE can be `comment', `string' or `paren'. It returns the start
366 character address of the specified TYPE."
367 (declare (compiler-macro
371 `(let ((ppss (or ,syntax-ppss
(syntax-ppss))))
372 (and (nth 4 ppss
) (nth 8 ppss
))))
374 `(let ((ppss (or ,syntax-ppss
(syntax-ppss))))
375 (and (nth 3 ppss
) (nth 8 ppss
))))
377 `(nth 1 (or ,syntax-ppss
(syntax-ppss))))
379 (let ((ppss (or syntax-ppss
(syntax-ppss))))
381 (`comment
(and (nth 4 ppss
) (nth 8 ppss
)))
382 (`string
(and (nth 3 ppss
) (nth 8 ppss
)))
383 (`paren
(nth 1 ppss
))
386 (defun python-syntax-context-type (&optional syntax-ppss
)
387 "Return the context type using SYNTAX-PPSS.
388 The type returned can be `comment', `string' or `paren'."
389 (let ((ppss (or syntax-ppss
(syntax-ppss))))
391 ((nth 8 ppss
) (if (nth 4 ppss
) 'comment
'string
))
392 ((nth 1 ppss
) 'paren
))))
394 (defsubst python-syntax-comment-or-string-p
()
395 "Return non-nil if point is inside 'comment or 'string."
396 (nth 8 (syntax-ppss)))
398 (define-obsolete-function-alias
399 'python-info-ppss-context
#'python-syntax-context
"24.3")
401 (define-obsolete-function-alias
402 'python-info-ppss-context-type
#'python-syntax-context-type
"24.3")
404 (define-obsolete-function-alias
405 'python-info-ppss-comment-or-string-p
406 #'python-syntax-comment-or-string-p
"24.3")
408 (defvar python-font-lock-keywords
412 "and" "del" "from" "not" "while" "as" "elif" "global" "or" "with"
413 "assert" "else" "if" "pass" "yield" "break" "except" "import" "class"
414 "in" "raise" "continue" "finally" "is" "return" "def" "for" "lambda"
419 ;; False, None, and True are listed as keywords on the Python 3
420 ;; documentation, but since they also qualify as constants they are
421 ;; fontified like that in order to keep font-lock consistent between
428 (,(rx symbol-start
"def" (1+ space
) (group (1+ (or word ?_
))))
429 (1 font-lock-function-name-face
))
431 (,(rx symbol-start
"class" (1+ space
) (group (1+ (or word ?_
))))
432 (1 font-lock-type-face
))
436 "Ellipsis" "False" "None" "NotImplemented" "True" "__debug__"
437 ;; copyright, license, credits, quit and exit are added by the site
438 ;; module and they are not intended to be used in programs
439 "copyright" "credits" "exit" "license" "quit")
440 symbol-end
) . font-lock-constant-face
)
442 (,(rx line-start
(* (any " \t")) (group "@" (1+ (or word ?_
))
443 (0+ "." (1+ (or word ?_
)))))
444 (1 font-lock-type-face
))
445 ;; Builtin Exceptions
448 "ArithmeticError" "AssertionError" "AttributeError" "BaseException"
449 "DeprecationWarning" "EOFError" "EnvironmentError" "Exception"
450 "FloatingPointError" "FutureWarning" "GeneratorExit" "IOError"
451 "ImportError" "ImportWarning" "IndexError" "KeyError"
452 "KeyboardInterrupt" "LookupError" "MemoryError" "NameError"
453 "NotImplementedError" "OSError" "OverflowError"
454 "PendingDeprecationWarning" "ReferenceError" "RuntimeError"
455 "RuntimeWarning" "StopIteration" "SyntaxError" "SyntaxWarning"
456 "SystemError" "SystemExit" "TypeError" "UnboundLocalError"
457 "UnicodeDecodeError" "UnicodeEncodeError" "UnicodeError"
458 "UnicodeTranslateError" "UnicodeWarning" "UserWarning" "VMSError"
459 "ValueError" "Warning" "WindowsError" "ZeroDivisionError"
463 "BufferError" "BytesWarning" "IndentationError" "ResourceWarning"
465 symbol-end
) . font-lock-type-face
)
469 "abs" "all" "any" "bin" "bool" "callable" "chr" "classmethod"
470 "compile" "complex" "delattr" "dict" "dir" "divmod" "enumerate"
471 "eval" "filter" "float" "format" "frozenset" "getattr" "globals"
472 "hasattr" "hash" "help" "hex" "id" "input" "int" "isinstance"
473 "issubclass" "iter" "len" "list" "locals" "map" "max" "memoryview"
474 "min" "next" "object" "oct" "open" "ord" "pow" "print" "property"
475 "range" "repr" "reversed" "round" "set" "setattr" "slice" "sorted"
476 "staticmethod" "str" "sum" "super" "tuple" "type" "vars" "zip"
479 "basestring" "cmp" "execfile" "file" "long" "raw_input" "reduce"
480 "reload" "unichr" "unicode" "xrange" "apply" "buffer" "coerce"
483 "ascii" "bytearray" "bytes" "exec"
485 "__all__" "__doc__" "__name__" "__package__")
486 symbol-end
) . font-lock-builtin-face
)
488 ;; support for a = b = c = 5
490 (let ((re (python-rx (group (+ (any word ?. ?_
)))
491 (? ?\
[ (+ (not (any ?\
]))) ?\
]) (* space
)
492 assignment-operator
)))
493 (when (re-search-forward re limit t
)
494 (while (and (python-syntax-context 'paren
)
495 (re-search-forward re limit t
)))
496 (if (not (or (python-syntax-context 'paren
)
497 (equal (char-after (point-marker)) ?
=)))
499 (set-match-data nil
)))))
500 (1 font-lock-variable-name-face nil nil
))
501 ;; support for a, b, c = (1, 2, 3)
503 (let ((re (python-rx (group (+ (any word ?. ?_
))) (* space
)
504 (* ?
, (* space
) (+ (any word ?. ?_
)) (* space
))
505 ?
, (* space
) (+ (any word ?. ?_
)) (* space
)
506 assignment-operator
)))
507 (when (and (re-search-forward re limit t
)
508 (goto-char (nth 3 (match-data))))
509 (while (and (python-syntax-context 'paren
)
510 (re-search-forward re limit t
))
511 (goto-char (nth 3 (match-data))))
512 (if (not (python-syntax-context 'paren
))
514 (set-match-data nil
)))))
515 (1 font-lock-variable-name-face nil nil
))))
517 (defconst python-syntax-propertize-function
518 (syntax-propertize-rules
519 ((python-rx string-delimiter
)
520 (0 (ignore (python-syntax-stringify))))))
522 (defsubst python-syntax-count-quotes
(quote-char &optional point limit
)
523 "Count number of quotes around point (max is 3).
524 QUOTE-CHAR is the quote char to count. Optional argument POINT is
525 the point where scan starts (defaults to current point) and LIMIT
526 is used to limit the scan."
529 (or (not limit
) (< (+ point i
) limit
))
530 (eq (char-after (+ point i
)) quote-char
))
534 (defun python-syntax-stringify ()
535 "Put `syntax-table' property correctly on single/triple quotes."
536 (let* ((num-quotes (length (match-string-no-properties 1)))
538 (backward-char num-quotes
)
540 (forward-char num-quotes
)))
541 (string-start (and (not (nth 4 ppss
)) (nth 8 ppss
)))
542 (quote-starting-pos (- (point) num-quotes
))
543 (quote-ending-pos (point))
546 (python-syntax-count-quotes
547 (char-before) string-start quote-starting-pos
))))
548 (cond ((and string-start
(= num-closing-quotes
0))
549 ;; This set of quotes doesn't match the string starting
553 ;; This set of quotes delimit the start of a string.
554 (put-text-property quote-starting-pos
(1+ quote-starting-pos
)
555 'syntax-table
(string-to-syntax "|")))
556 ((= num-quotes num-closing-quotes
)
557 ;; This set of quotes delimit the end of a string.
558 (put-text-property (1- quote-ending-pos
) quote-ending-pos
559 'syntax-table
(string-to-syntax "|")))
560 ((> num-quotes num-closing-quotes
)
561 ;; This may only happen whenever a triple quote is closing
562 ;; a single quoted string. Add string delimiter syntax to
564 (put-text-property quote-starting-pos quote-ending-pos
565 'syntax-table
(string-to-syntax "|"))))))
567 (defvar python-mode-syntax-table
568 (let ((table (make-syntax-table)))
569 ;; Give punctuation syntax to ASCII that normally has symbol
570 ;; syntax or has word syntax and isn't a letter.
571 (let ((symbol (string-to-syntax "_"))
572 (sst (standard-syntax-table)))
575 (if (equal symbol
(aref sst i
))
576 (modify-syntax-entry i
"." table
)))))
577 (modify-syntax-entry ?$
"." table
)
578 (modify-syntax-entry ?%
"." table
)
580 (modify-syntax-entry ?
# "<" table
)
581 (modify-syntax-entry ?
\n ">" table
)
582 (modify-syntax-entry ?
' "\"" table
)
583 (modify-syntax-entry ?
` "$" table
)
585 "Syntax table for Python files.")
587 (defvar python-dotty-syntax-table
588 (let ((table (make-syntax-table python-mode-syntax-table
)))
589 (modify-syntax-entry ?.
"w" table
)
590 (modify-syntax-entry ?_
"w" table
)
592 "Dotty syntax table for Python files.
593 It makes underscores and dots word constituent chars.")
598 (defcustom python-indent-offset
4
599 "Default indentation offset for Python."
604 (defcustom python-indent-guess-indent-offset t
605 "Non-nil tells Python mode to guess `python-indent-offset' value."
610 (defcustom python-indent-trigger-commands
611 '(indent-for-tab-command yas-expand yas
/expand
)
612 "Commands that might trigger a `python-indent-line' call."
613 :type
'(repeat symbol
)
616 (define-obsolete-variable-alias
617 'python-indent
'python-indent-offset
"24.3")
619 (define-obsolete-variable-alias
620 'python-guess-indent
'python-indent-guess-indent-offset
"24.3")
622 (defvar python-indent-current-level
0
623 "Current indentation level `python-indent-line-function' is using.")
625 (defvar python-indent-levels
'(0)
626 "Levels of indentation available for `python-indent-line-function'.")
628 (defvar python-indent-dedenters
'("else" "elif" "except" "finally")
629 "List of words that should be dedented.
630 These make `python-indent-calculate-indentation' subtract the value of
631 `python-indent-offset'.")
633 (defun python-indent-guess-indent-offset ()
634 "Guess and set `python-indent-offset' for the current buffer."
639 (goto-char (point-min))
641 (while (and (not block-end
)
643 (python-rx line-start block-start
) nil t
))
645 (not (python-syntax-context-type))
647 (goto-char (line-end-position))
648 (python-util-forward-comment -
1)
649 (if (equal (char-before) ?
:)
652 (when (python-info-block-continuation-line-p)
653 (while (and (python-info-continuation-line-p)
656 (python-util-forward-comment -
1)
657 (when (equal (char-before) ?
:)
659 (setq block-end
(point-marker))))
662 (goto-char block-end
)
663 (python-util-forward-comment)
664 (current-indentation))))
666 (set (make-local-variable 'python-indent-offset
) indentation
)
667 (message "Can't guess python-indent-offset, using defaults: %s"
668 python-indent-offset
)))))))
670 (defun python-indent-context ()
671 "Get information on indentation context.
672 Context information is returned with a cons with the form:
675 Where status can be any of the following symbols:
676 * inside-paren: If point in between (), {} or []
677 * inside-string: If point is inside a string
678 * after-backslash: Previous line ends in a backslash
679 * after-beginning-of-block: Point is after beginning of block
680 * after-line: Point is after normal line
681 * no-indent: Point is at beginning of buffer or other special case
682 START is the buffer position where the sexp starts."
685 (let ((ppss (save-excursion (beginning-of-line) (syntax-ppss)))
689 ;; Beginning of buffer
691 (goto-char (line-beginning-position))
695 ((setq start
(python-syntax-context 'string ppss
))
698 ((setq start
(python-syntax-context 'paren ppss
))
701 ((setq start
(when (not (or (python-syntax-context 'string ppss
)
702 (python-syntax-context 'comment ppss
)))
703 (let ((line-beg-pos (line-beginning-position)))
704 (when (python-info-line-ends-backslash-p
706 (- line-beg-pos
2)))))
708 ;; After beginning of block
709 ((setq start
(save-excursion
711 (back-to-indentation)
712 (python-util-forward-comment -
1)
713 (equal (char-before) ?
:))
714 ;; Move to the first block start that's not in within
715 ;; a string, comment or paren and that's not a
716 ;; continuation line.
717 (while (and (re-search-backward
718 (python-rx block-start
) nil t
)
720 (python-syntax-context-type)
721 (python-info-continuation-line-p))))
722 (when (looking-at (python-rx block-start
))
724 'after-beginning-of-block
)
726 ((setq start
(save-excursion
727 (back-to-indentation)
728 (skip-chars-backward (rx (or whitespace ?
\n)))
729 (python-nav-beginning-of-statement)
736 (defun python-indent-calculate-indentation ()
737 "Calculate correct indentation offset for the current line."
738 (let* ((indentation-context (python-indent-context))
739 (context-status (car indentation-context
))
740 (context-start (cdr indentation-context
)))
744 (pcase context-status
746 ;; When point is after beginning of block just add one level
747 ;; of indentation relative to the context-start
748 (`after-beginning-of-block
749 (goto-char context-start
)
750 (+ (current-indentation) python-indent-offset
))
751 ;; When after a simple line just use previous line
752 ;; indentation, in the case current line starts with a
753 ;; `python-indent-dedenters' de-indent one level.
757 (goto-char context-start
)
758 (current-indentation))
760 (back-to-indentation)
761 (looking-at (regexp-opt python-indent-dedenters
)))
764 ;; When inside of a string, do nothing. just use the current
765 ;; indentation. XXX: perhaps it would be a good idea to
766 ;; invoke standard text indentation here
768 (goto-char context-start
)
769 (current-indentation))
770 ;; After backslash we have several possibilities.
773 ;; Check if current line is a dot continuation. For this
774 ;; the current line must start with a dot and previous
775 ;; line must contain a dot too.
777 (back-to-indentation)
778 (when (looking-at "\\.")
779 ;; If after moving one line back point is inside a paren it
780 ;; needs to move back until it's not anymore
784 (python-syntax-context 'paren
))))
785 (goto-char (line-end-position))
786 (while (and (re-search-backward
787 "\\." (line-beginning-position) t
)
788 (python-syntax-context-type)))
789 (if (and (looking-at "\\.")
790 (not (python-syntax-context-type)))
791 ;; The indentation is the same column of the
792 ;; first matching dot that's not inside a
793 ;; comment, a string or a paren
795 ;; No dot found on previous line, just add another
796 ;; indentation level.
797 (+ (current-indentation) python-indent-offset
)))))
798 ;; Check if prev line is a block continuation
799 ((let ((block-continuation-start
800 (python-info-block-continuation-line-p)))
801 (when block-continuation-start
802 ;; If block-continuation-start is set jump to that
803 ;; marker and use first column after the block start
804 ;; as indentation value.
805 (goto-char block-continuation-start
)
807 (python-rx block-start
(* space
))
808 (line-end-position) t
)
810 ;; Check if current line is an assignment continuation
811 ((let ((assignment-continuation-start
812 (python-info-assignment-continuation-line-p)))
813 (when assignment-continuation-start
814 ;; If assignment-continuation is set jump to that
815 ;; marker and use first column after the assignment
816 ;; operator as indentation value.
817 (goto-char assignment-continuation-start
)
821 (goto-char (python-info-beginning-of-backslash))
826 (or (python-info-beginning-of-backslash) (point)))
827 (python-info-line-ends-backslash-p)))
828 ;; The two previous lines ended in a backslash so we must
829 ;; respect previous line indentation.
830 (current-indentation)
831 ;; What happens here is that we are dealing with the second
832 ;; line of a backslash continuation, in that case we just going
833 ;; to add one indentation level.
834 (+ (current-indentation) python-indent-offset
)))))
835 ;; When inside a paren there's a need to handle nesting
839 ;; If current line closes the outermost open paren use the
840 ;; current indentation of the context-start line.
842 (skip-syntax-forward "\s" (line-end-position))
843 (when (and (looking-at (regexp-opt '(")" "]" "}")))
846 (not (python-syntax-context 'paren
))))
847 (goto-char context-start
)
848 (current-indentation))))
849 ;; If open paren is contained on a line by itself add another
850 ;; indentation level, else look for the first word after the
851 ;; opening paren and use it's column position as indentation
853 ((let* ((content-starts-in-newline)
856 (if (setq content-starts-in-newline
858 (goto-char context-start
)
862 (line-beginning-position)
864 (python-util-forward-comment))
866 (+ (current-indentation) python-indent-offset
)
870 ;; If current line closes a nested open paren de-indent one
873 (back-to-indentation)
874 (looking-at (regexp-opt '(")" "]" "}"))))
875 (- indent python-indent-offset
))
876 ;; If the line of the opening paren that wraps the current
877 ;; line starts a block add another level of indentation to
878 ;; follow new pep8 recommendation. See: http://ur1.ca/5rojx
880 (when (and content-starts-in-newline
882 (goto-char context-start
)
883 (back-to-indentation)
884 (looking-at (python-rx block-start
))))
885 (+ indent python-indent-offset
))))
888 (defun python-indent-calculate-levels ()
889 "Calculate `python-indent-levels' and reset `python-indent-current-level'."
890 (let* ((indentation (python-indent-calculate-indentation))
891 (remainder (% indentation python-indent-offset
))
892 (steps (/ (- indentation remainder
) python-indent-offset
)))
893 (setq python-indent-levels
(list 0))
894 (dotimes (step steps
)
895 (push (* python-indent-offset
(1+ step
)) python-indent-levels
))
896 (when (not (eq 0 remainder
))
897 (push (+ (* python-indent-offset steps
) remainder
) python-indent-levels
))
898 (setq python-indent-levels
(nreverse python-indent-levels
))
899 (setq python-indent-current-level
(1- (length python-indent-levels
)))))
901 (defun python-indent-toggle-levels ()
902 "Toggle `python-indent-current-level' over `python-indent-levels'."
903 (setq python-indent-current-level
(1- python-indent-current-level
))
904 (when (< python-indent-current-level
0)
905 (setq python-indent-current-level
(1- (length python-indent-levels
)))))
907 (defun python-indent-line (&optional force-toggle
)
908 "Internal implementation of `python-indent-line-function'.
909 Uses the offset calculated in
910 `python-indent-calculate-indentation' and available levels
911 indicated by the variable `python-indent-levels' to set the
914 When the variable `last-command' is equal to one of the symbols
915 inside `python-indent-trigger-commands' or FORCE-TOGGLE is
916 non-nil it cycles levels indicated in the variable
917 `python-indent-levels' by setting the current level in the
918 variable `python-indent-current-level'.
920 When the variable `last-command' is not equal to one of the
921 symbols inside `python-indent-trigger-commands' and FORCE-TOGGLE
922 is nil it calculates possible indentation levels and saves it in
923 the variable `python-indent-levels'. Afterwards it sets the
924 variable `python-indent-current-level' correctly so offset is
925 equal to (`nth' `python-indent-current-level'
926 `python-indent-levels')"
928 (and (or (and (memq this-command python-indent-trigger-commands
)
929 (eq last-command this-command
))
931 (not (equal python-indent-levels
'(0)))
932 (or (python-indent-toggle-levels) t
))
933 (python-indent-calculate-levels))
934 (let* ((starting-pos (point-marker))
935 (indent-ending-position
936 (+ (line-beginning-position) (current-indentation)))
937 (follow-indentation-p
939 (and (<= (line-beginning-position) starting-pos
)
940 (>= indent-ending-position starting-pos
))))
941 (next-indent (nth python-indent-current-level python-indent-levels
)))
942 (unless (= next-indent
(current-indentation))
944 (delete-horizontal-space)
945 (indent-to next-indent
)
946 (goto-char starting-pos
))
947 (and follow-indentation-p
(back-to-indentation)))
948 (python-info-closing-block-message))
950 (defun python-indent-line-function ()
951 "`indent-line-function' for Python mode.
952 See `python-indent-line' for details."
953 (python-indent-line))
955 (defun python-indent-dedent-line ()
956 "De-indent current line."
958 (when (and (not (python-syntax-comment-or-string-p))
959 (<= (point-marker) (save-excursion
960 (back-to-indentation)
962 (> (current-column) 0))
963 (python-indent-line t
)
966 (defun python-indent-dedent-line-backspace (arg)
967 "De-indent current line.
968 Argument ARG is passed to `backward-delete-char-untabify' when
969 point is not in between the indentation."
971 (when (not (python-indent-dedent-line))
972 (backward-delete-char-untabify arg
)))
973 (put 'python-indent-dedent-line-backspace
'delete-selection
'supersede
)
975 (defun python-indent-region (start end
)
976 "Indent a python region automagically.
978 Called from a program, START and END specify the region to indent."
979 (let ((deactivate-mark nil
))
982 (setq end
(point-marker))
984 (or (bolp) (forward-line 1))
985 (while (< (point) end
)
986 (or (and (bolp) (eolp))
989 (back-to-indentation)
990 (setq word
(current-word))
993 ;; Don't mess with strings, unless it's the
994 ;; enclosing set of quotes.
995 (or (not (python-syntax-context 'string
))
999 (current-indentation)
1000 (python-syntax-count-quotes (char-after) (point))))
1001 (string-to-syntax "|"))))
1003 (delete-horizontal-space)
1004 (indent-to (python-indent-calculate-indentation)))))
1006 (move-marker end nil
))))
1008 (defun python-indent-shift-left (start end
&optional count
)
1009 "Shift lines contained in region START END by COUNT columns to the left.
1010 COUNT defaults to `python-indent-offset'. If region isn't
1011 active, the current line is shifted. The shifted region includes
1012 the lines in which START and END lie. An error is signaled if
1013 any lines in the region are indented less than COUNT columns."
1016 (list (region-beginning) (region-end) current-prefix-arg
)
1017 (list (line-beginning-position) (line-end-position) current-prefix-arg
)))
1019 (setq count
(prefix-numeric-value count
))
1020 (setq count python-indent-offset
))
1022 (let ((deactivate-mark nil
))
1025 (while (< (point) end
)
1026 (if (and (< (current-indentation) count
)
1027 (not (looking-at "[ \t]*$")))
1028 (error "Can't shift all lines enough"))
1030 (indent-rigidly start end
(- count
))))))
1032 (add-to-list 'debug-ignored-errors
"^Can't shift all lines enough")
1034 (defun python-indent-shift-right (start end
&optional count
)
1035 "Shift lines contained in region START END by COUNT columns to the left.
1036 COUNT defaults to `python-indent-offset'. If region isn't
1037 active, the current line is shifted. The shifted region includes
1038 the lines in which START and END lie."
1041 (list (region-beginning) (region-end) current-prefix-arg
)
1042 (list (line-beginning-position) (line-end-position) current-prefix-arg
)))
1043 (let ((deactivate-mark nil
))
1045 (setq count
(prefix-numeric-value count
))
1046 (setq count python-indent-offset
))
1047 (indent-rigidly start end count
)))
1049 (defun python-indent-electric-colon (arg)
1050 "Insert a colon and maybe de-indent the current line.
1051 With numeric ARG, just insert that many colons. With
1052 \\[universal-argument], just insert a single colon."
1054 (self-insert-command (if (not (integerp arg
)) 1 arg
))
1055 (when (and (not arg
)
1057 (not (equal ?
: (char-after (- (point-marker) 2))))
1058 (not (python-syntax-comment-or-string-p)))
1059 (let ((indentation (current-indentation))
1060 (calculated-indentation (python-indent-calculate-indentation)))
1061 (python-info-closing-block-message)
1062 (when (> indentation calculated-indentation
)
1064 (indent-line-to calculated-indentation
)
1065 (when (not (python-info-closing-block-message))
1066 (indent-line-to indentation
)))))))
1067 (put 'python-indent-electric-colon
'delete-selection t
)
1069 (defun python-indent-post-self-insert-function ()
1070 "Adjust closing paren line indentation after a char is added.
1071 This function is intended to be added to the
1072 `post-self-insert-hook.' If a line renders a paren alone, after
1073 adding a char before it, the line will be re-indented
1074 automatically if needed."
1075 (when (and (eq (char-before) last-command-event
)
1077 (memq (char-after) '(?\
) ?\
] ?\
})))
1079 (goto-char (line-beginning-position))
1080 ;; If after going to the beginning of line the point
1081 ;; is still inside a paren it's ok to do the trick
1082 (when (python-syntax-context 'paren
)
1083 (let ((indentation (python-indent-calculate-indentation)))
1084 (when (< (current-indentation) indentation
)
1085 (indent-line-to indentation
)))))))
1090 (defvar python-nav-beginning-of-defun-regexp
1091 (python-rx line-start
(* space
) defun
(+ space
) (group symbol-name
))
1092 "Regexp matching class or function definition.
1093 The name of the defun should be grouped so it can be retrieved
1094 via `match-string'.")
1096 (defun python-nav--beginning-of-defun (&optional arg
)
1097 "Internal implementation of `python-nav-beginning-of-defun'.
1098 With positive ARG search backwards, else search forwards."
1099 (when (or (null arg
) (= arg
0)) (setq arg
1))
1100 (let* ((re-search-fn (if (> arg
0)
1101 #'re-search-backward
1102 #'re-search-forward
))
1103 (line-beg-pos (line-beginning-position))
1104 (line-content-start (+ line-beg-pos
(current-indentation)))
1105 (pos (point-marker))
1110 (not (python-info-looking-at-beginning-of-defun))
1111 (python-nav-backward-block)))
1112 (or (and (python-info-looking-at-beginning-of-defun)
1113 (+ (current-indentation) python-indent-offset
))
1117 (when (and (< arg
0)
1118 (python-info-looking-at-beginning-of-defun))
1120 (while (and (funcall re-search-fn
1121 python-nav-beginning-of-defun-regexp nil t
)
1122 (or (python-syntax-context-type)
1123 ;; Handle nested defuns when moving
1124 ;; backwards by checking indentation.
1126 (not (= (current-indentation) 0))
1127 (>= (current-indentation) beg-indentation
)))))
1128 (and (python-info-looking-at-beginning-of-defun)
1129 (or (not (= (line-number-at-pos pos
)
1130 (line-number-at-pos)))
1131 (and (>= (point) line-beg-pos
)
1132 (<= (point) line-content-start
)
1133 (> pos line-content-start
)))))))
1135 (or (beginning-of-line 1) t
)
1136 (and (goto-char pos
) nil
))))
1138 (defun python-nav-beginning-of-defun (&optional arg
)
1139 "Move point to `beginning-of-defun'.
1140 With positive ARG search backwards else search forward. When ARG
1141 is nil or 0 defaults to 1. When searching backwards nested
1142 defuns are handled with care depending on current point
1143 position. Return non-nil if point is moved to
1144 `beginning-of-defun'."
1145 (when (or (null arg
) (= arg
0)) (setq arg
1))
1147 (cond ((and (eq this-command
'mark-defun
)
1148 (python-info-looking-at-beginning-of-defun)))
1150 (dotimes (i (if (> arg
0) arg
(- arg
)))
1151 (when (and (python-nav--beginning-of-defun arg)
1156 (defun python-nav-end-of-defun ()
1157 "Move point to the end of def or class.
1158 Returns nil if point is not in a def or class."
1160 (let ((beg-defun-indent)
1162 (when (or (python-info-looking-at-beginning-of-defun)
1163 (python-nav-beginning-of-defun 1)
1164 (python-nav-beginning-of-defun -1))
1165 (setq beg-defun-indent
(current-indentation))
1167 (python-nav-end-of-statement)
1168 (python-util-forward-comment 1)
1169 (and (> (current-indentation) beg-defun-indent
)
1171 (python-util-forward-comment -
1)
1173 ;; Ensure point moves forward.
1174 (and (> beg-pos
(point)) (goto-char beg-pos
)))))
1176 (defun python-nav-beginning-of-statement ()
1177 "Move to start of current statement."
1179 (while (and (or (back-to-indentation) t
)
1184 (python-info-line-ends-backslash-p))
1185 (python-syntax-context 'string
)
1186 (python-syntax-context 'paren
))
1187 (forward-line -
1))))
1190 (defun python-nav-end-of-statement ()
1191 "Move to end of current statement."
1193 (while (and (goto-char (line-end-position))
1196 (python-info-line-ends-backslash-p)
1197 (python-syntax-context 'string
)
1198 (python-syntax-context 'paren
))
1202 (defun python-nav-backward-statement (&optional arg
)
1203 "Move backward to previous statement.
1204 With ARG, repeat. See `python-nav-forward-statement'."
1206 (or arg
(setq arg
1))
1207 (python-nav-forward-statement (- arg
)))
1209 (defun python-nav-forward-statement (&optional arg
)
1210 "Move forward to next statement.
1211 With ARG, repeat. With negative argument, move ARG times
1212 backward to previous statement."
1214 (or arg
(setq arg
1))
1216 (python-nav-end-of-statement)
1217 (python-util-forward-comment)
1218 (python-nav-beginning-of-statement)
1219 (setq arg
(1- arg
)))
1221 (python-nav-beginning-of-statement)
1222 (python-util-forward-comment -
1)
1223 (python-nav-beginning-of-statement)
1224 (setq arg
(1+ arg
))))
1226 (defun python-nav-beginning-of-block ()
1227 "Move to start of current block."
1229 (let ((starting-pos (point))
1230 (block-regexp (python-rx
1231 line-start
(* whitespace
) block-start
)))
1233 (python-nav-beginning-of-statement)
1234 (looking-at (python-rx block-start
)))
1236 ;; Go to first line beginning a statement
1237 (while (and (not (bobp))
1238 (or (and (python-nav-beginning-of-statement) nil
)
1239 (python-info-current-line-comment-p)
1240 (python-info-current-line-empty-p)))
1242 (let ((block-matching-indent
1243 (- (current-indentation) python-indent-offset
)))
1245 (and (python-nav-backward-block)
1246 (> (current-indentation) block-matching-indent
)))
1247 (if (and (looking-at (python-rx block-start
))
1248 (= (current-indentation) block-matching-indent
))
1250 (and (goto-char starting-pos
) nil
))))))
1252 (defun python-nav-end-of-block ()
1253 "Move to end of current block."
1255 (when (python-nav-beginning-of-block)
1256 (let ((block-indentation (current-indentation)))
1257 (python-nav-end-of-statement)
1258 (while (and (forward-line 1)
1260 (or (and (> (current-indentation) block-indentation
)
1261 (or (python-nav-end-of-statement) t
))
1262 (python-info-current-line-comment-p)
1263 (python-info-current-line-empty-p))))
1264 (python-util-forward-comment -
1)
1267 (defun python-nav-backward-block (&optional arg
)
1268 "Move backward to previous block of code.
1269 With ARG, repeat. See `python-nav-forward-block'."
1271 (or arg
(setq arg
1))
1272 (python-nav-forward-block (- arg
)))
1274 (defun python-nav-forward-block (&optional arg
)
1275 "Move forward to next block of code.
1276 With ARG, repeat. With negative argument, move ARG times
1277 backward to previous block."
1279 (or arg
(setq arg
1))
1280 (let ((block-start-regexp
1281 (python-rx line-start
(* whitespace
) block-start
))
1282 (starting-pos (point)))
1284 (python-nav-end-of-statement)
1286 (re-search-forward block-start-regexp nil t
)
1287 (python-syntax-context-type)))
1288 (setq arg
(1- arg
)))
1290 (python-nav-beginning-of-statement)
1292 (re-search-backward block-start-regexp nil t
)
1293 (python-syntax-context-type)))
1294 (setq arg
(1+ arg
)))
1295 (python-nav-beginning-of-statement)
1296 (if (not (looking-at (python-rx block-start
)))
1297 (and (goto-char starting-pos
) nil
)
1298 (and (not (= (point) starting-pos
)) (point-marker)))))
1300 (defun python-nav-lisp-forward-sexp-safe (&optional arg
)
1301 "Safe version of standard `forward-sexp'.
1302 When ARG > 0 move forward, else if ARG is < 0."
1303 (or arg
(setq arg
1))
1304 (let ((forward-sexp-function nil
)
1306 (if (> arg
0) (python-rx close-paren
) (python-rx open-paren
)))
1308 (if (> arg
0) #'re-search-forward
#'re-search-backward
)))
1312 (while (and (funcall search-fn paren-regexp nil t
)
1313 (python-syntax-context 'paren
)))))))
1315 (defun python-nav--forward-sexp (&optional dir
)
1316 "Move to forward sexp.
1317 With positive Optional argument DIR direction move forward, else
1319 (setq dir
(or dir
1))
1321 (let* ((forward-p (if (> dir
0)
1322 (and (setq dir
1) t
)
1323 (and (setq dir -
1) nil
)))
1324 (re-search-fn (if forward-p
1326 're-search-backward
))
1327 (context-type (python-syntax-context-type)))
1329 ((eq context-type
'string
)
1330 ;; Inside of a string, get out of it.
1331 (while (and (funcall re-search-fn
"[\"']" nil t
)
1332 (python-syntax-context 'string
))))
1333 ((eq context-type
'comment
)
1334 ;; Inside of a comment, just move forward.
1335 (python-util-forward-comment dir
))
1336 ((or (eq context-type
'paren
)
1337 (and forward-p
(looking-at (python-rx open-paren
)))
1338 (and (not forward-p
)
1339 (eq (syntax-class (syntax-after (1- (point))))
1340 (car (string-to-syntax ")")))))
1341 ;; Inside a paren or looking at it, lisp knows what to do.
1342 (python-nav-lisp-forward-sexp-safe dir
))
1344 ;; This part handles the lispy feel of
1345 ;; `python-nav-forward-sexp'. Knowing everything about the
1346 ;; current context and the context of the next sexp tries to
1347 ;; follow the lisp sexp motion commands in a symmetric manner.
1350 ((python-info-beginning-of-block-p) 'block-start
)
1351 ((python-info-end-of-block-p) 'block-end
)
1352 ((python-info-beginning-of-statement-p) 'statement-start
)
1353 ((python-info-end-of-statement-p) 'statement-end
)))
1356 (python-nav-lisp-forward-sexp-safe dir
)
1360 (goto-char next-sexp-pos
)
1362 ((python-info-beginning-of-block-p) 'block-start
)
1363 ((python-info-end-of-block-p) 'block-end
)
1364 ((python-info-beginning-of-statement-p) 'statement-start
)
1365 ((python-info-end-of-statement-p) 'statement-end
)
1366 ((python-info-statement-starts-block-p) 'starts-block
)
1367 ((python-info-statement-ends-block-p) 'ends-block
)))))
1369 (cond ((and (not (eobp))
1370 (python-info-current-line-empty-p))
1371 (python-util-forward-comment dir
)
1372 (python-nav--forward-sexp dir
))
1373 ((eq context
'block-start
)
1374 (python-nav-end-of-block))
1375 ((eq context
'statement-start
)
1376 (python-nav-end-of-statement))
1377 ((and (memq context
'(statement-end block-end
))
1378 (eq next-sexp-context
'ends-block
))
1379 (goto-char next-sexp-pos
)
1380 (python-nav-end-of-block))
1381 ((and (memq context
'(statement-end block-end
))
1382 (eq next-sexp-context
'starts-block
))
1383 (goto-char next-sexp-pos
)
1384 (python-nav-end-of-block))
1385 ((memq context
'(statement-end block-end
))
1386 (goto-char next-sexp-pos
)
1387 (python-nav-end-of-statement))
1388 (t (goto-char next-sexp-pos
)))
1389 (cond ((and (not (bobp))
1390 (python-info-current-line-empty-p))
1391 (python-util-forward-comment dir
)
1392 (python-nav--forward-sexp dir
))
1393 ((eq context
'block-end
)
1394 (python-nav-beginning-of-block))
1395 ((eq context
'statement-end
)
1396 (python-nav-beginning-of-statement))
1397 ((and (memq context
'(statement-start block-start
))
1398 (eq next-sexp-context
'starts-block
))
1399 (goto-char next-sexp-pos
)
1400 (python-nav-beginning-of-block))
1401 ((and (memq context
'(statement-start block-start
))
1402 (eq next-sexp-context
'ends-block
))
1403 (goto-char next-sexp-pos
)
1404 (python-nav-beginning-of-block))
1405 ((memq context
'(statement-start block-start
))
1406 (goto-char next-sexp-pos
)
1407 (python-nav-beginning-of-statement))
1408 (t (goto-char next-sexp-pos
))))))))))
1410 (defun python-nav--backward-sexp ()
1411 "Move to backward sexp."
1412 (python-nav--forward-sexp -
1))
1414 (defun python-nav-forward-sexp (&optional arg
)
1415 "Move forward across one block of code.
1416 With ARG, do it that many times. Negative arg -N means
1417 move backward N times."
1419 (or arg
(setq arg
1))
1421 (python-nav--forward-sexp)
1422 (setq arg
(1- arg
)))
1424 (python-nav--backward-sexp)
1425 (setq arg
(1+ arg
))))
1427 (defun python-nav--up-list (&optional dir
)
1428 "Internal implementation of `python-nav-up-list'.
1429 DIR is always 1 or -1 and comes sanitized from
1430 `python-nav-up-list' calls."
1431 (let ((context (python-syntax-context-type))
1432 (forward-p (> dir
0)))
1434 ((memq context
'(string comment
)))
1435 ((eq context
'paren
)
1436 (let ((forward-sexp-function))
1438 ((and forward-p
(python-info-end-of-block-p))
1439 (let ((parent-end-pos
1441 (let ((indentation (and
1442 (python-nav-beginning-of-block)
1443 (current-indentation))))
1444 (while (and indentation
1446 (>= (current-indentation) indentation
)
1447 (python-nav-backward-block)))
1448 (python-nav-end-of-block)))))
1449 (and (> (or parent-end-pos
(point)) (point))
1450 (goto-char parent-end-pos
))))
1451 (forward-p (python-nav-end-of-block))
1452 ((and (not forward-p
)
1453 (> (current-indentation) 0)
1454 (python-info-beginning-of-block-p))
1455 (let ((prev-block-pos
1457 (let ((indentation (current-indentation)))
1458 (while (and (python-nav-backward-block)
1459 (>= (current-indentation) indentation
))))
1461 (and (> (point) prev-block-pos
)
1462 (goto-char prev-block-pos
))))
1463 ((not forward-p
) (python-nav-beginning-of-block)))))
1465 (defun python-nav-up-list (&optional arg
)
1466 "Move forward out of one level of parentheses (or blocks).
1467 With ARG, do this that many times.
1468 A negative argument means move backward but still to a less deep spot.
1469 This command assumes point is not in a string or comment."
1471 (or arg
(setq arg
1))
1473 (python-nav--up-list 1)
1474 (setq arg
(1- arg
)))
1476 (python-nav--up-list -
1)
1477 (setq arg
(1+ arg
))))
1479 (defun python-nav-backward-up-list (&optional arg
)
1480 "Move backward out of one level of parentheses (or blocks).
1481 With ARG, do this that many times.
1482 A negative argument means move backward but still to a less deep spot.
1483 This command assumes point is not in a string or comment."
1485 (or arg
(setq arg
1))
1486 (python-nav-up-list (- arg
)))
1489 ;;; Shell integration
1491 (defcustom python-shell-buffer-name
"Python"
1492 "Default buffer name for Python interpreter."
1497 (defcustom python-shell-interpreter
"python"
1498 "Default Python interpreter for shell."
1502 (defcustom python-shell-internal-buffer-name
"Python Internal"
1503 "Default buffer name for the Internal Python interpreter."
1508 (defcustom python-shell-interpreter-args
"-i"
1509 "Default arguments for the Python interpreter."
1513 (defcustom python-shell-prompt-regexp
">>> "
1514 "Regular Expression matching top\-level input prompt of python shell.
1515 It should not contain a caret (^) at the beginning."
1520 (defcustom python-shell-prompt-block-regexp
"[.][.][.] "
1521 "Regular Expression matching block input prompt of python shell.
1522 It should not contain a caret (^) at the beginning."
1527 (defcustom python-shell-prompt-output-regexp
""
1528 "Regular Expression matching output prompt of python shell.
1529 It should not contain a caret (^) at the beginning."
1534 (defcustom python-shell-prompt-pdb-regexp
"[(<]*[Ii]?[Pp]db[>)]+ "
1535 "Regular Expression matching pdb input prompt of python shell.
1536 It should not contain a caret (^) at the beginning."
1541 (defcustom python-shell-enable-font-lock t
1542 "Should syntax highlighting be enabled in the python shell buffer?
1543 Restart the python shell after changing this variable for it to take effect."
1548 (defcustom python-shell-process-environment nil
1549 "List of environment variables for Python shell.
1550 This variable follows the same rules as `process-environment'
1551 since it merges with it before the process creation routines are
1552 called. When this variable is nil, the Python shell is run with
1553 the default `process-environment'."
1554 :type
'(repeat string
)
1558 (defcustom python-shell-extra-pythonpaths nil
1559 "List of extra pythonpaths for Python shell.
1560 The values of this variable are added to the existing value of
1561 PYTHONPATH in the `process-environment' variable."
1562 :type
'(repeat string
)
1566 (defcustom python-shell-exec-path nil
1567 "List of path to search for binaries.
1568 This variable follows the same rules as `exec-path' since it
1569 merges with it before the process creation routines are called.
1570 When this variable is nil, the Python shell is run with the
1571 default `exec-path'."
1572 :type
'(repeat string
)
1576 (defcustom python-shell-virtualenv-path nil
1577 "Path to virtualenv root.
1578 This variable, when set to a string, makes the values stored in
1579 `python-shell-process-environment' and `python-shell-exec-path'
1580 to be modified properly so shells are started with the specified
1586 (defcustom python-shell-setup-codes
'(python-shell-completion-setup-code
1587 python-ffap-setup-code
1588 python-eldoc-setup-code
)
1589 "List of code run by `python-shell-send-setup-codes'."
1590 :type
'(repeat symbol
)
1594 (defcustom python-shell-compilation-regexp-alist
1595 `((,(rx line-start
(1+ (any " \t")) "File \""
1596 (group (1+ (not (any "\"<")))) ; avoid `<stdin>' &c
1597 "\", line " (group (1+ digit
)))
1599 (,(rx " in file " (group (1+ not-newline
)) " on line "
1602 (,(rx line-start
"> " (group (1+ (not (any "(\"<"))))
1603 "(" (group (1+ digit
)) ")" (1+ (not (any "("))) "()")
1605 "`compilation-error-regexp-alist' for inferior Python."
1606 :type
'(alist string
)
1609 (defun python-shell-get-process-name (dedicated)
1610 "Calculate the appropriate process name for inferior Python process.
1611 If DEDICATED is t and the variable `buffer-file-name' is non-nil
1612 returns a string with the form
1613 `python-shell-buffer-name'[variable `buffer-file-name'] else
1614 returns the value of `python-shell-buffer-name'."
1618 (format "%s[%s]" python-shell-buffer-name buffer-file-name
)
1619 (format "%s" python-shell-buffer-name
))))
1622 (defun python-shell-internal-get-process-name ()
1623 "Calculate the appropriate process name for Internal Python process.
1624 The name is calculated from `python-shell-global-buffer-name' and
1625 a hash of all relevant global shell settings in order to ensure
1626 uniqueness for different types of configurations."
1628 python-shell-internal-buffer-name
1631 (python-shell-parse-command)
1632 python-shell-prompt-regexp
1633 python-shell-prompt-block-regexp
1634 python-shell-prompt-output-regexp
1635 (mapconcat #'symbol-value python-shell-setup-codes
"")
1636 (mapconcat #'identity python-shell-process-environment
"")
1637 (mapconcat #'identity python-shell-extra-pythonpaths
"")
1638 (mapconcat #'identity python-shell-exec-path
"")
1639 (or python-shell-virtualenv-path
"")
1640 (mapconcat #'identity python-shell-exec-path
"")))))
1642 (defun python-shell-parse-command ()
1643 "Calculate the string used to execute the inferior Python process."
1644 (format "%s %s" python-shell-interpreter python-shell-interpreter-args
))
1646 (defun python-shell-calculate-process-environment ()
1647 "Calculate process environment given `python-shell-virtualenv-path'."
1648 (let ((process-environment (append
1649 python-shell-process-environment
1650 process-environment nil
))
1651 (virtualenv (if python-shell-virtualenv-path
1652 (directory-file-name python-shell-virtualenv-path
)
1654 (when python-shell-extra-pythonpaths
1655 (setenv "PYTHONPATH"
1657 (mapconcat 'identity
1658 python-shell-extra-pythonpaths
1661 (or (getenv "PYTHONPATH") ""))))
1662 (if (not virtualenv
)
1664 (setenv "PYTHONHOME" nil
)
1665 (setenv "PATH" (format "%s/bin%s%s"
1666 virtualenv path-separator
1667 (or (getenv "PATH") "")))
1668 (setenv "VIRTUAL_ENV" virtualenv
))
1669 process-environment
))
1671 (defun python-shell-calculate-exec-path ()
1672 "Calculate exec path given `python-shell-virtualenv-path'."
1673 (let ((path (append python-shell-exec-path
1675 (if (not python-shell-virtualenv-path
)
1677 (cons (format "%s/bin"
1678 (directory-file-name python-shell-virtualenv-path
))
1681 (defun python-comint-output-filter-function (output)
1682 "Hook run after content is put into comint buffer.
1683 OUTPUT is a string with the contents of the buffer."
1684 (ansi-color-filter-apply output
))
1686 (defvar python-shell--parent-buffer nil
)
1688 (defvar python-shell-output-syntax-table
1689 (let ((table (make-syntax-table python-dotty-syntax-table
)))
1690 (modify-syntax-entry ?
\' "." table
)
1691 (modify-syntax-entry ?
\" "." table
)
1692 (modify-syntax-entry ?\
( "." table
)
1693 (modify-syntax-entry ?\
[ "." table
)
1694 (modify-syntax-entry ?\
{ "." table
)
1695 (modify-syntax-entry ?\
) "." table
)
1696 (modify-syntax-entry ?\
] "." table
)
1697 (modify-syntax-entry ?\
} "." table
)
1699 "Syntax table for shell output.
1700 It makes parens and quotes be treated as punctuation chars.")
1702 (define-derived-mode inferior-python-mode comint-mode
"Inferior Python"
1703 "Major mode for Python inferior process.
1704 Runs a Python interpreter as a subprocess of Emacs, with Python
1705 I/O through an Emacs buffer. Variables
1706 `python-shell-interpreter' and `python-shell-interpreter-args'
1707 controls which Python interpreter is run. Variables
1708 `python-shell-prompt-regexp',
1709 `python-shell-prompt-output-regexp',
1710 `python-shell-prompt-block-regexp',
1711 `python-shell-enable-font-lock',
1712 `python-shell-completion-setup-code',
1713 `python-shell-completion-string-code',
1714 `python-shell-completion-module-string-code',
1715 `python-eldoc-setup-code', `python-eldoc-string-code',
1716 `python-ffap-setup-code' and `python-ffap-string-code' can
1717 customize this mode for different Python interpreters.
1719 You can also add additional setup code to be run at
1720 initialization of the interpreter via `python-shell-setup-codes'
1723 \(Type \\[describe-mode] in the process buffer for a list of commands.)"
1724 (and python-shell--parent-buffer
1725 (python-util-clone-local-variables python-shell--parent-buffer
))
1726 (setq comint-prompt-regexp
(format "^\\(?:%s\\|%s\\|%s\\)"
1727 python-shell-prompt-regexp
1728 python-shell-prompt-block-regexp
1729 python-shell-prompt-pdb-regexp
))
1730 (setq mode-line-process
'(":%s"))
1731 (make-local-variable 'comint-output-filter-functions
)
1732 (add-hook 'comint-output-filter-functions
1733 'python-comint-output-filter-function
)
1734 (add-hook 'comint-output-filter-functions
1735 'python-pdbtrack-comint-output-filter-function
)
1736 (set (make-local-variable 'compilation-error-regexp-alist
)
1737 python-shell-compilation-regexp-alist
)
1738 (define-key inferior-python-mode-map
[remap complete-symbol
]
1739 'completion-at-point
)
1740 (add-hook 'completion-at-point-functions
1741 'python-shell-completion-complete-at-point nil
'local
)
1742 (add-to-list (make-local-variable 'comint-dynamic-complete-functions
)
1743 'python-shell-completion-complete-at-point
)
1744 (define-key inferior-python-mode-map
"\t"
1745 'python-shell-completion-complete-or-indent
)
1746 (make-local-variable 'python-pdbtrack-buffers-to-kill
)
1747 (make-local-variable 'python-pdbtrack-tracked-buffer
)
1748 (make-local-variable 'python-shell-internal-last-output
)
1749 (when python-shell-enable-font-lock
1750 (set-syntax-table python-mode-syntax-table
)
1751 (set (make-local-variable 'font-lock-defaults
)
1752 '(python-font-lock-keywords nil nil nil nil
))
1753 (set (make-local-variable 'syntax-propertize-function
)
1755 ;; XXX: Unfortunately eval is needed here to make use of the
1756 ;; dynamic value of `comint-prompt-regexp'.
1757 `(syntax-propertize-rules
1758 (,comint-prompt-regexp
1761 comint-last-input-start end
'syntax-table
1762 python-shell-output-syntax-table
)
1763 ;; XXX: This might look weird, but it is the easiest
1764 ;; way to ensure font lock gets cleaned up before the
1765 ;; current prompt, which is needed for unclosed
1766 ;; strings to not mess up with current input.
1767 (font-lock-unfontify-region comint-last-input-start end
))))
1768 (,(python-rx string-delimiter
)
1770 (and (not (eq (get-text-property start
'field
) 'output
))
1771 (python-syntax-stringify)))))))))
1772 (compilation-shell-minor-mode 1))
1774 (defun python-shell-make-comint (cmd proc-name
&optional pop internal
)
1775 "Create a python shell comint buffer.
1776 CMD is the python command to be executed and PROC-NAME is the
1777 process name the comint buffer will get. After the comint buffer
1778 is created the `inferior-python-mode' is activated. When
1779 optional argument POP is non-nil the buffer is shown. When
1780 optional argument INTERNAL is non-nil this process is run on a
1781 buffer with a name that starts with a space, following the Emacs
1782 convention for temporary/internal buffers, and also makes sure
1783 the user is not queried for confirmation when the process is
1786 (let* ((proc-buffer-name
1787 (format (if (not internal
) "*%s*" " *%s*") proc-name
))
1788 (process-environment (python-shell-calculate-process-environment))
1789 (exec-path (python-shell-calculate-exec-path)))
1790 (when (not (comint-check-proc proc-buffer-name
))
1791 (let* ((cmdlist (split-string-and-unquote cmd
))
1792 (buffer (apply #'make-comint-in-buffer proc-name proc-buffer-name
1793 (car cmdlist
) nil
(cdr cmdlist
)))
1794 (python-shell--parent-buffer (current-buffer))
1795 (process (get-buffer-process buffer
)))
1796 (with-current-buffer buffer
1797 (inferior-python-mode))
1798 (accept-process-output process
)
1799 (and pop
(pop-to-buffer buffer t
))
1800 (and internal
(set-process-query-on-exit-flag process nil
))))
1804 (defun run-python (cmd &optional dedicated show
)
1805 "Run an inferior Python process.
1806 Input and output via buffer named after
1807 `python-shell-buffer-name'. If there is a process already
1808 running in that buffer, just switch to it.
1810 With argument, allows you to define CMD so you can edit the
1811 command used to call the interpreter and define DEDICATED, so a
1812 dedicated process for the current buffer is open. When numeric
1813 prefix arg is other than 0 or 4 do not SHOW.
1815 Runs the hook `inferior-python-mode-hook' (after the
1816 `comint-mode-hook' is run). \(Type \\[describe-mode] in the
1817 process buffer for a list of commands.)"
1819 (if current-prefix-arg
1821 (read-string "Run Python: " (python-shell-parse-command))
1822 (y-or-n-p "Make dedicated process? ")
1823 (= (prefix-numeric-value current-prefix-arg
) 4))
1824 (list (python-shell-parse-command) nil t
)))
1825 (python-shell-make-comint
1826 cmd
(python-shell-get-process-name dedicated
) show
)
1829 (defun run-python-internal ()
1830 "Run an inferior Internal Python process.
1831 Input and output via buffer named after
1832 `python-shell-internal-buffer-name' and what
1833 `python-shell-internal-get-process-name' returns.
1835 This new kind of shell is intended to be used for generic
1836 communication related to defined configurations, the main
1837 difference with global or dedicated shells is that these ones are
1838 attached to a configuration, not a buffer. This means that can
1839 be used for example to retrieve the sys.path and other stuff,
1840 without messing with user shells. Note that
1841 `python-shell-enable-font-lock' and `inferior-python-mode-hook'
1842 are set to nil for these shells, so setup codes are not sent at
1844 (let ((python-shell-enable-font-lock nil
)
1845 (inferior-python-mode-hook nil
))
1847 (python-shell-make-comint
1848 (python-shell-parse-command)
1849 (python-shell-internal-get-process-name) nil t
))))
1851 (defun python-shell-get-process ()
1852 "Get inferior Python process for current buffer and return it."
1853 (let* ((dedicated-proc-name (python-shell-get-process-name t
))
1854 (dedicated-proc-buffer-name (format "*%s*" dedicated-proc-name
))
1855 (global-proc-name (python-shell-get-process-name nil
))
1856 (global-proc-buffer-name (format "*%s*" global-proc-name
))
1857 (dedicated-running (comint-check-proc dedicated-proc-buffer-name
))
1858 (global-running (comint-check-proc global-proc-buffer-name
)))
1859 ;; Always prefer dedicated
1860 (get-buffer-process (or (and dedicated-running dedicated-proc-buffer-name
)
1861 (and global-running global-proc-buffer-name
)))))
1863 (defun python-shell-get-or-create-process ()
1864 "Get or create an inferior Python process for current buffer and return it."
1865 (let* ((dedicated-proc-name (python-shell-get-process-name t
))
1866 (dedicated-proc-buffer-name (format "*%s*" dedicated-proc-name
))
1867 (global-proc-name (python-shell-get-process-name nil
))
1868 (global-proc-buffer-name (format "*%s*" global-proc-name
))
1869 (dedicated-running (comint-check-proc dedicated-proc-buffer-name
))
1870 (global-running (comint-check-proc global-proc-buffer-name
))
1871 (current-prefix-arg 16))
1872 (when (and (not dedicated-running
) (not global-running
))
1873 (if (call-interactively 'run-python
)
1874 (setq dedicated-running t
)
1875 (setq global-running t
)))
1876 ;; Always prefer dedicated
1877 (get-buffer-process (if dedicated-running
1878 dedicated-proc-buffer-name
1879 global-proc-buffer-name
))))
1881 (defvar python-shell-internal-buffer nil
1882 "Current internal shell buffer for the current buffer.
1883 This is really not necessary at all for the code to work but it's
1884 there for compatibility with CEDET.")
1886 (defvar python-shell-internal-last-output nil
1887 "Last output captured by the internal shell.
1888 This is really not necessary at all for the code to work but it's
1889 there for compatibility with CEDET.")
1891 (defun python-shell-internal-get-or-create-process ()
1892 "Get or create an inferior Internal Python process."
1893 (let* ((proc-name (python-shell-internal-get-process-name))
1894 (proc-buffer-name (format " *%s*" proc-name
)))
1895 (when (not (process-live-p proc-name
))
1896 (run-python-internal)
1897 (setq python-shell-internal-buffer proc-buffer-name
)
1898 ;; XXX: Why is this `sit-for' needed?
1899 ;; `python-shell-make-comint' calls `accept-process-output'
1900 ;; already but it is not helping to get proper output on
1901 ;; 'gnu/linux when the internal shell process is not running and
1902 ;; a call to `python-shell-internal-send-string' is issued.
1904 (get-buffer-process proc-buffer-name
)))
1906 (define-obsolete-function-alias
1907 'python-proc
'python-shell-internal-get-or-create-process
"24.3")
1909 (define-obsolete-variable-alias
1910 'python-buffer
'python-shell-internal-buffer
"24.3")
1912 (define-obsolete-variable-alias
1913 'python-preoutput-result
'python-shell-internal-last-output
"24.3")
1915 (defun python-shell-send-string (string &optional process msg
)
1916 "Send STRING to inferior Python PROCESS.
1917 When MSG is non-nil messages the first line of STRING."
1918 (interactive "sPython command: ")
1919 (let ((process (or process
(python-shell-get-or-create-process)))
1920 (lines (split-string string
"\n" t
)))
1921 (and msg
(message "Sent: %s..." (nth 0 lines
)))
1922 (if (> (length lines
) 1)
1923 (let* ((temporary-file-directory
1924 (if (file-remote-p default-directory
)
1925 (concat (file-remote-p default-directory
) "/tmp")
1926 temporary-file-directory
))
1927 (temp-file-name (make-temp-file "py"))
1928 (file-name (or (buffer-file-name) temp-file-name
)))
1929 (with-temp-file temp-file-name
1931 (delete-trailing-whitespace))
1932 (python-shell-send-file file-name process temp-file-name
))
1933 (comint-send-string process string
)
1934 (when (or (not (string-match "\n$" string
))
1935 (string-match "\n[ \t].*\n?$" string
))
1936 (comint-send-string process
"\n")))))
1938 (defvar python-shell-output-filter-in-progress nil
)
1939 (defvar python-shell-output-filter-buffer nil
)
1941 (defun python-shell-output-filter (string)
1942 "Filter used in `python-shell-send-string-no-output' to grab output.
1943 STRING is the output received to this point from the process.
1944 This filter saves received output from the process in
1945 `python-shell-output-filter-buffer' and stops receiving it after
1946 detecting a prompt at the end of the buffer."
1948 string
(ansi-color-filter-apply string
)
1949 python-shell-output-filter-buffer
1950 (concat python-shell-output-filter-buffer string
))
1952 ;; XXX: It seems on OSX an extra carriage return is attached
1953 ;; at the end of output, this handles that too.
1954 (format "\r?\n\\(?:%s\\|%s\\|%s\\)$"
1955 python-shell-prompt-regexp
1956 python-shell-prompt-block-regexp
1957 python-shell-prompt-pdb-regexp
)
1958 python-shell-output-filter-buffer
)
1959 ;; Output ends when `python-shell-output-filter-buffer' contains
1960 ;; the prompt attached at the end of it.
1961 (setq python-shell-output-filter-in-progress nil
1962 python-shell-output-filter-buffer
1963 (substring python-shell-output-filter-buffer
1964 0 (match-beginning 0)))
1965 (when (and (> (length python-shell-prompt-output-regexp
) 0)
1966 (string-match (concat "^" python-shell-prompt-output-regexp
)
1967 python-shell-output-filter-buffer
))
1968 ;; Some shells, like iPython might append a prompt before the
1969 ;; output, clean that.
1970 (setq python-shell-output-filter-buffer
1971 (substring python-shell-output-filter-buffer
(match-end 0)))))
1974 (defun python-shell-send-string-no-output (string &optional process msg
)
1975 "Send STRING to PROCESS and inhibit output.
1976 When MSG is non-nil messages the first line of STRING. Return
1978 (let ((process (or process
(python-shell-get-or-create-process)))
1979 (comint-preoutput-filter-functions
1980 '(python-shell-output-filter))
1981 (python-shell-output-filter-in-progress t
)
1985 (python-shell-send-string string process msg
)
1986 (while python-shell-output-filter-in-progress
1987 ;; `python-shell-output-filter' takes care of setting
1988 ;; `python-shell-output-filter-in-progress' to NIL after it
1989 ;; detects end of output.
1990 (accept-process-output process
))
1992 python-shell-output-filter-buffer
1993 (setq python-shell-output-filter-buffer nil
)))
1994 (with-current-buffer (process-buffer process
)
1995 (comint-interrupt-subjob)))))
1997 (defun python-shell-internal-send-string (string)
1998 "Send STRING to the Internal Python interpreter.
1999 Returns the output. See `python-shell-send-string-no-output'."
2000 ;; XXX Remove `python-shell-internal-last-output' once CEDET is
2001 ;; updated to support this new mode.
2002 (setq python-shell-internal-last-output
2003 (python-shell-send-string-no-output
2004 ;; Makes this function compatible with the old
2005 ;; python-send-receive. (At least for CEDET).
2006 (replace-regexp-in-string "_emacs_out +" "" string
)
2007 (python-shell-internal-get-or-create-process) nil
)))
2009 (define-obsolete-function-alias
2010 'python-send-receive
'python-shell-internal-send-string
"24.3")
2012 (define-obsolete-function-alias
2013 'python-send-string
'python-shell-internal-send-string
"24.3")
2015 (defun python-shell-send-region (start end
)
2016 "Send the region delimited by START and END to inferior Python process."
2018 (python-shell-send-string
2020 (let ((line-num (line-number-at-pos start
)))
2021 ;; When sending a region, add blank lines for non sent code so
2022 ;; backtraces remain correct.
2023 (make-string (1- line-num
) ?
\n))
2024 (buffer-substring start end
))
2027 (defun python-shell-send-buffer (&optional arg
)
2028 "Send the entire buffer to inferior Python process.
2029 With prefix ARG allow execution of code inside blocks delimited
2030 by \"if __name__== '__main__':\""
2034 (let ((str (buffer-substring (point-min) (point-max))))
2037 (setq str
(replace-regexp-in-string
2038 (python-rx if-name-main
)
2039 "if __name__ == '__main__ ':" str
)))
2040 (python-shell-send-string str
))))
2042 (defun python-shell-send-defun (arg)
2043 "Send the current defun to inferior Python process.
2044 When argument ARG is non-nil do not include decorators."
2047 (python-shell-send-region
2050 (while (and (or (python-nav-beginning-of-defun)
2051 (beginning-of-line 1))
2052 (> (current-indentation) 0)))
2054 (while (and (forward-line -
1)
2055 (looking-at (python-rx decorator
))))
2059 (or (python-nav-end-of-defun)
2063 (defun python-shell-send-file (file-name &optional process temp-file-name
)
2064 "Send FILE-NAME to inferior Python PROCESS.
2065 If TEMP-FILE-NAME is passed then that file is used for processing
2066 instead, while internally the shell will continue to use
2068 (interactive "fFile to send: ")
2069 (let* ((process (or process
(python-shell-get-or-create-process)))
2070 (temp-file-name (when temp-file-name
2072 (or (file-remote-p temp-file-name
'localname
)
2074 (file-name (or (when file-name
2076 (or (file-remote-p file-name
'localname
)
2079 (when (not file-name
)
2080 (error "If FILE-NAME is nil then TEMP-FILE-NAME must be non-nil"))
2081 (python-shell-send-string
2083 (concat "__pyfile = open('''%s''');"
2084 "exec(compile(__pyfile.read(), '''%s''', 'exec'));"
2086 (or temp-file-name file-name
) file-name
)
2089 (defun python-shell-switch-to-shell ()
2090 "Switch to inferior Python process buffer."
2092 (pop-to-buffer (process-buffer (python-shell-get-or-create-process)) t
))
2094 (defun python-shell-send-setup-code ()
2095 "Send all setup code for shell.
2096 This function takes the list of setup code to send from the
2097 `python-shell-setup-codes' list."
2098 (let ((process (get-buffer-process (current-buffer))))
2099 (dolist (code python-shell-setup-codes
)
2101 (message "Sent %s" code
)
2102 (python-shell-send-string
2103 (symbol-value code
) process
)))))
2105 (add-hook 'inferior-python-mode-hook
2106 #'python-shell-send-setup-code
)
2109 ;;; Shell completion
2111 (defcustom python-shell-completion-setup-code
2115 def __COMPLETER_all_completions(text): []
2118 readline.set_completer(rlcompleter.Completer().complete)
2119 def __COMPLETER_all_completions(text):
2125 res = readline.get_completer()(text, i)
2128 completions.append(res)
2132 "Code used to setup completion in inferior Python processes."
2136 (defcustom python-shell-completion-string-code
2137 "';'.join(__COMPLETER_all_completions('''%s'''))\n"
2138 "Python code used to get a string of completions separated by semicolons."
2142 (defcustom python-shell-completion-module-string-code
""
2143 "Python code used to get completions separated by semicolons for imports.
2145 For IPython v0.11, add the following line to
2146 `python-shell-completion-setup-code':
2148 from IPython.core.completerlib import module_completion
2150 and use the following as the value of this variable:
2152 ';'.join(module_completion('''%s'''))\n"
2156 (defcustom python-shell-completion-pdb-string-code
2157 "';'.join(globals().keys() + locals().keys())"
2158 "Python code used to get completions separated by semicolons for [i]pdb."
2162 (defun python-shell-completion-get-completions (process line input
)
2163 "Do completion at point for PROCESS.
2164 LINE is used to detect the context on how to complete given
2167 ;; Get the last prompt for the inferior process
2168 ;; buffer. This is used for the completion code selection
2170 (with-current-buffer (process-buffer process
)
2171 (buffer-substring-no-properties
2172 (overlay-start comint-last-prompt-overlay
)
2173 (overlay-end comint-last-prompt-overlay
))))
2175 ;; Check whether a prompt matches a pdb string, an import
2176 ;; statement or just the standard prompt and use the
2177 ;; correct python-shell-completion-*-code string
2178 (cond ((and (> (length python-shell-completion-pdb-string-code
) 0)
2180 (concat "^" python-shell-prompt-pdb-regexp
) prompt
))
2183 (length python-shell-completion-module-string-code
) 0)
2185 (concat "^" python-shell-prompt-regexp
) prompt
)
2186 (string-match "^[ \t]*\\(from\\|import\\)[ \t]" line
))
2189 (concat "^" python-shell-prompt-regexp
) prompt
)
2193 (pcase completion-context
2194 (`pdb python-shell-completion-pdb-string-code
)
2195 (`import python-shell-completion-module-string-code
)
2196 (`default python-shell-completion-string-code
)
2199 (if (eq completion-context
'import
)
2200 (replace-regexp-in-string "^[ \t]+" "" line
)
2202 (and completion-code
2203 (> (length input
) 0)
2204 (with-current-buffer (process-buffer process
)
2205 (let ((completions (python-shell-send-string-no-output
2206 (format completion-code input
) process
)))
2207 (and (> (length completions
) 2)
2208 (split-string completions
2209 "^'\\|^\"\\|;\\|'$\\|\"$" t
)))))))
2211 (defun python-shell-completion-complete-at-point (&optional process
)
2212 "Perform completion at point in inferior Python.
2213 Optional argument PROCESS forces completions to be retrieved
2214 using that one instead of current buffer's process."
2215 (setq process
(or process
(get-buffer-process (current-buffer))))
2218 (with-syntax-table python-dotty-syntax-table
2219 (let* ((paren-depth (car (syntax-ppss)))
2220 (syntax-string "w_")
2221 (syntax-list (string-to-syntax syntax-string
)))
2222 ;; Stop scanning for the beginning of the completion
2223 ;; subject after the char before point matches a
2226 (car (syntax-after (1- (point)))) syntax-list
)
2227 (skip-syntax-backward syntax-string
)
2228 (when (or (equal (char-before) ?\
))
2229 (equal (char-before) ?
\"))
2232 ;; honor initial paren depth
2233 (> (car (syntax-ppss)) paren-depth
)
2234 (python-syntax-context 'string
))
2239 (completion-table-dynamic
2241 #'python-shell-completion-get-completions
2242 process
(buffer-substring-no-properties
2243 (line-beginning-position) end
))))))
2245 (defun python-shell-completion-complete-or-indent ()
2246 "Complete or indent depending on the context.
2247 If content before pointer is all whitespace indent. If not try
2250 (if (string-match "^[[:space:]]*$"
2251 (buffer-substring (comint-line-beginning-position)
2253 (indent-for-tab-command)
2254 (completion-at-point)))
2257 ;;; PDB Track integration
2259 (defcustom python-pdbtrack-activate t
2260 "Non-nil makes python shell enable pdbtracking."
2265 (defcustom python-pdbtrack-stacktrace-info-regexp
2266 "^> \\([^\"(<]+\\)(\\([0-9]+\\))\\([?a-zA-Z0-9_<>]+\\)()"
2267 "Regular Expression matching stacktrace information.
2268 Used to extract the current line and module being inspected."
2273 (defvar python-pdbtrack-tracked-buffer nil
2274 "Variable containing the value of the current tracked buffer.
2275 Never set this variable directly, use
2276 `python-pdbtrack-set-tracked-buffer' instead.")
2278 (defvar python-pdbtrack-buffers-to-kill nil
2279 "List of buffers to be deleted after tracking finishes.")
2281 (defun python-pdbtrack-set-tracked-buffer (file-name)
2282 "Set the buffer for FILE-NAME as the tracked buffer.
2283 Internally it uses the `python-pdbtrack-tracked-buffer' variable.
2284 Returns the tracked buffer."
2285 (let ((file-buffer (get-file-buffer file-name
)))
2287 (setq python-pdbtrack-tracked-buffer file-buffer
)
2288 (setq file-buffer
(find-file-noselect file-name
))
2289 (when (not (member file-buffer python-pdbtrack-buffers-to-kill
))
2290 (add-to-list 'python-pdbtrack-buffers-to-kill file-buffer
)))
2293 (defun python-pdbtrack-comint-output-filter-function (output)
2294 "Move overlay arrow to current pdb line in tracked buffer.
2295 Argument OUTPUT is a string with the output from the comint process."
2296 (when (and python-pdbtrack-activate
(not (string= output
"")))
2297 (let* ((full-output (ansi-color-filter-apply
2298 (buffer-substring comint-last-input-end
(point-max))))
2302 (insert full-output
)
2303 (goto-char (point-min))
2304 ;; OK, this sucked but now it became a cool hack. The
2305 ;; stacktrace information normally is on the first line
2306 ;; but in some cases (like when doing a step-in) it is
2308 (when (or (looking-at python-pdbtrack-stacktrace-info-regexp
)
2311 (looking-at python-pdbtrack-stacktrace-info-regexp
)))
2312 (setq line-number
(string-to-number
2313 (match-string-no-properties 2)))
2314 (match-string-no-properties 1)))))
2315 (if (and file-name line-number
)
2316 (let* ((tracked-buffer
2317 (python-pdbtrack-set-tracked-buffer file-name
))
2318 (shell-buffer (current-buffer))
2319 (tracked-buffer-window (get-buffer-window tracked-buffer
))
2320 (tracked-buffer-line-pos))
2321 (with-current-buffer tracked-buffer
2322 (set (make-local-variable 'overlay-arrow-string
) "=>")
2323 (set (make-local-variable 'overlay-arrow-position
) (make-marker))
2324 (setq tracked-buffer-line-pos
(progn
2325 (goto-char (point-min))
2326 (forward-line (1- line-number
))
2328 (when tracked-buffer-window
2330 tracked-buffer-window tracked-buffer-line-pos
))
2331 (set-marker overlay-arrow-position tracked-buffer-line-pos
))
2332 (pop-to-buffer tracked-buffer
)
2333 (switch-to-buffer-other-window shell-buffer
))
2334 (when python-pdbtrack-tracked-buffer
2335 (with-current-buffer python-pdbtrack-tracked-buffer
2336 (set-marker overlay-arrow-position nil
))
2337 (mapc #'(lambda (buffer)
2338 (ignore-errors (kill-buffer buffer
)))
2339 python-pdbtrack-buffers-to-kill
)
2340 (setq python-pdbtrack-tracked-buffer nil
2341 python-pdbtrack-buffers-to-kill nil
)))))
2345 ;;; Symbol completion
2347 (defun python-completion-complete-at-point ()
2348 "Complete current symbol at point.
2349 For this to work the best as possible you should call
2350 `python-shell-send-buffer' from time to time so context in
2351 inferior python process is updated properly."
2352 (let ((process (python-shell-get-process)))
2354 (error "Completion needs an inferior Python process running")
2355 (python-shell-completion-complete-at-point process
))))
2357 (add-to-list 'debug-ignored-errors
2358 "^Completion needs an inferior Python process running.")
2363 (defcustom python-fill-comment-function
'python-fill-comment
2364 "Function to fill comments.
2365 This is the function used by `python-fill-paragraph' to
2370 (defcustom python-fill-string-function
'python-fill-string
2371 "Function to fill strings.
2372 This is the function used by `python-fill-paragraph' to
2377 (defcustom python-fill-decorator-function
'python-fill-decorator
2378 "Function to fill decorators.
2379 This is the function used by `python-fill-paragraph' to
2384 (defcustom python-fill-paren-function
'python-fill-paren
2385 "Function to fill parens.
2386 This is the function used by `python-fill-paragraph' to
2391 (defcustom python-fill-docstring-style
'pep-257
2392 "Style used to fill docstrings.
2393 This affects `python-fill-string' behavior with regards to
2394 triple quotes positioning.
2396 Possible values are DJANGO, ONETWO, PEP-257, PEP-257-NN,
2397 SYMMETRIC, and NIL. A value of NIL won't care about quotes
2398 position and will treat docstrings a normal string, any other
2399 value may result in one of the following docstring styles:
2404 Process foo, return bar.
2408 Process foo, return bar.
2410 If processing fails throw ProcessingError.
2415 \"\"\"Process foo, return bar.\"\"\"
2418 Process foo, return bar.
2420 If processing fails throw ProcessingError.
2426 \"\"\"Process foo, return bar.\"\"\"
2428 \"\"\"Process foo, return bar.
2430 If processing fails throw ProcessingError.
2436 \"\"\"Process foo, return bar.\"\"\"
2438 \"\"\"Process foo, return bar.
2440 If processing fails throw ProcessingError.
2445 \"\"\"Process foo, return bar.\"\"\"
2448 Process foo, return bar.
2450 If processing fails throw ProcessingError.
2453 (const :tag
"Don't format docstrings" nil
)
2454 (const :tag
"Django's coding standards style." django
)
2455 (const :tag
"One newline and start and Two at end style." onetwo
)
2456 (const :tag
"PEP-257 with 2 newlines at end of string." pep-257
)
2457 (const :tag
"PEP-257 with 1 newline at end of string." pep-257-nn
)
2458 (const :tag
"Symmetric style." symmetric
))
2461 (memq val
'(django onetwo pep-257 pep-257-nn symmetric nil
))))
2463 (defun python-fill-paragraph (&optional justify
)
2464 "`fill-paragraph-function' handling multi-line strings and possibly comments.
2465 If any of the current line is in or at the end of a multi-line string,
2466 fill the string or the paragraph of it that point is in, preserving
2467 the string's indentation.
2468 Optional argument JUSTIFY defines if the paragraph should be justified."
2473 ((python-syntax-context 'comment
)
2474 (funcall python-fill-comment-function justify
))
2475 ;; Strings/Docstrings
2476 ((save-excursion (or (python-syntax-context 'string
)
2477 (equal (string-to-syntax "|")
2478 (syntax-after (point)))))
2479 (funcall python-fill-string-function justify
))
2481 ((equal (char-after (save-excursion
2482 (python-nav-beginning-of-statement))) ?
@)
2483 (funcall python-fill-decorator-function justify
))
2485 ((or (python-syntax-context 'paren
)
2486 (looking-at (python-rx open-paren
))
2488 (skip-syntax-forward "^(" (line-end-position))
2489 (looking-at (python-rx open-paren
))))
2490 (funcall python-fill-paren-function justify
))
2493 (defun python-fill-comment (&optional justify
)
2494 "Comment fill function for `python-fill-paragraph'.
2495 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
2496 (fill-comment-paragraph justify
))
2498 (defun python-fill-string (&optional justify
)
2499 "String fill function for `python-fill-paragraph'.
2500 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
2501 (let* ((marker (point-marker))
2505 (or (python-syntax-context 'string
)
2506 (and (equal (string-to-syntax "|")
2507 (syntax-after (point)))
2509 (num-quotes (python-syntax-count-quotes
2510 (char-after str-start-pos
) str-start-pos
))
2513 (goto-char (+ str-start-pos num-quotes
))
2514 (or (re-search-forward (rx (syntax string-delimiter
)) nil t
)
2515 (goto-char (point-max)))
2518 ;; Docstring styles may vary for oneliners and multi-liners.
2519 (> (count-matches "\n" str-start-pos str-end-pos
) 0))
2521 (pcase python-fill-docstring-style
2522 ;; delimiters-style is a cons cell with the form
2523 ;; (START-NEWLINES . END-NEWLINES). When any of the sexps
2524 ;; is NIL means to not add any newlines for start or end
2525 ;; of docstring. See `python-fill-docstring-style' for a
2526 ;; graphic idea of each style.
2527 (`django
(cons 1 1))
2528 (`onetwo
(and multi-line-p
(cons 1 2)))
2529 (`pep-257
(and multi-line-p
(cons nil
2)))
2530 (`pep-257-nn
(and multi-line-p
(cons nil
1)))
2531 (`symmetric
(and multi-line-p
(cons 1 1)))))
2532 (docstring-p (save-excursion
2533 ;; Consider docstrings those strings which
2534 ;; start on a line by themselves.
2535 (python-nav-beginning-of-statement)
2536 (and (= (point) str-start-pos
))))
2537 (fill-paragraph-function))
2539 (narrow-to-region str-start-pos str-end-pos
)
2540 (fill-paragraph justify
))
2542 (when (and docstring-p python-fill-docstring-style
)
2543 ;; Add the number of newlines indicated by the selected style
2544 ;; at the start of the docstring.
2545 (goto-char (+ str-start-pos num-quotes
))
2546 (delete-region (point) (progn
2547 (skip-syntax-forward "> ")
2549 (and (car delimiters-style
)
2550 (or (newline (car delimiters-style
)) t
)
2551 ;; Indent only if a newline is added.
2552 (indent-according-to-mode))
2553 ;; Add the number of newlines indicated by the selected style
2554 ;; at the end of the docstring.
2555 (goto-char (if (not (= str-end-pos
(point-max)))
2556 (- str-end-pos num-quotes
)
2558 (delete-region (point) (progn
2559 (skip-syntax-backward "> ")
2561 (and (cdr delimiters-style
)
2562 ;; Add newlines only if string ends.
2563 (not (= str-end-pos
(point-max)))
2564 (or (newline (cdr delimiters-style
)) t
)
2565 ;; Again indent only if a newline is added.
2566 (indent-according-to-mode))))) t
)
2568 (defun python-fill-decorator (&optional justify
)
2569 "Decorator fill function for `python-fill-paragraph'.
2570 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
2573 (defun python-fill-paren (&optional justify
)
2574 "Paren fill function for `python-fill-paragraph'.
2575 JUSTIFY should be used (if applicable) as in `fill-paragraph'."
2577 (narrow-to-region (progn
2578 (while (python-syntax-context 'paren
)
2579 (goto-char (1- (point-marker))))
2581 (line-beginning-position))
2583 (when (not (python-syntax-context 'paren
))
2585 (when (not (python-syntax-context 'paren
))
2586 (skip-syntax-backward "^)")))
2587 (while (python-syntax-context 'paren
)
2588 (goto-char (1+ (point-marker))))
2590 (let ((paragraph-start "\f\\|[ \t]*$")
2591 (paragraph-separate ",")
2592 (fill-paragraph-function))
2593 (goto-char (point-min))
2594 (fill-paragraph justify
))
2597 (python-indent-line)
2598 (goto-char (line-end-position)))) t
)
2603 (defcustom python-skeleton-autoinsert nil
2604 "Non-nil means template skeletons will be automagically inserted.
2605 This happens when pressing \"if<SPACE>\", for example, to prompt for
2611 (define-obsolete-variable-alias
2612 'python-use-skeletons
'python-skeleton-autoinsert
"24.3")
2614 (defvar python-skeleton-available
'()
2615 "Internal list of available skeletons.")
2617 (define-abbrev-table 'python-mode-abbrev-table
()
2618 "Abbrev table for Python mode."
2620 ;; Allow / inside abbrevs.
2621 :regexp
"\\(?:^\\|[^/]\\)\\<\\([[:word:]/]+\\)\\W*"
2622 ;; Only expand in code.
2623 :enable-function
(lambda ()
2625 (not (python-syntax-comment-or-string-p))
2626 python-skeleton-autoinsert
)))
2628 (defmacro python-skeleton-define
(name doc
&rest skel
)
2629 "Define a `python-mode' skeleton using NAME DOC and SKEL.
2630 The skeleton will be bound to python-skeleton-NAME and will
2631 be added to `python-mode-abbrev-table'."
2632 (declare (indent 2))
2633 (let* ((name (symbol-name name
))
2634 (function-name (intern (concat "python-skeleton-" name
))))
2636 (define-abbrev python-mode-abbrev-table
,name
"" ',function-name
2638 (setq python-skeleton-available
2639 (cons ',function-name python-skeleton-available
))
2640 (define-skeleton ,function-name
2642 (format "Insert %s statement." name
))
2645 (defmacro python-define-auxiliary-skeleton
(name doc
&optional
&rest skel
)
2646 "Define a `python-mode' auxiliary skeleton using NAME DOC and SKEL.
2647 The skeleton will be bound to python-skeleton-NAME."
2648 (declare (indent 2))
2649 (let* ((name (symbol-name name
))
2650 (function-name (intern (concat "python-skeleton--" name
)))
2652 "Add '%s' clause? " name
)))
2655 `(< ,(format "%s:" name
) \n \n
2657 `(define-skeleton ,function-name
2659 (format "Auxiliary skeleton for %s statement." name
))
2661 (unless (y-or-n-p ,msg
)
2665 (python-define-auxiliary-skeleton else nil
)
2667 (python-define-auxiliary-skeleton except nil
)
2669 (python-define-auxiliary-skeleton finally nil
)
2671 (python-skeleton-define if nil
2675 ("other condition, %s: "
2679 '(python-skeleton--else) | ^
)
2681 (python-skeleton-define while nil
2685 '(python-skeleton--else) | ^
)
2687 (python-skeleton-define for nil
2691 '(python-skeleton--else) | ^
)
2693 (python-skeleton-define try nil
2699 "except " str
":" \n
2702 '(python-skeleton--except)
2703 '(python-skeleton--else)
2704 '(python-skeleton--finally) | ^
)
2706 (python-skeleton-define def nil
2708 "def " str
"(" ("Parameter, %s: "
2709 (unless (equal ?\
( (char-before)) ", ")
2711 "\"\"\"" -
"\"\"\"" \n
2714 (python-skeleton-define class nil
2716 "class " str
"(" ("Inheritance, %s: "
2717 (unless (equal ?\
( (char-before)) ", ")
2721 "\"\"\"" -
"\"\"\"" \n
2724 (defun python-skeleton-add-menu-items ()
2725 "Add menu items to Python->Skeletons menu."
2726 (let ((skeletons (sort python-skeleton-available
'string
<))
2728 (dolist (skeleton skeletons
)
2730 nil
'("Python" "Skeletons")
2732 "Insert %s" (nth 2 (split-string (symbol-name skeleton
) "-")))
2737 (defcustom python-ffap-setup-code
2738 "def __FFAP_get_module_path(module):
2741 path = __import__(module).__file__
2742 if path[-4:] == '.pyc' and os.path.exists(path[0:-1]):
2747 "Python code to get a module path."
2751 (defcustom python-ffap-string-code
2752 "__FFAP_get_module_path('''%s''')\n"
2753 "Python code used to get a string with the path of a module."
2757 (defun python-ffap-module-path (module)
2758 "Function for `ffap-alist' to return path for MODULE."
2760 (and (eq major-mode
'inferior-python-mode
)
2761 (get-buffer-process (current-buffer)))
2762 (python-shell-get-process))))
2766 (python-shell-send-string-no-output
2767 (format python-ffap-string-code module
) process
)))
2769 (substring-no-properties module-file
1 -
1))))))
2771 (eval-after-load "ffap"
2773 (push '(python-mode . python-ffap-module-path
) ffap-alist
)
2774 (push '(inferior-python-mode . python-ffap-module-path
) ffap-alist
)))
2779 (defcustom python-check-command
2781 "Command used to check a Python file."
2785 (defcustom python-check-buffer-name
2786 "*Python check: %s*"
2787 "Buffer name used for check commands."
2791 (defvar python-check-custom-command nil
2794 (defun python-check (command)
2795 "Check a Python file (default current buffer's file).
2796 Runs COMMAND, a shell command, as if by `compile'. See
2797 `python-check-command' for the default."
2799 (list (read-string "Check command: "
2800 (or python-check-custom-command
2801 (concat python-check-command
" "
2802 (shell-quote-argument
2804 (let ((name (buffer-file-name)))
2806 (file-name-nondirectory name
)))
2808 (setq python-check-custom-command command
)
2809 (save-some-buffers (not compilation-ask-about-save
) nil
)
2810 (let ((process-environment (python-shell-calculate-process-environment))
2811 (exec-path (python-shell-calculate-exec-path)))
2812 (compilation-start command nil
2814 (format python-check-buffer-name command
)))))
2819 (defcustom python-eldoc-setup-code
2820 "def __PYDOC_get_help(obj):
2823 if hasattr(obj, 'startswith'):
2824 obj = eval(obj, globals())
2825 doc = inspect.getdoc(obj)
2826 if not doc and callable(obj):
2828 if inspect.isclass(obj) and hasattr(obj, '__init__'):
2829 target = obj.__init__
2835 args = inspect.formatargspec(
2836 *inspect.getargspec(target)
2839 doc = '{objtype} {name}{args}'.format(
2840 objtype=objtype, name=name, args=args
2843 doc = doc.splitlines()[0]
2850 "Python code to setup documentation retrieval."
2854 (defcustom python-eldoc-string-code
2855 "__PYDOC_get_help('''%s''')\n"
2856 "Python code used to get a string with the documentation of an object."
2860 (defun python-eldoc--get-doc-at-point (&optional force-input force-process
)
2861 "Internal implementation to get documentation at point.
2862 If not FORCE-INPUT is passed then what
2863 `python-info-current-symbol' returns will be used. If not
2864 FORCE-PROCESS is passed what `python-shell-get-process' returns
2866 (let ((process (or force-process
(python-shell-get-process))))
2868 (error "Eldoc needs an inferior Python process running")
2869 (let ((input (or force-input
2870 (python-info-current-symbol t
))))
2872 (python-shell-send-string-no-output
2873 (format python-eldoc-string-code input
)
2876 (defun python-eldoc-function ()
2877 "`eldoc-documentation-function' for Python.
2878 For this to work the best as possible you should call
2879 `python-shell-send-buffer' from time to time so context in
2880 inferior python process is updated properly."
2881 (python-eldoc--get-doc-at-point))
2883 (defun python-eldoc-at-point (symbol)
2884 "Get help on SYMBOL using `help'.
2885 Interactively, prompt for symbol."
2887 (let ((symbol (python-info-current-symbol t
))
2888 (enable-recursive-minibuffers t
))
2889 (list (read-string (if symbol
2890 (format "Describe symbol (default %s): " symbol
)
2891 "Describe symbol: ")
2893 (message (python-eldoc--get-doc-at-point symbol
)))
2895 (add-to-list 'debug-ignored-errors
2896 "^Eldoc needs an inferior Python process running.")
2901 (defun python-imenu-prev-index-position ()
2902 "Python mode's `imenu-prev-index-position-function'."
2904 (while (and (setq found
2905 (re-search-backward python-nav-beginning-of-defun-regexp nil t
))
2906 (not (python-info-looking-at-beginning-of-defun))))
2908 (python-info-looking-at-beginning-of-defun)
2909 (python-info-current-defun))))
2914 (defun python-info-current-defun (&optional include-type
)
2915 "Return name of surrounding function with Python compatible dotty syntax.
2916 Optional argument INCLUDE-TYPE indicates to include the type of the defun.
2917 This function is compatible to be used as
2918 `add-log-current-defun-function' since it returns nil if point is
2919 not inside a defun."
2925 (starting-indentation
2928 (python-nav-beginning-of-defun 1)
2929 ;; This extra number is just for checking code
2930 ;; against indentation to work well on first run.
2931 (+ (current-indentation) 4))))
2932 (starting-point (point)))
2933 ;; Check point is inside a defun.
2934 (when (and starting-indentation
2937 (python-nav-end-of-defun)
2940 (while (python-nav-beginning-of-defun 1)
2941 (when (< (current-indentation) starting-indentation
)
2942 (setq starting-indentation
(current-indentation))
2945 (if (not include-type
)
2946 (match-string-no-properties 1)
2947 (mapconcat 'identity
2949 (match-string-no-properties 0)) " "))
2951 (and (= (current-indentation) 0) (throw 'exit t
)))))
2953 (mapconcat (lambda (string) string
) names
"."))))))
2955 (defun python-info-current-symbol (&optional replace-self
)
2956 "Return current symbol using dotty syntax.
2957 With optional argument REPLACE-SELF convert \"self\" to current
2960 (and (not (python-syntax-comment-or-string-p))
2961 (with-syntax-table python-dotty-syntax-table
2962 (let ((sym (symbol-at-point)))
2964 (substring-no-properties (symbol-name sym
))))))))
2966 (if (not replace-self
)
2968 (let ((current-defun (python-info-current-defun)))
2969 (if (not current-defun
)
2971 (replace-regexp-in-string
2972 (python-rx line-start word-start
"self" word-end ?.
)
2974 (mapconcat 'identity
2975 (butlast (split-string current-defun
"\\."))
2979 (defun python-info-statement-starts-block-p ()
2980 "Return non-nil if current statement opens a block."
2982 (python-nav-beginning-of-statement)
2983 (looking-at (python-rx block-start
))))
2985 (defun python-info-statement-ends-block-p ()
2986 "Return non-nil if point is at end of block."
2987 (let ((end-of-block-pos (save-excursion
2988 (python-nav-end-of-block)))
2989 (end-of-statement-pos (save-excursion
2990 (python-nav-end-of-statement))))
2991 (and end-of-block-pos end-of-statement-pos
2992 (= end-of-block-pos end-of-statement-pos
))))
2994 (defun python-info-beginning-of-statement-p ()
2995 "Return non-nil if point is at beginning of statement."
2996 (= (point) (save-excursion
2997 (python-nav-beginning-of-statement)
3000 (defun python-info-end-of-statement-p ()
3001 "Return non-nil if point is at end of statement."
3002 (= (point) (save-excursion
3003 (python-nav-end-of-statement)
3006 (defun python-info-beginning-of-block-p ()
3007 "Return non-nil if point is at beginning of block."
3008 (and (python-info-beginning-of-statement-p)
3009 (python-info-statement-starts-block-p)))
3011 (defun python-info-end-of-block-p ()
3012 "Return non-nil if point is at end of block."
3013 (and (python-info-end-of-statement-p)
3014 (python-info-statement-ends-block-p)))
3016 (defun python-info-closing-block ()
3017 "Return the point of the block the current line closes."
3018 (let ((closing-word (save-excursion
3019 (back-to-indentation)
3021 (indentation (current-indentation)))
3022 (when (member closing-word python-indent-dedenters
)
3025 (while (and (> (current-indentation) indentation
)
3027 (not (back-to-indentation))
3029 (back-to-indentation)
3031 ((not (equal indentation
(current-indentation))) nil
)
3032 ((string= closing-word
"elif")
3033 (when (member (current-word) '("if" "elif"))
3035 ((string= closing-word
"else")
3036 (when (member (current-word) '("if" "elif" "except" "for" "while"))
3038 ((string= closing-word
"except")
3039 (when (member (current-word) '("try"))
3041 ((string= closing-word
"finally")
3042 (when (member (current-word) '("except" "else"))
3043 (point-marker))))))))
3045 (defun python-info-closing-block-message (&optional closing-block-point
)
3046 "Message the contents of the block the current line closes.
3047 With optional argument CLOSING-BLOCK-POINT use that instead of
3048 recalculating it calling `python-info-closing-block'."
3049 (let ((point (or closing-block-point
(python-info-closing-block))))
3053 (message "Closes %s" (save-excursion
3055 (back-to-indentation)
3057 (point) (line-end-position))))))))
3059 (defun python-info-line-ends-backslash-p (&optional line-number
)
3060 "Return non-nil if current line ends with backslash.
3061 With optional argument LINE-NUMBER, check that line instead."
3066 (goto-char line-number
))
3067 (while (and (not (eobp))
3068 (goto-char (line-end-position))
3069 (python-syntax-context 'paren
)
3070 (not (equal (char-before (point)) ?
\\)))
3072 (when (equal (char-before) ?
\\)
3075 (defun python-info-beginning-of-backslash (&optional line-number
)
3076 "Return the point where the backslashed line start.
3077 Optional argument LINE-NUMBER forces the line number to check against."
3082 (goto-char line-number
))
3083 (when (python-info-line-ends-backslash-p)
3084 (while (save-excursion
3085 (goto-char (line-beginning-position))
3086 (python-syntax-context 'paren
))
3088 (back-to-indentation)
3091 (defun python-info-continuation-line-p ()
3092 "Check if current line is continuation of another.
3093 When current line is continuation of another return the point
3094 where the continued line ends."
3098 (let* ((context-type (progn
3099 (back-to-indentation)
3100 (python-syntax-context-type)))
3101 (line-start (line-number-at-pos))
3102 (context-start (when context-type
3103 (python-syntax-context context-type
))))
3104 (cond ((equal context-type
'paren
)
3105 ;; Lines inside a paren are always a continuation line
3106 ;; (except the first one).
3107 (python-util-forward-comment -
1)
3109 ((member context-type
'(string comment
))
3110 ;; move forward an roll again
3111 (goto-char context-start
)
3112 (python-util-forward-comment)
3113 (python-info-continuation-line-p))
3115 ;; Not within a paren, string or comment, the only way
3116 ;; we are dealing with a continuation line is that
3117 ;; previous line contains a backslash, and this can
3118 ;; only be the previous line from current
3119 (back-to-indentation)
3120 (python-util-forward-comment -
1)
3121 (when (and (equal (1- line-start
) (line-number-at-pos))
3122 (python-info-line-ends-backslash-p))
3123 (point-marker))))))))
3125 (defun python-info-block-continuation-line-p ()
3126 "Return non-nil if current line is a continuation of a block."
3128 (when (python-info-continuation-line-p)
3130 (back-to-indentation)
3131 (when (looking-at (python-rx block-start
))
3134 (defun python-info-assignment-continuation-line-p ()
3135 "Check if current line is a continuation of an assignment.
3136 When current line is continuation of another with an assignment
3137 return the point of the first non-blank character after the
3140 (when (python-info-continuation-line-p)
3142 (back-to-indentation)
3143 (when (and (not (looking-at (python-rx block-start
)))
3144 (and (re-search-forward (python-rx not-simple-operator
3146 not-simple-operator
)
3147 (line-end-position) t
)
3148 (not (python-syntax-context-type))))
3149 (skip-syntax-forward "\s")
3152 (defun python-info-looking-at-beginning-of-defun (&optional syntax-ppss
)
3153 "Check if point is at `beginning-of-defun' using SYNTAX-PPSS."
3154 (and (not (python-syntax-context-type (or syntax-ppss
(syntax-ppss))))
3156 (beginning-of-line 1)
3157 (looking-at python-nav-beginning-of-defun-regexp
))))
3159 (defun python-info-current-line-comment-p ()
3160 "Check if current line is a comment line."
3161 (char-equal (or (char-after (+ (point) (current-indentation))) ?_
) ?
#))
3163 (defun python-info-current-line-empty-p ()
3164 "Check if current line is empty, ignoring whitespace."
3166 (beginning-of-line 1)
3168 (python-rx line-start
(* whitespace
)
3169 (group (* not-newline
))
3170 (* whitespace
) line-end
))
3171 (string-equal "" (match-string-no-properties 1))))
3174 ;;; Utility functions
3176 (defun python-util-position (item seq
)
3177 "Find the first occurrence of ITEM in SEQ.
3178 Return the index of the matching item, or nil if not found."
3179 (let ((member-result (member item seq
)))
3181 (- (length seq
) (length member-result
)))))
3183 ;; Stolen from org-mode
3184 (defun python-util-clone-local-variables (from-buffer &optional regexp
)
3185 "Clone local variables from FROM-BUFFER.
3186 Optional argument REGEXP selects variables to clone and defaults
3190 (and (symbolp (car pair
))
3191 (string-match (or regexp
"^python-")
3192 (symbol-name (car pair
)))
3193 (set (make-local-variable (car pair
))
3195 (buffer-local-variables from-buffer
)))
3197 (defun python-util-forward-comment (&optional direction
)
3198 "Python mode specific version of `forward-comment'.
3199 Optional argument DIRECTION defines the direction to move to."
3200 (let ((comment-start (python-syntax-context 'comment
))
3201 (factor (if (< (or direction
0) 0)
3205 (goto-char comment-start
))
3206 (forward-comment factor
)))
3210 (define-derived-mode python-mode prog-mode
"Python"
3211 "Major mode for editing Python files.
3214 Entry to this mode calls the value of `python-mode-hook'
3215 if that value is non-nil."
3216 (set (make-local-variable 'tab-width
) 8)
3217 (set (make-local-variable 'indent-tabs-mode
) nil
)
3219 (set (make-local-variable 'comment-start
) "# ")
3220 (set (make-local-variable 'comment-start-skip
) "#+\\s-*")
3222 (set (make-local-variable 'parse-sexp-lookup-properties
) t
)
3223 (set (make-local-variable 'parse-sexp-ignore-comments
) t
)
3225 (set (make-local-variable 'forward-sexp-function
)
3226 'python-nav-forward-sexp
)
3228 (set (make-local-variable 'font-lock-defaults
)
3229 '(python-font-lock-keywords nil nil nil nil
))
3231 (set (make-local-variable 'syntax-propertize-function
)
3232 python-syntax-propertize-function
)
3234 (set (make-local-variable 'indent-line-function
)
3235 #'python-indent-line-function
)
3236 (set (make-local-variable 'indent-region-function
) #'python-indent-region
)
3238 (set (make-local-variable 'paragraph-start
) "\\s-*$")
3239 (set (make-local-variable 'fill-paragraph-function
)
3240 'python-fill-paragraph
)
3242 (set (make-local-variable 'beginning-of-defun-function
)
3243 #'python-nav-beginning-of-defun
)
3244 (set (make-local-variable 'end-of-defun-function
)
3245 #'python-nav-end-of-defun
)
3247 (add-hook 'completion-at-point-functions
3248 'python-completion-complete-at-point nil
'local
)
3250 (add-hook 'post-self-insert-hook
3251 'python-indent-post-self-insert-function nil
'local
)
3253 (set (make-local-variable 'imenu-extract-index-name-function
)
3254 #'python-info-current-defun
)
3256 (set (make-local-variable 'imenu-prev-index-position-function
)
3257 #'python-imenu-prev-index-position
)
3259 (set (make-local-variable 'add-log-current-defun-function
)
3260 #'python-info-current-defun
)
3262 (add-hook 'which-func-functions
#'python-info-current-defun
nil t
)
3264 (set (make-local-variable 'skeleton-further-elements
)
3266 (< '(backward-delete-char-untabify (min python-indent-offset
3268 (^
'(- (1+ (current-indentation))))))
3270 (set (make-local-variable 'eldoc-documentation-function
)
3271 #'python-eldoc-function
)
3273 (add-to-list 'hs-special-modes-alist
3274 `(python-mode "^\\s-*\\(?:def\\|class\\)\\>" nil
"#"
3276 (python-nav-end-of-defun)) nil
))
3278 (set (make-local-variable 'mode-require-final-newline
) t
)
3280 (set (make-local-variable 'outline-regexp
)
3281 (python-rx (* space
) block-start
))
3282 (set (make-local-variable 'outline-heading-end-regexp
) ":\\s-*\n")
3283 (set (make-local-variable 'outline-level
)
3285 "`outline-level' function for Python mode."
3286 (1+ (/ (current-indentation) python-indent-offset
))))
3288 (python-skeleton-add-menu-items)
3290 (make-local-variable 'python-shell-internal-buffer
)
3292 (when python-indent-guess-indent-offset
3293 (python-indent-guess-indent-offset)))
3300 ;; indent-tabs-mode: nil
3303 ;;; python.el ends here