python.el 83.1 KB
Newer Older
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1 2
;;; python.el -- Python's flying circus support for Emacs

3
;; Copyright (C) 2010, 2011 Free Software Foundation, Inc.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36

;; Author: Fabián E. Gallina <fabian@anue.biz>
;; 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 <http://www.gnu.org/licenses/>.

;;; 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,
37
;; Skeletons, FFAP, Code Check, Eldoc.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
38 39 40 41 42 43

;; 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
44 45 46
;; indentation by hitting <tab> 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.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
47 48

;; Movement: `beginning-of-defun' and `end-of-defun' functions are
49
;; properly implemented.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
50 51 52 53 54

;; 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
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
55
;; word.  Shell completion is implemented in a manner that if you
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
56 57
;; change the `python-shell-interpreter' to any other (for example
;; IPython) it should be easy to integrate another way to calculate
58
;; completions.  You just need to specify your custom
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
59
;; `python-shell-completion-setup-code' and
60 61 62 63 64 65 66 67 68 69 70 71 72
;; `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")
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
73

74 75 76 77 78 79
;; 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.

80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
;; 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/"))

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
100 101 102 103
;; 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.

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
104
;; Symbol completion: you can complete the symbol at point.  It uses
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
105 106 107
;; the shell completion in background so you should run
;; `python-shell-send-buffer' from time to time to get better results.

108 109 110 111 112 113 114
;; 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.

115 116 117 118
;; 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.

119 120 121
;; Code check: Check the current file for errors using
;; `python-check-command'

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
122
;; Eldoc: returns documentation for object at point by using the
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
123
;; inferior python subprocess to inspect its documentation.  As you
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
124 125 126
;; might guessed you should run `python-shell-send-buffer' from time
;; to time to get better results too.

127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
;; 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.

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
142 143 144 145 146 147 148 149 150 151 152 153 154
;;; 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

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
155
;; Review code and cleanup
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
156 157 158 159

;;; Code:

(require 'ansi-color)
160
(require 'comint)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
161 162

(eval-when-compile
163 164 165 166 167
  (require 'cl)
  ;; Avoid compiler warnings
  (defvar view-return-to-alist)
  (defvar compilation-error-regexp-alist)
  (defvar outline-heading-end-regexp))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191

(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 "<backtab>") 'python-indent-dedent-line)
    (define-key map "\C-c<" 'python-indent-shift-left)
    (define-key map "\C-c>" 'python-indent-shift-right)
192
    (define-key map ":" 'python-indent-electric-colon)
193 194 195 196 197 198 199
    ;; 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)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
200 201 202 203 204 205 206
    ;; 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)
207 208
    ;; Some util commands
    (define-key map "\C-c\C-v" 'python-check)
209
    (define-key map "\C-c\C-f" 'python-eldoc-at-point)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
    ;; 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"]
        "-"
229 230
	("Skeletons")
        "-"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
	["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"]
        "-"
247 248
	["Check file" python-check
	 :help "Check file for errors"]
249 250
	["Help on symbol" python-eldoc-at-point
	 :help "Get help on symbol at point"]
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
251 252 253 254 255 256 257 258
	["Complete symbol" completion-at-point
	 :help "Complete symbol before point"]))
    map)
  "Keymap for `python-mode'.")


;;; Python specialized rx

259 260 261 262 263 264 265
(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))
266 267
     `(decorator            . ,(rx line-start (* space) ?@ (any letter ?_)
                                    (* (any word ?_))))
268
     `(defun                . ,(rx symbol-start (or "def" "class") symbol-end))
269
     `(symbol-name          . ,(rx (any letter ?_) (* (any word ?_))))
270 271 272 273 274 275 276 277
     `(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 "=" "+=" "-=" "*=" "/=" "//=" "%=" "**="
278 279
                                       ">>=" "<<=" "&=" "^=" "|="))))
    "Additional Python specific sexps for `python-rx'"))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
280 281

