python.el 165 KB
Newer Older
1
;;; python.el --- Python's flying circus support for Emacs -*- lexical-binding: t -*-
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
2

3
;; Copyright (C) 2003-2014 Free Software Foundation, Inc.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
4 5

;; Author: Fabián E. Gallina <fabian@anue.biz>
6
;; URL: https://github.com/fgallina/python.el
7
;; Version: 0.24.4
8
;; Maintainer: emacs-devel@gnu.org
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
9 10 11
;; Created: Jul 2010
;; Keywords: languages

12
;; This file is part of GNU Emacs.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
13

14 15 16 17
;; GNU Emacs 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.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
18

19 20 21 22
;; GNU Emacs 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.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
23 24

;; You should have received a copy of the GNU General Public License
25
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
26 27 28 29 30 31 32 33

;;; 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.

;; Implements Syntax highlighting, Indentation, Movement, Shell
34 35
;; interaction, Shell completion, Shell virtualenv support, Pdb
;; tracking, Symbol completion, Skeletons, FFAP, Code Check, Eldoc,
36
;; Imenu.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
37 38 39 40 41 42

;; 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
43 44 45
;; indentation by hitting <tab> several times.  Also electric-indent-mode
;; is supported such that when inserting a colon the current line is
;; dedented automatically if needed.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
46 47

;; Movement: `beginning-of-defun' and `end-of-defun' functions are
48
;; properly implemented.  There are also specialized
49 50 51 52
;; `forward-sentence' and `backward-sentence' replacements called
;; `python-nav-forward-block', `python-nav-backward-block'
;; respectively which navigate between beginning of blocks of code.
;; Extra functions `python-nav-forward-statement',
53 54
;; `python-nav-backward-statement',
;; `python-nav-beginning-of-statement', `python-nav-end-of-statement',
55 56 57 58 59 60
;; `python-nav-beginning-of-block', `python-nav-end-of-block' and
;; `python-nav-if-name-main' are included but no bound to any key.  At
;; last but not least the specialized `python-nav-forward-sexp' allows
;; easy navigation between code blocks.  If you prefer `cc-mode'-like
;; `forward-sexp' movement, setting `forward-sexp-function' to nil is
;; enough, You can do that using the `python-mode-hook':
61 62 63

;; (add-hook 'python-mode-hook
;;           (lambda () (setq forward-sexp-function nil)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
64

65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
;; Shell interaction: is provided and allows opening Python shells
;; inside Emacs and executing any block of code of your current buffer
;; in that inferior Python process.

;; Besides that only the standard CPython (2.x and 3.x) shell and
;; IPython are officially supported out of the box, the interaction
;; should support any other readline based Python shells as well
;; (e.g. Jython and Pypy have been reported to work).  You can change
;; your default interpreter and commandline arguments by setting the
;; `python-shell-interpreter' and `python-shell-interpreter-args'
;; variables.  This example enables IPython globally:

;; (setq python-shell-interpreter "ipython"
;;       python-shell-interpreter-args "-i")

