;;; python.el -- Python's flying circus support for Emacs ;; Copyright (C) 2010, 2011 Free Software Foundation, Inc. ;; Author: Fabián E. Gallina ;; Maintainer: FSF ;; Created: Jul 2010 ;; Keywords: languages ;; This file is NOT part of GNU Emacs. ;; python.el is free software: you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by ;; the Free Software Foundation, either version 3 of the License, or ;; (at your option) any later version. ;; python.el is distributed in the hope that it will be useful, ;; but WITHOUT ANY WARRANTY; without even the implied warranty of ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ;; GNU General Public License for more details. ;; You should have received a copy of the GNU General Public License ;; along with python.el. If not, see . ;;; Commentary: ;; Major mode for editing Python files with some fontification and ;; indentation bits extracted from original Dave Love's python.el ;; found in GNU/Emacs. ;; While it probably has less features than Dave Love's python.el and ;; PSF's python-mode.el it provides the main stuff you'll need while ;; keeping it simple :) ;; Implements Syntax highlighting, Indentation, Movement, Shell ;; interaction, Shell completion, Pdb tracking, Symbol completion, ;; Skeletons, FFAP, Code Check, Eldoc. ;; Syntax highlighting: Fontification of code is provided and supports ;; python's triple quoted strings properly. ;; Indentation: Automatic indentation with indentation cycling is ;; provided, it allows you to navigate different available levels of ;; indentation by hitting several times. Also when inserting a ;; colon the `python-indent-electric-colon' command is invoked and ;; causes the current line to be dedented automatically if needed. ;; Movement: `beginning-of-defun' and `end-of-defun' functions are ;; properly implemented. ;; Shell interaction: is provided and allows you easily execute any ;; block of code of your current buffer in an inferior Python process. ;; Shell completion: hitting tab will try to complete the current ;; word. Shell completion is implemented in a manner that if you ;; change the `python-shell-interpreter' to any other (for example ;; IPython) it should be easy to integrate another way to calculate ;; completions. You just need to specify your custom ;; `python-shell-completion-setup-code' and ;; `python-shell-completion-string-code' ;; Here is a complete example of the settings you would use for ;; iPython ;; (setq ;; python-shell-interpreter "ipython" ;; python-shell-interpreter-args "" ;; python-shell-prompt-regexp "In \\[[0-9]+\\]: " ;; python-shell-prompt-output-regexp "Out\\[[0-9]+\\]: " ;; python-shell-completion-setup-code "" ;; python-shell-completion-string-code ;; "';'.join(__IP.complete('''%s'''))\n") ;; Please note that the default completion system depends on the ;; readline module, so if you are using some Operating System that ;; bundles Python without it (like Windows) just install the ;; pyreadline from http://ipython.scipy.org/moin/PyReadline/Intro and ;; you should be good to go. ;; The shell also contains support for virtualenvs and other special ;; environment modification thanks to ;; `python-shell-process-environment' and `python-shell-exec-path'. ;; These two variables allows you to modify execution paths and ;; enviroment variables to make easy for you to setup virtualenv rules ;; or behaviors modifications when running shells. Here is an example ;; of how to make shell processes to be run using the /path/to/env/ ;; virtualenv: ;; (setq python-shell-process-environment ;; (list ;; (format "PATH=%s" (mapconcat ;; 'identity ;; (reverse ;; (cons (getenv "PATH") ;; '("/path/to/env/bin/"))) ;; ":")) ;; "VIRTUAL_ENV=/path/to/env/")) ;; (python-shell-exec-path . ("/path/to/env/bin/")) ;; Pdb tracking: when you execute a block of code that contains some ;; call to pdb (or ipdb) it will prompt the block of code and will ;; follow the execution of pdb marking the current line with an arrow. ;; Symbol completion: you can complete the symbol at point. It uses ;; the shell completion in background so you should run ;; `python-shell-send-buffer' from time to time to get better results. ;; Skeletons: 6 skeletons are provided for simple inserting of class, ;; def, for, if, try and while. These skeletons are integrated with ;; dabbrev. If you have `dabbrev-mode' activated and ;; `python-skeleton-autoinsert' is set to t, then whenever you type ;; the name of any of those defined and hit SPC, they will be ;; automatically expanded. ;; FFAP: You can find the filename for a given module when using ffap ;; out of the box. This feature needs an inferior python shell ;; running. ;; Code check: Check the current file for errors with `python-check' ;; using the program defined in `python-check-command'. ;; Eldoc: returns documentation for object at point by using the ;; inferior python subprocess to inspect its documentation. As you ;; might guessed you should run `python-shell-send-buffer' from time ;; to time to get better results too. ;; If you used python-mode.el you probably will miss auto-indentation ;; when inserting newlines. To achieve the same behavior you have ;; two options: ;; 1) Use GNU/Emacs' standard binding for `newline-and-indent': C-j. ;; 2) Add the following hook in your .emacs: ;; (add-hook 'python-mode-hook ;; #'(lambda () ;; (define-key python-mode-map "\C-m" 'newline-and-indent))) ;; I'd recommend the first one since you'll get the same behavior for ;; all modes out-of-the-box. ;;; Installation: ;; Add this to your .emacs: ;; (add-to-list 'load-path "/folder/containing/file") ;; (require 'python) ;;; TODO: ;; Ordered by priority: ;; Better decorator support for beginning of defun ;; Review code and cleanup ;;; Code: (require 'ansi-color) (require 'comint) (eval-when-compile (require 'cl) ;; Avoid compiler warnings (defvar view-return-to-alist) (defvar compilation-error-regexp-alist) (defvar outline-heading-end-regexp)) (autoload 'comint-mode "comint") ;;;###autoload (add-to-list 'auto-mode-alist (cons (purecopy "\\.py\\'") 'python-mode)) ;;;###autoload (add-to-list 'interpreter-mode-alist (cons (purecopy "python") 'python-mode)) (defgroup python nil "Python Language's flying circus support for Emacs." :group 'languages :version "23.2" :link '(emacs-commentary-link "python")) ;;; Bindings (defvar python-mode-map (let ((map (make-sparse-keymap))) ;; Indent specific (define-key map "\177" 'python-indent-dedent-line-backspace) (define-key map (kbd "") 'python-indent-dedent-line) (define-key map "\C-c<" 'python-indent-shift-left) (define-key map "\C-c>" 'python-indent-shift-right) (define-key map ":" 'python-indent-electric-colon) ;; Skeletons (define-key map "\C-c\C-tc" 'python-skeleton-class) (define-key map "\C-c\C-td" 'python-skeleton-def) (define-key map "\C-c\C-tf" 'python-skeleton-for) (define-key map "\C-c\C-ti" 'python-skeleton-if) (define-key map "\C-c\C-tt" 'python-skeleton-try) (define-key map "\C-c\C-tw" 'python-skeleton-while) ;; Shell interaction (define-key map "\C-c\C-s" 'python-shell-send-string) (define-key map "\C-c\C-r" 'python-shell-send-region) (define-key map "\C-\M-x" 'python-shell-send-defun) (define-key map "\C-c\C-c" 'python-shell-send-buffer) (define-key map "\C-c\C-l" 'python-shell-send-file) (define-key map "\C-c\C-z" 'python-shell-switch-to-shell) ;; Some util commands (define-key map "\C-c\C-v" 'python-check) (define-key map "\C-c\C-f" 'python-eldoc-at-point) ;; Utilities (substitute-key-definition 'complete-symbol 'completion-at-point map global-map) (easy-menu-define python-menu map "Python Mode menu" `("Python" :help "Python-specific Features" ["Shift region left" python-indent-shift-left :active mark-active :help "Shift region left by a single indentation step"] ["Shift region right" python-indent-shift-right :active mark-active :help "Shift region right by a single indentation step"] "-" ["Mark def/class" mark-defun :help "Mark outermost definition around point"] "-" ["Start of def/class" beginning-of-defun :help "Go to start of outermost definition around point"] ["End of def/class" end-of-defun :help "Go to end of definition around point"] "-" ("Skeletons") "-" ["Start interpreter" run-python :help "Run inferior Python process in a separate buffer"] ["Switch to shell" python-shell-switch-to-shell :help "Switch to running inferior Python process"] ["Eval string" python-shell-send-string :help "Eval string in inferior Python session"] ["Eval buffer" python-shell-send-buffer :help "Eval buffer in inferior Python session"] ["Eval region" python-shell-send-region :help "Eval region in inferior Python session"] ["Eval defun" python-shell-send-defun :help "Eval defun in inferior Python session"] ["Eval file" python-shell-send-file :help "Eval file in inferior Python session"] ["Debugger" pdb :help "Run pdb under GUD"] "-" ["Check file" python-check :help "Check file for errors"] ["Help on symbol" python-eldoc-at-point :help "Get help on symbol at point"] ["Complete symbol" completion-at-point :help "Complete symbol before point"])) map) "Keymap for `python-mode'.") ;;; Python specialized rx (eval-when-compile (defconst python-rx-constituents (list `(block-start . ,(rx symbol-start (or "def" "class" "if" "elif" "else" "try" "except" "finally" "for" "while" "with") symbol-end)) `(decorator . ,(rx line-start (* space) ?@ (any letter ?_) (* (any word ?_)))) `(defun . ,(rx symbol-start (or "def" "class") symbol-end)) `(symbol-name . ,(rx (any letter ?_) (* (any word ?_)))) `(open-paren . ,(rx (or "{" "[" "("))) `(close-paren . ,(rx (or "}" "]" ")"))) `(simple-operator . ,(rx (any ?+ ?- ?/ ?& ?^ ?~ ?| ?* ?< ?> ?= ?%))) `(not-simple-operator . ,(rx (not (any ?+ ?- ?/ ?& ?^ ?~ ?| ?* ?< ?> ?= ?%)))) `(operator . ,(rx (or "+" "-" "/" "&" "^" "~" "|" "*" "<" ">" "=" "%" "**" "//" "<<" ">>" "<=" "!=" "==" ">=" "is" "not"))) `(assignment-operator . ,(rx (or "=" "+=" "-=" "*=" "/=" "//=" "%=" "**=" ">>=" "<<=" "&=" "^=" "|=")))) "Additional Python specific sexps for `python-rx'")) (defmacro python-rx (&rest regexps) "Python mode especialized rx macro which supports common python named REGEXPS." (let ((rx-constituents (append python-rx-constituents rx-constituents))) (cond ((null regexps) (error "No regexp")) ((cdr regexps) (rx-to-string `(and ,@regexps) t)) (t (rx-to-string (car regexps) t))))) ;;; Font-lock and syntax (defvar python-font-lock-keywords ;; Keywords `(,(rx symbol-start (or "and" "del" "from" "not" "while" "as" "elif" "global" "or" "with" "assert" "else" "if" "pass" "yield" "break" "except" "import" "print" "class" "exec" "in" "raise" "continue" "finally" "is" "return" "def" "for" "lambda" "try" "self") symbol-end) ;; functions (,(rx symbol-start "def" (1+ space) (group (1+ (or word ?_)))) (1 font-lock-function-name-face)) ;; classes (,(rx symbol-start "class" (1+ space) (group (1+ (or word ?_)))) (1 font-lock-type-face)) ;; Constants (,(rx symbol-start (group "None" symbol-end)) (1 font-lock-constant-face)) ;; Decorators. (,(rx line-start (* (any " \t")) (group "@" (1+ (or word ?_)) (0+ "." (1+ (or word ?_))))) (1 font-lock-type-face)) ;; Builtin Exceptions (,(rx symbol-start (or "ArithmeticError" "AssertionError" "AttributeError" "BaseException" "BufferError" "BytesWarning" "DeprecationWarning" "EOFError" "EnvironmentError" "Exception" "FloatingPointError" "FutureWarning" "GeneratorExit" "IOError" "ImportError" "ImportWarning" "IndentationError" "IndexError" "KeyError" "KeyboardInterrupt" "LookupError" "MemoryError" "NameError" "NotImplemented" "NotImplementedError" "OSError" "OverflowError" "PendingDeprecationWarning" "ReferenceError" "RuntimeError" "RuntimeWarning" "StandardError" "StopIteration" "SyntaxError" "SyntaxWarning" "SystemError" "SystemExit" "TabError" "TypeError" "UnboundLocalError" "UnicodeDecodeError" "UnicodeEncodeError" "UnicodeError" "UnicodeTranslateError" "UnicodeWarning" "UserWarning" "ValueError" "Warning" "ZeroDivisionError") symbol-end) . font-lock-type-face) ;; Builtins (,(rx (or line-start (not (any ". \t"))) (* (any " \t")) symbol-start (group (or "_" "__debug__" "__doc__" "__import__" "__name__" "__package__" "abs" "all" "any" "apply" "basestring" "bin" "bool" "buffer" "bytearray" "bytes" "callable" "chr" "classmethod" "cmp" "coerce" "compile" "complex" "copyright" "credits" "delattr" "dict" "dir" "divmod" "enumerate" "eval" "execfile" "exit" "file" "filter" "float" "format" "frozenset" "getattr" "globals" "hasattr" "hash" "help" "hex" "id" "input" "int" "intern" "isinstance" "issubclass" "iter" "len" "license" "list" "locals" "long" "map" "max" "min" "next" "object" "oct" "open" "ord" "pow" "print" "property" "quit" "range" "raw_input" "reduce" "reload" "repr" "reversed" "round" "set" "setattr" "slice" "sorted" "staticmethod" "str" "sum" "super" "tuple" "type" "unichr" "unicode" "vars" "xrange" "zip" "True" "False" "Ellipsis")) symbol-end) (1 font-lock-builtin-face)) ;; asignations ;; support for a = b = c = 5 (,(lambda (limit) (let ((re (python-rx (group (+ (any word ?. ?_))) (? ?\[ (+ (not (any ?\]))) ?\]) (* space) assignment-operator))) (when (re-search-forward re limit t) (while (and (python-info-ppss-context 'paren) (re-search-forward re limit t))) (if (and (not (python-info-ppss-context 'paren)) (not (equal (char-after (point-marker)) ?=))) t (set-match-data nil))))) (1 font-lock-variable-name-face nil nil)) ;; support for a, b, c = (1, 2, 3) (,(lambda (limit) (let ((re (python-rx (group (+ (any word ?. ?_))) (* space) (* ?, (* space) (+ (any word ?. ?_)) (* space)) ?, (* space) (+ (any word ?. ?_)) (* space) assignment-operator))) (when (and (re-search-forward re limit t) (goto-char (nth 3 (match-data)))) (while (and (python-info-ppss-context 'paren) (re-search-forward re limit t)) (goto-char (nth 3 (match-data)))) (if (not (python-info-ppss-context 'paren)) t (set-match-data nil))))) (1 font-lock-variable-name-face nil nil)))) ;; Fixme: Is there a better way? (defconst python-font-lock-syntactic-keywords ;; First avoid a sequence preceded by an odd number of backslashes. `((,(rx (not (any ?\\)) ?\\ (* (and ?\\ ?\\)) (group (syntax string-quote)) (backref 1) (group (backref 1))) (2 ,(string-to-syntax "\""))) ; dummy (,(rx (group (optional (any "uUrR"))) ; prefix gets syntax property (optional (any "rR")) ; possible second prefix (group (syntax string-quote)) ; maybe gets property (backref 2) ; per first quote (group (backref 2))) ; maybe gets property (1 (python-quote-syntax 1)) (2 (python-quote-syntax 2)) (3 (python-quote-syntax 3)))) "Make outer chars of triple-quote strings into generic string delimiters.") (defun python-quote-syntax (n) "Put `syntax-table' property correctly on triple quote. Used for syntactic keywords. N is the match number (1, 2 or 3)." ;; Given a triple quote, we have to check the context to know ;; whether this is an opening or closing triple or whether it's ;; quoted anyhow, and should be ignored. (For that we need to do ;; the same job as `syntax-ppss' to be correct and it seems to be OK ;; to use it here despite initial worries.) We also have to sort ;; out a possible prefix -- well, we don't _have_ to, but I think it ;; should be treated as part of the string. ;; Test cases: ;; ur"""ar""" x='"' # """ ;; x = ''' """ ' a ;; ''' ;; x '"""' x """ \"""" x (save-excursion (goto-char (match-beginning 0)) (cond ;; Consider property for the last char if in a fenced string. ((= n 3) (let* ((font-lock-syntactic-keywords nil) (syntax (syntax-ppss))) (when (eq t (nth 3 syntax)) ; after unclosed fence (goto-char (nth 8 syntax)) ; fence position (skip-chars-forward "uUrR") ; skip any prefix ;; Is it a matching sequence? (if (eq (char-after) (char-after (match-beginning 2))) (eval-when-compile (string-to-syntax "|")))))) ;; Consider property for initial char, accounting for prefixes. ((or (and (= n 2) ; leading quote (not prefix) (= (match-beginning 1) (match-end 1))) ; prefix is null (and (= n 1) ; prefix (/= (match-beginning 1) (match-end 1)))) ; non-empty (let ((font-lock-syntactic-keywords nil)) (unless (eq 'string (syntax-ppss-context (syntax-ppss))) (eval-when-compile (string-to-syntax "|"))))) ;; Otherwise (we're in a non-matching string) the property is ;; nil, which is OK. ))) (defvar python-mode-syntax-table (let ((table (make-syntax-table))) ;; Give punctuation syntax to ASCII that normally has symbol ;; syntax or has word syntax and isn't a letter. (let ((symbol (string-to-syntax "_")) (sst (standard-syntax-table))) (dotimes (i 128) (unless (= i ?_) (if (equal symbol (aref sst i)) (modify-syntax-entry i "." table))))) (modify-syntax-entry ?$ "." table) (modify-syntax-entry ?% "." table) ;; exceptions (modify-syntax-entry ?# "<" table) (modify-syntax-entry ?\n ">" table) (modify-syntax-entry ?' "\"" table) (modify-syntax-entry ?` "$" table) table) "Syntax table for Python files.") (defvar python-dotty-syntax-table (let ((table (make-syntax-table python-mode-syntax-table))) (modify-syntax-entry ?. "w" table) (modify-syntax-entry ?_ "w" table) table) "Dotty syntax table for Python files. It makes underscores and dots word constituent chars.") ;;; Indentation (defcustom python-indent-offset 4 "Default indentation offset for Python." :group 'python :type 'integer :safe 'integerp) (defcustom python-indent-guess-indent-offset t "Non-nil tells Python mode to guess `python-indent-offset' value." :type 'boolean :group 'python) (defvar python-indent-current-level 0 "Current indentation level `python-indent-line-function' is using.") (defvar python-indent-levels '(0) "Levels of indentation available for `python-indent-line-function'.") (defvar python-indent-dedenters '("else" "elif" "except" "finally") "List of words that should be dedented. These make `python-indent-calculate-indentation' subtract the value of `python-indent-offset'.") (defun python-indent-guess-indent-offset () "Guess and set `python-indent-offset' for the current buffer." (save-excursion (save-restriction (widen) (goto-char (point-min)) (let ((found-block)) (while (and (not found-block) (re-search-forward (python-rx line-start block-start) nil t)) (when (and (not (python-info-ppss-context 'string)) (not (python-info-ppss-context 'comment)) (progn (goto-char (line-end-position)) (forward-comment -1) (eq ?: (char-before)))) (setq found-block t))) (if (not found-block) (message "Can't guess python-indent-offset, using defaults: %s" python-indent-offset) (while (and (progn (goto-char (line-end-position)) (python-info-continuation-line-p)) (not (eobp))) (forward-line 1)) (forward-line 1) (forward-comment 1) (let ((indent-offset (current-indentation))) (when (> indent-offset 0) (setq python-indent-offset indent-offset)))))))) (defun python-indent-context () "Get information on indentation context. Context information is returned with a cons with the form: \(STATUS . START) Where status can be any of the following symbols: * inside-paren: If point in between (), {} or [] * inside-string: If point is inside a string * after-backslash: Previous line ends in a backslash * after-beginning-of-block: Point is after beginning of block * after-line: Point is after normal line * no-indent: Point is at beginning of buffer or other special case START is the buffer position where the sexp starts." (save-restriction (widen) (let ((ppss (save-excursion (beginning-of-line) (syntax-ppss))) (start)) (cons (cond ;; Beginning of buffer ((save-excursion (goto-char (line-beginning-position)) (bobp)) 'no-indent) ;; Inside a paren ((setq start (python-info-ppss-context 'paren ppss)) 'inside-paren) ;; Inside string ((setq start (python-info-ppss-context 'string ppss)) 'inside-string) ;; After backslash ((setq start (when (not (or (python-info-ppss-context 'string ppss) (python-info-ppss-context 'comment ppss))) (let ((line-beg-pos (line-beginning-position))) (when (eq ?\\ (char-before (1- line-beg-pos))) (- line-beg-pos 2))))) 'after-backslash) ;; After beginning of block ((setq start (save-excursion (let ((block-regexp (python-rx block-start)) (block-start-line-end ":[[:space:]]*$")) (back-to-indentation) (while (and (forward-comment -1) (not (bobp)))) (back-to-indentation) (when (or (python-info-continuation-line-p) (and (not (looking-at block-regexp)) (save-excursion (re-search-forward block-start-line-end (line-end-position) t)))) (while (and (forward-line -1) (python-info-continuation-line-p) (not (bobp)))) (when (not (looking-at block-regexp)) (forward-line 1))) (back-to-indentation) (when (and (looking-at block-regexp) (or (re-search-forward block-start-line-end (line-end-position) t) (python-info-continuation-line-p))) (point-marker))))) 'after-beginning-of-block) ;; After normal line ((setq start (save-excursion (while (and (forward-comment -1) (not (bobp)))) (while (and (not (back-to-indentation)) (not (bobp)) (if (python-info-ppss-context 'paren) (forward-line -1) (if (save-excursion (forward-line -1) (python-info-line-ends-backslash-p)) (forward-line -1))))) (point-marker))) 'after-line) ;; Do not indent (t 'no-indent)) start)))) (defun python-indent-calculate-indentation () "Calculate correct indentation offset for the current line." (let* ((indentation-context (python-indent-context)) (context-status (car indentation-context)) (context-start (cdr indentation-context))) (save-restriction (widen) (save-excursion (case context-status ('no-indent 0) ('after-beginning-of-block (goto-char context-start) (+ (current-indentation) python-indent-offset)) ('after-line (- (save-excursion (goto-char context-start) (current-indentation)) (if (progn (back-to-indentation) (looking-at (regexp-opt python-indent-dedenters))) python-indent-offset 0))) ('inside-string (goto-char context-start) (current-indentation)) ('after-backslash (let* ((block-continuation (save-excursion (forward-line -1) (python-info-block-continuation-line-p))) (assignment-continuation (save-excursion (forward-line -1) (python-info-assignment-continuation-line-p))) (dot-continuation (save-excursion (back-to-indentation) (when (looking-at "\\.") (forward-line -1) (back-to-indentation) (forward-char (length (with-syntax-table python-dotty-syntax-table (current-word)))) (re-search-backward "\\." (line-beginning-position) t 1) (current-column)))) (indentation (cond (block-continuation (goto-char block-continuation) (re-search-forward (python-rx block-start (* space)) (line-end-position) t) (current-column)) (assignment-continuation (goto-char assignment-continuation) (re-search-forward (python-rx simple-operator) (line-end-position) t) (forward-char 1) (re-search-forward (python-rx (* space)) (line-end-position) t) (current-column)) (dot-continuation dot-continuation) (t (goto-char context-start) (current-indentation))))) indentation)) ('inside-paren (or (save-excursion (forward-comment 1) (when (and (looking-at (regexp-opt '(")" "]" "}"))) (not (forward-char 1)) (not (python-info-ppss-context 'paren))) (goto-char context-start) (back-to-indentation) (current-column))) (- (save-excursion (goto-char context-start) (forward-char) (save-restriction (narrow-to-region (line-beginning-position) (line-end-position)) (forward-comment 1)) (if (looking-at "$") (+ (current-indentation) python-indent-offset) (forward-comment 1) (current-column))) (if (progn (back-to-indentation) (looking-at (regexp-opt '(")" "]" "}")))) python-indent-offset 0))))))))) (defun python-indent-calculate-levels () "Calculate `python-indent-levels' and reset `python-indent-current-level'." (let* ((indentation (python-indent-calculate-indentation)) (remainder (% indentation python-indent-offset)) (steps (/ (- indentation remainder) python-indent-offset))) (setq python-indent-levels '(0)) (dotimes (step steps) (setq python-indent-levels (cons (* python-indent-offset (1+ step)) python-indent-levels))) (when (not (eq 0 remainder)) (setq python-indent-levels (cons (+ (* python-indent-offset steps) remainder) python-indent-levels))) (setq python-indent-levels (nreverse python-indent-levels)) (setq python-indent-current-level (1- (length python-indent-levels))))) (defun python-indent-toggle-levels () "Toggle `python-indent-current-level' over `python-indent-levels'." (setq python-indent-current-level (1- python-indent-current-level)) (when (< python-indent-current-level 0) (setq python-indent-current-level (1- (length python-indent-levels))))) (defun python-indent-line (&optional force-toggle) "Internal implementation of `python-indent-line-function'. Uses the offset calculated in `python-indent-calculate-indentation' and available levels indicated by the variable `python-indent-levels' to set the current indentation. When the variable `last-command' is equal to `indent-for-tab-command' or FORCE-TOGGLE is non-nil it cycles levels indicated in the variable `python-indent-levels' by setting the current level in the variable `python-indent-current-level'. When the variable `last-command' is not equal to `indent-for-tab-command' and FORCE-TOGGLE is nil it calculates possible indentation levels and saves it in the variable `python-indent-levels'. Afterwards it sets the variable `python-indent-current-level' correctly so offset is equal to (`nth' `python-indent-current-level' `python-indent-levels')" (if (or (and (eq this-command 'indent-for-tab-command) (eq last-command this-command)) force-toggle) (if (not (equal python-indent-levels '(0))) (python-indent-toggle-levels) (python-indent-calculate-levels)) (python-indent-calculate-levels)) (beginning-of-line) (delete-horizontal-space) (indent-to (nth python-indent-current-level python-indent-levels)) (save-restriction (widen) (let ((closing-block-point (python-info-closing-block))) (when closing-block-point (message "Closes %s" (buffer-substring closing-block-point (save-excursion (goto-char closing-block-point) (line-end-position)))))))) (defun python-indent-line-function () "`indent-line-function' for Python mode. See `python-indent-line' for details." (python-indent-line)) (defun python-indent-dedent-line () "De-indent current line." (interactive "*") (when (and (not (or (python-info-ppss-context 'string) (python-info-ppss-context 'comment))) (<= (point-marker) (save-excursion (back-to-indentation) (point-marker))) (> (current-column) 0)) (python-indent-line t) t)) (defun python-indent-dedent-line-backspace (arg) "De-indent current line. Argument ARG is passed to `backward-delete-char-untabify' when point is not in between the indentation." (interactive "*p") (when (not (python-indent-dedent-line)) (backward-delete-char-untabify arg))) (put 'python-indent-dedent-line-backspace 'delete-selection 'supersede) (defun python-indent-region (start end) "Indent a python region automagically. Called from a program, START and END specify the region to indent." (let ((deactivate-mark nil)) (save-excursion (goto-char end) (setq end (point-marker)) (goto-char start) (or (bolp) (forward-line 1)) (while (< (point) end) (or (and (bolp) (eolp)) (let (word) (forward-line -1) (back-to-indentation) (setq word (current-word)) (forward-line 1) (when word (beginning-of-line) (delete-horizontal-space) (indent-to (python-indent-calculate-indentation))))) (forward-line 1)) (move-marker end nil)))) (defun python-indent-shift-left (start end &optional count) "Shift lines contained in region START END by COUNT columns to the left. COUNT defaults to `python-indent-offset'. If region isn't active, the current line is shifted. The shifted region includes the lines in which START and END lie. An error is signaled if any lines in the region are indented less than COUNT columns." (interactive (if mark-active (list (region-beginning) (region-end) current-prefix-arg) (list (line-beginning-position) (line-end-position) current-prefix-arg))) (if count (setq count (prefix-numeric-value count)) (setq count python-indent-offset)) (when (> count 0) (let ((deactivate-mark nil)) (save-excursion (goto-char start) (while (< (point) end) (if (and (< (current-indentation) count) (not (looking-at "[ \t]*$"))) (error "Can't shift all lines enough")) (forward-line)) (indent-rigidly start end (- count)))))) (add-to-list 'debug-ignored-errors "^Can't shift all lines enough") (defun python-indent-shift-right (start end &optional count) "Shift lines contained in region START END by COUNT columns to the left. COUNT defaults to `python-indent-offset'. If region isn't active, the current line is shifted. The shifted region includes the lines in which START and END lie." (interactive (if mark-active (list (region-beginning) (region-end) current-prefix-arg) (list (line-beginning-position) (line-end-position) current-prefix-arg))) (let ((deactivate-mark nil)) (if count (setq count (prefix-numeric-value count)) (setq count python-indent-offset)) (indent-rigidly start end count))) (defun python-indent-electric-colon (arg) "Insert a colon and maybe de-indent the current line. With numeric ARG, just insert that many colons. With \\[universal-argument], just insert a single colon." (interactive "*P") (self-insert-command (if (not (integerp arg)) 1 arg)) (when (and (not arg) (eolp) (not (equal ?: (char-after (- (point-marker) 2)))) (not (or (python-info-ppss-context 'string) (python-info-ppss-context 'comment)))) (let ((indentation (current-indentation)) (calculated-indentation (python-indent-calculate-indentation))) (when (> indentation calculated-indentation) (save-excursion (indent-line-to calculated-indentation) (when (not (python-info-closing-block)) (indent-line-to indentation))))))) (put 'python-indent-electric-colon 'delete-selection t) ;;; Navigation (defvar python-nav-beginning-of-defun-regexp (python-rx line-start (* space) defun (+ space) (group symbol-name)) "Regular expresion matching beginning of class or function. The name of the class or function should be in a group so it can be retrieved via `match-string'.") (defun python-nav-beginning-of-defun (&optional nodecorators) "Move point to `beginning-of-defun'. When NODECORATORS is non-nil decorators are not included. This is the main part of`python-beginning-of-defun-function' implementation. Return non-nil if point is moved to the beginning-of-defun." (let ((indent-pos (save-excursion (back-to-indentation) (point-marker))) (found) (include-decorators (lambda () (when (not nodecorators) (when (save-excursion (forward-line -1) (looking-at (python-rx decorator))) (while (and (not (bobp)) (forward-line -1) (looking-at (python-rx decorator)))) (when (not (bobp)) (forward-line 1))))))) (if (and (> (point) indent-pos) (save-excursion (goto-char (line-beginning-position)) (looking-at python-nav-beginning-of-defun-regexp))) (progn (goto-char (line-beginning-position)) (funcall include-decorators) (setq found t)) (goto-char (line-beginning-position)) (when (re-search-backward python-nav-beginning-of-defun-regexp nil t) (setq found t)) (goto-char (or (python-info-ppss-context 'string) (point))) (funcall include-decorators)) found)) (defun python-beginning-of-defun-function (&optional arg nodecorators) "Move point to the beginning of def or class. With positive ARG move that number of functions forward. With negative do the same but backwards. When NODECORATORS is non-nil decorators are not included. Return non-nil if point is moved to the beginning-of-defun." (when (or (null arg) (= arg 0)) (setq arg 1)) (if (> arg 0) (dotimes (i arg (python-nav-beginning-of-defun nodecorators))) (let ((found)) (dotimes (i (- arg) found) (python-end-of-defun-function) (forward-comment 1) (goto-char (line-end-position)) (when (not (eobp)) (setq found (python-nav-beginning-of-defun nodecorators))))))) (defun python-end-of-defun-function () "Move point to the end of def or class. Returns nil if point is not in a def or class." (interactive) (let ((beg-defun-indent) (decorator-regexp "[[:space:]]*@")) (when (looking-at decorator-regexp) (while (and (not (eobp)) (forward-line 1) (looking-at decorator-regexp)))) (when (not (looking-at python-nav-beginning-of-defun-regexp)) (python-beginning-of-defun-function)) (setq beg-defun-indent (current-indentation)) (forward-line 1) (while (and (forward-line 1) (not (eobp)) (or (not (current-word)) (> (current-indentation) beg-defun-indent)))) (forward-comment 1) (goto-char (line-beginning-position)))) ;;; Shell integration (defvar python-shell-buffer-name "Python" "Default buffer name for Python interpreter.") (defcustom python-shell-interpreter "python" "Default Python interpreter for shell." :type 'string :group 'python :safe 'stringp) (defcustom python-shell-interpreter-args "-i" "Default arguments for the Python interpreter." :type 'string :group 'python :safe 'stringp) (defcustom python-shell-prompt-regexp ">>> " "Regular Expression matching top\-level input prompt of python shell. It should not contain a caret (^) at the beginning." :type 'string :group 'python :safe 'stringp) (defcustom python-shell-prompt-block-regexp "[.][.][.] " "Regular Expression matching block input prompt of python shell. It should not contain a caret (^) at the beginning." :type 'string :group 'python :safe 'stringp) (defcustom python-shell-prompt-output-regexp nil "Regular Expression matching output prompt of python shell. It should not contain a caret (^) at the beginning." :type 'string :group 'python :safe 'stringp) (defcustom python-shell-prompt-pdb-regexp "[(<]*[Ii]?[Pp]db[>)]+ " "Regular Expression matching pdb input prompt of python shell. It should not contain a caret (^) at the beginning." :type 'string :group 'python :safe 'stringp) (defcustom python-shell-send-setup-max-wait 5 "Seconds to wait for process output before code setup. If output is received before the especified time then control is returned in that moment and not after waiting." :type 'number :group 'python :safe 'numberp) (defcustom python-shell-process-environment nil "List of enviroment variables for Python shell. This variable follows the same rules as `process-enviroment' since it merges with it before the process creation routines are called. When this variable is nil, the Python shell is run with the default `process-enviroment'." :type '(repeat string) :group 'python :safe 'listp) (defcustom python-shell-exec-path nil "List of path to search for binaries. This variable follows the same rules as `exec-path' since it merges with it before the process creation routines are called. When this variable is nil, the Python shell is run with the default `exec-path'." :type '(repeat string) :group 'python :safe 'listp) (defcustom python-shell-setup-codes '(python-shell-completion-setup-code python-ffap-setup-code python-eldoc-setup-code) "List of code run by `python-shell-send-setup-codes'. Each variable can contain either a simple string with the code to execute or a cons with the form (CODE . DESCRIPTION), where CODE is a string with the code to execute and DESCRIPTION is the description of it." :type '(repeat symbol) :group 'python :safe 'listp) (defcustom python-shell-compilation-regexp-alist `((,(rx line-start (1+ (any " \t")) "File \"" (group (1+ (not (any "\"<")))) ; avoid `' &c "\", line " (group (1+ digit))) 1 2) (,(rx " in file " (group (1+ not-newline)) " on line " (group (1+ digit))) 1 2) (,(rx line-start "> " (group (1+ (not (any "(\"<")))) "(" (group (1+ digit)) ")" (1+ (not (any "("))) "()") 1 2)) "`compilation-error-regexp-alist' for inferior Python." :type '(alist string) :group 'python) (defun python-shell-get-process-name (dedicated) "Calculate the appropiate process name for inferior Python process. If DEDICATED is t and the variable `buffer-file-name' is non-nil returns a string with the form `python-shell-buffer-name'[variable `buffer-file-name'] else returns the value of `python-shell-buffer-name'. After calculating the process name adds the buffer name for the process in the `same-window-buffer-names' list." (let ((process-name (if (and dedicated buffer-file-name) (format "%s[%s]" python-shell-buffer-name buffer-file-name) (format "%s" python-shell-buffer-name)))) (add-to-list 'same-window-buffer-names (purecopy (format "*%s*" process-name))) process-name)) (defun python-shell-parse-command () "Calculate the string used to execute the inferior Python process." (format "%s %s" python-shell-interpreter python-shell-interpreter-args)) (defun python-comint-output-filter-function (output) "Hook run after content is put into comint buffer. OUTPUT is a string with the contents of the buffer." (ansi-color-filter-apply output)) (defvar inferior-python-mode-current-file nil "Current file from which a region was sent.") (make-variable-buffer-local 'inferior-python-mode-current-file) (define-derived-mode inferior-python-mode comint-mode "Inferior Python" "Major mode for Python inferior process. Runs a Python interpreter as a subprocess of Emacs, with Python I/O through an Emacs buffer. Variables `python-shell-interpreter' and `python-shell-interpreter-args' controls which Python interpreter is run. Variables `python-shell-prompt-regexp', `python-shell-prompt-output-regexp', `python-shell-prompt-block-regexp', `python-shell-completion-setup-code', `python-shell-completion-string-code', `python-eldoc-setup-code', `python-eldoc-string-code', `python-ffap-setup-code' and `python-ffap-string-code' can customize this mode for different Python interpreters. You can also add additional setup code to be run at initialization of the interpreter via `python-shell-setup-codes' variable. \(Type \\[describe-mode] in the process buffer for a list of commands.)" (set-syntax-table python-mode-syntax-table) (setq mode-line-process '(":%s")) (setq comint-prompt-regexp (format "^\\(?:%s\\|%s\\|%s\\)" python-shell-prompt-regexp python-shell-prompt-block-regexp python-shell-prompt-pdb-regexp)) (make-local-variable 'comint-output-filter-functions) (add-hook 'comint-output-filter-functions 'python-comint-output-filter-function) (add-hook 'comint-output-filter-functions 'python-pdbtrack-comint-output-filter-function) (set (make-local-variable 'compilation-error-regexp-alist) python-shell-compilation-regexp-alist) (define-key inferior-python-mode-map [remap complete-symbol] 'completion-at-point) (add-hook 'completion-at-point-functions 'python-shell-completion-complete-at-point nil 'local) (add-to-list (make-local-variable 'comint-dynamic-complete-functions) 'python-shell-completion-complete-at-point) (define-key inferior-python-mode-map (kbd "") 'python-shell-completion-complete-or-indent) (compilation-shell-minor-mode 1)) (defun run-python (dedicated cmd) "Run an inferior Python process. Input and output via buffer named after `python-shell-buffer-name'. If there is a process already running in that buffer, just switch to it. With argument, allows you to define DEDICATED, so a dedicated process for the current buffer is open, and define CMD so you can edit the command used to call the interpreter (default is value of `python-shell-interpreter' and arguments defined in `python-shell-interpreter-args'). Runs the hook `inferior-python-mode-hook' (after the `comint-mode-hook' is run). \(Type \\[describe-mode] in the process buffer for a list of commands.)" (interactive (if current-prefix-arg (list (y-or-n-p "Make dedicated process? ") (read-string "Run Python: " (python-shell-parse-command))) (list nil (python-shell-parse-command)))) (let* ((proc-name (python-shell-get-process-name dedicated)) (proc-buffer-name (format "*%s*" proc-name)) (process-environment (if python-shell-process-environment (merge 'list python-shell-process-environment process-environment 'string=) process-environment)) (exec-path (if python-shell-exec-path (merge 'list python-shell-exec-path exec-path 'string=) exec-path))) (when (not (comint-check-proc proc-buffer-name)) (let ((cmdlist (split-string-and-unquote cmd))) (set-buffer (apply 'make-comint proc-name (car cmdlist) nil (cdr cmdlist))) (inferior-python-mode))) (pop-to-buffer proc-buffer-name)) dedicated) (defun python-shell-get-process () "Get inferior Python process for current buffer and return it." (let* ((dedicated-proc-name (python-shell-get-process-name t)) (dedicated-proc-buffer-name (format "*%s*" dedicated-proc-name)) (global-proc-name (python-shell-get-process-name nil)) (global-proc-buffer-name (format "*%s*" global-proc-name)) (dedicated-running (comint-check-proc dedicated-proc-buffer-name)) (global-running (comint-check-proc global-proc-buffer-name))) ;; Always prefer dedicated (get-buffer-process (or (and dedicated-running dedicated-proc-buffer-name) (and global-running global-proc-buffer-name))))) (defun python-shell-get-or-create-process () "Get or create an inferior Python process for current buffer and return it." (let* ((old-buffer (current-buffer)) (dedicated-proc-name (python-shell-get-process-name t)) (dedicated-proc-buffer-name (format "*%s*" dedicated-proc-name)) (global-proc-name (python-shell-get-process-name nil)) (global-proc-buffer-name (format "*%s*" global-proc-name)) (dedicated-running (comint-check-proc dedicated-proc-buffer-name)) (global-running (comint-check-proc global-proc-buffer-name)) (current-prefix-arg 4)) (when (and (not dedicated-running) (not global-running)) (if (call-interactively 'run-python) (setq dedicated-running t) (setq global-running t))) ;; Always prefer dedicated (switch-to-buffer old-buffer) (get-buffer-process (if dedicated-running dedicated-proc-buffer-name global-proc-buffer-name)))) (defun python-shell-send-string (string &optional process msg) "Send STRING to inferior Python PROCESS. When MSG is non-nil messages the first line of STRING." (interactive "sPython command: ") (let ((process (or process (python-shell-get-or-create-process))) (lines (split-string string "\n" t))) (when msg (message (format "Sent: %s..." (nth 0 lines)))) (if (> (length lines) 1) (let* ((temp-file-name (make-temp-file "py")) (file-name (or (buffer-file-name) temp-file-name))) (with-temp-file temp-file-name (insert string) (delete-trailing-whitespace)) (python-shell-send-file file-name process temp-file-name)) (comint-send-string process string) (when (or (not (string-match "\n$" string)) (string-match "\n[ \t].*\n?$" string)) (comint-send-string process "\n"))))) (defun python-shell-send-string-no-output (string &optional process msg) "Send STRING to PROCESS and inhibit output. When MSG is non-nil messages the first line of STRING. Return the output." (let* ((output-buffer) (process (or process (python-shell-get-or-create-process))) (comint-preoutput-filter-functions (append comint-preoutput-filter-functions '(ansi-color-filter-apply (lambda (string) (setq output-buffer (concat output-buffer string)) ""))))) (python-shell-send-string string process msg) (accept-process-output process) ;; Cleanup output prompt regexp (when (and (not (string= "" output-buffer)) (> (length python-shell-prompt-output-regexp) 0)) (setq output-buffer (with-temp-buffer (insert output-buffer) (goto-char (point-min)) (forward-comment 1) (buffer-substring-no-properties (or (and (looking-at python-shell-prompt-output-regexp) (re-search-forward python-shell-prompt-output-regexp nil t 1)) (point-marker)) (point-max))))) (mapconcat (lambda (string) string) (butlast (split-string output-buffer "\n")) "\n"))) (defun python-shell-send-region (start end) "Send the region delimited by START and END to inferior Python process." (interactive "r") (let ((deactivate-mark nil)) (python-shell-send-string (buffer-substring start end) nil t))) (defun python-shell-send-buffer () "Send the entire buffer to inferior Python process." (interactive) (save-restriction (widen) (python-shell-send-region (point-min) (point-max)))) (defun python-shell-send-defun (arg) "Send the current defun to inferior Python process. When argument ARG is non-nil sends the innermost defun." (interactive "P") (save-excursion (python-shell-send-region (progn (or (python-beginning-of-defun-function) (progn (beginning-of-line) (point-marker)))) (progn (or (python-end-of-defun-function) (progn (end-of-line) (point-marker))))))) (defun python-shell-send-file (file-name &optional process temp-file-name) "Send FILE-NAME to inferior Python PROCESS. If TEMP-FILE-NAME is passed then that file is used for processing instead, while internally the shell will continue to use FILE-NAME." (interactive "fFile to send: ") (let* ((process (or process (python-shell-get-or-create-process))) (temp-file-name (when temp-file-name (expand-file-name temp-file-name))) (file-name (or (expand-file-name file-name) temp-file-name))) (when (not file-name) (error "If FILE-NAME is nil then TEMP-FILE-NAME must be non-nil")) (with-current-buffer (process-buffer process) (setq inferior-python-mode-current-file (convert-standard-filename file-name))) (python-shell-send-string (format (concat "__pyfile = open('''%s''');" "exec(compile(__pyfile.read(), '''%s''', 'exec'));" "__pyfile.close()") (or temp-file-name file-name) file-name) process))) (defun python-shell-switch-to-shell () "Switch to inferior Python process buffer." (interactive) (pop-to-buffer (process-buffer (python-shell-get-or-create-process)) t)) (defun python-shell-send-setup-code () "Send all setup code for shell. This function takes the list of setup code to send from the `python-shell-setup-codes' list." (let ((msg "Sent %s") (process (get-buffer-process (current-buffer)))) (accept-process-output process python-shell-send-setup-max-wait) (dolist (code python-shell-setup-codes) (when code (when (consp code) (setq msg (cdr code))) (message (format msg code)) (python-shell-send-string-no-output (symbol-value code) process))))) (add-hook 'inferior-python-mode-hook #'python-shell-send-setup-code) ;;; Shell completion (defvar python-shell-completion-setup-code "try: import readline except ImportError: def __COMPLETER_all_completions(text): [] else: import rlcompleter readline.set_completer(rlcompleter.Completer().complete) def __COMPLETER_all_completions(text): import sys completions = [] try: i = 0 while True: res = readline.get_completer()(text, i) if not res: break i += 1 completions.append(res) except NameError: pass return completions" "Code used to setup completion in inferior Python processes.") (defvar python-shell-completion-string-code "';'.join(__COMPLETER_all_completions('''%s'''))\n" "Python code used to get a string of completions separated by semicolons.") (defun python-shell-completion--get-completions (input process) "Retrieve available completions for INPUT using PROCESS." (with-current-buffer (process-buffer process) (let ((completions (python-shell-send-string-no-output (format python-shell-completion-string-code input) process))) (when (> (length completions) 2) (split-string completions "^'\\|^\"\\|;\\|'$\\|\"$" t))))) (defun python-shell-completion--get-completion (input completions) "Get completion for INPUT using COMPLETIONS." (let ((completion (when completions (try-completion input completions)))) (cond ((eq completion t) input) ((null completion) (message "Can't find completion for \"%s\"" input) (ding) input) ((not (string= input completion)) completion) (t (message "Making completion list...") (with-output-to-temp-buffer "*Python Completions*" (display-completion-list (all-completions input completions))) input)))) (defun python-shell-completion-complete-at-point () "Perform completion at point in inferior Python process." (interactive) (with-syntax-table python-dotty-syntax-table (when (and comint-last-prompt-overlay (> (point-marker) (overlay-end comint-last-prompt-overlay))) (let* ((process (get-buffer-process (current-buffer))) (input (substring-no-properties (or (comint-word (current-word)) "") nil nil))) (delete-char (- (length input))) (insert (python-shell-completion--get-completion input (python-shell-completion--get-completions input process))))))) (defun python-shell-completion-complete-or-indent () "Complete or indent depending on the context. If content before pointer is all whitespace indent. If not try to complete." (interactive) (if (string-match "^[[:space:]]*$" (buffer-substring (comint-line-beginning-position) (point-marker))) (indent-for-tab-command) (comint-dynamic-complete))) ;;; PDB Track integration (defvar python-pdbtrack-stacktrace-info-regexp "> %s(\\([0-9]+\\))\\([?a-zA-Z0-9_<>]+\\)()" "Regular Expression matching stacktrace information. Used to extract the current line and module beign inspected. The regexp should not start with a caret (^) and can contain a string placeholder (\%s) which is replaced with the filename beign inspected (so other files in the debugging process are not opened)") (defvar python-pdbtrack-tracking-buffers '() "Alist containing elements of form (# . #). The car of each element of the alist is the tracking buffer and the cdr is the tracked buffer.") (defun python-pdbtrack-get-or-add-tracking-buffers () "Get/Add a tracked buffer for the current buffer. Internally it uses the `python-pdbtrack-tracking-buffers' alist. Returns a cons with the form: * (# . #< tracked buffer>)." (or (assq (current-buffer) python-pdbtrack-tracking-buffers) (let* ((file (with-current-buffer (current-buffer) inferior-python-mode-current-file)) (tracking-buffers `(,(current-buffer) . ,(or (get-file-buffer file) (find-file-noselect file))))) (set-buffer (cdr tracking-buffers)) (python-mode) (set-buffer (car tracking-buffers)) (setq python-pdbtrack-tracking-buffers (cons tracking-buffers python-pdbtrack-tracking-buffers)) tracking-buffers))) (defun python-pdbtrack-comint-output-filter-function (output) "Move overlay arrow to current pdb line in tracked buffer. Argument OUTPUT is a string with the output from the comint process." (when (not (string= output "")) (let ((full-output (ansi-color-filter-apply (buffer-substring comint-last-input-end (point-max))))) (if (string-match python-shell-prompt-pdb-regexp full-output) (let* ((tracking-buffers (python-pdbtrack-get-or-add-tracking-buffers)) (line-num (save-excursion (string-match (format python-pdbtrack-stacktrace-info-regexp (regexp-quote inferior-python-mode-current-file)) full-output) (string-to-number (or (match-string-no-properties 1 full-output) "")))) (tracked-buffer-window (get-buffer-window (cdr tracking-buffers))) (tracked-buffer-line-pos)) (when line-num (with-current-buffer (cdr tracking-buffers) (set (make-local-variable 'overlay-arrow-string) "=>") (set (make-local-variable 'overlay-arrow-position) (make-marker)) (setq tracked-buffer-line-pos (progn (goto-char (point-min)) (forward-line (1- line-num)) (point-marker))) (when tracked-buffer-window (set-window-point tracked-buffer-window tracked-buffer-line-pos)) (set-marker overlay-arrow-position tracked-buffer-line-pos))) (pop-to-buffer (cdr tracking-buffers)) (switch-to-buffer-other-window (car tracking-buffers))) (let ((tracking-buffers (assq (current-buffer) python-pdbtrack-tracking-buffers))) (when tracking-buffers (if inferior-python-mode-current-file (with-current-buffer (cdr tracking-buffers) (set-marker overlay-arrow-position nil)) (kill-buffer (cdr tracking-buffers))) (setq python-pdbtrack-tracking-buffers (assq-delete-all (current-buffer) python-pdbtrack-tracking-buffers))))))) output) ;;; Symbol completion (defun python-completion-complete-at-point () "Complete current symbol at point. For this to work the best as possible you should call `python-shell-send-buffer' from time to time so context in inferior python process is updated properly." (interactive) (let ((process (python-shell-get-process))) (if (not process) (error "Completion needs an inferior Python process running") (with-syntax-table python-dotty-syntax-table (let* ((input (substring-no-properties (or (comint-word (current-word)) "") nil nil)) (completions (python-shell-completion--get-completions input process))) (delete-char (- (length input))) (insert (python-shell-completion--get-completion input completions))))))) (add-to-list 'debug-ignored-errors "^Completion needs an inferior Python process running.") ;;; Fill paragraph (defcustom python-fill-comment-function 'python-fill-comment "Function to fill comments. This is the function used by `python-fill-paragraph-function' to fill comments." :type 'symbol :group 'python :safe 'symbolp) (defcustom python-fill-string-function 'python-fill-string "Function to fill strings. This is the function used by `python-fill-paragraph-function' to fill strings." :type 'symbol :group 'python :safe 'symbolp) (defcustom python-fill-decorator-function 'python-fill-decorator "Function to fill decorators. This is the function used by `python-fill-paragraph-function' to fill decorators." :type 'symbol :group 'python :safe 'symbolp) (defcustom python-fill-paren-function 'python-fill-paren "Function to fill parens. This is the function used by `python-fill-paragraph-function' to fill parens." :type 'symbol :group 'python :safe 'symbolp) (defun python-fill-paragraph-function (&optional justify) "`fill-paragraph-function' handling multi-line strings and possibly comments. If any of the current line is in or at the end of a multi-line string, fill the string or the paragraph of it that point is in, preserving the string's indentation. Optional argument JUSTIFY defines if the paragraph should be justified." (interactive "P") (save-excursion (back-to-indentation) (cond ;; Comments ((funcall python-fill-comment-function justify)) ;; Strings/Docstrings ((save-excursion (skip-chars-forward "\"'uUrR") (python-info-ppss-context 'string)) (funcall python-fill-string-function justify)) ;; Decorators ((equal (char-after (save-excursion (back-to-indentation) (point-marker))) ?@) (funcall python-fill-decorator-function justify)) ;; Parens ((or (python-info-ppss-context 'paren) (looking-at (python-rx open-paren)) (save-excursion (skip-syntax-forward "^(" (line-end-position)) (looking-at (python-rx open-paren)))) (funcall python-fill-paren-function justify)) (t t)))) (defun python-fill-comment (&optional justify) "Comment fill function for `python-fill-paragraph-function'. JUSTIFY should be used (if applicable) as in `fill-paragraph'." (fill-comment-paragraph justify)) (defun python-fill-string (&optional justify) "String fill function for `python-fill-paragraph-function'. JUSTIFY should be used (if applicable) as in `fill-paragraph'." (let ((marker (point-marker)) (string-start-marker (progn (skip-chars-forward "\"'uUrR") (goto-char (python-info-ppss-context 'string)) (skip-chars-forward "\"'uUrR") (point-marker))) (reg-start (line-beginning-position)) (string-end-marker (progn (while (python-info-ppss-context 'string) (goto-char (1+ (point-marker)))) (skip-chars-backward "\"'") (point-marker))) (reg-end (line-end-position)) (fill-paragraph-function)) (save-restriction (narrow-to-region reg-start reg-end) (save-excursion (goto-char string-start-marker) (delete-region (point-marker) (progn (skip-syntax-forward "> ") (point-marker))) (goto-char string-end-marker) (delete-region (point-marker) (progn (skip-syntax-backward "> ") (point-marker))) (save-excursion (goto-char marker) (fill-paragraph justify)) ;; If there is a newline in the docstring lets put triple ;; quote in it's own line to follow pep 8 (when (save-excursion (re-search-backward "\n" string-start-marker t)) (newline) (newline-and-indent)) (fill-paragraph justify)))) t) (defun python-fill-decorator (&optional justify) "Decorator fill function for `python-fill-paragraph-function'. JUSTIFY should be used (if applicable) as in `fill-paragraph'." t) (defun python-fill-paren (&optional justify) "Paren fill function for `python-fill-paragraph-function'. JUSTIFY should be used (if applicable) as in `fill-paragraph'." (save-restriction (narrow-to-region (progn (while (python-info-ppss-context 'paren) (goto-char (1- (point-marker)))) (point-marker) (line-beginning-position)) (progn (when (not (python-info-ppss-context 'paren)) (end-of-line) (when (not (python-info-ppss-context 'paren)) (skip-syntax-backward "^)"))) (while (python-info-ppss-context 'paren) (goto-char (1+ (point-marker)))) (point-marker))) (let ((paragraph-start "\f\\|[ \t]*$") (paragraph-separate ",") (fill-paragraph-function)) (goto-char (point-min)) (fill-paragraph justify)) (while (not (eobp)) (forward-line 1) (python-indent-line) (goto-char (line-end-position)))) t) ;;; Skeletons (defcustom python-skeleton-autoinsert nil "Non-nil means template skeletons will be automagically inserted. This happens when pressing \"if\", for example, to prompt for the if condition." :type 'boolean :group 'python) (defvar python-skeleton-available '() "Internal list of available skeletons.") (make-variable-buffer-local 'inferior-python-mode-current-file) (define-abbrev-table 'python-mode-abbrev-table () "Abbrev table for Python mode." :case-fixed t ;; Allow / inside abbrevs. :regexp "\\(?:^\\|[^/]\\)\\<\\([[:word:]/]+\\)\\W*" ;; Only expand in code. :enable-function (lambda () (and (not (or (python-info-ppss-context 'string) (python-info-ppss-context 'comment))) python-skeleton-autoinsert))) (defmacro python-skeleton-define (name doc &rest skel) "Define a `python-mode' skeleton using NAME DOC and SKEL. The skeleton will be bound to python-skeleton-NAME and will be added to `python-mode-abbrev-table'." (let* ((name (symbol-name name)) (function-name (intern (concat "python-skeleton-" name)))) `(progn (define-abbrev python-mode-abbrev-table ,name "" ',function-name) (setq python-skeleton-available (cons ',function-name python-skeleton-available)) (define-skeleton ,function-name ,(or doc (format "Insert %s statement." name)) ,@skel)))) (put 'python-skeleton-define 'lisp-indent-function 2) (defmacro python-define-auxiliary-skeleton (name doc &optional &rest skel) "Define a `python-mode' auxiliary skeleton using NAME DOC and SKEL. The skeleton will be bound to python-skeleton-NAME." (let* ((name (symbol-name name)) (function-name (intern (concat "python-skeleton--" name))) (msg (format "Add '%s' clause? " name))) (when (not skel) (setq skel `(< ,(format "%s:" name) \n \n > _ \n))) `(define-skeleton ,function-name ,(or doc (format "Auxiliary skeleton for %s statement." name)) nil (unless (y-or-n-p ,msg) (signal 'quit t)) ,@skel))) (put 'python-define-auxiliary-skeleton 'lisp-indent-function 2) (python-define-auxiliary-skeleton else nil) (python-define-auxiliary-skeleton except nil) (python-define-auxiliary-skeleton finally nil) (python-skeleton-define if nil "Condition: " "if " str ":" \n _ \n ("other condition, %s: " < "elif " str ":" \n > _ \n nil) '(python-skeleton--else) | ^) (python-skeleton-define while nil "Condition: " "while " str ":" \n > _ \n '(python-skeleton--else) | ^) (python-skeleton-define for nil "Iteration spec: " "for " str ":" \n > _ \n '(python-skeleton--else) | ^) (python-skeleton-define try nil nil "try:" \n > _ \n ("Exception, %s: " < "except " str ":" \n > _ \n nil) resume: '(python-skeleton--except) '(python-skeleton--else) '(python-skeleton--finally) | ^) (python-skeleton-define def nil "Function name: " "def " str " (" ("Parameter, %s: " (unless (equal ?\( (char-before)) ", ") str) "):" \n "\"\"\"" - "\"\"\"" \n > _ \n) (python-skeleton-define class nil "Class name: " "class " str " (" ("Inheritance, %s: " (unless (equal ?\( (char-before)) ", ") str) & ")" | -2 ":" \n "\"\"\"" - "\"\"\"" \n > _ \n) (defun python-skeleton-add-menu-items () "Add menu items to Python->Skeletons menu." (let ((skeletons (sort python-skeleton-available 'string<)) (items)) (dolist (skeleton skeletons) (easy-menu-add-item nil '("Python" "Skeletons") `[,(format "Insert %s" (caddr (split-string (symbol-name skeleton) "-"))) ,skeleton t])))) ;;; FFAP (defvar python-ffap-setup-code "def __FFAP_get_module_path(module): try: import os path = __import__(module).__file__ if path[-4:] == '.pyc' and os.path.exists(path[0:-1]): path = path[:-1] return path except: return ''" "Python code to get a module path.") (defvar python-ffap-string-code "__FFAP_get_module_path('''%s''')\n" "Python code used to get a string with the path of a module.") (defun python-ffap-module-path (module) "Function for `ffap-alist' to return path for MODULE." (let ((process (or (and (eq major-mode 'inferior-python-mode) (get-buffer-process (current-buffer))) (python-shell-get-process)))) (if (not process) nil (let ((module-file (python-shell-send-string-no-output (format python-ffap-string-code module) process))) (when module-file (substring-no-properties module-file 1 -1)))))) (eval-after-load "ffap" '(progn (push '(python-mode . python-ffap-module-path) ffap-alist) (push '(inferior-python-mode . python-ffap-module-path) ffap-alist))) ;;; Code check (defvar python-check-command "pychecker --stdlib" "Command used to check a Python file.") (defvar python-check-custom-command nil "Internal use.") (defun python-check (command) "Check a Python file (default current buffer's file). Runs COMMAND, a shell command, as if by `compile'. See `python-check-command' for the default." (interactive (list (read-string "Check command: " (or python-check-custom-command (concat python-check-command " " (shell-quote-argument (or (let ((name (buffer-file-name))) (and name (file-name-nondirectory name))) ""))))))) (setq python-check-custom-command command) (save-some-buffers (not compilation-ask-about-save) nil) (compilation-start command)) ;;; Eldoc (defvar python-eldoc-setup-code "def __PYDOC_get_help(obj): try: import pydoc if hasattr(obj, 'startswith'): obj = eval(obj, globals()) doc = pydoc.getdoc(obj) except: doc = '' try: exec('print doc') except SyntaxError: print(doc)" "Python code to setup documentation retrieval.") (defvar python-eldoc-string-code "__PYDOC_get_help('''%s''')\n" "Python code used to get a string with the documentation of an object.") (defun python-eldoc--get-doc-at-point (&optional force-input force-process) "Internal implementation to get documentation at point. If not FORCE-INPUT is passed then what `current-word' returns will be used. If not FORCE-PROCESS is passed what `python-shell-get-process' returns is used." (let ((process (or force-process (python-shell-get-process)))) (if (not process) "Eldoc needs an inferior Python process running." (let* ((current-defun (python-info-current-defun)) (input (or force-input (with-syntax-table python-dotty-syntax-table (if (not current-defun) (current-word) (concat current-defun "." (current-word)))))) (ppss (syntax-ppss)) (help (when (and input (not (string= input (concat current-defun "."))) (not (or (python-info-ppss-context 'string ppss) (python-info-ppss-context 'comment ppss)))) (when (string-match (concat (regexp-quote (concat current-defun ".")) "self\\.") input) (with-temp-buffer (insert input) (goto-char (point-min)) (forward-word) (forward-char) (delete-region (point-marker) (search-forward "self.")) (setq input (buffer-substring (point-min) (point-max))))) (python-shell-send-string-no-output (format python-eldoc-string-code input) process)))) (with-current-buffer (process-buffer process) (when comint-last-prompt-overlay (delete-region comint-last-input-end (overlay-start comint-last-prompt-overlay)))) (when (and help (not (string= help "\n"))) help))))) (defun python-eldoc-function () "`eldoc-documentation-function' for Python. For this to work the best as possible you should call `python-shell-send-buffer' from time to time so context in inferior python process is updated properly." (python-eldoc--get-doc-at-point)) (defun python-eldoc-at-point (symbol) "Get help on SYMBOL using `help'. Interactively, prompt for symbol." (interactive (let ((symbol (with-syntax-table python-dotty-syntax-table (current-word))) (enable-recursive-minibuffers t)) (list (read-string (if symbol (format "Describe symbol (default %s): " symbol) "Describe symbol: ") nil nil symbol)))) (let ((process (python-shell-get-process))) (if (not process) (message "Eldoc needs an inferior Python process running.") (let ((temp-buffer-show-hook (lambda () (toggle-read-only 1) (setq view-return-to-alist (list (cons (selected-window) help-return-method)))))) (with-output-to-temp-buffer (help-buffer) (with-current-buffer standard-output (insert (python-eldoc--get-doc-at-point symbol process)) (help-print-return-message))))))) ;;; Misc helpers (defun python-info-current-defun () "Return name of surrounding function with Python compatible dotty syntax. This function is compatible to be used as `add-log-current-defun-function' since it returns nil if point is not inside a defun." (let ((names '()) (min-indent)) (save-restriction (widen) (save-excursion (goto-char (line-end-position)) (forward-comment -1) (while (and (not (equal 0 (current-indentation))) (python-beginning-of-defun-function 1 t)) (when (or (not min-indent) (< (current-indentation) min-indent)) (setq min-indent (current-indentation)) (looking-at python-nav-beginning-of-defun-regexp) (setq names (cons (match-string-no-properties 1) names)))))) (when names (mapconcat (lambda (string) string) names ".")))) (defun python-info-closing-block () "Return the point of the block the current line closes." (let ((closing-word (save-excursion (back-to-indentation) (current-word))) (indentation (current-indentation))) (when (member closing-word python-indent-dedenters) (save-excursion (forward-line -1) (while (and (> (current-indentation) indentation) (not (bobp)) (not (back-to-indentation)) (forward-line -1))) (back-to-indentation) (cond ((not (equal indentation (current-indentation))) nil) ((string= closing-word "elif") (when (member (current-word) '("if" "elif")) (point-marker))) ((string= closing-word "else") (when (member (current-word) '("if" "elif" "except" "for" "while")) (point-marker))) ((string= closing-word "except") (when (member (current-word) '("try")) (point-marker))) ((string= closing-word "finally") (when (member (current-word) '("except" "else")) (point-marker)))))))) (defun python-info-line-ends-backslash-p () "Return non-nil if current line ends with backslash." (string= (or (ignore-errors (buffer-substring (line-end-position) (- (line-end-position) 1))) "") "\\")) (defun python-info-continuation-line-p () "Return non-nil if current line is continuation of another." (or (python-info-line-ends-backslash-p) (string-match ",[[:space:]]*$" (buffer-substring (line-beginning-position) (line-end-position))) (save-excursion (let ((innermost-paren (progn (goto-char (line-end-position)) (python-info-ppss-context 'paren)))) (when (and innermost-paren (and (<= (line-beginning-position) innermost-paren) (>= (line-end-position) innermost-paren))) (goto-char innermost-paren) (looking-at (python-rx open-paren (* space) line-end))))) (save-excursion (back-to-indentation) (python-info-ppss-context 'paren)))) (defun python-info-block-continuation-line-p () "Return non-nil if current line is a continuation of a block." (save-excursion (while (and (not (bobp)) (python-info-continuation-line-p)) (forward-line -1)) (forward-line 1) (back-to-indentation) (when (looking-at (python-rx block-start)) (point-marker)))) (defun python-info-assignment-continuation-line-p () "Return non-nil if current line is a continuation of an assignment." (save-excursion (while (and (not (bobp)) (python-info-continuation-line-p)) (forward-line -1)) (forward-line 1) (back-to-indentation) (when (and (not (looking-at (python-rx block-start))) (save-excursion (and (re-search-forward (python-rx not-simple-operator assignment-operator not-simple-operator) (line-end-position) t) (not (or (python-info-ppss-context 'string) (python-info-ppss-context 'paren) (python-info-ppss-context 'comment)))))) (point-marker)))) (defun python-info-ppss-context (type &optional syntax-ppss) "Return non-nil if point is on TYPE using SYNTAX-PPSS. TYPE can be 'comment, 'string or 'parent. It returns the start character address of the specified TYPE." (let ((ppss (or syntax-ppss (syntax-ppss)))) (case type ('comment (and (nth 4 ppss) (nth 8 ppss))) ('string (nth 8 ppss)) ('paren (nth 1 ppss)) (t nil)))) ;;;###autoload (define-derived-mode python-mode fundamental-mode "Python" "Major mode for editing Python files. \\{python-mode-map} Entry to this mode calls the value of `python-mode-hook' if that value is non-nil." (set (make-local-variable 'tab-width) 8) (set (make-local-variable 'indent-tabs-mode) nil) (set (make-local-variable 'comment-start) "# ") (set (make-local-variable 'comment-start-skip) "#+\\s-*") (set (make-local-variable 'parse-sexp-lookup-properties) t) (set (make-local-variable 'parse-sexp-ignore-comments) t) (set (make-local-variable 'font-lock-defaults) '(python-font-lock-keywords nil nil nil nil (font-lock-syntactic-keywords . python-font-lock-syntactic-keywords))) (set (make-local-variable 'indent-line-function) #'python-indent-line-function) (set (make-local-variable 'indent-region-function) #'python-indent-region) (set (make-local-variable 'paragraph-start) "\\s-*$") (set (make-local-variable 'fill-paragraph-function) 'python-fill-paragraph-function) (set (make-local-variable 'beginning-of-defun-function) #'python-beginning-of-defun-function) (set (make-local-variable 'end-of-defun-function) #'python-end-of-defun-function) (add-hook 'completion-at-point-functions 'python-completion-complete-at-point nil 'local) (set (make-local-variable 'add-log-current-defun-function) #'python-info-current-defun) (set (make-local-variable 'skeleton-further-elements) '((abbrev-mode nil) (< '(backward-delete-char-untabify (min python-indent-offset (current-column)))) (^ '(- (1+ (current-indentation)))))) (set (make-local-variable 'eldoc-documentation-function) #'python-eldoc-function) (add-to-list 'hs-special-modes-alist `(python-mode "^\\s-*\\(?:def\\|class\\)\\>" nil "#" ,(lambda (arg) (python-end-of-defun-function)) nil)) (set (make-local-variable 'outline-regexp) (python-rx (* space) block-start)) (set (make-local-variable 'outline-heading-end-regexp) ":\\s-*\n") (set (make-local-variable 'outline-level) #'(lambda () "`outline-level' function for Python mode." (1+ (/ (current-indentation) python-indent-offset)))) (python-skeleton-add-menu-items) (when python-indent-guess-indent-offset (python-indent-guess-indent-offset))) (provide 'python) ;;; python.el ends here