1 ;;; python.el --- silly walks for Python
3 ;; Copyright (C) 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
5 ;; Author: Dave Love <fx@gnu.org>
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
29 ;; Major mode for editing Python, with support for inferior processes.
31 ;; There is another Python mode, python-mode.el, used by XEmacs and
32 ;; maintained with Python. That isn't covered by an FSF copyright
33 ;; assignment, unlike this code, and seems not to be well-maintained
34 ;; for Emacs (though I've submitted fixes). This mode is rather
35 ;; simpler and is better in other ways. In particular, using the
36 ;; syntax functions with text properties maintained by font-lock makes
37 ;; it more correct with arbitrary string and comment contents.
39 ;; This doesn't implement all the facilities of python-mode.el. Some
40 ;; just need doing, e.g. catching exceptions in the inferior Python
41 ;; buffer (but see M-x pdb for debugging). [Actually, the use of
42 ;; `compilation-shell-minor-mode' now is probably enough for that.]
43 ;; Others don't seem appropriate. For instance,
44 ;; `forward-into-nomenclature' should be done separately, since it's
45 ;; not specific to Python, and I've installed a minor mode to do the
46 ;; job properly in Emacs 23. [CC mode 5.31 contains an incompatible
47 ;; feature, `c-subword-mode' which is intended to have a similar
48 ;; effect, but actually only affects word-oriented keybindings.]
50 ;; Other things seem more natural or canonical here, e.g. the
51 ;; {beginning,end}-of-defun implementation dealing with nested
52 ;; definitions, and the inferior mode following `cmuscheme'. (The
53 ;; inferior mode can find the source of errors from
54 ;; `python-send-region' & al via `compilation-shell-minor-mode'.)
55 ;; There is (limited) symbol completion using lookup in Python and
56 ;; Eldoc support also using the inferior process. Successive TABs
57 ;; cycle between possible indentations for the line.
59 ;; Even where it has similar facilities, this mode is incompatible
60 ;; with python-mode.el in some respects. For instance, various key
61 ;; bindings are changed to obey Emacs conventions.
63 ;; TODO: See various Fixmes below.
71 (require 'hippie-exp))
73 (autoload 'comint-mode "comint")
76 "Silly walks in the Python language."
79 :link '(emacs-commentary-link "python"))
82 (add-to-list 'interpreter-mode-alist '("jython" . jython-mode))
84 (add-to-list 'interpreter-mode-alist '("python" . python-mode))
86 (add-to-list 'auto-mode-alist '("\\.py\\'" . python-mode))
90 (defvar python-font-lock-keywords
92 ;; From v 2.4 reference.
93 ;; def and class dealt with separately below
94 (or "and" "assert" "break" "continue" "del" "elif" "else"
95 "except" "exec" "finally" "for" "from" "global" "if"
96 "import" "in" "is" "lambda" "not" "or" "pass" "print"
97 "raise" "return" "try" "while" "yield"
100 ;; Not real keywords, but close enough to be fontified as such
101 "self" "True" "False")
104 (,(rx symbol-start (group "class") (1+ space) (group (1+ (or word ?_))))
105 (1 font-lock-keyword-face) (2 font-lock-type-face))
106 (,(rx symbol-start (group "def") (1+ space) (group (1+ (or word ?_))))
107 (1 font-lock-keyword-face) (2 font-lock-function-name-face))
108 ;; Top-level assignments are worth highlighting.
109 (,(rx line-start (group (1+ (or word ?_))) (0+ space) "=")
110 (1 font-lock-variable-name-face))
111 (,(rx "@" (1+ (or word ?_))) ; decorators
112 (0 font-lock-preprocessor-face))))
114 (defconst python-font-lock-syntactic-keywords
115 ;; Make outer chars of matching triple-quote sequences into generic
116 ;; string delimiters. Fixme: Is there a better way?
117 `((,(rx (or line-start buffer-start
118 (not (syntax escape))) ; avoid escaped leading quote
119 (group (optional (any "uUrR"))) ; prefix gets syntax property
120 (optional (any "rR")) ; possible second prefix
121 (group (syntax string-quote)) ; maybe gets property
122 (backref 2) ; per first quote
123 (group (backref 2))) ; maybe gets property
124 (1 (python-quote-syntax 1))
125 (2 (python-quote-syntax 2))
126 (3 (python-quote-syntax 3)))
127 ;; This doesn't really help.
128 ;;; (,(rx (and ?\\ (group ?\n))) (1 " "))
131 (defun python-quote-syntax (n)
132 "Put `syntax-table' property correctly on triple quote.
133 Used for syntactic keywords. N is the match number (1, 2 or 3)."
134 ;; Given a triple quote, we have to check the context to know
135 ;; whether this is an opening or closing triple or whether it's
136 ;; quoted anyhow, and should be ignored. (For that we need to do
137 ;; the same job as `syntax-ppss' to be correct and it seems to be OK
138 ;; to use it here despite initial worries.) We also have to sort
139 ;; out a possible prefix -- well, we don't _have_ to, but I think it
140 ;; should be treated as part of the string.
143 ;; ur"""ar""" x='"' # """
146 ;; x '"""' x """ \"""" x
147 ;; Fixme: """""" goes wrong (due to syntax-ppss not getting the string
150 (goto-char (match-beginning 0))
152 ;; Consider property for the last char if in a fenced string.
154 (let ((syntax (syntax-ppss)))
155 (when (eq t (nth 3 syntax)) ; after unclosed fence
156 (goto-char (nth 8 syntax)) ; fence position
157 (skip-chars-forward "uUrR") ; skip any prefix
158 ;; Is it a matching sequence?
159 (if (eq (char-after) (char-after (match-beginning 2)))
160 (eval-when-compile (string-to-syntax "|"))))))
161 ;; Consider property for initial char, accounting for prefixes.
162 ((or (and (= n 2) ; leading quote (not prefix)
163 (= (match-beginning 1) (match-end 1))) ; prefix is null
164 (and (= n 1) ; prefix
165 (/= (match-beginning 1) (match-end 1)))) ; non-empty
166 (unless (nth 3 (syntax-ppss))
167 (eval-when-compile (string-to-syntax "|"))))
168 ;; Otherwise (we're in a non-matching string) the property is
172 ;; This isn't currently in `font-lock-defaults' as probably not worth
173 ;; it -- we basically only mess with a few normally-symbol characters.
175 ;; (defun python-font-lock-syntactic-face-function (state)
176 ;; "`font-lock-syntactic-face-function' for Python mode.
177 ;; Returns the string or comment face as usual, with side effect of putting
178 ;; a `syntax-table' property on the inside of the string or comment which is
179 ;; the standard syntax table."
182 ;; (goto-char (nth 8 state))
183 ;; (condition-case nil
186 ;; (put-text-property (1+ (nth 8 state)) (1- (point))
187 ;; 'syntax-table (standard-syntax-table))
188 ;; 'font-lock-string-face)
189 ;; (put-text-property (1+ (nth 8 state)) (line-end-position)
190 ;; 'syntax-table (standard-syntax-table))
191 ;; 'font-lock-comment-face))
193 ;;;; Keymap and syntax
195 (defvar python-mode-map
196 (let ((map (make-sparse-keymap)))
197 ;; Mostly taken from python-mode.el.
198 (define-key map ":" 'python-electric-colon)
199 (define-key map "\177" 'python-backspace)
200 (define-key map "\C-c<" 'python-shift-left)
201 (define-key map "\C-c>" 'python-shift-right)
202 (define-key map "\C-c\C-k" 'python-mark-block)
203 (define-key map "\C-c\C-n" 'python-next-statement)
204 (define-key map "\C-c\C-p" 'python-previous-statement)
205 (define-key map "\C-c\C-u" 'python-beginning-of-block)
206 (define-key map "\C-c\C-f" 'python-describe-symbol)
207 (define-key map "\C-c\C-w" 'python-check)
208 (define-key map "\C-c\C-v" 'python-check) ; a la sgml-mode
209 (define-key map "\C-c\C-s" 'python-send-string)
210 (define-key map [?\C-\M-x] 'python-send-defun)
211 (define-key map "\C-c\C-r" 'python-send-region)
212 (define-key map "\C-c\M-r" 'python-send-region-and-go)
213 (define-key map "\C-c\C-c" 'python-send-buffer)
214 (define-key map "\C-c\C-z" 'python-switch-to-python)
215 (define-key map "\C-c\C-m" 'python-load-file)
216 (define-key map "\C-c\C-l" 'python-load-file) ; a la cmuscheme
217 (substitute-key-definition 'complete-symbol 'python-complete-symbol
219 (define-key map "\C-c\C-i" 'python-find-imports)
220 (define-key map "\C-c\C-t" 'python-expand-template)
221 (easy-menu-define python-menu map "Python Mode menu"
223 :help "Python-specific Features"
224 ["Shift region left" python-shift-left :active mark-active
225 :help "Shift by a single indentation step"]
226 ["Shift region right" python-shift-right :active mark-active
227 :help "Shift by a single indentation step"]
229 ["Mark block" python-mark-block
230 :help "Mark innermost block around point"]
231 ["Mark def/class" mark-defun
232 :help "Mark innermost definition around point"]
234 ["Start of block" python-beginning-of-block
235 :help "Go to start of innermost definition around point"]
236 ["End of block" python-end-of-block
237 :help "Go to end of innermost definition around point"]
238 ["Start of def/class" beginning-of-defun
239 :help "Go to start of innermost definition around point"]
240 ["End of def/class" end-of-defun
241 :help "Go to end of innermost definition around point"]
244 :help "Expand templates for compound statements"
245 :filter (lambda (&rest junk)
246 (mapcar (lambda (elt)
247 (vector (car elt) (cdr elt) t))
248 python-skeletons))) ; defined later
250 ["Start interpreter" run-python
251 :help "Run `inferior' Python in separate buffer"]
252 ["Import/reload file" python-load-file
253 :help "Load into inferior Python session"]
254 ["Eval buffer" python-send-buffer
255 :help "Evaluate buffer en bloc in inferior Python session"]
256 ["Eval region" python-send-region :active mark-active
257 :help "Evaluate region en bloc in inferior Python session"]
258 ["Eval def/class" python-send-defun
259 :help "Evaluate current definition in inferior Python session"]
260 ["Switch to interpreter" python-switch-to-python
261 :help "Switch to inferior Python buffer"]
262 ["Set default process" python-set-proc
263 :help "Make buffer's inferior process the default"
264 :active (buffer-live-p python-buffer)]
265 ["Check file" python-check :help "Run pychecker"]
266 ["Debugger" pdb :help "Run pdb under GUD"]
268 ["Help on symbol" python-describe-symbol
269 :help "Use pydoc on symbol at point"]
270 ["Complete symbol" python-complete-symbol
271 :help "Complete (qualified) symbol before point"]
272 ["Update imports" python-find-imports
273 :help "Update list of top-level imports for completion"]))
275 ;; Fixme: add toolbar stuff for useful things like symbol help, send
276 ;; region, at least. (Shouldn't be specific to Python, obviously.)
277 ;; eric has items including: (un)indent, (un)comment, restart script,
278 ;; run script, debug script; also things for profiling, unit testing.
280 (defvar python-mode-syntax-table
281 (let ((table (make-syntax-table)))
282 ;; Give punctuation syntax to ASCII that normally has symbol
283 ;; syntax or has word syntax and isn't a letter.
284 (let ((symbol (string-to-syntax "_"))
285 (sst (standard-syntax-table)))
288 (if (equal symbol (aref sst i))
289 (modify-syntax-entry i "." table)))))
290 (modify-syntax-entry ?$ "." table)
291 (modify-syntax-entry ?% "." table)
293 (modify-syntax-entry ?# "<" table)
294 (modify-syntax-entry ?\n ">" table)
295 (modify-syntax-entry ?' "\"" table)
296 (modify-syntax-entry ?` "$" table)
301 (defsubst python-in-string/comment ()
302 "Return non-nil if point is in a Python literal (a comment or string)."
303 ;; We don't need to save the match data.
304 (nth 8 (syntax-ppss)))
306 (defconst python-space-backslash-table
307 (let ((table (copy-syntax-table python-mode-syntax-table)))
308 (modify-syntax-entry ?\\ " " table)
310 "`python-mode-syntax-table' with backslash given whitespace syntax.")
312 (defun python-skip-comments/blanks (&optional backward)
313 "Skip comments and blank lines.
314 BACKWARD non-nil means go backwards, otherwise go forwards.
315 Backslash is treated as whitespace so that continued blank lines
316 are skipped. Doesn't move out of comments -- should be outside
318 (let ((arg (if backward
319 ;; If we're in a comment (including on the trailing
320 ;; newline), forward-comment doesn't move backwards out
321 ;; of it. Don't set the syntax table round this bit!
322 (let ((syntax (syntax-ppss)))
324 (goto-char (nth 8 syntax)))
327 (with-syntax-table python-space-backslash-table
328 (forward-comment arg))))
330 (defun python-backslash-continuation-line-p ()
331 "Non-nil if preceding line ends with backslash that is not in a comment."
332 (and (eq ?\\ (char-before (line-end-position 0)))
333 (not (syntax-ppss-context (syntax-ppss)))))
335 (defun python-continuation-line-p ()
336 "Return non-nil if current line continues a previous one.
337 The criteria are that the previous line ends in a backslash outside
338 comments and strings, or that point is within brackets/parens."
339 (or (python-backslash-continuation-line-p)
340 (let ((depth (syntax-ppss-depth
341 (save-excursion ; syntax-ppss with arg changes point
342 (syntax-ppss (line-beginning-position))))))
344 (if (< depth 0) ; Unbalanced brackets -- act locally
347 (progn (backward-up-list) t) ; actually within brackets
350 (defun python-comment-line-p ()
351 "Return non-nil iff current line has only a comment."
354 (when (eq 'comment (syntax-ppss-context (syntax-ppss)))
355 (back-to-indentation)
356 (looking-at (rx (or (syntax comment-start) line-end))))))
358 (defun python-blank-line-p ()
359 "Return non-nil iff current line is blank."
362 (looking-at "\\s-*$")))
364 (defun python-beginning-of-string ()
365 "Go to beginning of string around point.
366 Do nothing if not in string."
367 (let ((state (syntax-ppss)))
368 (when (eq 'string (syntax-ppss-context state))
369 (goto-char (nth 8 state)))))
371 (defun python-open-block-statement-p (&optional bos)
372 "Return non-nil if statement at point opens a block.
373 BOS non-nil means point is known to be at beginning of statement."
375 (unless bos (python-beginning-of-statement))
376 (looking-at (rx (and (or "if" "else" "elif" "while" "for" "def"
377 "class" "try" "except" "finally" "with")
380 (defun python-close-block-statement-p (&optional bos)
381 "Return non-nil if current line is a statement closing a block.
382 BOS non-nil means point is at beginning of statement.
383 The criteria are that the line isn't a comment or in string and
384 starts with keyword `raise', `break', `continue' or `pass'."
386 (unless bos (python-beginning-of-statement))
387 (back-to-indentation)
388 (looking-at (rx (or "return" "raise" "break" "continue" "pass")
391 (defun python-outdent-p ()
392 "Return non-nil if current line should outdent a level."
394 (back-to-indentation)
395 (and (looking-at (rx (and (or "else" "finally" "except" "elif")
397 (not (python-in-string/comment))
398 ;; Ensure there's a previous statement and move to it.
399 (zerop (python-previous-statement))
400 (not (python-close-block-statement-p t))
402 (not (python-open-block-statement-p)))))
406 (defcustom python-indent 4
407 "Number of columns for a unit of indentation in Python mode.
408 See also `\\[python-guess-indent]'"
411 (put 'python-indent 'safe-local-variable 'integerp)
413 (defcustom python-guess-indent t
414 "Non-nil means Python mode guesses `python-indent' for the buffer."
418 (defcustom python-indent-string-contents t
419 "Non-nil means indent contents of multi-line strings together.
420 This means indent them the same as the preceding non-blank line.
421 Otherwise preserve their indentation.
423 This only applies to `doc' strings, i.e. those that form statements;
424 the indentation is preserved in others."
425 :type '(choice (const :tag "Align with preceding" t)
426 (const :tag "Preserve indentation" nil))
429 (defcustom python-honour-comment-indentation nil
430 "Non-nil means indent relative to preceding comment line.
431 Only do this for comments where the leading comment character is
432 followed by space. This doesn't apply to comment lines, which
433 are always indented in lines with preceding comments."
437 (defcustom python-continuation-offset 4
438 "Number of columns of additional indentation for continuation lines.
439 Continuation lines follow a backslash-terminated line starting a
444 (defun python-guess-indent ()
445 "Guess step for indentation of current buffer.
446 Set `python-indent' locally to the value guessed."
451 (goto-char (point-min))
453 (while (and (not done) (not (eobp)))
454 (when (and (re-search-forward (rx ?: (0+ space)
455 (or (syntax comment-start)
458 (python-open-block-statement-p))
460 (python-beginning-of-statement)
461 (let ((initial (current-indentation)))
462 (if (zerop (python-next-statement))
463 (setq indent (- (current-indentation) initial)))
464 (if (and indent (>= indent 2) (<= indent 8)) ; sanity check
467 (when (/= indent (default-value 'python-indent))
468 (set (make-local-variable 'python-indent) indent)
469 (unless (= tab-width python-indent)
470 (setq indent-tabs-mode nil)))
473 ;; Alist of possible indentations and start of statement they would
474 ;; close. Used in indentation cycling (below).
475 (defvar python-indent-list nil
477 ;; Length of the above
478 (defvar python-indent-list-length nil
480 ;; Current index into the alist.
481 (defvar python-indent-index nil
484 (defun python-calculate-indentation ()
485 "Calculate Python indentation for line at point."
486 (setq python-indent-list nil
487 python-indent-list-length 1)
490 (let ((syntax (syntax-ppss))
493 ((eq 'string (syntax-ppss-context syntax)) ; multi-line string
494 (if (not python-indent-string-contents)
495 (current-indentation)
496 ;; Only respect `python-indent-string-contents' in doc
497 ;; strings (defined as those which form statements).
498 (if (not (save-excursion
499 (python-beginning-of-statement)
500 (looking-at (rx (or (syntax string-delimiter)
501 (syntax string-quote))))))
502 (current-indentation)
503 ;; Find indentation of preceding non-blank line within string.
504 (setq start (nth 8 syntax))
506 (while (and (< start (point)) (looking-at "\\s-*$"))
508 (current-indentation))))
509 ((python-continuation-line-p) ; after backslash, or bracketed
510 (let ((point (point))
511 (open-start (cadr syntax))
512 (backslash (python-backslash-continuation-line-p))
513 (colon (eq ?: (char-before (1- (line-beginning-position))))))
515 ;; Inside bracketed expression.
517 (goto-char (1+ open-start))
518 ;; Look for first item in list (preceding point) and
519 ;; align with it, if found.
520 (if (with-syntax-table python-space-backslash-table
521 (let ((parse-sexp-ignore-comments t))
523 (progn (forward-sexp)
527 ;; Extra level if we're backslash-continued or
529 (if (or backslash colon)
530 (+ python-indent (current-column))
532 ;; Otherwise indent relative to statement start, one
533 ;; level per bracketing level.
534 (goto-char (1+ open-start))
535 (python-beginning-of-statement)
536 (+ (current-indentation) (* (car syntax) python-indent))))
537 ;; Otherwise backslash-continued.
539 (if (python-continuation-line-p)
540 ;; We're past first continuation line. Align with
542 (current-indentation)
543 ;; First continuation line. Indent one step, with an
544 ;; extra one if statement opens a block.
545 (python-beginning-of-statement)
546 (+ (current-indentation) python-continuation-offset
547 (if (python-open-block-statement-p t)
551 ;; Fixme: Like python-mode.el; not convinced by this.
552 ((looking-at (rx (0+ space) (syntax comment-start)
553 (not (any " \t\n")))) ; non-indentable comment
554 (current-indentation))
555 (t (if python-honour-comment-indentation
556 ;; Back over whitespace, newlines, non-indentable comments.
560 ;; not at comment start
561 ((not (forward-comment -1))
562 (python-beginning-of-statement)
565 ((/= (current-column) (current-indentation))
566 (python-beginning-of-statement)
568 ;; indentable comment like python-mode.el
569 ((and (looking-at (rx (syntax comment-start)
570 (or space line-end)))
571 (/= 0 (current-column)))))
573 (python-indentation-levels)
574 ;; Prefer to indent comments with an immediately-following
579 (when (and (> python-indent-list-length 1)
580 (python-comment-line-p))
582 (unless (python-comment-line-p)
583 (let ((elt (assq (current-indentation) python-indent-list)))
584 (setq python-indent-list
585 (nconc (delete elt python-indent-list)
587 (caar (last python-indent-list)))))))
589 ;;;; Cycling through the possible indentations with successive TABs.
591 ;; These don't need to be buffer-local since they're only relevant
594 (defun python-initial-text ()
595 "Text of line following indentation and ignoring any trailing comment."
597 (buffer-substring (progn
598 (back-to-indentation)
605 (defconst python-block-pairs
606 '(("else" "if" "elif" "while" "for" "try" "except")
608 ("except" "try" "except")
610 "Alist of keyword matches.
611 The car of an element is a keyword introducing a statement which
612 can close a block opened by a keyword in the cdr.")
614 (defun python-first-word ()
615 "Return first word (actually symbol) on the line."
617 (back-to-indentation)
620 (defun python-indentation-levels ()
621 "Return a list of possible indentations for this line.
622 It is assumed not to be a continuation line or in a multi-line string.
623 Includes the default indentation and those which would close all
624 enclosing blocks. Elements of the list are actually pairs:
625 \(INDENTATION . TEXT), where TEXT is the initial text of the
626 corresponding block opening (or nil)."
630 ;; Only one possibility immediately following a block open
631 ;; statement, assuming it doesn't have a `suite' on the same line.
633 ((save-excursion (and (python-previous-statement)
634 (python-open-block-statement-p t)
635 (setq indent (current-indentation))
636 ;; Check we don't have something like:
638 (if (progn (python-end-of-statement)
639 (python-skip-comments/blanks t)
640 (eq ?: (char-before)))
641 (setq indent (+ python-indent indent)))))
642 (push (cons indent initial) levels))
643 ;; Only one possibility for comment line immediately following
646 (when (python-comment-line-p)
648 (if (python-comment-line-p)
649 (push (cons (current-indentation) initial) levels)))))
650 ;; Fixme: Maybe have a case here which indents (only) first
651 ;; line after a lambda.
653 (let ((start (car (assoc (python-first-word) python-block-pairs))))
654 (python-previous-statement)
655 ;; Is this a valid indentation for the line of interest?
656 (unless (or (if start ; potentially only outdentable
657 ;; Check for things like:
660 ;; where the second line need not be outdented.
661 (not (member (python-first-word)
663 python-block-pairs)))))
664 ;; Not sensible to indent to the same level as
665 ;; previous `return' &c.
666 (python-close-block-statement-p))
667 (push (cons (current-indentation) (python-initial-text))
669 (while (python-beginning-of-block)
670 (when (or (not start)
671 (member (python-first-word)
672 (cdr (assoc start python-block-pairs))))
673 (push (cons (current-indentation) (python-initial-text))
675 (prog1 (or levels (setq levels '((0 . ""))))
676 (setq python-indent-list levels
677 python-indent-list-length (length python-indent-list))))))
679 ;; This is basically what `python-indent-line' would be if we didn't
681 (defun python-indent-line-1 (&optional leave)
682 "Subroutine of `python-indent-line'.
683 Does non-repeated indentation. LEAVE non-nil means leave
684 indentation if it is valid, i.e. one of the positions returned by
685 `python-calculate-indentation'."
686 (let ((target (python-calculate-indentation))
687 (pos (- (point-max) (point))))
688 (if (or (= target (current-indentation))
689 ;; Maybe keep a valid indentation.
690 (and leave python-indent-list
691 (assq (current-indentation) python-indent-list)))
692 (if (< (current-column) (current-indentation))
693 (back-to-indentation))
695 (delete-horizontal-space)
697 (if (> (- (point-max) pos) (point))
698 (goto-char (- (point-max) pos))))))
700 (defun python-indent-line ()
701 "Indent current line as Python code.
702 When invoked via `indent-for-tab-command', cycle through possible
703 indentations for current line. The cycle is broken by a command
704 different from `indent-for-tab-command', i.e. successive TABs do
707 (if (and (eq this-command 'indent-for-tab-command)
708 (eq last-command this-command))
709 (if (= 1 python-indent-list-length)
710 (message "Sole indentation")
711 (progn (setq python-indent-index
712 (% (1+ python-indent-index) python-indent-list-length))
714 (delete-horizontal-space)
715 (indent-to (car (nth python-indent-index python-indent-list)))
716 (if (python-block-end-p)
717 (let ((text (cdr (nth python-indent-index
718 python-indent-list))))
720 (message "Closes: %s" text))))))
721 (python-indent-line-1)
722 (setq python-indent-index (1- python-indent-list-length))))
724 (defun python-indent-region (start end)
725 "`indent-region-function' for Python.
726 Leaves validly-indented lines alone, i.e. doesn't indent to
727 another valid position."
730 (setq end (point-marker))
732 (or (bolp) (forward-line 1))
733 (while (< (point) end)
734 (or (and (bolp) (eolp))
735 (python-indent-line-1 t))
737 (move-marker end nil)))
739 (defun python-block-end-p ()
740 "Non-nil if this is a line in a statement closing a block,
741 or a blank line indented to where it would close a block."
742 (and (not (python-comment-line-p))
743 (or (python-close-block-statement-p t)
744 (< (current-indentation)
746 (python-previous-statement)
747 (current-indentation))))))
751 ;; Fixme: Define {for,back}ward-sexp-function? Maybe skip units like
752 ;; block, statement, depending on context.
754 (defun python-beginning-of-defun ()
755 "`beginning-of-defun-function' for Python.
756 Finds beginning of innermost nested class or method definition.
757 Returns the name of the definition found at the end, or nil if
758 reached start of buffer."
759 (let ((ci (current-indentation))
760 (def-re (rx line-start (0+ space) (or "def" "class") (1+ space)
761 (group (1+ (or word (syntax symbol))))))
762 found lep) ;; def-line
763 (if (python-comment-line-p)
764 (setq ci most-positive-fixnum))
765 (while (and (not (bobp)) (not found))
766 ;; Treat bol at beginning of function as outside function so
767 ;; that successive C-M-a makes progress backwards.
768 ;;(setq def-line (looking-at def-re))
769 (unless (bolp) (end-of-line))
770 (setq lep (line-end-position))
771 (if (and (re-search-backward def-re nil 'move)
772 ;; Must be less indented or matching top level, or
773 ;; equally indented if we started on a definition line.
774 (let ((in (current-indentation)))
775 (or (and (zerop ci) (zerop in))
776 (= lep (line-end-position)) ; on initial line
777 ;; Not sure why it was like this -- fails in case of
778 ;; last internal function followed by first
779 ;; non-def statement of the main body.
780 ;;(and def-line (= in ci))
783 (not (python-in-string/comment)))
786 (defun python-end-of-defun ()
787 "`end-of-defun-function' for Python.
788 Finds end of innermost nested class or method definition."
790 (pattern (rx line-start (0+ space) (or "def" "class") space)))
791 ;; Go to start of current block and check whether it's at top
792 ;; level. If it is, and not a block start, look forward for
793 ;; definition statement.
794 (when (python-comment-line-p)
796 (forward-comment most-positive-fixnum))
797 (if (not (python-open-block-statement-p))
798 (python-beginning-of-block))
799 (if (zerop (current-indentation))
800 (unless (python-open-block-statement-p)
801 (while (and (re-search-forward pattern nil 'move)
802 (python-in-string/comment))) ; just loop
804 (beginning-of-line)))
805 ;; Don't move before top-level statement that would end defun.
807 (python-beginning-of-defun))
808 ;; If we got to the start of buffer, look forward for
809 ;; definition statement.
810 (if (and (bobp) (not (looking-at "def\\|class")))
811 (while (and (not (eobp))
812 (re-search-forward pattern nil 'move)
813 (python-in-string/comment)))) ; just loop
814 ;; We're at a definition statement (or end-of-buffer).
816 (python-end-of-block)
817 ;; Count trailing space in defun (but not trailing comments).
818 (skip-syntax-forward " >")
819 (unless (eobp) ; e.g. missing final newline
820 (beginning-of-line)))
821 ;; Catch pathological cases like this, where the beginning-of-defun
822 ;; skips to a definition we're not in:
830 (goto-char (point-max)))))
832 (defun python-beginning-of-statement ()
833 "Go to start of current statement.
834 Accounts for continuation lines, multi-line strings, and
835 multi-line bracketed expressions."
837 (python-beginning-of-string)
838 (while (python-continuation-line-p)
840 (if (python-backslash-continuation-line-p)
843 (while (python-backslash-continuation-line-p)
845 (python-beginning-of-string)
847 (back-to-indentation))
849 (defun python-skip-out (&optional forward syntax)
850 "Skip out of any nested brackets.
851 Skip forward if FORWARD is non-nil, else backward.
852 If SYNTAX is non-nil it is the state returned by `syntax-ppss' at point.
853 Return non-nil iff skipping was done."
854 (let ((depth (syntax-ppss-depth (or syntax (syntax-ppss))))
855 (forward (if forward -1 1)))
856 (unless (zerop depth)
858 ;; Skip forward out of nested brackets.
859 (condition-case () ; beware invalid syntax
860 (progn (backward-up-list (* forward depth)) t)
862 ;; Invalid syntax (too many closed brackets).
863 ;; Skip out of as many as possible.
865 (while (condition-case ()
866 (progn (backward-up-list forward)
871 (defun python-end-of-statement ()
872 "Go to the end of the current statement and return point.
873 Usually this is the start of the next line, but if this is a
874 multi-line statement we need to skip over the continuation lines.
875 On a comment line, go to end of line."
877 (while (let (comment)
878 ;; Move past any enclosing strings and sexps, or stop if
879 ;; we're in a comment.
880 (while (let ((s (syntax-ppss)))
881 (cond ((eq 'comment (syntax-ppss-context s))
884 ((eq 'string (syntax-ppss-context s))
885 ;; Go to start of string and skip it.
887 (goto-char (nth 8 s))
888 (condition-case () ; beware invalid syntax
889 (progn (forward-sexp) t)
890 ;; If there's a mismatched string, make sure
891 ;; we still overall move *forward*.
892 (error (goto-char pos) (end-of-line)))))
893 ((python-skip-out t s))))
896 (eq ?\\ (char-before)))) ; Line continued?
897 (end-of-line 2)) ; Try next line.
900 (defun python-previous-statement (&optional count)
901 "Go to start of previous statement.
902 With argument COUNT, do it COUNT times. Stop at beginning of buffer.
903 Return count of statements left to move."
905 (unless count (setq count 1))
907 (python-next-statement (- count))
908 (python-beginning-of-statement)
909 (while (and (> count 0) (not (bobp)))
910 (python-skip-comments/blanks t)
911 (python-beginning-of-statement)
912 (unless (bobp) (setq count (1- count))))
915 (defun python-next-statement (&optional count)
916 "Go to start of next statement.
917 With argument COUNT, do it COUNT times. Stop at end of buffer.
918 Return count of statements left to move."
920 (unless count (setq count 1))
922 (python-previous-statement (- count))
924 (while (and (> count 0) (not (eobp)))
925 (python-end-of-statement)
926 (python-skip-comments/blanks)
928 (setq count (1- count))))
931 (defun python-beginning-of-block (&optional arg)
932 "Go to start of current block.
933 With numeric arg, do it that many times. If ARG is negative, call
934 `python-end-of-block' instead.
935 If point is on the first line of a block, use its outer block.
936 If current statement is in column zero, don't move and return nil.
937 Otherwise return non-nil."
939 (unless arg (setq arg 1))
942 ((< arg 0) (python-end-of-block (- arg)))
944 (let ((point (point)))
945 (if (or (python-comment-line-p)
946 (python-blank-line-p))
947 (python-skip-comments/blanks t))
948 (python-beginning-of-statement)
949 (let ((ci (current-indentation)))
951 (not (goto-char point)) ; return nil
952 ;; Look upwards for less indented statement.
954 ;;; This is slower than the below.
955 ;;; (while (zerop (python-previous-statement))
956 ;;; (when (and (< (current-indentation) ci)
957 ;;; (python-open-block-statement-p t))
958 ;;; (beginning-of-line)
959 ;;; (throw 'done t)))
960 (while (and (zerop (forward-line -1)))
961 (when (and (< (current-indentation) ci)
962 (not (python-comment-line-p))
963 ;; Move to beginning to save effort in case
964 ;; this is in string.
965 (progn (python-beginning-of-statement) t)
966 (python-open-block-statement-p t))
969 (not (goto-char point))) ; Failed -- return nil
970 (python-beginning-of-block (1- arg)))))))))
972 (defun python-end-of-block (&optional arg)
973 "Go to end of current block.
974 With numeric arg, do it that many times. If ARG is negative,
975 call `python-beginning-of-block' instead.
976 If current statement is in column zero and doesn't open a block,
977 don't move and return nil. Otherwise return t."
979 (unless arg (setq arg 1))
981 (python-beginning-of-block (- arg))
982 (while (and (> arg 0)
983 (let* ((point (point))
984 (_ (if (python-comment-line-p)
985 (python-skip-comments/blanks t)))
986 (ci (current-indentation))
987 (open (python-open-block-statement-p)))
988 (if (and (zerop ci) (not open))
989 (not (goto-char point))
991 (while (zerop (python-next-statement))
992 (when (or (and open (<= (current-indentation) ci))
993 (< (current-indentation) ci))
994 (python-skip-comments/blanks t)
995 (beginning-of-line 2)
996 (throw 'done t)))))))
1002 (defvar python-recursing)
1003 (defun python-imenu-create-index ()
1004 "`imenu-create-index-function' for Python.
1006 Makes nested Imenu menus from nested `class' and `def' statements.
1007 The nested menus are headed by an item referencing the outer
1008 definition; it has a space prepended to the name so that it sorts
1009 first with `imenu--sort-by-name' (though, unfortunately, sub-menus
1011 (unless (boundp 'python-recursing) ; dynamically bound below
1012 ;; Normal call from Imenu.
1013 (goto-char (point-min))
1014 ;; Without this, we can get an infloop if the buffer isn't all
1015 ;; fontified. I guess this is really a bug in syntax.el. OTOH,
1016 ;; _with_ this, imenu doesn't immediately work; I can't figure out
1017 ;; what's going on, but it must be something to do with timers in
1019 ;; This can't be right, especially not when jit-lock is not used. --Stef
1020 ;; (unless (get-text-property (1- (point-max)) 'fontified)
1021 ;; (font-lock-fontify-region (point-min) (point-max)))
1023 (let (index-alist) ; accumulated value to return
1024 (while (re-search-forward
1025 (rx line-start (0+ space) ; leading space
1026 (or (group "def") (group "class")) ; type
1027 (1+ space) (group (1+ (or word ?_)))) ; name
1029 (unless (python-in-string/comment)
1030 (let ((pos (match-beginning 0))
1031 (name (match-string-no-properties 3)))
1032 (if (match-beginning 2) ; def or class?
1033 (setq name (concat "class " name)))
1036 (let* ((python-recursing t)
1037 (sublist (python-imenu-create-index)))
1039 (progn (push (cons (concat " " name) pos) sublist)
1040 (push (cons name sublist) index-alist))
1041 (push (cons name pos) index-alist)))))))
1042 (unless (boundp 'python-recursing)
1043 ;; Look for module variables.
1045 (goto-char (point-min))
1046 (while (re-search-forward
1047 (rx line-start (group (1+ (or word ?_))) (0+ space) "=")
1049 (unless (python-in-string/comment)
1050 (push (cons (match-string 1) (match-beginning 1))
1052 (setq index-alist (nreverse index-alist))
1054 (push (cons "Module variables"
1059 ;;;; `Electric' commands.
1061 (defun python-electric-colon (arg)
1062 "Insert a colon and maybe outdent the line if it is a statement like `else'.
1063 With numeric ARG, just insert that many colons. With \\[universal-argument],
1064 just insert a single colon."
1066 (self-insert-command (if (not (integerp arg)) 1 arg))
1070 (not (python-in-string/comment))
1071 (> (current-indentation) (python-calculate-indentation))
1072 (python-indent-line))) ; OK, do it
1073 (put 'python-electric-colon 'delete-selection t)
1075 (defun python-backspace (arg)
1076 "Maybe delete a level of indentation on the current line.
1077 Do so if point is at the end of the line's indentation.
1078 Otherwise just call `backward-delete-char-untabify'.
1081 (if (or (/= (current-indentation) (current-column))
1083 (python-continuation-line-p))
1084 (backward-delete-char-untabify arg)
1085 ;; Look for the largest valid indentation which is smaller than
1086 ;; the current indentation.
1088 (ci (current-indentation))
1089 (indents (python-indentation-levels))
1093 (setq indent (max indent (car x)))))
1094 (setq initial (cdr (assq indent indents)))
1095 (if (> (length initial) 0)
1096 (message "Closes %s" initial))
1097 (delete-horizontal-space)
1098 (indent-to indent))))
1099 (put 'python-backspace 'delete-selection 'supersede)
1103 (defcustom python-check-command "pychecker --stdlib"
1104 "Command used to check a Python file."
1108 (defvar python-saved-check-command nil
1111 ;; After `sgml-validate-command'.
1112 (defun python-check (command)
1113 "Check a Python file (default current buffer's file).
1114 Runs COMMAND, a shell command, as if by `compile'.
1115 See `python-check-command' for the default."
1117 (list (read-string "Checker command: "
1118 (or python-saved-check-command
1119 (concat python-check-command " "
1120 (let ((name (buffer-file-name)))
1122 (file-name-nondirectory name))))))))
1123 (setq python-saved-check-command command)
1124 (require 'compile) ;To define compilation-* variables.
1125 (save-some-buffers (not compilation-ask-about-save) nil)
1126 (let ((compilation-error-regexp-alist
1127 (cons '("(\\([^,]+\\), line \\([0-9]+\\))" 1 2)
1128 compilation-error-regexp-alist)))
1129 (compilation-start command)))
1131 ;;;; Inferior mode stuff (following cmuscheme).
1133 ;; Fixme: Make sure we can work with IPython.
1135 (defcustom python-python-command "python"
1136 "Shell command to run Python interpreter.
1137 Any arguments can't contain whitespace.
1138 Note that IPython may not work properly; it must at least be used
1139 with the `-cl' flag, i.e. use `ipython -cl'."
1143 (defcustom python-jython-command "jython"
1144 "Shell command to run Jython interpreter.
1145 Any arguments can't contain whitespace."
1149 (defvar python-command python-python-command
1150 "Actual command used to run Python.
1151 May be `python-python-command' or `python-jython-command', possibly
1152 modified by the user. Additional arguments are added when the command
1153 is used by `run-python' et al.")
1155 (defvar python-buffer nil
1156 "*The current Python process buffer.
1158 Commands that send text from source buffers to Python processes have
1159 to choose a process to send to. This is determined by buffer-local
1160 value of `python-buffer'. If its value in the current buffer,
1161 i.e. both any local value and the default one, is nil, `run-python'
1162 and commands that send to the Python process will start a new process.
1164 Whenever \\[run-python] starts a new process, it resets the default
1165 value of `python-buffer' to be the new process's buffer and sets the
1166 buffer-local value similarly if the current buffer is in Python mode
1167 or Inferior Python mode, so that source buffer stays associated with a
1168 specific sub-process.
1170 Use \\[python-set-proc] to set the default value from a buffer with a
1172 (make-variable-buffer-local 'python-buffer)
1174 (defconst python-compilation-regexp-alist
1175 ;; FIXME: maybe these should move to compilation-error-regexp-alist-alist.
1176 ;; The first already is (for CAML), but the second isn't. Anyhow,
1177 ;; these are specific to the inferior buffer. -- fx
1178 `((,(rx line-start (1+ (any " \t")) "File \""
1179 (group (1+ (not (any "\"<")))) ; avoid `<stdin>' &c
1180 "\", line " (group (1+ digit)))
1182 (,(rx " in file " (group (1+ not-newline)) " on line "
1185 "`compilation-error-regexp-alist' for inferior Python.")
1187 (defvar inferior-python-mode-map
1188 (let ((map (make-sparse-keymap)))
1189 ;; This will inherit from comint-mode-map.
1190 (define-key map "\C-c\C-l" 'python-load-file)
1191 (define-key map "\C-c\C-v" 'python-check)
1192 ;; Note that we _can_ still use these commands which send to the
1193 ;; Python process even at the prompt iff we have a normal prompt,
1194 ;; i.e. '>>> ' and not '... '. See the comment before
1195 ;; python-send-region. Fixme: uncomment these if we address that.
1197 ;; (define-key map [(meta ?\t)] 'python-complete-symbol)
1198 ;; (define-key map "\C-c\C-f" 'python-describe-symbol)
1201 (defvar inferior-python-mode-syntax-table
1202 (let ((st (make-syntax-table python-mode-syntax-table)))
1203 ;; Don't get confused by apostrophes in the process's output (e.g. if
1204 ;; you execute "help(os)").
1205 (modify-syntax-entry ?\' "." st)
1206 ;; Maybe we should do the same for double quotes?
1207 ;; (modify-syntax-entry ?\" "." st)
1210 ;; Fixme: This should inherit some stuff from `python-mode', but I'm
1211 ;; not sure how much: at least some keybindings, like C-c C-f;
1212 ;; syntax?; font-locking, e.g. for triple-quoted strings?
1213 (define-derived-mode inferior-python-mode comint-mode "Inferior Python"
1214 "Major mode for interacting with an inferior Python process.
1215 A Python process can be started with \\[run-python].
1217 Hooks `comint-mode-hook' and `inferior-python-mode-hook' are run in
1220 You can send text to the inferior Python process from other buffers
1221 containing Python source.
1222 * \\[python-switch-to-python] switches the current buffer to the Python
1224 * \\[python-send-region] sends the current region to the Python process.
1225 * \\[python-send-region-and-go] switches to the Python process buffer
1226 after sending the text.
1227 For running multiple processes in multiple buffers, see `run-python' and
1230 \\{inferior-python-mode-map}"
1232 (setq mode-line-process '(":%s"))
1233 (set (make-local-variable 'comint-input-filter) 'python-input-filter)
1234 (add-hook 'comint-preoutput-filter-functions #'python-preoutput-filter
1236 ;; Still required by `comint-redirect-send-command', for instance
1237 ;; (and we need to match things like `>>> ... >>> '):
1238 (set (make-local-variable 'comint-prompt-regexp)
1239 (rx line-start (1+ (and (repeat 3 (any ">.")) " "))))
1240 (set (make-local-variable 'compilation-error-regexp-alist)
1241 python-compilation-regexp-alist)
1242 (compilation-shell-minor-mode 1))
1244 (defcustom inferior-python-filter-regexp "\\`\\s-*\\S-?\\S-?\\s-*\\'"
1245 "Input matching this regexp is not saved on the history list.
1246 Default ignores all inputs of 0, 1, or 2 non-blank characters."
1250 (defun python-input-filter (str)
1251 "`comint-input-filter' function for inferior Python.
1252 Don't save anything for STR matching `inferior-python-filter-regexp'."
1253 (not (string-match inferior-python-filter-regexp str)))
1255 ;; Fixme: Loses with quoted whitespace.
1256 (defun python-args-to-list (string)
1257 (let ((where (string-match "[ \t]" string)))
1258 (cond ((null where) (list string))
1260 (cons (substring string 0 where)
1261 (python-args-to-list (substring string (+ 1 where)))))
1262 (t (let ((pos (string-match "[^ \t]" string)))
1263 (if pos (python-args-to-list (substring string pos))))))))
1265 (defvar python-preoutput-result nil
1266 "Data from last `_emacs_out' line seen by the preoutput filter.")
1268 (defvar python-preoutput-leftover nil)
1269 (defvar python-preoutput-skip-next-prompt nil)
1271 ;; Using this stops us getting lines in the buffer like
1273 (defun python-preoutput-filter (s)
1274 "`comint-preoutput-filter-functions' function: ignore prompts not at bol."
1275 (when python-preoutput-leftover
1276 (setq s (concat python-preoutput-leftover s))
1277 (setq python-preoutput-leftover nil))
1280 ;; First process whole lines.
1281 (while (string-match "\n" s start)
1282 (let ((line (substring s start (setq start (match-end 0)))))
1283 ;; Skip prompt if needed.
1284 (when (and python-preoutput-skip-next-prompt
1285 (string-match comint-prompt-regexp line))
1286 (setq python-preoutput-skip-next-prompt nil)
1287 (setq line (substring line (match-end 0))))
1288 ;; Recognize special _emacs_out lines.
1289 (if (and (string-match "\\`_emacs_out \\(.*\\)\n\\'" line)
1290 (local-variable-p 'python-preoutput-result))
1292 (setq python-preoutput-result (match-string 1 line))
1293 (set (make-local-variable 'python-preoutput-skip-next-prompt) t))
1294 (setq res (concat res line)))))
1295 ;; Then process the remaining partial line.
1296 (unless (zerop start) (setq s (substring s start)))
1297 (cond ((and (string-match comint-prompt-regexp s)
1298 ;; Drop this prompt if it follows an _emacs_out...
1299 (or python-preoutput-skip-next-prompt
1300 ;; ... or if it's not gonna be inserted at BOL.
1301 ;; Maybe we could be more selective here.
1302 (if (zerop (length res))
1304 (string-match ".\\'" res))))
1305 ;; The need for this seems to be system-dependent:
1306 ;; What is this all about, exactly? --Stef
1307 ;; (if (and (eq ?. (aref s 0)))
1308 ;; (accept-process-output (get-buffer-process (current-buffer)) 1))
1309 (setq python-preoutput-skip-next-prompt nil)
1311 ((let ((end (min (length "_emacs_out ") (length s))))
1312 (eq t (compare-strings s nil end "_emacs_out " nil end)))
1313 ;; The leftover string is a prefix of _emacs_out so we don't know
1314 ;; yet whether it's an _emacs_out or something else: wait until we
1315 ;; get more output so we can resolve this ambiguity.
1316 (set (make-local-variable 'python-preoutput-leftover) s)
1318 (t (concat res s)))))
1320 (autoload 'comint-check-proc "comint")
1323 (defun run-python (&optional cmd noshow new)
1324 "Run an inferior Python process, input and output via buffer *Python*.
1325 CMD is the Python command to run. NOSHOW non-nil means don't show the
1326 buffer automatically.
1328 Normally, if there is a process already running in `python-buffer',
1329 switch to that buffer. Interactively, a prefix arg allows you to edit
1330 the initial command line (default is `python-command'); `-i' etc. args
1331 will be added to this as appropriate. A new process is started if:
1332 one isn't running attached to `python-buffer', or interactively the
1333 default `python-command', or argument NEW is non-nil. See also the
1334 documentation for `python-buffer'.
1336 Runs the hook `inferior-python-mode-hook' \(after the
1337 `comint-mode-hook' is run). \(Type \\[describe-mode] in the process
1338 buffer for a list of commands.)"
1339 (interactive (if current-prefix-arg
1340 (list (read-string "Run Python: " python-command) nil t)
1341 (list python-command)))
1342 (unless cmd (setq cmd python-python-command))
1343 (setq python-command cmd)
1344 ;; Fixme: Consider making `python-buffer' buffer-local as a buffer
1345 ;; (not a name) in Python buffers from which `run-python' &c is
1346 ;; invoked. Would support multiple processes better.
1347 (when (or new (not (comint-check-proc python-buffer)))
1348 (with-current-buffer
1349 (let* ((cmdlist (append (python-args-to-list cmd) '("-i")))
1350 (path (getenv "PYTHONPATH"))
1351 (process-environment ; to import emacs.py
1352 (cons (concat "PYTHONPATH=" data-directory
1353 (if path (concat ":" path)))
1354 process-environment)))
1355 (apply 'make-comint-in-buffer "Python"
1356 (if new (generate-new-buffer "*Python*") "*Python*")
1357 (car cmdlist) nil (cdr cmdlist)))
1358 (setq-default python-buffer (current-buffer))
1359 (setq python-buffer (current-buffer))
1360 (accept-process-output (get-buffer-process python-buffer) 5)
1361 (inferior-python-mode)
1362 ;; Load function definitions we need.
1363 ;; Before the preoutput function was used, this was done via -c in
1364 ;; cmdlist, but that loses the banner and doesn't run the startup
1365 ;; file. The code might be inline here, but there's enough that it
1366 ;; seems worth putting in a separate file, and it's probably cleaner
1367 ;; to put it in a module.
1368 ;; Ensure we're at a prompt before doing anything else.
1369 (python-send-receive "import emacs; print '_emacs_out ()'")))
1370 (if (derived-mode-p 'python-mode)
1371 (setq python-buffer (default-value 'python-buffer))) ; buffer-local
1372 ;; Without this, help output goes into the inferior python buffer if
1373 ;; the process isn't already running.
1374 (sit-for 1 t) ;Should we use accept-process-output instead? --Stef
1375 (unless noshow (pop-to-buffer python-buffer t)))
1377 ;; Fixme: We typically lose if the inferior isn't in the normal REPL,
1378 ;; e.g. prompt is `help> '. Probably raise an error if the form of
1379 ;; the prompt is unexpected. Actually, it needs to be `>>> ', not
1380 ;; `... ', i.e. we're not inputting a block &c. However, this may not
1381 ;; be the place to check it, e.g. we might actually want to send
1382 ;; commands having set up such a state.
1384 (defun python-send-command (command)
1385 "Like `python-send-string' but resets `compilation-shell-minor-mode'.
1386 COMMAND should be a single statement."
1387 ;; (assert (not (string-match "\n" command)))
1388 ;; (let ((end (marker-position (process-mark (python-proc)))))
1389 (with-current-buffer (process-buffer (python-proc))
1390 (goto-char (point-max))
1391 (compilation-forget-errors)
1392 (python-send-string command)
1393 (setq compilation-last-buffer (current-buffer)))
1394 ;; No idea what this is for but it breaks the call to
1395 ;; compilation-fake-loc in python-send-region. -- Stef
1396 ;; Must wait until this has completed before re-setting variables below.
1397 ;; (python-send-receive "print '_emacs_out ()'")
1398 ;; (with-current-buffer python-buffer
1399 ;; (set-marker compilation-parsing-end end))
1402 (defun python-send-region (start end)
1403 "Send the region to the inferior Python process."
1404 ;; The region is evaluated from a temporary file. This avoids
1405 ;; problems with blank lines, which have different semantics
1406 ;; interactively and in files. It also saves the inferior process
1407 ;; buffer filling up with interpreter prompts. We need a Python
1408 ;; function to remove the temporary file when it has been evaluated
1409 ;; (though we could probably do it in Lisp with a Comint output
1410 ;; filter). This function also catches exceptions and truncates
1411 ;; tracebacks not to mention the frame of the function itself.
1413 ;; The `compilation-shell-minor-mode' parsing takes care of relating
1414 ;; the reference to the temporary file to the source.
1416 ;; Fixme: Write a `coding' header to the temp file if the region is
1419 (let* ((f (make-temp-file "py"))
1420 (command (format "emacs.eexecfile(%S)" f))
1421 (orig-start (copy-marker start)))
1422 (when (save-excursion
1424 (/= 0 (current-indentation))) ; need dummy block
1426 (goto-char orig-start)
1427 ;; Wrong if we had indented code at buffer start.
1428 (set-marker orig-start (line-beginning-position 0)))
1429 (write-region "if True:\n" nil f nil 'nomsg))
1430 (write-region start end f t 'nomsg)
1431 (python-send-command command)
1432 (with-current-buffer (process-buffer (python-proc))
1433 ;; Tell compile.el to redirect error locations in file `f' to
1434 ;; positions past marker `orig-start'. It has to be done *after*
1435 ;; `python-send-command''s call to `compilation-forget-errors'.
1436 (compilation-fake-loc orig-start f))))
1438 (defun python-send-string (string)
1439 "Evaluate STRING in inferior Python process."
1440 (interactive "sPython command: ")
1441 (comint-send-string (python-proc) string)
1442 (unless (string-match "\n\\'" string)
1443 ;; Make sure the text is properly LF-terminated.
1444 (comint-send-string (python-proc) "\n"))
1445 (when (string-match "\n[ \t].*\n?\\'" string)
1446 ;; If the string contains a final indented line, add a second newline so
1447 ;; as to make sure we terminate the multiline instruction.
1448 (comint-send-string (python-proc) "\n")))
1450 (defun python-send-buffer ()
1451 "Send the current buffer to the inferior Python process."
1453 (python-send-region (point-min) (point-max)))
1455 ;; Fixme: Try to define the function or class within the relevant
1456 ;; module, not just at top level.
1457 (defun python-send-defun ()
1458 "Send the current defun (class or method) to the inferior Python process."
1460 (save-excursion (python-send-region (progn (beginning-of-defun) (point))
1461 (progn (end-of-defun) (point)))))
1463 (defun python-switch-to-python (eob-p)
1464 "Switch to the Python process buffer, maybe starting new process.
1465 With prefix arg, position cursor at end of buffer."
1467 (pop-to-buffer (process-buffer (python-proc)) t) ;Runs python if needed.
1470 (goto-char (point-max))))
1472 (defun python-send-region-and-go (start end)
1473 "Send the region to the inferior Python process.
1474 Then switch to the process buffer."
1476 (python-send-region start end)
1477 (python-switch-to-python t))
1479 (defcustom python-source-modes '(python-mode jython-mode)
1480 "Used to determine if a buffer contains Python source code.
1481 If a file is loaded into a buffer that is in one of these major modes,
1482 it is considered Python source by `python-load-file', which uses the
1483 value to determine defaults."
1484 :type '(repeat function)
1487 (defvar python-prev-dir/file nil
1488 "Caches (directory . file) pair used in the last `python-load-file' command.
1489 Used for determining the default in the next one.")
1491 (autoload 'comint-get-source "comint")
1493 (defun python-load-file (file-name)
1494 "Load a Python file FILE-NAME into the inferior Python process.
1495 If the file has extension `.py' import or reload it as a module.
1496 Treating it as a module keeps the global namespace clean, provides
1497 function location information for debugging, and supports users of
1498 module-qualified names."
1499 (interactive (comint-get-source "Load Python file: " python-prev-dir/file
1501 t)) ; because execfile needs exact name
1502 (comint-check-source file-name) ; Check to see if buffer needs saving.
1503 (setq python-prev-dir/file (cons (file-name-directory file-name)
1504 (file-name-nondirectory file-name)))
1505 (with-current-buffer (process-buffer (python-proc)) ;Runs python if needed.
1506 ;; Fixme: I'm not convinced by this logic from python-mode.el.
1507 (python-send-command
1508 (if (string-match "\\.py\\'" file-name)
1509 (let ((module (file-name-sans-extension
1510 (file-name-nondirectory file-name))))
1511 (format "emacs.eimport(%S,%S)"
1512 module (file-name-directory file-name)))
1513 (format "execfile(%S)" file-name)))
1514 (message "%s loaded" file-name)))
1516 (defun python-proc ()
1517 "Return the current Python process.
1518 See variable `python-buffer'. Starts a new process if necessary."
1519 ;; Fixme: Maybe should look for another active process if there
1520 ;; isn't one for `python-buffer'.
1521 (unless (comint-check-proc python-buffer)
1523 (get-buffer-process (if (derived-mode-p 'inferior-python-mode)
1527 (defun python-set-proc ()
1528 "Set the default value of `python-buffer' to correspond to this buffer.
1529 If the current buffer has a local value of `python-buffer', set the
1530 default (global) value to that. The associated Python process is
1531 the one that gets input from \\[python-send-region] et al when used
1532 in a buffer that doesn't have a local value of `python-buffer'."
1534 (if (local-variable-p 'python-buffer)
1535 (setq-default python-buffer python-buffer)
1536 (error "No local value of `python-buffer'")))
1538 ;;;; Context-sensitive help.
1540 (defconst python-dotty-syntax-table
1541 (let ((table (make-syntax-table)))
1542 (set-char-table-parent table python-mode-syntax-table)
1543 (modify-syntax-entry ?. "_" table)
1545 "Syntax table giving `.' symbol syntax.
1546 Otherwise inherits from `python-mode-syntax-table'.")
1548 (defvar view-return-to-alist)
1549 (eval-when-compile (autoload 'help-buffer "help-fns"))
1551 (defvar python-imports) ; forward declaration
1553 ;; Fixme: Should this actually be used instead of info-look, i.e. be
1554 ;; bound to C-h S? [Probably not, since info-look may work in cases
1555 ;; where this doesn't.]
1556 (defun python-describe-symbol (symbol)
1557 "Get help on SYMBOL using `help'.
1558 Interactively, prompt for symbol.
1560 Symbol may be anything recognized by the interpreter's `help'
1561 command -- e.g. `CALLS' -- not just variables in scope in the
1562 interpreter. This only works for Python version 2.2 or newer
1563 since earlier interpreters don't support `help'.
1565 In some cases where this doesn't find documentation, \\[info-lookup-symbol]
1567 ;; Note that we do this in the inferior process, not a separate one, to
1568 ;; ensure the environment is appropriate.
1570 (let ((symbol (with-syntax-table python-dotty-syntax-table
1572 (enable-recursive-minibuffers t))
1573 (list (read-string (if symbol
1574 (format "Describe symbol (default %s): " symbol)
1575 "Describe symbol: ")
1577 (if (equal symbol "") (error "No symbol"))
1578 ;; Ensure we have a suitable help buffer.
1579 ;; Fixme: Maybe process `Related help topics' a la help xrefs and
1580 ;; allow C-c C-f in help buffer.
1581 (let ((temp-buffer-show-hook ; avoid xref stuff
1583 (toggle-read-only 1)
1584 (setq view-return-to-alist
1585 (list (cons (selected-window) help-return-method))))))
1586 (with-output-to-temp-buffer (help-buffer)
1587 (with-current-buffer standard-output
1588 ;; Fixme: Is this actually useful?
1589 (help-setup-xref (list 'python-describe-symbol symbol) (interactive-p))
1590 (set (make-local-variable 'comint-redirect-subvert-readonly) t)
1591 (print-help-return-message))))
1592 (comint-redirect-send-command-to-process (format "emacs.ehelp(%S, %s)"
1593 symbol python-imports)
1594 "*Help*" (python-proc) nil nil))
1596 (add-to-list 'debug-ignored-errors "^No symbol")
1598 (defun python-send-receive (string)
1599 "Send STRING to inferior Python (if any) and return result.
1600 The result is what follows `_emacs_out' in the output."
1601 (python-send-string string)
1602 (let ((proc (python-proc)))
1603 (with-current-buffer (process-buffer proc)
1604 (set (make-local-variable 'python-preoutput-result) nil)
1606 (accept-process-output proc 5)
1607 (null python-preoutput-result)))
1608 (prog1 python-preoutput-result
1609 (kill-local-variable 'python-preoutput-result)))))
1611 ;; Fixme: Is there anything reasonable we can do with random methods?
1612 ;; (Currently only works with functions.)
1613 (defun python-eldoc-function ()
1614 "`eldoc-print-current-symbol-info' for Python.
1615 Only works when point is in a function name, not its arg list, for
1616 instance. Assumes an inferior Python is running."
1617 (let ((symbol (with-syntax-table python-dotty-syntax-table
1619 ;; This is run from timers, so inhibit-quit tends to be set.
1621 ;; First try the symbol we're on.
1623 (python-send-receive (format "emacs.eargs(%S, %s)"
1624 symbol python-imports)))
1625 ;; Try moving to symbol before enclosing parens.
1626 (let ((s (syntax-ppss)))
1627 (unless (zerop (car s))
1628 (when (eq ?\( (char-after (nth 1 s)))
1630 (goto-char (nth 1 s))
1631 (skip-syntax-backward "-")
1632 (let ((point (point)))
1633 (skip-chars-backward "a-zA-Z._")
1634 (if (< (point) point)
1635 (python-send-receive
1636 (format "emacs.eargs(%S, %s)"
1637 (buffer-substring-no-properties (point) point)
1638 python-imports))))))))))))
1640 ;;;; Info-look functionality.
1642 (defun python-after-info-look ()
1643 "Set up info-look for Python.
1644 Used with `eval-after-load'."
1645 (let* ((version (let ((s (shell-command-to-string (concat python-command
1647 (string-match "^Python \\([0-9]+\\.[0-9]+\\>\\)" s)
1648 (match-string 1 s)))
1649 ;; Whether info files have a Python version suffix, e.g. in Debian.
1652 (with-no-warnings (Info-mode))
1654 ;; Don't use `info' because it would pop-up a *info* buffer.
1656 (Info-goto-node (format "(python%s-lib)Miscellaneous Index"
1660 (info-lookup-maybe-add-help
1662 :regexp "[[:alnum:]_]+"
1664 ;; Fixme: Can this reasonably be made specific to indices with
1665 ;; different rules? Is the order of indices optimal?
1666 ;; (Miscellaneous in -ref first prefers lookup of keywords, for
1669 ;; The empty prefix just gets us highlighted terms.
1670 `((,(concat "(python" version "-ref)Miscellaneous Index") nil "")
1671 (,(concat "(python" version "-ref)Module Index" nil ""))
1672 (,(concat "(python" version "-ref)Function-Method-Variable Index"
1674 (,(concat "(python" version "-ref)Class-Exception-Object Index"
1676 (,(concat "(python" version "-lib)Module Index" nil ""))
1677 (,(concat "(python" version "-lib)Class-Exception-Object Index"
1679 (,(concat "(python" version "-lib)Function-Method-Variable Index"
1681 (,(concat "(python" version "-lib)Miscellaneous Index" nil "")))
1682 '(("(python-ref)Miscellaneous Index" nil "")
1683 ("(python-ref)Module Index" nil "")
1684 ("(python-ref)Function-Method-Variable Index" nil "")
1685 ("(python-ref)Class-Exception-Object Index" nil "")
1686 ("(python-lib)Module Index" nil "")
1687 ("(python-lib)Class-Exception-Object Index" nil "")
1688 ("(python-lib)Function-Method-Variable Index" nil "")
1689 ("(python-lib)Miscellaneous Index" nil ""))))))
1690 (eval-after-load "info-look" '(python-after-info-look))
1694 (defcustom python-jython-packages '("java" "javax" "org" "com")
1695 "Packages implying `jython-mode'.
1696 If these are imported near the beginning of the buffer, `python-mode'
1697 actually punts to `jython-mode'."
1698 :type '(repeat string)
1701 ;; Called from `python-mode', this causes a recursive call of the
1702 ;; mode. See logic there to break out of the recursion.
1703 (defun python-maybe-jython ()
1704 "Invoke `jython-mode' if the buffer appears to contain Jython code.
1705 The criterion is either a match for `jython-mode' via
1706 `interpreter-mode-alist' or an import of a module from the list
1707 `python-jython-packages'."
1708 ;; The logic is taken from python-mode.el.
1712 (goto-char (point-min))
1713 (let ((interpreter (if (looking-at auto-mode-interpreter-regexp)
1715 (if (and interpreter (eq 'jython-mode
1716 (cdr (assoc (file-name-nondirectory
1718 interpreter-mode-alist))))
1721 (while (re-search-forward
1722 (rx line-start (or "import" "from") (1+ space)
1723 (group (1+ (not (any " \t\n.")))))
1724 (+ (point-min) 10000) ; Probably not worth customizing.
1726 (if (member (match-string 1) python-jython-packages)
1730 (defun python-fill-paragraph (&optional justify)
1731 "`fill-paragraph-function' handling comments and multi-line strings.
1732 If any of the current line is a comment, fill the comment or the
1733 paragraph of it that point is in, preserving the comment's
1734 indentation and initial comment characters. Similarly if the end
1735 of the current line is in or at the end of a multi-line string.
1736 Otherwise, do nothing."
1738 (or (fill-comment-paragraph justify)
1739 ;; The `paragraph-start' and `paragraph-separate' variables
1740 ;; don't allow us to delimit the last paragraph in a multi-line
1741 ;; string properly, so narrow to the string and then fill around
1742 ;; (the end of) the current line.
1745 (let* ((syntax (syntax-ppss))
1747 (start (nth 8 syntax))
1749 (cond ((eq t (nth 3 syntax)) ; in fenced string
1750 (goto-char (nth 8 syntax)) ; string start
1751 (setq end (condition-case () ; for unbalanced quotes
1752 (progn (forward-sexp) (point))
1753 (error (point-max)))))
1754 ((re-search-backward "\\s|\\s-*\\=" nil t) ; end of fenced
1759 (progn (backward-sexp)
1760 (setq start (point)))
1761 (error (setq end nil)))))
1764 (narrow-to-region start end)
1766 (let ((paragraph-separate
1767 ;; Make sure that fenced-string delimiters that stand
1768 ;; on their own line stay there.
1769 (concat "[ \t]*['\"]+[ \t]*$\\|" paragraph-separate)))
1770 (fill-paragraph justify))))))
1773 (defun python-shift-left (start end &optional count)
1774 "Shift lines in region COUNT (the prefix arg) columns to the left.
1775 COUNT defaults to `python-indent'. If region isn't active, just shift
1776 current line. The region shifted includes the lines in which START and
1777 END lie. It is an error if any lines in the region are indented less than
1779 (interactive (if mark-active
1780 (list (region-beginning) (region-end) current-prefix-arg)
1781 (list (point) (point) current-prefix-arg)))
1783 (setq count (prefix-numeric-value count))
1784 (setq count python-indent))
1788 (while (< (point) end)
1789 (if (and (< (current-indentation) count)
1790 (not (looking-at "[ \t]*$")))
1791 (error "Can't shift all lines enough"))
1793 (indent-rigidly start end (- count)))))
1795 (add-to-list 'debug-ignored-errors "^Can't shift all lines enough")
1797 (defun python-shift-right (start end &optional count)
1798 "Shift lines in region COUNT (the prefix arg) columns to the right.
1799 COUNT defaults to `python-indent'. If region isn't active, just shift
1800 current line. The region shifted includes the lines in which START and
1802 (interactive (if mark-active
1803 (list (region-beginning) (region-end) current-prefix-arg)
1804 (list (point) (point) current-prefix-arg)))
1806 (setq count (prefix-numeric-value count))
1807 (setq count python-indent))
1808 (indent-rigidly start end count))
1810 (defun python-outline-level ()
1811 "`outline-level' function for Python mode.
1812 The level is the number of `python-indent' steps of indentation
1814 (1+ (/ (current-indentation) python-indent)))
1816 ;; Fixme: Consider top-level assignments, imports, &c.
1817 (defun python-current-defun ()
1818 "`add-log-current-defun-function' for Python."
1820 ;; Move up the tree of nested `class' and `def' blocks until we
1821 ;; get to zero indentation, accumulating the defined names.
1824 (while (or start (> (current-indentation) 0))
1826 (python-beginning-of-block)
1828 (beginning-of-defun)
1829 (if (looking-at (rx (0+ space) (or "def" "class") (1+ space)
1830 (group (1+ (or word (syntax symbol))))))
1831 (push (match-string 1) accum)))
1832 (if accum (mapconcat 'identity accum ".")))))
1834 (defun python-mark-block ()
1835 "Mark the block around point.
1836 Uses `python-beginning-of-block', `python-end-of-block'."
1839 (python-beginning-of-block)
1840 (push-mark (point) nil t)
1841 (python-end-of-block)
1842 (exchange-point-and-mark))
1844 ;; Fixme: Provide a find-function-like command to find source of a
1845 ;; definition (separate from BicycleRepairMan). Complicated by
1846 ;; finding the right qualified name.
1850 (defvar python-imports nil
1851 "String of top-level import statements updated by `python-find-imports'.")
1852 (make-variable-buffer-local 'python-imports)
1854 ;; Fixme: Should font-lock try to run this when it deals with an import?
1855 ;; Maybe not a good idea if it gets run multiple times when the
1856 ;; statement is being edited, and is more likely to end up with
1857 ;; something syntactically incorrect.
1858 ;; However, what we should do is to trundle up the block tree from point
1859 ;; to extract imports that appear to be in scope, and add those.
1860 (defun python-find-imports ()
1861 "Find top-level imports, updating `python-imports'."
1865 (goto-char (point-min))
1866 (while (re-search-forward "^import\\>\\|^from\\>" nil t)
1867 (unless (syntax-ppss-context (syntax-ppss))
1868 (push (buffer-substring (line-beginning-position)
1869 (line-beginning-position 2))
1871 (setq python-imports
1874 ;; This is probably best left out since you're unlikely to need the
1875 ;; doc for a function in the buffer and the import will lose if the
1876 ;; Python sub-process' working directory isn't the same as the
1878 ;; (if buffer-file-name
1881 ;; (file-name-sans-extension
1882 ;; (file-name-nondirectory buffer-file-name))))
1886 (set-text-properties 0 (length python-imports) nil python-imports)
1887 ;; The output ends up in the wrong place if the string we
1888 ;; send contains newlines (from the imports).
1889 (setq python-imports
1890 (replace-regexp-in-string "\n" "\\n"
1891 (format "%S" python-imports) t t))))))
1893 ;; Fixme: This fails the first time if the sub-process isn't already
1894 ;; running. Presumably a timing issue with i/o to the process.
1895 (defun python-symbol-completions (symbol)
1896 "Return a list of completions of the string SYMBOL from Python process.
1898 Uses `python-imports' to load modules against which to complete."
1902 (car (read-from-string
1903 (python-send-receive
1904 (format "emacs.complete(%S,%s)" symbol python-imports))))
1907 ;; We can get duplicates from the above -- don't know why.
1908 (delete-dups completions)
1911 (defun python-partial-symbol ()
1912 "Return the partial symbol before point (for completion)."
1914 (start (save-excursion
1915 (and (re-search-backward
1916 (rx (or buffer-start (regexp "[^[:alnum:]._]"))
1917 (group (1+ (regexp "[[:alnum:]._]"))) point)
1919 (match-beginning 1)))))
1920 (if start (buffer-substring-no-properties start end))))
1922 (defun python-complete-symbol ()
1923 "Perform completion on the Python symbol preceding point.
1924 Repeating the command scrolls the completion window."
1926 (let ((window (get-buffer-window "*Completions*")))
1927 (if (and (eq last-command this-command)
1928 window (window-live-p window) (window-buffer window)
1929 (buffer-name (window-buffer window)))
1930 (with-current-buffer (window-buffer window)
1931 (if (pos-visible-in-window-p (point-max) window)
1932 (set-window-start window (point-min))
1933 (save-selected-window
1934 (select-window window)
1937 (let* ((end (point))
1938 (symbol (python-partial-symbol))
1939 (completions (python-symbol-completions symbol))
1940 (completion (if completions
1941 (try-completion symbol completions))))
1943 (cond ((eq completion t))
1945 (message "Can't find completion for \"%s\"" symbol)
1947 ((not (string= symbol completion))
1948 (delete-region (- end (length symbol)) end)
1949 (insert completion))
1951 (message "Making completion list...")
1952 (with-output-to-temp-buffer "*Completions*"
1953 (display-completion-list completions symbol))
1954 (message "Making completion list...%s" "done"))))))))
1956 (defun python-try-complete (old)
1957 "Completion function for Python for use with `hippie-expand'."
1958 (when (derived-mode-p 'python-mode) ; though we only add it locally
1960 (let ((symbol (python-partial-symbol)))
1961 (he-init-string (- (point) (length symbol)) (point))
1962 (if (not (he-string-member he-search-string he-tried-table))
1963 (push he-search-string he-tried-table))
1964 (setq he-expand-list
1965 (and symbol (python-symbol-completions symbol)))))
1966 (while (and he-expand-list
1967 (he-string-member (car he-expand-list) he-tried-table))
1968 (pop he-expand-list))
1971 (he-substitute-string (pop he-expand-list))
1973 (if old (he-reset-string))
1978 (defun python-module-path (module)
1979 "Function for `ffap-alist' to return path to MODULE."
1980 (python-send-receive (format "emacs.modpath (%S)" module)))
1982 (eval-after-load "ffap"
1983 '(push '(python-mode . python-module-path) ffap-alist))
1987 (defcustom python-use-skeletons nil
1988 "Non-nil means template skeletons will be automagically inserted.
1989 This happens when pressing \"if<SPACE>\", for example, to prompt for
1994 (defvar python-skeletons nil
1995 "Alist of named skeletons for Python mode.
1996 Elements are of the form (NAME . EXPANDER-FUNCTION).")
1998 (defvar python-mode-abbrev-table nil
1999 "Abbrev table for Python mode.
2000 The default contents correspond to the elements of `python-skeletons'.")
2001 (define-abbrev-table 'python-mode-abbrev-table ())
2004 ;; Define a user-level skeleton and add it to `python-skeletons' and
2005 ;; the abbrev table.
2006 (defmacro def-python-skeleton (name &rest elements)
2007 (let* ((name (symbol-name name))
2008 (function (intern (concat "python-insert-" name))))
2010 (add-to-list 'python-skeletons ',(cons name function))
2011 (if python-use-skeletons
2012 (define-abbrev python-mode-abbrev-table ,name "" ',function nil t))
2013 (define-skeleton ,function
2014 ,(format "Insert Python \"%s\" template." name)
2016 (put 'def-python-skeleton 'lisp-indent-function 2)
2018 ;; From `skeleton-further-elements':
2019 ;; `<': outdent a level;
2020 ;; `^': delete indentation on current line and also previous newline.
2021 ;; Not quote like `delete-indentation'. Assumes point is at
2022 ;; beginning of indentation.
2024 (def-python-skeleton if
2028 ("other condition, %s: "
2029 < ; Avoid wrong indentation after block opening.
2034 (define-skeleton python-else
2035 "Auxiliary skeleton."
2037 (unless (eq ?y (read-char "Add `else' clause? (y for yes or RET for no) "))
2042 (def-python-skeleton while
2048 (def-python-skeleton for
2050 "for " str " in " (skeleton-read "Expression, %s: ") ":" \n
2054 (def-python-skeleton try/except
2059 < "except " str (python-target) ":" \n
2065 (define-skeleton python-target
2066 "Auxiliary skeleton."
2067 "Target, %s: " ", " str | -2)
2069 (def-python-skeleton try/finally
2076 (def-python-skeleton def
2078 "def " str " (" ("Parameter, %s: " (unless (equal ?\( (char-before)) ", ")
2080 "\"\"\"" @ " \"\"\"" \n ; Fixme: syntaxification wrong for """"""
2083 (def-python-skeleton class
2085 "class " str " (" ("Inheritance, %s: "
2086 (unless (equal ?\( (char-before)) ", ")
2088 & ")" | -2 ; close list or remove opening
2090 "\"\"\"" @ " \"\"\"" \n
2093 (defvar python-default-template "if"
2094 "Default template to expand by `python-expand-template'.
2095 Updated on each expansion.")
2097 (defun python-expand-template (name)
2098 "Expand template named NAME.
2099 Interactively, prompt for the name with completion."
2101 (list (completing-read (format "Template to expand (default %s): "
2102 python-default-template)
2103 python-skeletons nil t)))
2105 (setq name python-default-template)
2106 (setq python-default-template name))
2107 (let ((func (cdr (assoc name python-skeletons))))
2110 (error "Undefined template: %s" name))))
2112 ;;;; Bicycle Repair Man support
2114 (autoload 'pymacs-load "pymacs" nil t)
2115 (autoload 'brm-init "bikemacs")
2117 ;; I'm not sure how useful BRM really is, and it's certainly dangerous
2118 ;; the way it modifies files outside Emacs... Also note that the
2119 ;; current BRM loses with tabs used for indentation -- I submitted a
2120 ;; fix <URL:http://www.loveshack.ukfsn.org/emacs/bikeemacs.py.diff>.
2121 (defun python-setup-brm ()
2122 "Set up Bicycle Repair Man refactoring tool (if available).
2124 Note that the `refactoring' features change files independently of
2125 Emacs and may modify and save the contents of the current buffer
2126 without confirmation."
2128 (condition-case data
2129 (unless (fboundp 'brm-rename)
2130 (pymacs-load "bikeemacs" "brm-") ; first line of normal recipe
2131 (let ((py-mode-map (make-sparse-keymap)) ; it assumes this
2132 (features (cons 'python-mode features))) ; and requires this
2133 (brm-init)) ; second line of normal recipe
2134 (remove-hook 'python-mode-hook ; undo this from `brm-init'
2135 '(lambda () (easy-menu-add brm-menu)))
2137 python-brm-menu python-mode-map
2138 "Bicycle Repair Man"
2139 '("BicycleRepairMan"
2140 :help "Interface to navigation and refactoring tool"
2142 ["Find References" brm-find-references
2143 :help "Find references to name at point in compilation buffer"]
2144 ["Find Definition" brm-find-definition
2145 :help "Find definition of name at point"]
2148 ["Rename" brm-rename
2149 :help "Replace name at point with a new name everywhere"]
2150 ["Extract Method" brm-extract-method
2151 :active (and mark-active (not buffer-read-only))
2152 :help "Replace statements in region with a method"]
2153 ["Extract Local Variable" brm-extract-local-variable
2154 :active (and mark-active (not buffer-read-only))
2155 :help "Replace expression in region with an assignment"]
2156 ["Inline Local Variable" brm-inline-local-variable
2158 "Substitute uses of variable at point with its definition"]
2159 ;; Fixme: Should check for anything to revert.
2160 ["Undo Last Refactoring" brm-undo :help ""])))
2161 (error (error "Bicyclerepairman setup failed: %s" data))))
2165 (defvar outline-heading-end-regexp)
2166 (defvar eldoc-documentation-function)
2168 ;; Stuff to allow expanding abbrevs with non-word constituents.
2169 (defun python-abbrev-pc-hook ()
2170 "Set the syntax table before possibly expanding abbrevs."
2171 (remove-hook 'post-command-hook 'python-abbrev-pc-hook t)
2172 (set-syntax-table python-mode-syntax-table))
2174 (defvar python-abbrev-syntax-table
2175 (copy-syntax-table python-mode-syntax-table)
2176 "Syntax table used when expanding abbrevs.")
2178 (defun python-pea-hook ()
2179 "Reset the syntax table after possibly expanding abbrevs."
2180 (set-syntax-table python-abbrev-syntax-table)
2181 (add-hook 'post-command-hook 'python-abbrev-pc-hook nil t))
2182 (modify-syntax-entry ?/ "w" python-abbrev-syntax-table)
2184 (defvar python-mode-running) ;Dynamically scoped var.
2187 (define-derived-mode python-mode fundamental-mode "Python"
2188 "Major mode for editing Python files.
2189 Font Lock mode is currently required for correct parsing of the source.
2190 See also `jython-mode', which is actually invoked if the buffer appears to
2191 contain Jython code. See also `run-python' and associated Python mode
2192 commands for running Python under Emacs.
2194 The Emacs commands which work with `defun's, e.g. \\[beginning-of-defun], deal
2195 with nested `def' and `class' blocks. They take the innermost one as
2196 current without distinguishing method and class definitions. Used multiple
2197 times, they move over others at the same indentation level until they reach
2198 the end of definitions at that level, when they move up a level.
2200 Colon is electric: it outdents the line if appropriate, e.g. for
2201 an else statement. \\[python-backspace] at the beginning of an indented statement
2202 deletes a level of indentation to close the current block; otherwise it
2203 deletes a character backward. TAB indents the current line relative to
2204 the preceding code. Successive TABs, with no intervening command, cycle
2205 through the possibilities for indentation on the basis of enclosing blocks.
2207 \\[fill-paragraph] fills comments and multi-line strings appropriately, but has no
2208 effect outside them.
2210 Supports Eldoc mode (only for functions, using a Python process),
2211 Info-Look and Imenu. In Outline minor mode, `class' and `def'
2212 lines count as headers. Symbol completion is available in the
2213 same way as in the Python shell using the `rlcompleter' module
2214 and this is added to the Hippie Expand functions locally if
2215 Hippie Expand mode is turned on. Completion of symbols of the
2216 form x.y only works if the components are literal
2217 module/attribute names, not variables. An abbrev table is set up
2218 with skeleton expansions for compound statement templates.
2220 \\{python-mode-map}"
2222 (set (make-local-variable 'font-lock-defaults)
2223 '(python-font-lock-keywords nil nil nil nil
2224 (font-lock-syntactic-keywords
2225 . python-font-lock-syntactic-keywords)
2226 ;; This probably isn't worth it.
2227 ;; (font-lock-syntactic-face-function
2228 ;; . python-font-lock-syntactic-face-function)
2230 (set (make-local-variable 'parse-sexp-lookup-properties) t)
2231 (set (make-local-variable 'parse-sexp-ignore-comments) t)
2232 (set (make-local-variable 'comment-start) "# ")
2233 (set (make-local-variable 'indent-line-function) #'python-indent-line)
2234 (set (make-local-variable 'indent-region-function) #'python-indent-region)
2235 (set (make-local-variable 'paragraph-start) "\\s-*$")
2236 (set (make-local-variable 'fill-paragraph-function) 'python-fill-paragraph)
2237 (set (make-local-variable 'require-final-newline) mode-require-final-newline)
2238 (set (make-local-variable 'add-log-current-defun-function)
2239 #'python-current-defun)
2240 (set (make-local-variable 'outline-regexp)
2241 (rx (* space) (or "class" "def" "elif" "else" "except" "finally"
2242 "for" "if" "try" "while" "with")
2244 (set (make-local-variable 'outline-heading-end-regexp) ":\\s-*\n")
2245 (set (make-local-variable 'outline-level) #'python-outline-level)
2246 (set (make-local-variable 'open-paren-in-column-0-is-defun-start) nil)
2247 (make-local-variable 'python-saved-check-command)
2248 (set (make-local-variable 'beginning-of-defun-function)
2249 'python-beginning-of-defun)
2250 (set (make-local-variable 'end-of-defun-function) 'python-end-of-defun)
2251 (setq imenu-create-index-function #'python-imenu-create-index)
2252 (set (make-local-variable 'eldoc-documentation-function)
2253 #'python-eldoc-function)
2254 (add-hook 'eldoc-mode-hook
2255 (lambda () (run-python nil t)) ; need it running
2257 ;; Fixme: should be in hideshow. This seems to be of limited use
2258 ;; since it isn't (can't be) indentation-based. Also hide-level
2259 ;; doesn't seem to work properly.
2260 (add-to-list 'hs-special-modes-alist
2261 `(python-mode "^\\s-*def\\>" nil "#"
2263 (python-end-of-defun)
2264 (skip-chars-backward " \t\n"))
2266 (set (make-local-variable 'skeleton-further-elements)
2267 '((< '(backward-delete-char-untabify (min python-indent
2269 (^ '(- (1+ (current-indentation))))))
2270 (add-hook 'pre-abbrev-expand-hook 'python-pea-hook nil t)
2271 (if (featurep 'hippie-exp)
2272 (set (make-local-variable 'hippie-expand-try-functions-list)
2273 (cons 'python-try-complete hippie-expand-try-functions-list)))
2274 ;; Python defines TABs as being 8-char wide.
2275 (set (make-local-variable 'tab-width) 8)
2276 (when python-guess-indent (python-guess-indent))
2277 ;; Let's make it harder for the user to shoot himself in the foot.
2278 (unless (= tab-width python-indent)
2279 (setq indent-tabs-mode nil))
2280 (set (make-local-variable 'python-command) python-python-command)
2281 (python-find-imports)
2282 (unless (boundp 'python-mode-running) ; kill the recursion from jython-mode
2283 (let ((python-mode-running t))
2284 (python-maybe-jython))))
2286 (custom-add-option 'python-mode-hook 'imenu-add-menubar-index)
2287 (custom-add-option 'python-mode-hook
2289 "Turn off Indent Tabs mode."
2290 (set (make-local-variable 'indent-tabs-mode) nil)))
2291 (custom-add-option 'python-mode-hook 'turn-on-eldoc-mode)
2292 (custom-add-option 'python-mode-hook 'abbrev-mode)
2293 (custom-add-option 'python-mode-hook 'python-setup-brm)
2296 (define-derived-mode jython-mode python-mode "Jython"
2297 "Major mode for editing Jython files.
2298 Like `python-mode', but sets up parameters for Jython subprocesses.
2299 Runs `jython-mode-hook' after `python-mode-hook'."
2301 (set (make-local-variable 'python-command) python-jython-command))
2304 (provide 'python-21)
2305 ;; arch-tag: 6fce1d99-a704-4de9-ba19-c6e4912b0554
2306 ;;; python.el ends here