;; Using the "console" subcommand to start IPython in server-client
;; mode is known to fail intermittently due a bug on IPython itself
;; (see URL `http://debbugs.gnu.org/cgi/bugreport.cgi?bug=18052#27').
;; There seems to be a race condition in the IPython server (A.K.A
;; kernel) when code is sent while it is still initializing, sometimes
;; causing the shell to get stalled.  With that said, if an IPython
;; kernel is already running, "console --existing" seems to work fine.

;; Running IPython on Windows needs more tweaking.  The way you should
;; set `python-shell-interpreter' and `python-shell-interpreter-args'
;; is as follows (of course you need to modify the paths according to
;; your system):

;; (setq python-shell-interpreter "C:\\Python27\\python.exe"
;;       python-shell-interpreter-args
;;       "-i C:\\Python27\\Scripts\\ipython-script.py")

97 98 99 100 101 102 103 104
;; If you are experiencing missing or delayed output in your shells,
;; that's likely caused by your Operating System's pipe buffering
;; (e.g. this is known to happen running CPython 3.3.4 in Windows 7.
;; See URL `http://debbugs.gnu.org/cgi/bugreport.cgi?bug=17304').  To
;; fix this, using CPython's "-u" commandline argument or setting the
;; "PYTHONUNBUFFERED" environment variable should help: See URL
;; `https://docs.python.org/3/using/cmdline.html#cmdoption-u'.

105 106 107 108 109 110 111 112
;; The interaction relies upon having prompts for input (e.g. ">>> "
;; and "... " in standard Python shell) and output (e.g. "Out[1]: " in
;; IPython) detected properly.  Failing that Emacs may hang but, in
;; the case that happens, you can recover with \\[keyboard-quit].  To
;; avoid this issue, a two-step prompt autodetection mechanism is
;; provided: the first step is manual and consists of a collection of
;; regular expressions matching common prompts for Python shells
;; stored in `python-shell-prompt-input-regexps' and
113 114 115 116 117 118 119
;; `python-shell-prompt-output-regexps', and dir-local friendly vars
;; `python-shell-prompt-regexp', `python-shell-prompt-block-regexp',
;; `python-shell-prompt-output-regexp' which are appended to the
;; former automatically when a shell spawns; the second step is
;; automatic and depends on the `python-shell-prompt-detect' helper
;; function.  See its docstring for details on global variables that
;; modify its behavior.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
120 121

;; Shell completion: hitting tab will try to complete the current
122 123 124 125 126 127 128
;; word.  Shell completion is implemented in such way that if you
;; change the `python-shell-interpreter' it should be possible to
;; integrate custom logic to calculate completions.  To achieve this
;; you just need to set `python-shell-completion-setup-code' and
;; `python-shell-completion-string-code'.  The default provided code,
;; enables autocompletion for both CPython and IPython (and ideally
;; any readline based Python shell).  This code depends on the
129
;; readline module, so if you are using some Operating System that
130 131 132 133 134 135 136 137 138
;; bundles Python without it (like Windows), installing pyreadline
;; from URL `http://ipython.scipy.org/moin/PyReadline/Intro' should
;; suffice.  To troubleshoot why you are not getting any completions
;; you can try the following in your Python shell:

;; >>> import readline, rlcompleter

;; If you see an error, then you need to either install pyreadline or
;; setup custom code that avoids that dependency.
139

140 141
;; Shell virtualenv support: The shell also contains support for
;; virtualenvs and other special environment modifications thanks to
142 143
;; `python-shell-process-environment' and `python-shell-exec-path'.
;; These two variables allows you to modify execution paths and
144
;; environment variables to make easy for you to setup virtualenv rules
145
;; or behavior modifications when running shells.  Here is an example
146 147 148 149 150 151 152 153 154 155 156 157 158 159
;; 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/"))

Paul Eggert's avatar
Paul Eggert committed
160
;; Since the above is cumbersome and can be programmatically
161 162 163 164 165 166 167 168
;; calculated, the variable `python-shell-virtualenv-path' is
;; provided.  When this variable is set with the path of the
;; virtualenv to use, `process-environment' and `exec-path' get proper
;; values in order to run shells inside the specified virtualenv.  So
;; the following will achieve the same as the previous example:

;; (setq python-shell-virtualenv-path "/path/to/env/")

169 170 171 172
;; Also the `python-shell-extra-pythonpaths' variable have been
;; introduced as simple way of adding paths to the PYTHONPATH without
;; affecting existing values.

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
173 174 175 176
;; 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
177
;; Symbol completion: you can complete the symbol at point.  It uses
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
178 179 180
;; the shell completion in background so you should run
;; `python-shell-send-buffer' from time to time to get better results.

181 182
;; Skeletons: 6 skeletons are provided for simple inserting of class,
;; def, for, if, try and while.  These skeletons are integrated with
183
;; abbrev.  If you have `abbrev-mode' activated and
184 185
;; `python-skeleton-autoinsert' is set to t, then whenever you type
;; the name of any of those defined and hit SPC, they will be
186 187 188 189
;; automatically expanded.  As an alternative you can use the defined
;; skeleton commands: `python-skeleton-class', `python-skeleton-def'
;; `python-skeleton-for', `python-skeleton-if', `python-skeleton-try'
;; and `python-skeleton-while'.
190

191 192 193 194
;; 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.

195 196
;; Code check: Check the current file for errors with `python-check'
;; using the program defined in `python-check-command'.
197

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

203 204 205
;; Imenu: There are two index building functions to be used as
;; `imenu-create-index-function': `python-imenu-create-index' (the
;; default one, builds the alist in form of a tree) and
206
;; `python-imenu-create-flat-index'.  See also
207 208 209 210
;; `python-imenu-format-item-label-function',
;; `python-imenu-format-parent-item-label-function',
;; `python-imenu-format-parent-item-jump-label-function' variables for
;; changing the way labels are formatted in the tree version.
211

212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
;; 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
227 228 229 230 231 232 233 234 235 236 237 238
;;; Installation:

;; Add this to your .emacs:

;; (add-to-list 'load-path "/folder/containing/file")
;; (require 'python)

;;; TODO:

;;; Code:

(require 'ansi-color)
239
(require 'cl-lib)
240
(require 'comint)
241
(require 'json)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
242

243 244 245 246
;; 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
247 248 249 250 251 252

(autoload 'comint-mode "comint")

;;;###autoload
(add-to-list 'auto-mode-alist (cons (purecopy "\\.py\\'")  'python-mode))
;;;###autoload
253
(add-to-list 'interpreter-mode-alist (cons (purecopy "python[0-9.]*") 'python-mode))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
254 255 256 257

(defgroup python nil
  "Python Language's flying circus support for Emacs."
  :group 'languages
258
  :version "24.3"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
259 260 261 262 263 264 265
  :link '(emacs-commentary-link "python"))


;;; Bindings

(defvar python-mode-map
  (let ((map (make-sparse-keymap)))
266
    ;; Movement
267 268 269
    (define-key map [remap backward-sentence] 'python-nav-backward-block)
    (define-key map [remap forward-sentence] 'python-nav-forward-block)
    (define-key map [remap backward-up-list] 'python-nav-backward-up-list)
270
    (define-key map "\C-c\C-j" 'imenu)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
271 272 273 274 275
    ;; 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)
276 277 278 279 280 281 282
    ;; 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
283
    ;; Shell interaction
284
    (define-key map "\C-c\C-p" 'run-python)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
285 286 287 288 289 290
    (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)
291 292
    ;; Some util commands
    (define-key map "\C-c\C-v" 'python-check)
293
    (define-key map "\C-c\C-f" 'python-eldoc-at-point)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
294 295
    ;; Utilities
    (substitute-key-definition 'complete-symbol 'completion-at-point
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
296
                               map global-map)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
297 298
    (easy-menu-define python-menu map "Python Mode menu"
      `("Python"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
299 300 301 302 303 304 305 306 307 308 309 310
        :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"]
        "-"
        ["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"]
        ["Mark def/class" mark-defun
         :help "Mark outermost definition around point"]
311
        ["Jump to def/class" imenu
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
312
         :help "Jump to a class or function definition"]
313
        "--"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
314
        ("Skeletons")
315
        "---"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
        ["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"]
331
        "----"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
332 333 334 335 336 337
        ["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"]))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
338 339 340 341 342 343
    map)
  "Keymap for `python-mode'.")


;;; Python specialized rx

344 345
(eval-when-compile
  (defconst python-rx-constituents
346
    `((block-start          . ,(rx symbol-start
347 348 349
                                   (or "def" "class" "if" "elif" "else" "try"
                                       "except" "finally" "for" "while" "with")
                                   symbol-end))
350 351 352 353 354 355 356
      (dedenter            . ,(rx symbol-start
                                   (or "elif" "else" "except" "finally")
                                   symbol-end))
      (block-ender         . ,(rx symbol-start
                                  (or
                                   "break" "continue" "pass" "raise" "return")
                                  symbol-end))
357
      (decorator            . ,(rx line-start (* space) ?@ (any letter ?_)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
358
                                   (* (any word ?_))))
359 360
      (defun                . ,(rx symbol-start (or "def" "class") symbol-end))
      (if-name-main         . ,(rx line-start "if" (+ space) "__name__"
361 362 363
                                   (+ space) "==" (+ space)
                                   (any ?' ?\") "__main__" (any ?' ?\")
                                   (* space) ?:))
364 365 366 367 368 369
      (symbol-name          . ,(rx (any letter ?_) (* (any word ?_))))
      (open-paren           . ,(rx (or "{" "[" "(")))
      (close-paren          . ,(rx (or "}" "]" ")")))
      (simple-operator      . ,(rx (any ?+ ?- ?/ ?& ?^ ?~ ?| ?* ?< ?> ?= ?%)))
      ;; FIXME: rx should support (not simple-operator).
      (not-simple-operator  . ,(rx
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
370 371
                                (not
                                 (any ?+ ?- ?/ ?& ?^ ?~ ?| ?* ?< ?> ?= ?%))))
372 373
      ;; FIXME: Use regexp-opt.
      (operator             . ,(rx (or "+" "-" "/" "&" "^" "~" "|" "*" "<" ">"
374 375
                                       "=" "%" "**" "//" "<<" ">>" "<=" "!="
                                       "==" ">=" "is" "not")))
376 377
      ;; FIXME: Use regexp-opt.
      (assignment-operator  . ,(rx (or "=" "+=" "-=" "*=" "/=" "//=" "%=" "**="
378 379 380 381 382 383 384 385 386 387 388 389 390 391
                                       ">>=" "<<=" "&=" "^=" "|=")))
      (string-delimiter . ,(rx (and
                                ;; Match even number of backslashes.
                                (or (not (any ?\\ ?\' ?\")) point
                                    ;; Quotes might be preceded by a escaped quote.
                                    (and (or (not (any ?\\)) point) ?\\
                                         (* ?\\ ?\\) (any ?\' ?\")))
                                (* ?\\ ?\\)
                                ;; Match single or triple quotes of any kind.
                                (group (or  "\"" "\"\"\"" "'" "'''"))))))
    "Additional Python specific sexps for `python-rx'")

  (defmacro python-rx (&rest regexps)
    "Python mode specialized rx macro.
392
This variant of `rx' supports common Python named REGEXPS."
393 394 395 396 397 398 399
    (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))))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
400 401 402


;;; Font-lock and syntax
403

404 405 406 407 408 409 410 411 412 413 414 415 416
(eval-when-compile
  (defun python-syntax--context-compiler-macro (form type &optional syntax-ppss)
    (pcase type
      (`'comment
       `(let ((ppss (or ,syntax-ppss (syntax-ppss))))
          (and (nth 4 ppss) (nth 8 ppss))))
      (`'string
       `(let ((ppss (or ,syntax-ppss (syntax-ppss))))
          (and (nth 3 ppss) (nth 8 ppss))))
      (`'paren
       `(nth 1 (or ,syntax-ppss (syntax-ppss))))
      (_ form))))

417 418 419 420
(defun python-syntax-context (type &optional syntax-ppss)
  "Return non-nil if point is on TYPE using SYNTAX-PPSS.
TYPE can be `comment', `string' or `paren'.  It returns the start
character address of the specified TYPE."
421
  (declare (compiler-macro python-syntax--context-compiler-macro))
422
  (let ((ppss (or syntax-ppss (syntax-ppss))))
423 424 425 426 427
    (pcase type
      (`comment (and (nth 4 ppss) (nth 8 ppss)))
      (`string (and (nth 3 ppss) (nth 8 ppss)))
      (`paren (nth 1 ppss))
      (_ nil))))
428 429 430 431 432 433 434 435 436 437 438 439 440 441

(defun python-syntax-context-type (&optional syntax-ppss)
  "Return the context type using SYNTAX-PPSS.
The type returned can be `comment', `string' or `paren'."
  (let ((ppss (or syntax-ppss (syntax-ppss))))
    (cond
     ((nth 8 ppss) (if (nth 4 ppss) 'comment 'string))
     ((nth 1 ppss) 'paren))))

(defsubst python-syntax-comment-or-string-p ()
  "Return non-nil if point is inside 'comment or 'string."
  (nth 8 (syntax-ppss)))

(define-obsolete-function-alias
442
  'python-info-ppss-context #'python-syntax-context "24.3")
443 444

(define-obsolete-function-alias
445
  'python-info-ppss-context-type #'python-syntax-context-type "24.3")
446 447 448

(define-obsolete-function-alias
  'python-info-ppss-comment-or-string-p
449
  #'python-syntax-comment-or-string-p "24.3")
450

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
451 452 453
(defvar python-font-lock-keywords
  ;; Keywords
  `(,(rx symbol-start
454 455 456 457 458 459 460 461 462 463 464 465
         (or
          "and" "del" "from" "not" "while" "as" "elif" "global" "or" "with"
          "assert" "else" "if" "pass" "yield" "break" "except" "import" "class"
          "in" "raise" "continue" "finally" "is" "return" "def" "for" "lambda"
          "try"
          ;; Python 2:
          "print" "exec"
          ;; Python 3:
          ;; False, None, and True are listed as keywords on the Python 3
          ;; documentation, but since they also qualify as constants they are
          ;; fontified like that in order to keep font-lock consistent between
          ;; Python versions.
466 467 468
          "nonlocal"
          ;; Extra:
          "self")
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
469 470 471 472 473 474 475 476
         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
477
    (,(rx symbol-start
478 479 480 481 482
          (or
           "Ellipsis" "False" "None" "NotImplemented" "True" "__debug__"
           ;; copyright, license, credits, quit and exit are added by the site
           ;; module and they are not intended to be used in programs
           "copyright" "credits" "exit" "license" "quit")
483
          symbol-end) . font-lock-constant-face)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
484 485 486 487 488 489
    ;; Decorators.
    (,(rx line-start (* (any " \t")) (group "@" (1+ (or word ?_))
                                            (0+ "." (1+ (or word ?_)))))
     (1 font-lock-type-face))
    ;; Builtin Exceptions
    (,(rx symbol-start
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
          (or
           "ArithmeticError" "AssertionError" "AttributeError" "BaseException"
           "DeprecationWarning" "EOFError" "EnvironmentError" "Exception"
           "FloatingPointError" "FutureWarning" "GeneratorExit" "IOError"
           "ImportError" "ImportWarning" "IndexError" "KeyError"
           "KeyboardInterrupt" "LookupError" "MemoryError" "NameError"
           "NotImplementedError" "OSError" "OverflowError"
           "PendingDeprecationWarning" "ReferenceError" "RuntimeError"
           "RuntimeWarning" "StopIteration" "SyntaxError" "SyntaxWarning"
           "SystemError" "SystemExit" "TypeError" "UnboundLocalError"
           "UnicodeDecodeError" "UnicodeEncodeError" "UnicodeError"
           "UnicodeTranslateError" "UnicodeWarning" "UserWarning" "VMSError"
           "ValueError" "Warning" "WindowsError" "ZeroDivisionError"
           ;; Python 2:
           "StandardError"
           ;; Python 3:
           "BufferError" "BytesWarning" "IndentationError" "ResourceWarning"
           "TabError")
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
508 509
          symbol-end) . font-lock-type-face)
    ;; Builtins
510
    (,(rx symbol-start
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
          (or
           "abs" "all" "any" "bin" "bool" "callable" "chr" "classmethod"
           "compile" "complex" "delattr" "dict" "dir" "divmod" "enumerate"
           "eval" "filter" "float" "format" "frozenset" "getattr" "globals"
           "hasattr" "hash" "help" "hex" "id" "input" "int" "isinstance"
           "issubclass" "iter" "len" "list" "locals" "map" "max" "memoryview"
           "min" "next" "object" "oct" "open" "ord" "pow" "print" "property"
           "range" "repr" "reversed" "round" "set" "setattr" "slice" "sorted"
           "staticmethod" "str" "sum" "super" "tuple" "type" "vars" "zip"
           "__import__"
           ;; Python 2:
           "basestring" "cmp" "execfile" "file" "long" "raw_input" "reduce"
           "reload" "unichr" "unicode" "xrange" "apply" "buffer" "coerce"
           "intern"
           ;; Python 3:
           "ascii" "bytearray" "bytes" "exec"
           ;; Extra:
           "__all__" "__doc__" "__name__" "__package__")
529
          symbol-end) . font-lock-builtin-face)
Paul Eggert's avatar
Paul Eggert committed
530
    ;; assignments
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
531 532
    ;; support for a = b = c = 5
    (,(lambda (limit)
533 534
        (let ((re (python-rx (group (+ (any word ?. ?_)))
                             (? ?\[ (+ (not (any  ?\]))) ?\]) (* space)
535 536 537 538 539 540
                             assignment-operator))
              (res nil))
          (while (and (setq res (re-search-forward re limit t))
                      (or (python-syntax-context 'paren)
                          (equal (char-after (point-marker)) ?=))))
          res))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
541 542 543 544 545 546
     (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)
547 548 549 550 551 552
                             assignment-operator))
              (res nil))
          (while (and (setq res (re-search-forward re limit t))
                      (goto-char (match-end 1))
                      (python-syntax-context 'paren)))
          res))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
553 554
     (1 font-lock-variable-name-face nil nil))))

555 556
(defconst python-syntax-propertize-function
  (syntax-propertize-rules
557
   ((python-rx string-delimiter)
558
    (0 (ignore (python-syntax-stringify))))))
559 560 561 562

(defsubst python-syntax-count-quotes (quote-char &optional point limit)
  "Count number of quotes around point (max is 3).
QUOTE-CHAR is the quote char to count.  Optional argument POINT is
563
the point where scan starts (defaults to current point), and LIMIT
564 565 566 567 568
is used to limit the scan."
  (let ((i 0))
    (while (and (< i 3)
                (or (not limit) (< (+ point i) limit))
                (eq (char-after (+ point i)) quote-char))
569
      (setq i (1+ i)))
570 571 572 573
    i))

(defun python-syntax-stringify ()
  "Put `syntax-table' property correctly on single/triple quotes."
574
  (let* ((num-quotes (length (match-string-no-properties 1)))
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
         (ppss (prog2
                   (backward-char num-quotes)
                   (syntax-ppss)
                 (forward-char num-quotes)))
         (string-start (and (not (nth 4 ppss)) (nth 8 ppss)))
         (quote-starting-pos (- (point) num-quotes))
         (quote-ending-pos (point))
         (num-closing-quotes
          (and string-start
               (python-syntax-count-quotes
                (char-before) string-start quote-starting-pos))))
    (cond ((and string-start (= num-closing-quotes 0))
           ;; This set of quotes doesn't match the string starting
           ;; kind. Do nothing.
           nil)
          ((not string-start)
           ;; This set of quotes delimit the start of a string.
           (put-text-property quote-starting-pos (1+ quote-starting-pos)
                              'syntax-table (string-to-syntax "|")))
          ((= num-quotes num-closing-quotes)
           ;; This set of quotes delimit the end of a string.
           (put-text-property (1- quote-ending-pos) quote-ending-pos
                              'syntax-table (string-to-syntax "|")))
          ((> num-quotes num-closing-quotes)
           ;; This may only happen whenever a triple quote is closing
           ;; a single quoted string. Add string delimiter syntax to
           ;; all three quotes.
           (put-text-property quote-starting-pos quote-ending-pos
                              'syntax-table (string-to-syntax "|"))))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
604 605 606 607 608 609

(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 "_"))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
610
          (sst (standard-syntax-table)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
611
      (dotimes (i 128)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
612 613 614
        (unless (= i ?_)
          (if (equal symbol (aref sst i))
              (modify-syntax-entry i "." table)))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
    (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
645 646
  :group 'python
  :safe 'booleanp)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
647

648 649 650 651 652 653
(defcustom python-indent-trigger-commands
  '(indent-for-tab-command yas-expand yas/expand)
  "Commands that might trigger a `python-indent-line' call."
  :type '(repeat symbol)
  :group 'python)

654
(define-obsolete-variable-alias
655
  'python-indent 'python-indent-offset "24.3")
656 657

(define-obsolete-variable-alias
658
  'python-guess-indent 'python-indent-guess-indent-offset "24.3")
659

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
660 661 662 663 664 665 666
(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'.")

(defun python-indent-guess-indent-offset ()
667
  "Guess and set `python-indent-offset' for the current buffer."
668
  (interactive)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
669 670 671 672 673 674 675 676 677
  (save-excursion
    (save-restriction
      (widen)
      (goto-char (point-min))
      (let ((block-end))
        (while (and (not block-end)
                    (re-search-forward
                     (python-rx line-start block-start) nil t))
          (when (and
678
                 (not (python-syntax-context-type))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
                 (progn
                   (goto-char (line-end-position))
                   (python-util-forward-comment -1)
                   (if (equal (char-before) ?:)
                       t
                     (forward-line 1)
                     (when (python-info-block-continuation-line-p)
                       (while (and (python-info-continuation-line-p)
                                   (not (eobp)))
                         (forward-line 1))
                       (python-util-forward-comment -1)
                       (when (equal (char-before) ?:)
                         t)))))
            (setq block-end (point-marker))))
        (let ((indentation
               (when block-end
                 (goto-char block-end)
                 (python-util-forward-comment)
                 (current-indentation))))
698
          (if (and indentation (not (zerop indentation)))
699
              (set (make-local-variable 'python-indent-offset) indentation)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
700 701
            (message "Can't guess python-indent-offset, using defaults: %s"
                     python-indent-offset)))))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
702

703 704 705
(defun python-indent-context ()
  "Get information on indentation context.
Context information is returned with a cons with the form:
706
    (STATUS . START)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
707 708

Where status can be any of the following symbols:
709 710

 * after-comment: When current line might continue a comment block
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
711 712 713 714 715
 * 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
716
 * dedenter-statement: Point is on a dedenter statement.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
717 718 719 720 721 722 723 724
 * 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
725
        ;; Beginning of buffer
726 727 728
        ((save-excursion
           (goto-char (line-beginning-position))
           (bobp))
729
         'no-indent)
730 731 732 733 734 735 736 737 738 739 740
        ;; Comment continuation
        ((save-excursion
           (when (and
                  (or
                   (python-info-current-line-comment-p)
                   (python-info-current-line-empty-p))
                  (progn
                    (forward-comment -1)
                    (python-info-current-line-comment-p)))
             (setq start (point))
             'after-comment)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
741
        ;; Inside string
742
        ((setq start (python-syntax-context 'string ppss))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
743
         'inside-string)
744 745 746
        ;; Inside a paren
        ((setq start (python-syntax-context 'paren ppss))
         'inside-paren)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
747
        ;; After backslash
748 749
        ((setq start (when (not (or (python-syntax-context 'string ppss)
                                    (python-syntax-context 'comment ppss)))
750 751 752
                       (let ((line-beg-pos (line-number-at-pos)))
                         (python-info-line-ends-backslash-p
                          (1- line-beg-pos)))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
753 754 755
         'after-backslash)
        ;; After beginning of block
        ((setq start (save-excursion
756 757 758 759 760 761 762 763 764 765
                       (when (progn
                               (back-to-indentation)
                               (python-util-forward-comment -1)
                               (equal (char-before) ?:))
                         ;; Move to the first block start that's not in within
                         ;; a string, comment or paren and that's not a
                         ;; continuation line.
                         (while (and (re-search-backward
                                      (python-rx block-start) nil t)
                                     (or
766
                                      (python-syntax-context-type)
767 768
                                      (python-info-continuation-line-p))))
                         (when (looking-at (python-rx block-start))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
769 770
                           (point-marker)))))
         'after-beginning-of-block)
771 772
        ((when (setq start (python-info-dedenter-statement-p))
           'dedenter-statement))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
773 774
        ;; After normal line
        ((setq start (save-excursion
775
                       (back-to-indentation)
776
                       (skip-chars-backward (rx (or whitespace ?\n)))
777
                       (python-nav-beginning-of-statement)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
778 779 780 781 782 783 784 785 786 787 788 789 790 791
                       (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
792 793
        (pcase context-status
          (`no-indent 0)
794 795 796
          (`after-comment
           (goto-char context-start)
           (current-indentation))
797 798
          ;; When point is after beginning of block just add one level
          ;; of indentation relative to the context-start
799
          (`after-beginning-of-block
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
800 801
           (goto-char context-start)
           (+ (current-indentation) python-indent-offset))
802
          ;; When after a simple line just use previous line
803
          ;; indentation.
804
          (`after-line
805 806 807 808 809 810
           (let* ((pair (save-excursion
                          (goto-char context-start)
                          (cons
                           (current-indentation)
                           (python-info-beginning-of-block-p))))
                  (context-indentation (car pair))
811
                  ;; TODO: Separate block enders into its own case.
812
                  (adjustment
813 814 815 816
                   (if (save-excursion
                         (python-util-forward-comment -1)
                         (python-nav-beginning-of-statement)
                         (looking-at (python-rx block-ender)))
817 818 819
                       python-indent-offset
                     0)))
             (- context-indentation adjustment)))
820 821 822 823 824 825 826 827 828 829 830 831
          ;; When point is on a dedenter statement, search for the
          ;; opening block that corresponds to it and use its
          ;; indentation.  If no opening block is found just remove
          ;; indentation as this is an invalid python file.
          (`dedenter-statement
           (let ((block-start-point
                  (python-info-dedenter-opening-block-position)))
             (save-excursion
               (if (not block-start-point)
                   0
                 (goto-char block-start-point)
                 (current-indentation)))))
832 833 834
          ;; When inside of a string, do nothing. just use the current
          ;; indentation.  XXX: perhaps it would be a good idea to
          ;; invoke standard text indentation here
835
          (`inside-string
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
836 837
           (goto-char context-start)
           (current-indentation))
Paul Eggert's avatar
Paul Eggert committed
838
          ;; After backslash we have several possibilities.
839
          (`after-backslash
840 841 842 843 844 845 846
           (cond
            ;; Check if current line is a dot continuation.  For this
            ;; the current line must start with a dot and previous
            ;; line must contain a dot too.
            ((save-excursion
               (back-to-indentation)
               (when (looking-at "\\.")
847 848 849 850 851
                 ;; If after moving one line back point is inside a paren it
                 ;; needs to move back until it's not anymore
                 (while (prog2
                            (forward-line -1)
                            (and (not (bobp))
852
                                 (python-syntax-context 'paren))))
853
                 (goto-char (line-end-position))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
854 855
                 (while (and (re-search-backward
                              "\\." (line-beginning-position) t)
856
                             (python-syntax-context-type)))
857
                 (if (and (looking-at "\\.")
858
                          (not (python-syntax-context-type)))
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
                     ;; The indentation is the same column of the
                     ;; first matching dot that's not inside a
                     ;; comment, a string or a paren
                     (current-column)
                   ;; No dot found on previous line, just add another
                   ;; indentation level.
                   (+ (current-indentation) python-indent-offset)))))
            ;; Check if prev line is a block continuation
            ((let ((block-continuation-start
                    (python-info-block-continuation-line-p)))
               (when block-continuation-start
                 ;; If block-continuation-start is set jump to that
                 ;; marker and use first column after the block start
                 ;; as indentation value.
                 (goto-char block-continuation-start)
                 (re-search-forward
                  (python-rx block-start (* space))
                  (line-end-position) t)
                 (current-column))))
            ;; Check if current line is an assignment continuation
            ((let ((assignment-continuation-start
                    (python-info-assignment-continuation-line-p)))
               (when assignment-continuation-start
                 ;; If assignment-continuation is set jump to that
                 ;; marker and use first column after the assignment
                 ;; operator as indentation value.
                 (goto-char assignment-continuation-start)
                 (current-column))))
            (t
             (forward-line -1)
Paul Eggert's avatar
Paul Eggert committed
889
             (goto-char (python-info-beginning-of-backslash))
890 891 892
             (if (save-excursion
                   (and
                    (forward-line -1)
893
                    (goto-char
Paul Eggert's avatar
Paul Eggert committed
894
                     (or (python-info-beginning-of-backslash) (point)))
895 896 897 898 899 900 901 902 903 904
                    (python-info-line-ends-backslash-p)))
                 ;; The two previous lines ended in a backslash so we must
                 ;; respect previous line indentation.
                 (current-indentation)
               ;; What happens here is that we are dealing with the second
               ;; line of a backslash continuation, in that case we just going
               ;; to add one indentation level.
               (+ (current-indentation) python-indent-offset)))))
          ;; When inside a paren there's a need to handle nesting
          ;; correctly
905
          (`inside-paren
906
           (cond
Paul Eggert's avatar
Paul Eggert committed
907
            ;; If current line closes the outermost open paren use the
908 909 910 911 912 913
            ;; current indentation of the context-start line.
            ((save-excursion
               (skip-syntax-forward "\s" (line-end-position))
               (when (and (looking-at (regexp-opt '(")" "]" "}")))
                          (progn
                            (forward-char 1)
914
                            (not (python-syntax-context 'paren))))
915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
                 (goto-char context-start)
                 (current-indentation))))
            ;; If open paren is contained on a line by itself add another
            ;; indentation level, else look for the first word after the
            ;; opening paren and use it's column position as indentation
            ;; level.
            ((let* ((content-starts-in-newline)
                    (indent
                     (save-excursion
                       (if (setq content-starts-in-newline
                                 (progn
                                   (goto-char context-start)
                                   (forward-char)
                                   (save-restriction
                                     (narrow-to-region
                                      (line-beginning-position)
                                      (line-end-position))
                                     (python-util-forward-comment))
                                   (looking-at "$")))
                           (+ (current-indentation) python-indent-offset)
                         (current-column)))))
               ;; Adjustments
               (cond
                ;; If current line closes a nested open paren de-indent one
                ;; level.
                ((progn
941
                   (back-to-indentation)
942 943 944 945 946 947 948 949 950 951 952 953 954
                   (looking-at (regexp-opt '(")" "]" "}"))))
                 (- indent python-indent-offset))
                ;; If the line of the opening paren that wraps the current
                ;; line starts a block add another level of indentation to
                ;; follow new pep8 recommendation. See: http://ur1.ca/5rojx
                ((save-excursion
                   (when (and content-starts-in-newline
                              (progn
                                (goto-char context-start)
                                (back-to-indentation)
                                (looking-at (python-rx block-start))))
                     (+ indent python-indent-offset))))
                (t indent)))))))))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
955 956 957

(defun python-indent-calculate-levels ()
  "Calculate `python-indent-levels' and reset `python-indent-current-level'."
958 959 960 961 962
  (if (or (python-info-continuation-line-p)
          (not (python-info-dedenter-statement-p)))
      ;; XXX: This asks for a refactor.  Even if point is on a
      ;; dedenter statement, it could be multiline and in that case
      ;; the continuation lines should be indented with normal rules.
963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980
      (let* ((indentation (python-indent-calculate-indentation))
             (remainder (% indentation python-indent-offset))
             (steps (/ (- indentation remainder) python-indent-offset)))
        (setq python-indent-levels (list 0))
        (dotimes (step steps)
          (push (* python-indent-offset (1+ step)) python-indent-levels))
        (when (not (eq 0 remainder))
          (push (+ (* python-indent-offset steps) remainder) python-indent-levels)))
    (setq python-indent-levels
          (or
           (mapcar (lambda (pos)
                     (save-excursion
                       (goto-char pos)
                       (current-indentation)))
                   (python-info-dedenter-opening-block-positions))
           (list 0))))
  (setq python-indent-current-level (1- (length python-indent-levels))
        python-indent-levels (nreverse python-indent-levels)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
981 982 983 984 985 986 987 988 989 990 991

(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
992 993
indicated by the variable `python-indent-levels' to set the
current indentation.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
994

995 996 997 998 999 1000 1001 1002
When the variable `last-command' is equal to one of the symbols
inside `python-indent-trigger-commands' 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 one of the
symbols inside `python-indent-trigger-commands' and FORCE-TOGGLE
1003 1004
is nil it calculates possible indentation levels and saves them
in the variable `python-indent-levels'.  Afterwards it sets the
1005
variable `python-indent-current-level' correctly so offset is
1006 1007
equal to
   (nth python-indent-current-level python-indent-levels)"
1008
  (or
1009
   (and (or (and (memq this-command python-indent-trigger-commands)
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
                 (eq last-command this-command))
            force-toggle)
        (not (equal python-indent-levels '(0)))
        (or (python-indent-toggle-levels) t))
   (python-indent-calculate-levels))
  (let* ((starting-pos (point-marker))
         (indent-ending-position
          (+ (line-beginning-position) (current-indentation)))
         (follow-indentation-p
          (or (bolp)
              (and (<= (line-beginning-position) starting-pos)
                   (>= indent-ending-position starting-pos))))
         (next-indent (nth python-indent-current-level python-indent-levels)))
    (unless (= next-indent (current-indentation))
      (beginning-of-line)
      (delete-horizontal-space)
      (indent-to next-indent)
      (goto-char starting-pos))
    (and follow-indentation-p (back-to-indentation)))
1029
  (python-info-dedenter-opening-block-message))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1030 1031 1032

(defun python-indent-line-function ()
  "`indent-line-function' for Python mode.
1033
See `python-indent-line' for details."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1034 1035 1036
  (python-indent-line))

(defun python-indent-dedent-line ()
1037
  "De-indent current line."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1038
  (interactive "*")
1039
  (when (and (not (python-syntax-comment-or-string-p))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1040 1041 1042 1043 1044 1045 1046 1047
             (<= (point-marker) (save-excursion
                                  (back-to-indentation)
                                  (point-marker)))
             (> (current-column) 0))
    (python-indent-line t)
    t))

(defun python-indent-dedent-line-backspace (arg)
1048
  "De-indent current line.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1049
Argument ARG is passed to `backward-delete-char-untabify' when
1050
point is not in between the indentation."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1051 1052 1053
  (interactive "*p")
  (when (not (python-indent-dedent-line))
    (backward-delete-char-untabify arg)))
1054
(put 'python-indent-dedent-line-backspace 'delete-selection 'supersede)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1055 1056

(defun python-indent-region (start end)
1057
  "Indent a Python region automagically.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1058 1059

Called from a program, START and END specify the region to indent."
1060 1061 1062 1063 1064 1065 1066 1067
  (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))
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
            (when (and
                   ;; Skip if previous line is empty or a comment.
                   (save-excursion
                     (let ((line-is-comment-p
                            (python-info-current-line-comment-p)))
                       (forward-line -1)
                       (not
                        (or (and (python-info-current-line-comment-p)
                                 ;; Unless this line is a comment too.
                                 (not line-is-comment-p))
                            (python-info-current-line-empty-p)))))
                   ;; Don't mess with strings, unless it's the
                   ;; enclosing set of quotes.
                   (or (not (python-syntax-context 'string))
                       (eq
                        (syntax-after
                         (+ (1- (point))
                            (current-indentation)
                            (python-syntax-count-quotes (char-after) (point))))
                        (string-to-syntax "|")))
                   ;; Skip if current line is a block start, a
                   ;; dedenter or block ender.
                   (save-excursion
                     (back-to-indentation)
                     (not (looking-at
                           (python-rx
                            (or block-start dedenter block-ender))))))
              (python-indent-line)))
1096 1097
        (forward-line 1))
      (move-marker end nil))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1098 1099 1100

(defun python-indent-shift-left (start end &optional count)
  "Shift lines contained in region START END by COUNT columns to the left.
1101 1102 1103 1104
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
1105 1106 1107 1108 1109 1110 1111 1112
  (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)
1113 1114 1115 1116 1117 1118 1119 1120 1121
    (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
1122 1123 1124 1125

(add-to-list 'debug-ignored-errors "^Can't shift all lines enough")

(defun python-indent-shift-right (start end &optional count)
1126
  "Shift lines contained in region START END by COUNT columns to the right.
1127 1128 1129
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
1130 1131 1132 1133
  (interactive
   (if mark-active
       (list (region-beginning) (region-end) current-prefix-arg)
     (list (line-beginning-position) (line-end-position) current-prefix-arg)))
1134
  (let ((deactivate-mark nil))
1135 1136
    (setq count (if count (prefix-numeric-value count)
                  python-indent-offset))
1137
    (indent-rigidly start end count)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1138

1139
(defun python-indent-post-self-insert-function ()
1140
  "Adjust indentation after insertion of some characters.
1141 1142 1143
This function is intended to be added to `post-self-insert-hook.'
If a line renders a paren alone, after adding a char before it,
the line will be re-indented automatically if needed."
1144 1145 1146
  (when (and electric-indent-mode
             (eq (char-before) last-command-event))
    (cond
1147 1148 1149 1150 1151 1152 1153 1154