(defmacro python-rx (&rest regexps)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
282
 "Python mode especialized rx macro which supports common python named REGEXPS."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
 (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)
351 352
        (let ((re (python-rx (group (+ (any word ?. ?_)))
                             (? ?\[ (+ (not (any  ?\]))) ?\]) (* space)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
353 354
                             assignment-operator)))
          (when (re-search-forward re limit t)
355
            (while (and (python-info-ppss-context 'paren)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
356
                        (re-search-forward re limit t)))
357
            (if (and (not (python-info-ppss-context 'paren))
358
                     (not (equal (char-after (point-marker)) ?=)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
359 360 361 362 363 364 365 366 367 368 369
                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))))
370
            (while (and (python-info-ppss-context 'paren)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
371 372
                        (re-search-forward re limit t))
              (goto-char (nth 3 (match-data))))
373
            (if (not (python-info-ppss-context 'paren))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
                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 ()
492
  "Guess and set `python-indent-offset' for the current buffer."
493 494 495 496 497 498 499 500
    (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))
501 502
            (when (and (not (python-info-ppss-context 'string))
                       (not (python-info-ppss-context 'comment))
503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
                       (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)
518 519 520
            (let ((indent-offset (current-indentation)))
              (when (> indent-offset 0)
                (setq python-indent-offset indent-offset))))))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
521

522 523 524 525
(defun python-indent-context ()
  "Get information on indentation context.
Context information is returned with a cons with the form:
    \(STATUS . START)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540

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
541
        ;; Beginning of buffer
542 543 544
        ((save-excursion
           (goto-char (line-beginning-position))
           (bobp))
545
         'no-indent)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
546
        ;; Inside a paren
547
        ((setq start (python-info-ppss-context 'paren ppss))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
548 549
         'inside-paren)
        ;; Inside string
550
        ((setq start (python-info-ppss-context 'string ppss))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
551 552
         'inside-string)
        ;; After backslash
553 554
        ((setq start (when (not (or (python-info-ppss-context 'string ppss)
                                    (python-info-ppss-context 'comment ppss)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
                       (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))
590
                                   (if (python-info-ppss-context 'paren)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
                                       (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)))
637 638 639 640 641 642 643 644 645 646 647
                  (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))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
                  (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))
664 665
                                     (dot-continuation
                                      dot-continuation)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
666 667 668 669 670
                                     (t
                                      (goto-char context-start)
                                      (current-indentation)))))
             indentation))
          ('inside-paren
671 672
           (or (save-excursion
                 (forward-comment 1)
673 674 675
                 (when (and (looking-at (regexp-opt '(")" "]" "}")))
                            (not (forward-char 1))
                            (not (python-info-ppss-context 'paren)))
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696
                   (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)))))))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
697 698 699 700 701 702

(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)))
703
    (setq python-indent-levels '(0))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
    (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
724 725
indicated by the variable `python-indent-levels' to set the
current indentation.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
726 727

When the variable `last-command' is equal to
728 729 730 731
`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'.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
732 733

When the variable `last-command' is not equal to
734 735 736 737 738
`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')"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
739 740 741
  (if (or (and (eq this-command 'indent-for-tab-command)
               (eq last-command this-command))
          force-toggle)
742 743 744
      (if (not (equal python-indent-levels '(0)))
          (python-indent-toggle-levels)
        (python-indent-calculate-levels))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
    (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.
761
See `python-indent-line' for details."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
762 763 764
  (python-indent-line))

(defun python-indent-dedent-line ()
765
  "De-indent current line."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
766
  (interactive "*")
767 768
  (when (and (not (or (python-info-ppss-context 'string)
                      (python-info-ppss-context 'comment)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
769 770 771 772 773 774 775 776
             (<= (point-marker) (save-excursion
                                  (back-to-indentation)
                                  (point-marker)))
             (> (current-column) 0))
    (python-indent-line t)
    t))

(defun python-indent-dedent-line-backspace (arg)
777
  "De-indent current line.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
778
Argument ARG is passed to `backward-delete-char-untabify' when
779
point is  not in between the indentation."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
780 781 782
  (interactive "*p")
  (when (not (python-indent-dedent-line))
    (backward-delete-char-untabify arg)))
783
(put 'python-indent-dedent-line-backspace 'delete-selection 'supersede)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
784 785 786 787 788

(defun python-indent-region (start end)
  "Indent a python region automagically.

Called from a program, START and END specify the region to indent."
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
  (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))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
808 809 810

(defun python-indent-shift-left (start end &optional count)
  "Shift lines contained in region START END by COUNT columns to the left.
811 812 813 814
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."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
815 816 817 818 819 820 821 822
  (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)
823 824 825 826 827 828 829 830 831
    (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))))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
832 833 834 835 836

(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.
837 838 839
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."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
840 841 842 843
  (interactive
   (if mark-active
       (list (region-beginning) (region-end) current-prefix-arg)
     (list (line-beginning-position) (line-end-position) current-prefix-arg)))
844 845 846 847 848
  (let ((deactivate-mark nil))
    (if count
        (setq count (prefix-numeric-value count))
      (setq count python-indent-offset))
    (indent-rigidly start end count)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
849

850
(defun python-indent-electric-colon (arg)
851 852 853
  "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."
854 855
  (interactive "*P")
  (self-insert-command (if (not (integerp arg)) 1 arg))
856 857 858 859 860 861 862 863 864 865 866 867
  (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)))))))
868 869
(put 'python-indent-electric-colon 'delete-selection t)

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
870 871 872

;;; Navigation

873 874
(defvar python-nav-beginning-of-defun-regexp
  (python-rx line-start (* space) defun (+ space) symbol-name)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
875 876
  "Regular expresion matching beginning of innermost class or function.")

877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
(defun python-nav-beginning-of-defun ()
  "Move point to beginning-of-defun.
This is the main part of`python-beginning-of-defun-function'
implementation."
  (let ((indent-pos (save-excursion
                      (back-to-indentation)
                      (point-marker)))
        (include-decorators
         (lambda ()
           (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)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
897
        (progn
898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
          (goto-char (line-beginning-position))
          (funcall include-decorators))
      (goto-char (line-beginning-position))
      (re-search-backward python-nav-beginning-of-defun-regexp nil t)
      (goto-char (or (python-info-ppss-context 'string) (point)))
      (funcall include-decorators))))

(defun python-beginning-of-defun-function (&optional arg)
  "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 (or (null arg) (= arg 0)) (setq arg 1))
  (if (> arg 0)
      (dotimes (i arg)
        (python-nav-beginning-of-defun))
    (dotimes (i (- arg))
      (python-end-of-defun-function)
      (forward-comment 1)
      (goto-char (line-end-position))
      (when (not (eobp))
        (python-nav-beginning-of-defun)))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
919 920 921 922

(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."
923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
  (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))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
940 941 942 943 944 945 946 947 948 949


;;; 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
950
  :group 'python
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
951 952 953 954 955
  :safe 'stringp)

(defcustom python-shell-interpreter-args "-i"
  "Default arguments for the Python interpreter."
  :type 'string
956
  :group 'python
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
957 958 959
  :safe 'stringp)

(defcustom python-shell-prompt-regexp ">>> "
960 961
  "Regular Expression matching top\-level input prompt of python shell.
It should not contain a caret (^) at the beginning."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
962 963 964 965 966
  :type 'string
  :group 'python
  :safe 'stringp)

(defcustom python-shell-prompt-block-regexp "[.][.][.] "
967 968
  "Regular Expression matching block input prompt of python shell.
It should not contain a caret (^) at the beginning."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
969 970 971 972
  :type 'string
  :group 'python
  :safe 'stringp)

973
(defcustom python-shell-prompt-output-regexp nil
974 975
  "Regular Expression matching output prompt of python shell.
It should not contain a caret (^) at the beginning."
976 977 978 979
  :type 'string
  :group 'python
  :safe 'stringp)

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
980
(defcustom python-shell-prompt-pdb-regexp "[(<]*[Ii]?[Pp]db[>)]+ "
981 982
  "Regular Expression matching pdb input prompt of python shell.
It should not contain a caret (^) at the beginning."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
983 984 985 986
  :type 'string
  :group 'python
  :safe 'stringp)

987 988 989 990 991 992 993 994
(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)

995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
(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)

1015 1016 1017 1018
(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'.
1019
Each variable can contain either a simple string with the code to
1020 1021 1022 1023 1024 1025 1026
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)

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
(defcustom python-shell-compilation-regexp-alist
  `((,(rx line-start (1+ (any " \t")) "File \""
	  (group (1+ (not (any "\"<")))) ; avoid `<stdin>' &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
1047 1048 1049
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."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
  (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 ()
1060
  "Calculate the string used to execute the inferior Python process."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
  (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"
1073
  "Major mode for Python inferior process.
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
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.)"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
  (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)
1105 1106 1107 1108
  (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)
1109 1110 1111 1112
  (add-to-list (make-local-variable 'comint-dynamic-complete-functions)
               'python-shell-completion-complete-at-point)
  (define-key inferior-python-mode-map (kbd "<tab>")
    'python-shell-completion-complete-or-indent)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1113 1114 1115 1116
  (compilation-shell-minor-mode 1))

(defun run-python (dedicated cmd)
  "Run an inferior Python process.
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127
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.)"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1128 1129 1130 1131 1132 1133 1134
  (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))
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
         (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)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
    (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."
1169 1170
  (let* ((old-buffer (current-buffer))
         (dedicated-proc-name (python-shell-get-process-name t))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181
         (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
1182
    (switch-to-buffer old-buffer)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1183 1184 1185 1186
    (get-buffer-process (if dedicated-running
                            dedicated-proc-buffer-name
                          global-proc-buffer-name))))

1187 1188 1189
(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."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1190
  (interactive "sPython command: ")
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208
  (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.
1209 1210
When MSG is non-nil messages the first line of STRING.  Return
the output."
1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
  (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)
1221 1222 1223 1224 1225
    ;; Cleanup output prompt regexp
    (when (and (not (string= "" output-buffer))
               (> (length python-shell-prompt-output-regexp) 0))
      (setq output-buffer
            (with-temp-buffer
1226
              (insert output-buffer)
1227 1228 1229 1230 1231 1232 1233 1234 1235
              (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)))))
1236 1237 1238
    (mapconcat
     (lambda (string) string)
     (butlast (split-string output-buffer "\n")) "\n")))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1239 1240 1241 1242

(defun python-shell-send-region (start end)
  "Send the region delimited by START and END to inferior Python process."
  (interactive "r")
1243 1244
  (let ((deactivate-mark nil))
    (python-shell-send-string (buffer-substring start end) nil t)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266

(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 (inner|outer)most def or class to inferior Python process.
When argument ARG is non-nil sends the innermost defun."
  (interactive "P")
  (save-excursion
    (python-shell-send-region (progn
                            (or (if arg
                                    (python-beginning-of-innermost-defun)
                                  (python-beginning-of-defun-function))
                                (progn (beginning-of-line) (point-marker))))
                          (progn
                            (or (python-end-of-defun-function)
                                (progn (end-of-line) (point-marker)))))))

1267 1268 1269 1270 1271
(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."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1272
  (interactive "fFile to send: ")
1273 1274 1275 1276 1277 1278
  (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"))
1279
    (with-current-buffer (process-buffer process)
1280 1281
      (setq inferior-python-mode-current-file
            (convert-standard-filename file-name)))
1282
    (python-shell-send-string
1283
     (format
1284 1285 1286 1287
      (concat "__pyfile = open('''%s''');"
              "exec(compile(__pyfile.read(), '''%s''', 'exec'));"
              "__pyfile.close()")
      (or temp-file-name file-name) file-name)
1288
     process)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1289 1290 1291 1292 1293 1294

(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))

1295 1296 1297 1298 1299 1300
(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))))
1301
    (accept-process-output process python-shell-send-setup-max-wait)
1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312
    (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)

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338

;;; 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.")

1339
(defvar python-shell-completion-string-code
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1340 1341 1342
  "';'.join(__COMPLETER_all_completions('''%s'''))\n"
  "Python code used to get a string of completions separated by semicolons.")

1343 1344 1345
(defun python-shell-completion--get-completions (input process)
  "Retrieve available completions for INPUT using PROCESS."
  (with-current-buffer (process-buffer process)
1346 1347 1348 1349 1350
    (let ((completions (python-shell-send-string-no-output
                        (format python-shell-completion-string-code input)
                        process)))
      (when (> (length completions) 2)
        (split-string completions "^'\\|^\"\\|;\\|'$\\|\"$" t)))))
1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370

(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))))

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1371 1372 1373
(defun python-shell-completion-complete-at-point ()
  "Perform completion at point in inferior Python process."
  (interactive)
1374 1375 1376 1377
  (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)))
1378 1379 1380 1381 1382 1383
             (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)))))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1384 1385 1386

(defun python-shell-completion-complete-or-indent ()
  "Complete or indent depending on the context.
1387 1388
If content before pointer is all whitespace indent.  If not try
to complete."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400
  (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_<>]+\\)()"
1401 1402 1403 1404 1405
  "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
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420
opened)")

(defvar python-pdbtrack-tracking-buffers '()
  "Alist containing elements of form (#<buffer> . #<buffer>).
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 ()